To verify your email address, please click on the following link: Verify Email
" }, "success_redirection_url": { "description": "The URL that the recipient is sent to if their address is successfully verified", "type": "string", "format": "uri", "example": "https://example.com/success" }, "failure_redirection_url": { "description": "The URL that the recipient is sent to if their address is not successfully verified", "type": "string", "format": "uri", "example": "https://example.com/failure" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Custom verification email template created successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "AWS SES API error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/aws/verify-domain": { "post": { "tags": [ "AWS" ], "summary": "Initiate AWS SES domain verification", "description": "Starts DKIM verification for a domain with AWS SES, sets a MAIL FROM subdomain (mail.This is the HTML body of the campaign
" }, "preview_text": { "type": "string", "example": "This is a preview", "maxLength": 140 }, "file[]": { "description": "Multiple attachment files", "type": "array", "items": { "type": "string", "format": "binary" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Campaign updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Campaign Updated Successfully" }, "campaign": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Validation error" }, "404": { "description": "Campaign not found" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/save-followup/{id}": { "post": { "tags": [ "Campaign" ], "summary": "Save followup status for a campaign", "description": "Updates the followup field of a campaign by ID", "operationId": "7c1c5c36dc97d9c3803119155419264f", "parameters": [ { "name": "id", "in": "path", "description": "Campaign ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "followup" ], "properties": { "followup": { "type": "string", "example": "1" }, "leadId": { "type": "integer", "example": 123, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Followup saved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Campaign Followup Saved Successfully" }, "campaign": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Campaign not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/update_title/{id}": { "post": { "tags": [ "Campaign" ], "summary": "Update campaign title", "description": "Updates the title of a campaign by ID.", "operationId": "f2671a0c63518d47f8bef471446d1b75", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign to update", "required": true, "schema": { "type": "integer", "example": 123 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title" ], "properties": { "title": { "type": "string", "example": "Updated Campaign Title" } }, "type": "object" } } } }, "responses": { "200": { "description": "Campaign Title Saved Successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Campaign Title Saved Successfully" }, "title": { "type": "string", "example": "Updated Campaign Title" } }, "type": "object" } } } }, "400": { "description": "Validation error" }, "404": { "description": "Campaign not found" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/lead-search": { "post": { "tags": [ "Campaign" ], "summary": "Search campaign leads based on filters and keywords", "description": "Searches leads using start and end date, and keyword for contact/company fields.", "operationId": "leadSearch", "parameters": [ { "name": "start_date", "in": "query", "description": "Start date for the search range", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-01-01" } }, { "name": "end_date", "in": "query", "description": "End date for the search range (must be after or equal to start_date)", "required": false, "schema": { "type": "string", "format": "date", "example": "2024-12-31" } }, { "name": "search[value]", "in": "query", "description": "Search keyword for name, email, mobile, or company", "required": false, "schema": { "type": "string", "example": "john" } }, { "name": "search[regex]", "in": "query", "description": "Whether the search value should be interpreted as a regular expression", "required": false, "schema": { "type": "boolean", "example": false } } ], "responses": { "200": { "description": "List of matched leads", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "assigned_to": { "type": "integer", "example": 2 }, "contact_id": { "type": "integer", "example": 5 }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "company_name": { "type": "string", "example": "Acme Inc." }, "company_id": { "type": "integer", "example": 3 }, "mobile_number": { "type": "string", "example": "1234567890" }, "email": { "type": "string", "example": "john@example.com" }, "lead_position_id": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "format": "date-time", "example": "2025-01-01T12:00:00Z" } }, "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "400": { "description": "No search results found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No search results found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/send": { "post": { "tags": [ "Campaign" ], "summary": "Send campaign emails to selected leads or filtered list", "description": "Initiates sending of a campaign to either selected leads or all filtered leads.", "operationId": "sendCampaignEmails", "parameters": [ { "name": "campaign_id", "in": "query", "description": "The ID of the campaign to send", "required": true, "schema": { "type": "integer", "example": 101 } }, { "name": "list_selection_type", "in": "query", "description": "Indicates whether all leads are selected or filtered", "required": true, "schema": { "type": "string", "example": "all_selected", "enum": [ "all_selected", "all_filtered" ] } }, { "name": "lead_ids[]", "in": "query", "description": "Array of lead IDs (required if list_selection_type is all_selected)", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "contact_ids[]", "in": "query", "description": "Array of contact IDs (required if list_selection_type is all_selected)", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "email_list[]", "in": "query", "description": "Array of email addresses (required if list_selection_type is all_selected)", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "email" } } }, { "name": "schedule_time", "in": "query", "description": "Schedule time to send emails (optional, UTC timezone expected)", "required": false, "schema": { "type": "string", "format": "date-time", "example": "2025-06-01T10:00:00Z" } }, { "name": "campaign_sending_initiated_from", "in": "query", "description": "Origin of the request, used to include extra fields", "required": false, "schema": { "type": "string", "example": "from_lead_edit_tab" } }, { "name": "updated_campaign_html", "in": "query", "description": "Updated HTML content of the campaign (sent if initiated from lead edit tab)", "required": false, "schema": { "type": "string" } }, { "name": "lead_campaign_bcc_emails", "in": "query", "description": "BCC email addresses (sent if initiated from lead edit tab)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Emails initiated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Emails sending has been initiated." }, "is_email_verified_check": { "type": "boolean", "example": false }, "start_automation_message": { "type": "string", "example": "Automation started." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "An error occurred" }, "trace": { "type": "array", "items": { "type": "object" } }, "line_number": { "type": "integer", "example": 123 }, "is_email_verified_check": { "type": "boolean", "example": false } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/upload-file": { "post": { "tags": [ "Campaign" ], "summary": "Upload a file for Unlayer editor", "description": "Uploads a single file and returns file info and URL", "operationId": "uploadUnlayerFile", "requestBody": { "description": "File to upload", "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "description": "File to upload", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "File uploaded successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "File has been uploaded Successfully" }, "data": { "properties": { "file_name": { "type": "string", "example": "abc123.jpg" }, "filelink": { "type": "string", "example": "https://example.com/storage/unlayer-files/abc123.jpg" }, "file_size": { "type": "integer", "example": 123456 }, "extension": { "type": "string", "example": "jpg" } }, "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/delete-all": { "post": { "tags": [ "Campaign" ], "summary": "Delete multiple campaigns", "description": "Deletes campaigns specified by an array of IDs.", "operationId": "deleteAllCampaigns", "requestBody": { "description": "Array of campaign IDs to delete", "required": true, "content": { "application/json": { "schema": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "example": [ 1, 2, 3 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Campaigns deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Campaign Deleted Successfully" } }, "type": "object" } } } }, "400": { "description": "No campaign IDs provided", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Campaign Not Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign_list_by_email_type/{email_type}": { "get": { "tags": [ "Campaign" ], "summary": "Get Campaign List By Email Type", "description": "Returns a list of campaigns filtered by the email type. If the type is 'follow_up', all campaigns for the client are returned.", "operationId": "5b13ce3b8163c5e9a6ac5f09ba0e8961", "parameters": [ { "name": "email_type", "in": "path", "description": "Type of email to filter campaigns (e.g., 'regular', 'follow_up', etc.)", "required": true, "schema": { "type": "string", "example": "regular" } } ], "responses": { "200": { "description": "Successful response with campaign list", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "campaign_list_by_email_type": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 101 }, "title": { "type": "string", "example": "My Campaign" } }, "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No campaigns found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "campaign_list_by_email_type": { "type": "string", "example": "No Campaign Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/send-reponse-email-on-form-submit": { "post": { "tags": [ "Campaign" ], "summary": "Send campaign email on form submit", "description": "Sends a campaign follow-up email to the provided recipient after form submission.", "operationId": "sendResponseEmailOnFormSubmit", "parameters": [ { "name": "campaign_id", "in": "query", "description": "ID of the campaign", "required": true, "schema": { "type": "integer", "example": 123 } }, { "name": "to_email", "in": "query", "description": "Recipient email address", "required": true, "schema": { "type": "string", "format": "email", "example": "user@example.com" } } ], "responses": { "200": { "description": "Email sent successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Campaign mail has been sent successfully." } }, "type": "object" } } } }, "403": { "description": "Campaign not approved", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Campaign is not approved. Please get it approved" }, "success": { "type": "boolean", "example": false }, "is_email_verified_check": { "type": "boolean", "example": false }, "from_email": { "type": "string", "example": "sender@example.com" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Something went wrong." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/get-list-campaign-email/{id}": { "post": { "tags": [ "Campaign" ], "summary": "Get detailed email stats and list for a campaign", "description": "Returns aggregated statistics and email delivery info for a specific campaign.", "operationId": "getListCampaignEmail", "parameters": [ { "name": "id", "in": "path", "description": "Campaign ID", "required": true, "schema": { "type": "integer", "example": 123 } }, { "name": "filter_by_event", "in": "query", "description": "Event filter type. Default is 'sent'.", "required": false, "schema": { "type": "string", "example": "sent" } } ], "responses": { "200": { "description": "Campaign email statistics and list", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "delivered_at": { "type": "string", "format": "date-time", "example": "2024-06-01 12:00:00" }, "sent_at": { "type": "string", "format": "date-time", "example": "2024-06-01 11:50:00" }, "viewed_at": { "type": "string", "format": "date-time", "example": "2024-06-01 12:10:00" }, "queued_at": { "type": "string", "format": "date-time", "example": "2024-06-01 11:30:00" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-06-01 11:20:00" }, "updated_at": { "type": "string", "format": "date-time", "example": "2024-06-01 12:15:00" } }, "type": "object" } }, "title": { "type": "string", "example": "June Newsletter" }, "Queued": { "type": "integer", "example": 100 }, "Sent": { "type": "integer", "example": 95 }, "Delivered": { "type": "integer", "example": 90 }, "Viewed": { "type": "integer", "example": 80 }, "Clicked": { "type": "integer", "example": 25 }, "Failed": { "type": "integer", "example": 5 } }, "type": "object" } } } }, "404": { "description": "Campaign not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Campaign not found" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Unexpected error occurred." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/clone/{id}": { "get": { "tags": [ "Campaign" ], "summary": "Clone a campaign", "description": "Clones an existing campaign and prepends 'Copy of' to the campaign title.", "operationId": "campaignListClone", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign to clone", "required": true, "schema": { "type": "integer", "example": 101 } } ], "responses": { "200": { "description": "Campaign cloned successfully", "content": { "application/json": { "schema": { "properties": { "campaign": { "properties": { "id": { "type": "integer", "example": 102 }, "title": { "type": "string", "example": "Copy of Spring Launch Campaign" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-05-19T10:15:00Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-05-19T10:15:00Z" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "Campaign not found or unauthorized access", "content": { "application/json": { "schema": { "properties": { "campaign": { "type": "string", "example": "Campaign Not Found" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Unexpected error occurred." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/image-upload-post": { "post": { "tags": [ "Campaign" ], "summary": "Upload an image to S3 storage", "description": "Uploads an image file (jpeg, png, jpg, gif, svg) with max size 2MB and returns the accessible URL", "operationId": "imageUploadPost", "requestBody": { "description": "Image file to upload", "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "image" ], "properties": { "image": { "description": "Image file (jpeg, png, jpg, gif, svg)", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "File uploaded successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "File has been uploaded Successfully" }, "path": { "type": "string", "example": "https://bucket.s3.region.amazonaws.com/images/123456.jpg" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "The image field is required." }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/check-email-verify": { "get": { "tags": [ "Campaign" ], "summary": "Check unverified campaign email addresses", "description": "Retrieves a list of campaign 'from_email' and 'reply_to' addresses that are not verified.", "operationId": "c9b8f2c851235277a627a47b862a7a0f", "responses": { "200": { "description": "List of unverified emails", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "string", "example": "noreply@example.com" } } }, "type": "object" } } } }, "404": { "description": "No emails found or all emails verified", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false } }, "type": "object" } } } }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/test-campaign-mail": { "post": { "tags": [ "Campaign" ], "summary": "Send a test campaign email", "description": "Sends a test email with campaign content. Appends the user's signature if specified.", "operationId": "51442c1644d7e934e8de66543a37781c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "to_email", "from_email", "html_body" ], "properties": { "to_email": { "description": "Recipient email", "type": "string", "format": "email", "example": "test@example.com" }, "from_email": { "description": "Verified sender email", "type": "string", "format": "email", "example": "sender@example.com" }, "html_body": { "description": "HTML content of the email", "type": "string", "example": "Hello world!
" }, "signature": { "description": "Whether to append signature", "type": "string", "example": "true", "enum": [ "true", "false" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Test email sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "is_verified": { "type": "boolean", "example": true }, "data": { "type": "object" }, "message": { "type": "string", "example": "Mail sent successfully." } }, "type": "object" } } } }, "403": { "description": "Feature temporarily disabled or email not verified", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "is_verified": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Email is not verified on AWS." } }, "type": "object" } } } }, "500": { "description": "Error sending email", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Some error message" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/test-campaign-list-mail": { "post": { "tags": [ "Campaign" ], "summary": "Send a test campaign listing", "description": "Sends a test email with campaign content.", "operationId": "5119778c2ecc9fa976084f3f5bd43df4", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "campaign_id", "to_mail" ], "properties": { "to_email": { "description": "Recipient email", "type": "string", "format": "email", "example": "test@example.com" }, "campaign_id": { "description": "Campaign ID", "type": "id", "format": "number", "example": "123" } }, "type": "object" } } } }, "responses": { "200": { "description": "Test email sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "is_verified": { "type": "boolean", "example": true }, "data": { "type": "object" }, "message": { "type": "string", "example": "Mail sent successfully." } }, "type": "object" } } } }, "403": { "description": "Feature temporarily disabled or email not verified", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "is_verified": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Email is not verified on AWS." } }, "type": "object" } } } }, "500": { "description": "Error sending email", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Some error message" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/view-reports": { "post": { "tags": [ "Campaign" ], "summary": "View campaign reports", "description": "Get aggregated campaign email performance metrics filtered by client.", "operationId": "viewCampaignReports", "responses": { "200": { "description": "List of campaigns with aggregated email metrics", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 101 }, "campaign_id": { "type": "integer", "example": 101 }, "queued": { "type": "integer", "example": 150 }, "sent": { "type": "integer", "example": 145 }, "viewed": { "type": "integer", "example": 130 }, "clicked": { "type": "integer", "example": 50 }, "total_queued": { "type": "integer", "example": 150 }, "total_sent": { "type": "integer", "example": 145 }, "total_viewed": { "type": "integer", "example": 130 }, "total_clicked": { "type": "integer", "example": 50 }, "created_at": { "type": "string", "format": "date-time", "example": "2025-05-19T12:34:56Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2025-05-19T13:00:00Z" } }, "type": "object" } }, "draw": { "type": "integer", "example": 1 }, "recordsTotal": { "type": "integer", "example": 10 }, "recordsFiltered": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Unexpected error occurred." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/view-reports-chart": { "post": { "tags": [ "Campaign" ], "summary": "Get campaign reports chart data", "description": "Fetch aggregated campaign email metrics for chart visualization.", "operationId": "viewCampaignReportsChart", "responses": { "200": { "description": "Aggregated campaign email metrics grouped by campaign", "content": { "application/json": { "schema": { "properties": { "chart_report": { "type": "array", "items": { "properties": { "total_queued": { "type": "integer", "example": 200 }, "total_sent": { "type": "integer", "example": 190 }, "total_viewed": { "type": "integer", "example": 180 }, "total_clicked": { "type": "integer", "example": 120 } }, "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Unexpected error occurred." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/send-html-perview": { "post": { "tags": [ "Campaign" ], "summary": "Get personalized HTML preview of a campaign", "description": "Returns a preview of the campaign's HTML content after replacing dynamic placeholders with actual values like customer name and appointment date.", "operationId": "htmlPreview", "parameters": [ { "name": "campaign_id", "in": "query", "description": "ID of the campaign", "required": true, "schema": { "type": "integer", "example": 101 } }, { "name": "lead_contact_id", "in": "query", "description": "ID of the lead contact", "required": true, "schema": { "type": "integer", "example": 555 } }, { "name": "lead_id", "in": "query", "description": "ID of the lead", "required": true, "schema": { "type": "integer", "example": 222 } } ], "responses": { "200": { "description": "Preview generated or campaign not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Campaign found." }, "html": { "type": "string", "example": "Hello John Doe" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/campaign/html-perview/{id}": { "get": { "tags": [ "Campaign" ], "summary": "Get HTML preview of a campaign", "description": "Returns the HTML content of a campaign, optionally appending the user's signature based on campaign and user settings.", "operationId": "getHtmlPreview", "parameters": [ { "name": "id", "in": "path", "description": "ID of the campaign", "required": true, "schema": { "type": "integer", "example": 101 } } ], "responses": { "200": { "description": "Preview returned or campaign not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Campaign found." }, "html": { "type": "string", "example": "Hello, this is the campaign content.This is the content of the letter
" } } ], "responses": { "200": { "description": "Letter created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Letter Added Successfully" }, "letter": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/letter/{id}": { "get": { "tags": [ "Letters" ], "summary": "Get a specific letter by ID", "operationId": "42ec45cbe8cc53778cf74533dab98707", "parameters": [ { "name": "id", "in": "path", "description": "Letter ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Letter retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "letter": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Letter not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Letters" ], "summary": "Update an existing letter", "operationId": "2196797e39eb7f04eb84ecc118dc35f1", "parameters": [ { "name": "id", "in": "path", "description": "Letter ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Letter title", "required": true, "schema": { "type": "string", "example": "Updated Letter Title" } }, { "name": "description", "in": "query", "description": "Letter content/description in HTML format", "required": true, "schema": { "type": "string", "example": "Updated content of the letter
" } } ], "responses": { "200": { "description": "Letter updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Letter Updated Successfully" }, "letter": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Letter not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Letters" ], "summary": "Delete a letter", "operationId": "9c89a540d02f6332ba9e60eae2636743", "parameters": [ { "name": "id", "in": "path", "description": "Letter ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Letter deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Letter Deleted Successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Letter not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Letter Not Found." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-pdf/{id}": { "get": { "tags": [ "Letters" ], "summary": "Generate PDF from letter HTML content", "operationId": "1d860a73039f35a175d90430a4b2af07", "parameters": [ { "name": "id", "in": "path", "description": "Letter ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "PDF file generated successfully", "content": { "application/pdf": {} } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Letter not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/print-contact-information/{id}": { "get": { "tags": [ "Letters" ], "summary": "Generate PDF with contact information for a lead", "operationId": "7a297a8b76389f4dfdfa8560e003beed", "parameters": [ { "name": "id", "in": "path", "description": "Lead ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "PDF with contact information generated successfully", "content": { "application/pdf": {} } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Lead not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/data-table/get": { "post": { "tags": [ "Marketplace" ], "summary": "Get marketplace data for datatable", "operationId": "4fb807309ae8747f57ccbe9bcf89f219", "responses": { "200": { "description": "Marketplace data retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/get/{slug}": { "get": { "tags": [ "Marketplace" ], "summary": "Get marketplace integrations for the current client by platform slug", "description": "Returns every Marketplace row for the authenticated user's client where `platform` matches the slug (e.g. shopify, woocommerce).", "operationId": "getFrameworkDataBySlug", "parameters": [ { "name": "slug", "in": "path", "description": "Platform slug filter, matched against Marketplace.platform", "required": true, "schema": { "type": "string", "example": "shopify" } } ], "responses": { "200": { "description": "Marketplace rows matching the slug", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "description": "No marketplace rows for this client/slug", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Data not found." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace": { "get": { "tags": [ "Marketplace" ], "summary": "Get all marketplace integrations", "operationId": "49e4a0f0f79e5e96515eda469ffeadbd", "responses": { "200": { "description": "List of marketplace integrations", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Data not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Marketplace" ], "summary": "Create a new marketplace integration", "operationId": "94a1856ee276d4a2b69b4cf99f40c7ca", "parameters": [ { "name": "platform", "in": "query", "description": "Platform type (magento2, shopify, wordpress)", "required": true, "schema": { "type": "string", "enum": [ "magento2", "shopify", "wordpress" ] } }, { "name": "url", "in": "query", "description": "Store URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Access token (required for magento2 and shopify)", "required": false, "schema": { "type": "string" } }, { "name": "consumerKey", "in": "query", "description": "Consumer key (required for wordpress)", "required": false, "schema": { "type": "string" } }, { "name": "consumerSecret", "in": "query", "description": "Consumer secret (required for wordpress)", "required": false, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Username", "required": false, "schema": { "type": "string" } }, { "name": "password", "in": "query", "description": "Password", "required": false, "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Integration title", "required": false, "schema": { "type": "string" } }, { "name": "is_token_expiry_check", "in": "query", "description": "Whether to check token expiry", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Record created successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Record has been created successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" }, "500": { "description": "Something went wrong" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/{id}": { "get": { "tags": [ "Marketplace" ], "summary": "Get specific marketplace integration", "operationId": "ff61715cbe1adff30aafbac15a58dd23", "parameters": [ { "name": "id", "in": "path", "description": "Marketplace integration ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Marketplace integration details", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Data not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Marketplace" ], "summary": "Update an existing marketplace integration", "operationId": "b9bc7eb6a85a27c065584c444f30fb11", "parameters": [ { "name": "id", "in": "path", "description": "Marketplace integration ID", "required": true, "schema": { "type": "integer" } }, { "name": "platform", "in": "query", "description": "Platform type (magento2, shopify, wordpress)", "required": true, "schema": { "type": "string", "enum": [ "magento2", "shopify", "wordpress" ] } }, { "name": "url", "in": "query", "description": "Store URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Access token (required for magento2 and shopify)", "required": false, "schema": { "type": "string" } }, { "name": "consumerKey", "in": "query", "description": "Consumer key (required for wordpress)", "required": false, "schema": { "type": "string" } }, { "name": "consumerSecret", "in": "query", "description": "Consumer secret (required for wordpress)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Record updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Record has been updated successfully!" }, "data": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Record not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Marketplace" ], "summary": "Delete a marketplace integration", "operationId": "20565e9ec707bd4aba72a775f4180cc9", "parameters": [ { "name": "id", "in": "path", "description": "Marketplace integration ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Record deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Record has been Deleted Successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Record Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/shopify-currency": { "post": { "tags": [ "Marketplace" ], "summary": "Get Shopify currency information", "operationId": "1659686bffa99c4a5a6d5896b31fb3e6", "parameters": [ { "name": "apiUrl", "in": "query", "description": "Shopify API URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Shopify access token", "required": true, "schema": { "type": "string" } }, { "name": "created_at_min", "in": "query", "description": "Filter by minimum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "created_at_max", "in": "query", "description": "Filter by maximum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Shopify API response successful", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Shopify API response successful." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Something wrong with api" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/shopify-one-order": { "post": { "tags": [ "Marketplace" ], "summary": "Get Shopify order information", "operationId": "56d7a04bd1c8051bbff8da8aeb368145", "parameters": [ { "name": "apiUrl", "in": "query", "description": "Shopify API URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Shopify access token", "required": true, "schema": { "type": "string" } }, { "name": "created_at_min", "in": "query", "description": "Filter by minimum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "created_at_max", "in": "query", "description": "Filter by maximum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Shopify API response successful", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Shopify API response successful." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Something wrong with api" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/shopify-customer-count": { "post": { "tags": [ "Marketplace" ], "summary": "Get Shopify customer count", "operationId": "09c905fc2e43ea29402080129571fda1", "parameters": [ { "name": "apiUrl", "in": "query", "description": "Shopify API URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Shopify access token", "required": true, "schema": { "type": "string" } }, { "name": "created_at_min", "in": "query", "description": "Filter by minimum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "created_at_max", "in": "query", "description": "Filter by maximum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Shopify API response successful", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Shopify API response successful." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Something wrong with api" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/shopify-order-count": { "post": { "tags": [ "Marketplace" ], "summary": "Get Shopify order count", "operationId": "2a4db7563c75930717c094dc6c2b2eb5", "parameters": [ { "name": "apiUrl", "in": "query", "description": "Shopify API URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Shopify access token", "required": true, "schema": { "type": "string" } }, { "name": "created_at_min", "in": "query", "description": "Filter by minimum creation date", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "created_at_max", "in": "query", "description": "Filter by maximum creation date", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Shopify count retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Shopify count got." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Something wrong" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/shopify-customers": { "post": { "tags": [ "Marketplace" ], "summary": "Get Shopify customers", "operationId": "a39b46a535b9a58878934ef2f92c67e1", "parameters": [ { "name": "apiUrl", "in": "query", "description": "Shopify API URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Shopify access token", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of records to return", "required": true, "schema": { "type": "integer" } }, { "name": "page_info", "in": "query", "description": "Pagination information", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Customers fetched successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "headers": { "type": "object" }, "url": { "type": "string" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Customer fetched." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Something wrong with customer" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/shopify-order": { "post": { "tags": [ "Marketplace" ], "summary": "Get Shopify orders", "operationId": "09c24af4ccafba80340d52f9f37f1396", "parameters": [ { "name": "apiUrl", "in": "query", "description": "Shopify API URL", "required": true, "schema": { "type": "string" } }, { "name": "token", "in": "query", "description": "Shopify access token", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Number of records to return", "required": true, "schema": { "type": "integer" } }, { "name": "page_info", "in": "query", "description": "Pagination information", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search query", "required": false, "schema": { "type": "string" } }, { "name": "created_at_min", "in": "query", "description": "Filter by minimum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "created_at_max", "in": "query", "description": "Filter by maximum creation date", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Shopify orders retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "object" }, "headers": { "type": "object" }, "query": { "type": "string" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Shopify connected." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Something wrong" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-ecommerce-market-place-by-client-id/{client_id}": { "get": { "tags": [ "Marketplace" ], "summary": "Get marketplace integrations by client ID", "operationId": "01eb780a426840d5793cf03cacab3b1a", "parameters": [ { "name": "client_id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Marketplace integrations retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Record not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ecommerce-marketplace/cronUpdate": { "post": { "tags": [ "Marketplace" ], "summary": "Update cron status for a marketplace integration", "operationId": "cd8d2e1eb16c7f4616f2b3682555b11d", "parameters": [ { "name": "id", "in": "query", "description": "Marketplace integration ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cron status updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Cron Status Updated Successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Record Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/metered-billing-prices": { "get": { "tags": [ "Metered Billing Prices" ], "summary": "Get all metered billing prices", "operationId": "44177a804b338f0554bd12ade25d59b1", "responses": { "200": { "description": "Metered billing prices retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-milestone": { "get": { "tags": [ "Project Milestone" ], "summary": "List project milestones (resource index – placeholder, not currently implemented)", "operationId": "17c9bd11020344d288f021eb0ad88c1e", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Milestones" ], "summary": "Create a new project milestone", "operationId": "067e872e146e6b160b6dfce85000147d", "parameters": [ { "name": "title", "in": "query", "description": "Milestone title", "required": true, "schema": { "type": "string", "example": "Phase 1 Completion" } }, { "name": "description", "in": "query", "description": "Milestone description", "required": true, "schema": { "type": "string", "example": "Complete all initial requirements" } }, { "name": "project_id", "in": "query", "description": "ID of the project", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "due_date", "in": "query", "description": "Due date for the milestone", "required": true, "schema": { "type": "string", "format": "date", "example": "2023-12-31" } } ], "responses": { "200": { "description": "Milestone created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Project Milestone Added Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-milestone/{id}": { "get": { "tags": [ "Project Milestones" ], "summary": "Get specific project milestone by ID", "operationId": "256ab1254e56d1f31728c70c782bca5e", "parameters": [ { "name": "id", "in": "path", "description": "Milestone ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "milestone": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Milestone not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Project Milestones" ], "summary": "Update an existing project milestone", "operationId": "b4efedf6074c1fd2b86ef4af2b50f0fb", "parameters": [ { "name": "id", "in": "path", "description": "Milestone ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Milestone title", "required": true, "schema": { "type": "string", "example": "Updated Phase 1 Completion" } }, { "name": "description", "in": "query", "description": "Milestone description", "required": true, "schema": { "type": "string", "example": "Updated description for milestone" } }, { "name": "project_id", "in": "query", "description": "ID of the project", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "due_date", "in": "query", "description": "Due date for the milestone", "required": true, "schema": { "type": "string", "format": "date", "example": "2023-12-31" } } ], "responses": { "200": { "description": "Milestone updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Project Milestone Updated Successfully" }, "project": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Milestone not found" }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Milestones" ], "summary": "Delete a project milestone", "operationId": "e50fd12aa28ff9495d6568254cd8de23", "parameters": [ { "name": "id", "in": "path", "description": "Milestone ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Milestone deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Milestone Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "Milestone not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-milestone/data-table/{id}": { "post": { "tags": [ "Project Milestones" ], "summary": "Get project milestones for datatable", "operationId": "bd0fd8f3661543eae4027e9a7690dc34", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "order", "in": "query", "description": "Order parameter for datatable", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mms-service": { "get": { "tags": [ "MMS" ], "summary": "List all MMS resources", "operationId": "727bb8a70e94604bfde4de5a27089a97", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "MMS" ], "summary": "Store a newly created MMS resource", "operationId": "cca45ef7b2766e784cce6c7894d46cda", "parameters": [ { "name": "name", "in": "query", "description": "Name of the MMS", "required": true, "schema": { "type": "string", "example": "My MMS" } }, { "name": "file", "in": "query", "description": "Media file to upload (max 25MB)", "required": true, "schema": { "type": "file" } }, { "name": "description", "in": "query", "description": "Description of the MMS", "required": false, "schema": { "type": "string", "example": "This is my MMS description" } }, { "name": "type", "in": "query", "description": "Media type (audio or video)", "required": true, "schema": { "type": "string", "example": "audio", "enum": [ "audio", "video" ] } }, { "name": "from", "in": "query", "description": "Sender phone number", "required": true, "schema": { "type": "string", "example": "+1234567890" } }, { "name": "video_tytpe", "in": "query", "description": "Video type (youtube if applicable)", "required": false, "schema": { "type": "string", "example": "youtube", "enum": [ "youtube" ] } } ], "responses": { "200": { "description": "MMS created successfully", "content": { "application/json": { "schema": { "properties": { "plan": { "type": "object" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Media uploaded successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mms-service/{id}": { "get": { "tags": [ "MMS" ], "summary": "Display the specified MMS resource", "operationId": "295c290db7db6b7cac9abd5857e31f30", "parameters": [ { "name": "id", "in": "path", "description": "ID of the MMS to retrieve", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "MMS retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "mediaData": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "MMS not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Something went wrong." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "MMS" ], "summary": "Update the specified MMS resource", "operationId": "72a0e39348765ef0f0f5c9a2b0c36d50", "parameters": [ { "name": "id", "in": "path", "description": "ID of the MMS to update", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Title of the MMS", "required": true, "schema": { "type": "string", "example": "Updated MMS Title" } }, { "name": "from_number", "in": "query", "description": "Sender phone number", "required": true, "schema": { "type": "string", "example": "+1234567890" } }, { "name": "description", "in": "query", "description": "Description of the MMS", "required": false, "schema": { "type": "string", "example": "Updated MMS description" } } ], "responses": { "200": { "description": "MMS updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Mms updated successfully." } }, "type": "object" } } } }, "404": { "description": "MMS not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Data not found." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "MMS" ], "summary": "Remove the specified MMS resource", "operationId": "a946253f5d7178cae5f024b82aada759", "parameters": [ { "name": "id", "in": "path", "description": "ID of the MMS to delete", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "MMS deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "MMS Deleted Successfully." } }, "type": "object" } } } }, "404": { "description": "MMS not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "MMS Not Found." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-media": { "post": { "tags": [ "MMS" ], "summary": "Get media based on type", "operationId": "bdab75937cbd452800d0acec719b204c", "parameters": [ { "name": "type", "in": "query", "description": "Type of media to retrieve (audio or video)", "required": true, "schema": { "type": "string", "example": "audio", "enum": [ "audio", "video" ] } } ], "responses": { "200": { "description": "Media retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "mediaData": { "type": "array", "items": { "type": "object" } }, "fromNumber": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Something went wrong." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mms/send": { "post": { "tags": [ "MMS" ], "summary": "Send an MMS to a contact", "operationId": "d8f42055e594e10807c928283c9c1495", "parameters": [ { "name": "lead_id", "in": "query", "description": "ID of the lead to send MMS to", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "file", "in": "query", "description": "Media file to send (max 25MB)", "required": true, "schema": { "type": "file" } }, { "name": "description", "in": "query", "description": "Description or message text", "required": false, "schema": { "type": "string", "example": "Check out this media", "maxLength": 400 } }, { "name": "mobile", "in": "query", "description": "Mobile number to send to", "required": true, "schema": { "type": "string", "example": "+1234567890", "maxLength": 20 } }, { "name": "title", "in": "query", "description": "Title of the MMS", "required": false, "schema": { "type": "string", "example": "Important Media" } }, { "name": "from_mobile", "in": "query", "description": "Sender phone number", "required": true, "schema": { "type": "string", "example": "+1234567890" } }, { "name": "media_type", "in": "query", "description": "Type of media (audio or video)", "required": true, "schema": { "type": "string", "example": "audio", "enum": [ "audio", "video" ] } }, { "name": "to_mobile", "in": "query", "description": "Recipient phone number", "required": true, "schema": { "type": "string", "example": "+1234567890" } } ], "responses": { "200": { "description": "MMS sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Media has been sent to the contact." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mms/get-available-credits": { "get": { "tags": [ "MMS" ], "summary": "Get available MMS credits for the authenticated user", "operationId": "e8602a3b4fa4ad04f52140dfa8b98b7c", "responses": { "200": { "description": "Credits retrieved successfully", "content": { "application/json": { "schema": { "properties": { "credits_available": { "type": "integer", "example": 100 }, "fromPhoneNumber": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mms/data-table/get": { "post": { "tags": [ "MMS" ], "summary": "Get MMS data for datatable", "operationId": "f8a436d7e357071ad804b9e5826b630f", "responses": { "200": { "description": "Data retrieved successfully", "content": { "application/json": { "schema": { "properties": { "datatableResponse": { "type": "object" }, "fromPhoneNumber": { "type": "array", "items": { "type": "object" } }, "sms_credits": { "type": "integer", "example": 100 } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mms-report/{id}": { "post": { "tags": [ "MMS" ], "summary": "Get report for a specific MMS", "operationId": "9ff750a7135bd79813ce1ada28d7c384", "parameters": [ { "name": "id", "in": "path", "description": "ID of the MMS to get report for", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Report retrieved successfully", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No results found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No search results found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/send-voice-drop-mms": { "post": { "tags": [ "MMS" ], "summary": "Send a voice drop MMS to a contact", "operationId": "812a8bca0f3e9b23e27d8c8fe66c95b9", "parameters": [ { "name": "lead_id", "in": "query", "description": "ID of the lead to send MMS to", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "to_mobile", "in": "query", "description": "Recipient phone number", "required": true, "schema": { "type": "string", "example": "+1234567890", "maxLength": 20 } }, { "name": "mms_id", "in": "query", "description": "ID of the MMS to send", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "MMS sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Media has been sent to the contact." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Something went wrong.!" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/monthly-invoice": { "get": { "tags": [ "Monthly Invoice" ], "summary": "Get list of monthly invoices for authenticated user", "operationId": "e2068d57a55725df6894c4255ec4dac8", "responses": { "200": { "description": "List of monthly invoices", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "invoice" }, "data": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "No invoice found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Monthly Invoice" ], "summary": "Create a new monthly invoice", "operationId": "ae7c86658fac8c400d51d9c99f7236aa", "parameters": [ { "name": "work", "in": "query", "description": "Work description", "required": true, "schema": { "type": "string", "maxLength": 30 } }, { "name": "amount", "in": "query", "description": "Invoice amount", "required": true, "schema": { "type": "string", "maxLength": 6 } }, { "name": "currency", "in": "query", "description": "Currency code", "required": true, "schema": { "type": "string" } }, { "name": "duration", "in": "query", "description": "Duration", "required": true, "schema": { "type": "string" } }, { "name": "bill_date", "in": "query", "description": "Bill date (Y-m-d)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "due_date", "in": "query", "description": "Due date (Y-m-d), must be after or equal to bill_date", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "last_email_sent_date", "in": "query", "description": "Last email sent date (Y-m-d), must be after or equal to bill_date", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Invoice created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invoice added successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/monthly-invoice/data-table": { "post": { "tags": [ "Monthly Invoice" ], "summary": "Get monthly invoices data for datatables", "operationId": "0207965e8d08342d4d049158f69464d8", "responses": { "200": { "description": "Monthly invoices data for datatables", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/monthly-invoice/{id}": { "get": { "tags": [ "Monthly Invoice" ], "summary": "Get a specific monthly invoice", "operationId": "06bbe216ec461fe53a17074a5d09d782", "parameters": [ { "name": "id", "in": "path", "description": "Monthly invoice ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Monthly invoice details", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" }, "user_info": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Invoice not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Monthly Invoice" ], "summary": "Update a specific monthly invoice", "operationId": "82ef21a299d33d940dbeef286083e506", "parameters": [ { "name": "id", "in": "path", "description": "Monthly invoice ID", "required": true, "schema": { "type": "integer" } }, { "name": "work", "in": "query", "description": "Work description", "required": true, "schema": { "type": "string", "maxLength": 30 } }, { "name": "amount", "in": "query", "description": "Invoice amount", "required": true, "schema": { "type": "string", "maxLength": 6 } }, { "name": "currency", "in": "query", "description": "Currency code", "required": true, "schema": { "type": "string" } }, { "name": "duration", "in": "query", "description": "Duration", "required": true, "schema": { "type": "string" } }, { "name": "bill_date", "in": "query", "description": "Bill date (Y-m-d)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "due_date", "in": "query", "description": "Due date (Y-m-d), must be after or equal to bill_date", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "last_email_sent_date", "in": "query", "description": "Last email sent date (Y-m-d), must be after or equal to bill_date", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Invoice updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invoice Updated Successfully." }, "invoice": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Invoice not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Monthly Invoice" ], "summary": "Delete a specific monthly invoice", "operationId": "566b174871839eaa8150dfb01289435a", "parameters": [ { "name": "id", "in": "path", "description": "Monthly invoice ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Invoice deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invoice Deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Invoice not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/monthly-invoice-pdf/{id}": { "get": { "tags": [ "Monthly Invoice" ], "summary": "Generate PDF for a specific monthly invoice", "operationId": "97a755b5c5df1331a6914cf9dd8a37ad", "parameters": [ { "name": "id", "in": "path", "description": "Monthly invoice ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "PDF file", "content": { "application/pdf": {} } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Invoice not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/monthly-invoice-mail/{id}": { "put": { "tags": [ "Monthly Invoice" ], "summary": "Send invoice by email", "operationId": "793fc4a5f99e85a481f58bd169b31106", "parameters": [ { "name": "id", "in": "path", "description": "Monthly invoice ID", "required": true, "schema": { "type": "integer" } }, { "name": "to", "in": "query", "description": "Email recipient", "required": true, "schema": { "type": "string", "format": "email" } }, { "name": "subject", "in": "query", "description": "Email subject", "required": true, "schema": { "type": "string" } }, { "name": "cc", "in": "query", "description": "CC recipients", "required": false, "schema": { "type": "string" } }, { "name": "bcc", "in": "query", "description": "BCC recipients", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invoice sent successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Invoice sent Successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Invoice not found" }, "422": { "description": "Validation error" }, "500": { "description": "Email sending failed" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/no-of-employees-options": { "get": { "tags": [ "Employee Settings" ], "summary": "Get number of employee settings", "operationId": "264c15a5a1ff2bb5dbf2eed8e71c70ea", "responses": { "200": { "description": "Settings retrieved successfully", "content": { "application/json": { "schema": { "properties": { "settings": { "type": "array", "items": { "type": "object" } }, "lead_positions": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Employee Settings" ], "summary": "Save number of employee settings", "operationId": "2604f8b81be7f8104edf9c3a11cae83c", "parameters": [ { "name": "settings", "in": "query", "description": "Array of employee settings", "required": true, "schema": { "type": "array", "items": { "properties": { "name": { "type": "string", "example": "1-10" }, "visibility_position_wise": { "type": "array", "items": { "type": "object" } }, "sort": { "type": "integer", "example": 1 } }, "type": "object" } } } ], "responses": { "200": { "description": "Settings saved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Settings saved successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/no-of-employees-options/{id}": { "put": { "tags": [ "Employee Settings" ], "summary": "Update number of employee setting", "operationId": "b86384a0ec51a2c2d9a40023a68575b3", "parameters": [ { "name": "id", "in": "path", "description": "ID of the employee setting to update", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "name", "in": "query", "description": "Name of the employee setting", "required": true, "schema": { "type": "string", "example": "1-10" } }, { "name": "visibility_position_wise", "in": "query", "description": "Visibility settings for different positions", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "sort", "in": "query", "description": "Sort order", "required": false, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Settings updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Settings updated successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Setting not found" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/notes": { "get": { "tags": [ "Notes" ], "summary": "Get a list of all notes", "operationId": "1dc6cbbddca59398445a4629cc524db1", "responses": { "200": { "description": "List of notes retrieved successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Notes" ], "summary": "Create a new note", "operationId": "1d2f133e028e4f92114ff265422b262f", "parameters": [ { "name": "title", "in": "query", "description": "Title of the note", "required": true, "schema": { "type": "string", "example": "Meeting Notes" } }, { "name": "description", "in": "query", "description": "Content of the note", "required": true, "schema": { "type": "string", "example": "Discussed project timeline and deliverables" } }, { "name": "important", "in": "query", "description": "Flag to mark note as important", "required": false, "schema": { "type": "boolean", "example": true } }, { "name": "lead_id", "in": "query", "description": "ID of the associated lead", "required": false, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Note created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Notes Added Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/notes/data-table/get": { "post": { "tags": [ "Notes" ], "summary": "Get notes data for datatables", "operationId": "c620a93ccfc94292e53089c683185c11", "responses": { "200": { "description": "Notes data retrieved successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/notes/{id}": { "get": { "tags": [ "Notes" ], "summary": "Get a specific note by ID", "operationId": "79fda49835a377aff2f6a09c6d29d92e", "parameters": [ { "name": "id", "in": "path", "description": "ID of the note to retrieve", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Note retrieved successfully", "content": { "application/json": { "schema": { "properties": { "notes": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Note not found", "content": { "application/json": { "schema": { "properties": { "notes": { "type": "string", "example": "No Notes Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Notes" ], "summary": "Update a specific note", "operationId": "26bd94d8620c2cd0eb502c5b8926e1a7", "parameters": [ { "name": "id", "in": "path", "description": "ID of the note to update", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Updated title of the note", "required": true, "schema": { "type": "string", "example": "Updated Meeting Notes" } }, { "name": "description", "in": "query", "description": "Updated content of the note", "required": true, "schema": { "type": "string", "example": "Updated project timeline and deliverables" } }, { "name": "important", "in": "query", "description": "Flag to mark note as important", "required": false, "schema": { "type": "boolean", "example": true } } ], "responses": { "200": { "description": "Note updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Notes Updated Successfully" } }, "type": "object" } } } }, "404": { "description": "Note not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Notes Not Found" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Notes" ], "summary": "Delete a specific note", "operationId": "65a8529f109b415ac9a929f7fb9e02cc", "parameters": [ { "name": "id", "in": "path", "description": "ID of the note to delete", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Note deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Notes Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "Note not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Notes Not Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/note-search": { "post": { "tags": [ "Notes" ], "summary": "Search for notes by title", "operationId": "e55cd49cffa4efea23a975067957295b", "parameters": [ { "name": "title", "in": "query", "description": "Search term to find in note titles", "required": true, "schema": { "type": "string", "example": "Meeting" } } ], "responses": { "200": { "description": "Search results retrieved successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Search" }, "notes": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No search results found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No search results found" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/add-note-to-selected-leads": { "post": { "tags": [ "Notes" ], "summary": "Add the same note to multiple selected leads in one call", "operationId": "f8f3b6c5e96b7e965f556cfadd7f224d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "lead_id", "note" ], "properties": { "lead_id": { "description": "Array of lead IDs to attach the note to", "type": "array", "items": { "type": "integer" } }, "note": { "description": "Note text to add to each lead", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Notes inserted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/add-important-note": { "post": { "tags": [ "Notes" ], "summary": "Add an important note (route declared but handler not yet implemented)", "operationId": "aadc94a4ed4e3ed2cfb9cbd6c73773ec", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/notifications": { "get": { "tags": [ "Notifications" ], "summary": "Get a list of notifications", "operationId": "c253e861b8713c9da4f8ae35505d71bf", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Notifications" ], "summary": "Store a newly created notification", "operationId": "2ddff52751886862c960838b9aef996d", "responses": { "200": { "description": "Notification stored successfully" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/notifications/{id}": { "get": { "tags": [ "Notifications" ], "summary": "Get a specific notification", "operationId": "fe00059610eca333d527222bec6c93e1", "parameters": [ { "name": "id", "in": "path", "description": "ID of the notification", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Notification not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/all-notificationsEs": { "get": { "tags": [ "Notifications" ], "summary": "Get all notifications for the authenticated user using Elasticsearch", "operationId": "ad1326b628a023039d811015e303e1e8", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "filterValue", "in": "query", "description": "Filter value for notifications", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "notifications": { "type": "array", "items": { "type": "object" } }, "seen_notification": { "type": "array", "items": { "type": "object" } }, "unseen_notification": { "type": "array", "items": { "type": "object" } }, "unread": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" }, "seenPages": { "type": "integer" }, "unSeenPages": { "type": "integer" } }, "type": "object" } } } }, "500": { "description": "Elasticsearch is down" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/all-notifications": { "get": { "tags": [ "Notifications" ], "summary": "Get all notifications for the authenticated user using database", "operationId": "8a0fbd96e872777c8a93cdc42d59a10b", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "filterValue", "in": "query", "description": "Filter value for notifications", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "notifications": { "type": "array", "items": { "type": "object" } }, "seen_notification": { "type": "array", "items": { "type": "object" } }, "unseen_notification": { "type": "array", "items": { "type": "object" } }, "unread": { "type": "integer" }, "total": { "type": "integer" }, "pages": { "type": "integer" }, "seenPages": { "type": "integer" }, "unSeenPages": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/all-leave-notifications": { "get": { "tags": [ "Notifications" ], "summary": "Get all leave notifications for the authenticated user", "operationId": "aa8c45e0d3d76aecf7e84da91e2fa0ea", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "notifications": { "type": "array", "items": { "type": "object" } }, "readCount": { "type": "integer" }, "total": { "type": "integer" }, "leave_notifications_count": { "type": "integer" }, "current_page": { "type": "integer" }, "pages": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/set-leave-notification-as-opened": { "put": { "tags": [ "Notifications" ], "summary": "Mark a leave notification as opened", "operationId": "5829a7117eb75e6d4d75c6017696e831", "parameters": [ { "name": "id", "in": "query", "description": "ID of the notification", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Notification marked as opened successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Notification not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mark-all-as-unread": { "put": { "tags": [ "Notifications" ], "summary": "Mark all notifications as unread for the authenticated user", "operationId": "a3f20fcf8c5b1266b2384cd9d96d4356", "responses": { "200": { "description": "All notifications marked as unread successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "totalUpdatedCount": { "type": "integer" }, "message": { "type": "string", "example": "All notifications has been marked as unread successfully." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-notification": { "post": { "tags": [ "Notifications" ], "summary": "Delete a specific notification for the authenticated user", "operationId": "963cbfa0162a10a09853d108e7b4cd54", "parameters": [ { "name": "id", "in": "query", "description": "ID of the notification to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Notification deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Notification has been cleared successfully." } }, "type": "object" } } } }, "404": { "description": "Notification not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Notification not found" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-all-leave-notification": { "get": { "tags": [ "Notifications" ], "summary": "Delete all leave notifications for the authenticated user", "operationId": "06718d4e496f6adb9853976d8dcdde2f", "responses": { "200": { "description": "All leave notifications deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "All leave notification has been cleared successfully." }, "recodeIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/mark-all-as-read": { "put": { "tags": [ "Notifications" ], "summary": "Mark all notifications as read for the authenticated user", "operationId": "680d7438373c5c943621a948d9bb3157", "responses": { "200": { "description": "All notifications marked as read successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "totalUpdatedCount": { "type": "integer" }, "message": { "type": "string", "example": "All notifications has been marked as read successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-all-notification": { "get": { "tags": [ "Notifications" ], "summary": "Delete all non-leave notifications for the authenticated user", "operationId": "d1f55679443efd94fb28891e40cebe9e", "responses": { "200": { "description": "All notifications deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "All notification has been cleared successfully." }, "recodeIds": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-notification-by-id/{id}": { "get": { "tags": [ "Notifications" ], "summary": "Get a specific notification by ID with full details", "operationId": "7ea709436a2692c3d433fae6a9e1955d", "parameters": [ { "name": "id", "in": "path", "description": "ID of the notification", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Notification retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Notification not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Notification not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-leave-notification-by-id/{id}": { "get": { "tags": [ "Notifications" ], "summary": "Get a specific leave notification by ID", "operationId": "b4724653982f0fcf4047e00773608fa5", "parameters": [ { "name": "id", "in": "path", "description": "ID of the leave notification", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Leave notification retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Notification not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Notification not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/notifications/{notification}": { "put": { "tags": [ "Notifications" ], "summary": "Update the specified notification", "operationId": "39924e16a8c017afd220cec926fcb0b1", "parameters": [ { "name": "notification", "in": "path", "description": "ID of the notification to update", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Notification updated successfully" }, "404": { "description": "Notification not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Notifications" ], "summary": "Delete the specified notification", "operationId": "a67b903f2f0f8c1251f3a0a1c86ac803", "parameters": [ { "name": "notification", "in": "path", "description": "ID of the notification to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Notification deleted successfully" }, "404": { "description": "Notification not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/onboarding": { "get": { "tags": [ "Onboarding" ], "summary": "Get the onboarding wizard catalog and the client's progress", "description": "Returns the full active feature catalog grouped by wizard step, plus the client's onboarding record, selected feature IDs, and enabled modules. Read-only: never creates a record — clients who have never started onboarding get a transient default (id=null, status=pending, current_step=1).", "operationId": "7294cde68694f1f22949da13147b26e5", "responses": { "200": { "description": "Wizard catalog + client progress", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "steps": { "description": "Catalog options grouped by wizard step", "type": "array", "items": { "properties": { "step_group": { "type": "string", "enum": [ "industry", "role", "goals", "current_management", "team_size", "tools" ] }, "features": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "step_group": { "type": "string" }, "module_key": { "description": "Sidebar module key this option maps to (drives dashboard widget priority)", "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "is_recommended": { "type": "boolean" }, "sort_order": { "type": "integer" } }, "type": "object" } } }, "type": "object" } }, "onboarding": { "description": "The client's onboarding record. id is null for clients who have never started (transient, un-saved default).", "properties": { "id": { "type": "integer", "nullable": true }, "client_id": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "skipped" ] }, "current_step": { "type": "integer", "example": 1 }, "industry": { "type": "string", "nullable": true }, "team_size": { "type": "string", "nullable": true }, "extra": { "description": "Free-form answers merged from saved steps", "type": "object" }, "onboarding_version": { "type": "integer", "example": 1 }, "completed_at": { "type": "string", "format": "date-time", "nullable": true }, "selected_feature_ids": { "description": "IDs of all onboarding features the client has selected (across all steps)", "type": "array", "items": { "type": "integer" } } }, "type": "object" }, "enabled_modules": { "description": "Module keys selected during onboarding, intersected with the known sidebar modules", "type": "array", "items": { "type": "string", "example": "crm-sales" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/onboarding/status": { "get": { "tags": [ "Onboarding" ], "summary": "Get the client's onboarding status (route-guard check)", "description": "Lightweight, read-only status lookup. Never creates a record — status is null when the client has never started onboarding (e.g. accounts predating the feature), so the frontend route guard doesn't force existing users into the wizard.", "operationId": "36498286fa168b7cdb7a5faa184fa45f", "responses": { "200": { "description": "Onboarding status", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "status": { "description": "Null when the client has never started onboarding", "type": "string", "example": "in_progress", "nullable": true, "enum": [ "pending", "in_progress", "completed", "skipped" ] } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/onboarding/step": { "post": { "tags": [ "Onboarding" ], "summary": "Save the selections for a single wizard step", "description": "Persists the feature selections for one wizard step (replacing that step's previous selections without touching other steps), sets status to in_progress, and advances current_step (never backwards — the max of the stored and submitted value is kept). Validated by SaveOnboardingStepRequest; the request is rejected with 403 when the authenticated user has no client_id.", "operationId": "71d81e197211e4e3bdaf34781d8cfe4e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "step", "feature_ids" ], "properties": { "step": { "description": "The wizard step being saved", "type": "string", "enum": [ "industry", "role", "goals", "current_management", "team_size", "tools" ] }, "feature_ids": { "description": "Selected onboarding feature IDs for this step (must exist in onboarding_features and not be soft-deleted). Send an empty array to clear the step.", "type": "array", "items": { "type": "integer" } }, "extra": { "description": "Free-form answers merged into the record's extra column", "type": "object", "nullable": true }, "current_step": { "description": "Wizard position to record; defaults to the step's own 1-based number when omitted", "type": "integer", "nullable": true, "maximum": 255, "minimum": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Step saved", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Onboarding step saved." }, "data": { "description": "The updated onboarding record", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "status": { "type": "string", "example": "in_progress" }, "current_step": { "type": "integer" }, "industry": { "type": "string", "nullable": true }, "team_size": { "type": "string", "nullable": true }, "extra": { "type": "object" }, "onboarding_version": { "type": "integer" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Authenticated user has no client_id" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/onboarding/progress": { "post": { "tags": [ "Onboarding" ], "summary": "Record the wizard position without saving selections", "description": "Persists the wizard position so a page reload resumes from the same step (used when a step is skipped, which saves no selections). Sets status to in_progress; current_step never moves backwards.", "operationId": "7de8dfdab4dd017c5d33ae335a26c0af", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "current_step" ], "properties": { "current_step": { "type": "integer", "example": 3, "maximum": 255, "minimum": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Progress recorded", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "description": "The updated onboarding record", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "status": { "type": "string", "example": "in_progress" }, "current_step": { "type": "integer" }, "industry": { "type": "string", "nullable": true }, "team_size": { "type": "string", "nullable": true }, "extra": { "type": "object" }, "onboarding_version": { "type": "integer" }, "completed_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/onboarding/skip": { "post": { "tags": [ "Onboarding" ], "summary": "Skip onboarding entirely", "description": "Marks onboarding as skipped, stamps completed_at, writes ALL sidebar modules into choose_module (so every menu stays visible), and logs a single activity entry. No request body.", "operationId": "41ceeea3a3489a3fca51c361e71845ca", "responses": { "200": { "description": "Onboarding skipped", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Onboarding skipped." }, "data": { "description": "The updated onboarding record", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "status": { "type": "string", "example": "skipped" }, "current_step": { "type": "integer" }, "industry": { "type": "string", "nullable": true }, "team_size": { "type": "string", "nullable": true }, "extra": { "type": "object" }, "onboarding_version": { "type": "integer" }, "completed_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/onboarding/complete": { "post": { "tags": [ "Onboarding" ], "summary": "Finalise onboarding and apply the selected modules", "description": "Marks onboarding as completed, stamps completed_at, writes ALL sidebar modules into choose_module (selections only re-prioritise dashboard widgets, they never hide menus), and logs a single activity entry. No request body. Also returns the client's choose_module row and enabled modules for the frontend to apply immediately.", "operationId": "c8f43559458e4d2cf9113cf22cf2c154", "responses": { "200": { "description": "Onboarding completed", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Onboarding completed." }, "data": { "description": "The updated onboarding record", "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "status": { "type": "string", "example": "completed" }, "current_step": { "type": "integer" }, "industry": { "type": "string", "nullable": true }, "team_size": { "type": "string", "nullable": true }, "extra": { "type": "object" }, "onboarding_version": { "type": "integer" }, "completed_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "choose_module_info": { "description": "The client's latest choose_module row (its response column is a JSON-encoded array of module keys)", "type": "object", "nullable": true }, "enabled_modules": { "description": "Module keys selected during onboarding, intersected with the known sidebar modules", "type": "array", "items": { "type": "string", "example": "crm-sales" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/onboarding/dashboard-widgets": { "get": { "tags": [ "Onboarding" ], "summary": "Get dashboard widget descriptors for the client's enabled modules", "description": "Maps the client's enabled modules (from onboarding selections carrying a module_key) through the server-side widget registry (config/onboarding.php → widgets). Returns an empty array when no modules are enabled.", "operationId": "f21a36bb2fd1313d347574829c180058", "responses": { "200": { "description": "Widget descriptors, in module priority order", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "properties": { "key": { "description": "Dashboard widget key used by the Angular dynamic dashboard", "type": "string", "example": "todayStatistics" }, "title": { "type": "string", "example": "Today's Statistics" }, "size": { "description": "full spans the row; half sits in a two-column layout", "type": "string", "enum": [ "full", "half" ] } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/orders": { "get": { "tags": [ "Orders" ], "summary": "Get all orders with their items", "operationId": "c02aa30f94291e4be52bbbf6370aff55", "responses": { "200": { "description": "List of all orders with their items", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "order_type": { "type": "string", "example": "plan" }, "order_history": { "type": "string" }, "orderItem": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Orders" ], "summary": "Store a newly created order", "operationId": "29fe167e28f1159282f58534e40288c0", "responses": { "200": { "description": "Order created successfully" }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-ind-order/{id}": { "get": { "tags": [ "Orders" ], "summary": "Get a specific order by ID", "operationId": "3c79b5ed3d48475e3882a5c9386f4a03", "parameters": [ { "name": "id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Order details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "order": { "type": "object" }, "order_items": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Order not found or not authorized to view", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "The order you're trying to view doesn't seem to be yours, hmmmm." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/check-active-subscription": { "get": { "tags": [ "Orders" ], "summary": "Check if the authenticated user's client has an active subscription", "operationId": "a5b7042a6ac173aee721502e84069541", "responses": { "200": { "description": "Subscription status retrieved successfully", "content": { "application/json": { "schema": { "properties": { "subscribe": { "type": "boolean", "example": true }, "checkout": { "type": "boolean", "example": false }, "buy_plan": { "type": "boolean", "example": false }, "msg": { "type": "string", "example": "Subscription is active." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/check-active-plan": { "get": { "tags": [ "Orders" ], "summary": "Check if the authenticated user's client has an active plan", "operationId": "bddc12a7df55ef178b27235b1290063d", "responses": { "200": { "description": "Plan status retrieved successfully", "content": { "application/json": { "schema": { "properties": { "order": { "description": "Order details if active", "type": "object" }, "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/unsubscribe-forever-free-email/{id}": { "get": { "tags": [ "Orders" ], "summary": "Unsubscribe from forever free emails", "operationId": "49f7796a4fd0d33d9b18a4756d1088e7", "parameters": [ { "name": "id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "302": { "description": "Redirect to unsubscribe page or home page" } } } }, "/api/orders/data-table/get": { "post": { "tags": [ "Orders" ], "summary": "Get orders data for data table with pagination, sorting and filtering", "operationId": "2c7b8e7899e72e1edef7f0d6d10d6b67", "parameters": [ { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "per_page", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "sort_by", "in": "query", "description": "Field to sort by", "required": false, "schema": { "type": "string", "example": "created_at" } }, { "name": "sort_dir", "in": "query", "description": "Sort direction (asc or desc)", "required": false, "schema": { "type": "string", "example": "desc", "enum": [ "asc", "desc" ] } }, { "name": "search", "in": "query", "description": "Search term", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Orders data retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "total": { "type": "integer", "example": 100 }, "per_page": { "type": "integer", "example": 10 }, "current_page": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-active-plan-limits": { "get": { "tags": [ "Orders" ], "summary": "Get combined limits from active plan and add-ons", "description": "Returns aggregated package item limits from all active orders (plan + add-ons). Limits are summed by package item type.", "operationId": "db5f27b8d2c2d9f591d999edabc059bd", "parameters": [ { "name": "clientId", "in": "query", "description": "Client ID (optional, defaults to authenticated user's client)", "required": false, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Active plan and add-on limits retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "client_id": { "type": "integer", "example": 1 }, "package_items": { "type": "array", "items": { "properties": { "id": { "description": "Package item ID", "type": "integer", "example": 5 }, "name": { "description": "Package item name", "type": "string", "example": "Team Members" }, "slug": { "description": "Package item slug", "type": "string", "example": "team-members" }, "limit": { "description": "Total combined limit from plan + add-ons", "type": "integer", "example": 7 }, "is_marketplace": { "type": "boolean", "example": false }, "start_date": { "type": "string", "format": "date-time", "example": "2026-01-01 00:00:00" }, "end_date": { "type": "string", "format": "date-time", "example": "2026-02-01 00:00:00" } }, "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No active plan or add-ons found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "No active plan or add-ons found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/orders/{order}": { "get": { "tags": [ "Orders" ], "summary": "Display the specified order with its items", "operationId": "32979ce4a314e82081173b33083b5c62", "parameters": [ { "name": "order", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Order retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "order": { "type": "object" }, "order_items": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Order not found or not authorized to view" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Orders" ], "summary": "Update the specified order", "operationId": "7fda901af6c5e16e84229fcd8480f5a6", "parameters": [ { "name": "order", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Order updated successfully" }, "404": { "description": "Order not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Orders" ], "summary": "Delete the specified order", "operationId": "f9877620832096f16acb005b0a9681b5", "parameters": [ { "name": "order", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Order deleted successfully" }, "404": { "description": "Order not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-active-plan-items/{clientId}": { "get": { "tags": [ "Orders" ], "summary": "Get combined active plan and add-on package item limits for a client", "description": "Returns aggregated package item limits from all active orders (plan + add-ons) for the given client.", "operationId": "cb37baf467f596ccb8ee848a1996c6c6", "parameters": [ { "name": "clientId", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Active plan and add-on limits retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "client_id": { "type": "integer", "example": 1 }, "package_items": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No active plan or add-ons found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "No active plan or add-ons found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-client-package-limit/{id}": { "get": { "tags": [ "Orders" ], "summary": "Replicate and reset client package item limits for an order", "description": "Clones existing client_package_item_limits records for the given order, resets their dates to now, then deletes the originals.", "operationId": "81c7c4117933bfdd981ef40c0170861a", "parameters": [ { "name": "id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Client package limits updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/list": { "get": { "tags": [ "Outlook" ], "summary": "Get list of messages from Outlook inbox organized by conversation threads (excluding unknown senders)", "operationId": "44da1fc2d7eda829a7b5ab83374c214c", "parameters": [ { "name": "next_link", "in": "query", "description": "Next link for pagination", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "messages": { "type": "array", "items": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "conversation_id": { "type": "string" }, "from": { "type": "string" }, "email": { "type": "string" }, "is_read": { "type": "boolean" }, "date": { "type": "string", "format": "date-time" }, "snippet": { "type": "string" } }, "type": "object" } } }, "is_end": { "type": "boolean" }, "next_link": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error_description": { "type": "string" }, "auth_link": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Outlook" ], "summary": "Get list of messages from Outlook inbox organized by conversation threads", "operationId": "477d6de258d65990d49d0a8ac1c8bf95", "parameters": [ { "name": "next_link", "in": "query", "description": "Next link for pagination", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Messages retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "messages": { "type": "array", "items": { "type": "object" } }, "is_end": { "type": "boolean" }, "next_link": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Error while connecting outlook" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/check-client": { "get": { "tags": [ "Outlook" ], "summary": "Check if client is authenticated with Outlook", "operationId": "e2996a41f64f99f703e092c11cc9893c", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "profile": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error_description": { "type": "string" }, "auth_link": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/oauth2-callback": { "get": { "tags": [ "Outlook" ], "summary": "Handle OAuth2 callback from Outlook", "operationId": "0606034d9a383d31287498d2eb9972ad", "parameters": [ { "name": "code", "in": "query", "description": "Authorization code received from Outlook", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Token has been generated successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/all-oauth2-callback": { "get": { "tags": [ "Outlook" ], "summary": "Handle OAuth2 callback from Outlook for all users", "operationId": "7946c0fd7204de0d1c923ebeb94b2914", "parameters": [ { "name": "code", "in": "query", "description": "Authorization code received from Outlook", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Token has been generated successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/view": { "get": { "tags": [ "Outlook" ], "summary": "View a specific message from Outlook", "operationId": "fbd2e164fdd2ed377b4f7c18342cf347", "parameters": [ { "name": "id", "in": "query", "description": "ID of the message to view", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "from_name": { "type": "string" }, "from_email": { "type": "string" }, "reply_to": { "type": "string" }, "data": { "type": "string" }, "date": { "type": "string" }, "attachments": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error": { "type": "string" }, "error_trace": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/download-attachment": { "get": { "tags": [ "Outlook" ], "summary": "Download an attachment from an Outlook message", "operationId": "481ece67b2256ceaa23997284e2dde80", "parameters": [ { "name": "message_id", "in": "query", "description": "ID of the message containing the attachment", "required": true, "schema": { "type": "string" } }, { "name": "attachment_id", "in": "query", "description": "ID of the attachment to download", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success - File download", "content": { "application/octet-stream": {} } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error": { "type": "string" }, "error_trace": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/send": { "post": { "tags": [ "Outlook" ], "summary": "Send an email through Outlook", "operationId": "0396d20c8e0dac1fba18b8377554596d", "parameters": [ { "name": "to", "in": "query", "description": "Email address of the recipient", "required": true, "schema": { "type": "string", "format": "email" } }, { "name": "subject", "in": "query", "description": "Subject of the email", "required": true, "schema": { "type": "string" } }, { "name": "mail_body", "in": "query", "description": "Body of the email", "required": true, "schema": { "type": "string" } }, { "name": "reply_to_mail_id", "in": "query", "description": "ID of the email to reply to", "required": false, "schema": { "type": "string" } }, { "name": "append_signature", "in": "query", "description": "Whether to append signature to the email", "required": false, "schema": { "type": "boolean" } }, { "name": "file_names", "in": "query", "description": "Names of files to attach", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "cc", "in": "query", "description": "Email addresses for CC (comma-separated)", "required": false, "schema": { "type": "string" } }, { "name": "bcc", "in": "query", "description": "Email addresses for BCC (comma-separated)", "required": false, "schema": { "type": "string" } }, { "name": "lead_id", "in": "query", "description": "ID of the lead associated with this email", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Mail has been sent successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error": { "type": "string" }, "error_trace": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/upload-attachment": { "post": { "tags": [ "Outlook" ], "summary": "Upload an attachment for use in Outlook emails", "operationId": "b6fb092dde40c2d9a818d705d5bc5cba", "parameters": [ { "name": "file", "in": "query", "description": "File to upload (max 25MB)", "required": true, "schema": { "type": "file" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "File has been uploaded successfully" }, "path": { "type": "string" }, "file_name": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/logout": { "post": { "tags": [ "Outlook" ], "summary": "Logout from Outlook", "operationId": "38df6952d1b30e36cb74de283393bfc5", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "You have been logged out successfully." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/leads-threads": { "post": { "tags": [ "Outlook" ], "summary": "Get email threads related to a specific lead (excluding unknown senders)", "operationId": "65a4957b59a85b120e69aada0926b969", "parameters": [ { "name": "lead_id", "in": "query", "description": "ID of the lead", "required": true, "schema": { "type": "integer" } }, { "name": "page_token", "in": "query", "description": "Page token for pagination", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "messages": { "type": "array", "items": { "type": "object" } }, "is_end": { "type": "boolean" }, "next_page": { "type": "integer" }, "previous_page": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/get-profile": { "post": { "tags": [ "Outlook" ], "summary": "Get the user's Outlook profile", "operationId": "6d161b9de6f73c298d03b8dbb4d898e1", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "profile": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "auth_link": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/set-outlook-subscription": { "post": { "tags": [ "Outlook" ], "summary": "Set up subscriptions for Outlook notifications", "description": "Refreshes tokens and sets up subscriptions for Outlook notifications for all users", "operationId": "9a86a412042d6aa4b4f140a177217d7e", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Subscription set successfully" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-outlook-response": { "post": { "tags": [ "Outlook" ], "summary": "Handle webhook responses from Outlook", "description": "Processes webhook notifications from Outlook, validates subscription tokens, and handles email notifications. Also manages lead actions based on email replies.", "operationId": "05ddc1156d0d72ad068292deef4271dc", "parameters": [ { "name": "validationToken", "in": "query", "description": "Validation token for subscription verification", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Webhook notification data from Outlook", "required": false, "content": { "application/json": { "schema": { "properties": { "value": { "type": "array", "items": { "properties": { "subscriptionId": { "type": "string" }, "resourceData": { "properties": { "id": { "type": "string" } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success - For validation token requests, returns the token. For notifications, returns empty response.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Webhook response processed successfully" } }, "type": "object" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" }, "error": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/check-project-client": { "get": { "tags": [ "Outlook" ], "summary": "Check Outlook project client connection and retrieve profile", "operationId": "0f330a7a4dfc94c1807908d814aec3f0", "responses": { "200": { "description": "Profile retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "profile": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Error while connecting outlook" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/project-oauth2-callback": { "get": { "tags": [ "Outlook" ], "summary": "Handle Outlook project OAuth2 callback and store access tokens", "operationId": "1e14385b343ded590119546a55e3f85f", "parameters": [ { "name": "code", "in": "query", "description": "Authorization code from Outlook OAuth2 flow", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token has been generated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Token has been generated successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "400": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/outlook/send/{user_id}": { "post": { "tags": [ "Outlook" ], "summary": "Send an Outlook email on behalf of the specified user", "operationId": "c38ea1c711af280c3e23ea4c13ed33bf", "parameters": [ { "name": "user_id", "in": "path", "description": "ID of the user sending the email", "required": true, "schema": { "type": "integer" } }, { "name": "to", "in": "query", "description": "Recipient email address or array of addresses", "required": true, "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Email subject", "required": true, "schema": { "type": "string" } }, { "name": "mail_body", "in": "query", "description": "Email body content", "required": true, "schema": { "type": "string" } }, { "name": "cc", "in": "query", "description": "Comma separated CC recipients", "required": false, "schema": { "type": "string" } }, { "name": "bcc", "in": "query", "description": "Comma separated BCC recipients", "required": false, "schema": { "type": "string" } }, { "name": "reply_to_mail_id", "in": "query", "description": "Outlook message ID to reply to", "required": false, "schema": { "type": "string" } }, { "name": "append_signature", "in": "query", "description": "Whether to append the user signature", "required": false, "schema": { "type": "boolean" } }, { "name": "file_names", "in": "query", "description": "Array of attachment filenames", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "lead_id", "in": "query", "description": "Optional lead ID used for short code replacement", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Email sent successfully" }, "422": { "description": "Validation error" }, "400": { "description": "Error while sending email" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/calendar-event/outlook/list": { "get": { "tags": [ "Outlook Calendar Event" ], "summary": "List Outlook calendar events within a date range", "operationId": "238ff2010a3d70bc4b9eb91c873329c3", "parameters": [ { "name": "start_date", "in": "query", "description": "Start date for the calendar window", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date for the calendar window (must be on or after start_date)", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Outlook calendar events retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "events": { "type": "array", "items": { "type": "object" } }, "colors": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error or invalid date format" }, "500": { "description": "Outlook API error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/check-outlook-calendar-auth": { "post": { "tags": [ "Outlook Calendar Event" ], "summary": "Check whether the authenticated user has a valid Outlook calendar connection", "operationId": "88197e1fbbf525e4a54b37fd9e348f6e", "responses": { "200": { "description": "Outlook authentication status", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "calendar_email": { "type": "string" }, "auth_link": { "description": "Returned when re-authentication is required", "type": "string" } }, "type": "object" } } } }, "500": { "description": "Outlook API error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/calendar-event/outlook/logout": { "post": { "tags": [ "Outlook Calendar Event" ], "summary": "Disconnect the authenticated user's Outlook calendar integration", "operationId": "4fdadd744826d14ef3ad798a06c30da8", "responses": { "200": { "description": "Outlook calendar disconnected successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "You have been logged out successfully." }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/all-integration/outlook/logout": { "post": { "tags": [ "Outlook Calendar Event" ], "summary": "Disconnect Outlook calendar from the all-integration flow", "operationId": "58679b5bad4bbee0d3d4d3397c5414bf", "responses": { "200": { "description": "Outlook calendar disconnected successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "You have been logged out successfully." }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/calendar-event/outlook/delete": { "delete": { "tags": [ "Outlook Calendar Event" ], "summary": "Delete an event from Outlook calendar and the local database", "operationId": "8b342f6ce119223488197ba62e5e0d17", "parameters": [ { "name": "id", "in": "query", "description": "Local event ID to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Event deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Event deleted successfully." } }, "type": "object" } } } }, "403": { "description": "Viewer role cannot delete events" }, "404": { "description": "Event not found" }, "500": { "description": "Outlook API error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/calendar-event/outlook/create": { "post": { "tags": [ "Outlook Calendar Event" ], "summary": "Create a new event in Outlook calendar and the local database", "operationId": "22da6a41f72c1599e9f22b0cde40d7f1", "parameters": [ { "name": "title", "in": "query", "description": "Event title", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Event description (HTML allowed)", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Event start datetime", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "end_date", "in": "query", "description": "Event end datetime (must be on or after start_date)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "color_id", "in": "query", "description": "Optional color identifier", "required": false, "schema": { "type": "integer" } }, { "name": "location", "in": "query", "description": "Event location", "required": false, "schema": { "type": "string" } }, { "name": "invite_emails", "in": "query", "description": "Comma or semicolon separated list of attendee email addresses", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Event created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Event created successfully." }, "event_id": { "type": "string" }, "event": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "403": { "description": "Viewer role cannot create events" }, "422": { "description": "Validation error" }, "500": { "description": "Outlook API error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/calendar-event/outlook/update": { "post": { "tags": [ "Outlook Calendar Event" ], "summary": "Update an existing Outlook calendar event and the local database record", "operationId": "d8ab56cf1c6fb806c77f35e4d41eadd2", "parameters": [ { "name": "id", "in": "query", "description": "Local event ID to update", "required": true, "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Event title", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Event description (HTML allowed)", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Event start datetime", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "end_date", "in": "query", "description": "Event end datetime (must be on or after start_date)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "color_id", "in": "query", "description": "Optional color identifier", "required": false, "schema": { "type": "integer" } }, { "name": "location", "in": "query", "description": "Event location", "required": false, "schema": { "type": "string" } }, { "name": "invite_emails", "in": "query", "description": "Comma or semicolon separated list of attendee email addresses", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Event updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Event updated locally and on Outlook." }, "event_id": { "type": "integer" }, "event": { "type": "object" } }, "type": "object" } } } }, "403": { "description": "Viewer role cannot update events" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/event-cancel-outlook/{id}": { "get": { "tags": [ "Outlook Calendar Event" ], "summary": "Mark an Outlook calendar event as cancelled", "operationId": "6b21cd373a8dd85eebee3bc45e3690a8", "parameters": [ { "name": "id", "in": "path", "description": "Local event ID to cancel", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Event cancelled successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "error": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Cancelled Successfully" }, "event": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Event not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packageitemtype": { "get": { "tags": [ "Package Item Type" ], "summary": "Get all package item types", "operationId": "6d8cc9688fbc1d75c8b30d49a61b890e", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "package_item_type": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Package Item Type" ], "summary": "Create a new package item type", "operationId": "45f51f8f0ee1a54c761d75e6711a2024", "parameters": [ { "name": "title", "in": "query", "description": "Title of the package item type", "required": true, "schema": { "type": "string", "example": "Premium Package" } } ], "responses": { "200": { "description": "Package item type created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Package Item Type Added Successfully." }, "package_item_type": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packageitemtype/data-table/get": { "post": { "tags": [ "Package Item Type" ], "summary": "Get package item types for DataTables", "operationId": "1ba32c0e886cd17d6f970e32c0983311", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" } }, "type": "object" } } } }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packageitemtype/{id}": { "get": { "tags": [ "Package Item Type" ], "summary": "Get a specific package item type", "operationId": "6fd47f6f77209273dc20aa9f933c7fa3", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item type", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "package_item_type": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package item type not found" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Package Item Type" ], "summary": "Update a specific package item type", "operationId": "b1cd019d1e3ac12efd285ba31dfef027", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item type", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Title of the package item type", "required": true, "schema": { "type": "string", "example": "Updated Premium Package" } } ], "responses": { "200": { "description": "Package item type updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Package Item Type Updated Successfully." }, "package_item_type": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package item type not found" }, "422": { "description": "Validation error" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Package Item Type" ], "summary": "Delete a specific package item type", "operationId": "0451b26eb1eeb512a52383f0841f5b84", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item type to delete", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Package item type deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Package Item Type Deleted Successfully." } }, "type": "object" } } } }, "404": { "description": "Package item type not found" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packageitemslist": { "get": { "tags": [ "Package Items List" ], "summary": "Get all package items list", "operationId": "8f79b3cee2dfc990983fcc472f6de807", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "package_items_list": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Package Items List" ], "summary": "Store a new package item", "operationId": "2360d8d9b93319190d5c4254fef5f7da", "parameters": [ { "name": "title", "in": "query", "description": "Title of the package item", "required": true, "schema": { "type": "string" } }, { "name": "rate", "in": "query", "description": "Rate of the package item", "required": true, "schema": { "type": "number" } }, { "name": "limit", "in": "query", "description": "Limit of the package item", "required": true, "schema": { "type": "integer" } }, { "name": "rate_month", "in": "query", "description": "Monthly rate of the package item", "required": true, "schema": { "type": "number" } }, { "name": "limit_month", "in": "query", "description": "Monthly limit of the package item", "required": true, "schema": { "type": "integer" } }, { "name": "rate_year", "in": "query", "description": "Yearly rate of the package item", "required": true, "schema": { "type": "number" } }, { "name": "limit_year", "in": "query", "description": "Yearly limit of the package item", "required": true, "schema": { "type": "integer" } }, { "name": "package_item_type_id", "in": "query", "description": "Package item type ID", "required": true, "schema": { "type": "integer" } }, { "name": "description", "in": "query", "description": "Description of the package item", "required": false, "schema": { "type": "string" } }, { "name": "file[]", "in": "query", "description": "Files to upload", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "binary" } } } ], "responses": { "200": { "description": "Package item created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Package Items Added Successfully" }, "package_items_list": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packageitemslist/data-table/get": { "post": { "tags": [ "Package Items List" ], "summary": "Get package items list for data table", "operationId": "9f557469873b6a1b83658a87ce17fbff", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packageitemslist/{id}": { "get": { "tags": [ "Package Items List" ], "summary": "Get a specific package item", "operationId": "ac48ed258caff400db52cdb638bac4af", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "package_items_list": { "type": "object" }, "clientSecret": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found or other error" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Package Items List" ], "summary": "Update a package item", "operationId": "50e3315f84d00c6352fded1b99c15b20", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item to update", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package Items Deleted Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Package Items Deleted Successfully." } }, "type": "object" } } } }, "500": { "description": "Error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Package Items List" ], "summary": "Delete a package item", "operationId": "55434c2b71ac725df16597a62b4bdd40", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package Items Deleted Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Package Items Deleted Successfully." } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packageitemslist_item_update/{id}": { "post": { "tags": [ "Package Items List" ], "summary": "Update a package item with specific fields", "operationId": "aae0eb88ae82302ccdcff69fbe69b698", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item to update", "required": true, "schema": { "type": "integer" } }, { "name": "title", "in": "query", "description": "Title of the package item", "required": true, "schema": { "type": "string" } }, { "name": "short_description", "in": "query", "description": "Short description of the package item", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description of the package item", "required": false, "schema": { "type": "string" } }, { "name": "files", "in": "query", "description": "JSON string of existing files", "required": false, "schema": { "type": "string" } }, { "name": "file[]", "in": "query", "description": "New files to upload", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "binary" } } } ], "responses": { "200": { "description": "Package Items Updated Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Package Items Updated Successfully." }, "package_items_list": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Package Items Not Found or other error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/all-package-items-list": { "get": { "tags": [ "Package Items List" ], "summary": "Get all package items list based on client's package", "operationId": "db4bbca2013f3142084206d632528857", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "package_items_list": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found or Package Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/updateprimaryimage/{id}": { "post": { "tags": [ "Package Items List" ], "summary": "Update the primary image of a package item", "operationId": "06b052e079776eaed66773104fdf7647", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item", "required": true, "schema": { "type": "integer" } }, { "name": "file_name", "in": "query", "description": "Name of the file to set as primary image", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Package Items Updated Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Package Items Updated Successfully." }, "package_items_list": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-coupon/{code}": { "get": { "tags": [ "Package Items List" ], "summary": "Get coupon details by code", "operationId": "bff2dec67a47bd9b563dbdc1ffa4da52", "parameters": [ { "name": "code", "in": "path", "description": "Coupon code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "coupon": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Invalid coupon code or other error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packages": { "get": { "tags": [ "Packages" ], "summary": "Get a list of all packages with their items", "operationId": "1c5d87c3ec07a1281538754b1171c9fb", "responses": { "200": { "description": "List of packages retrieved successfully", "content": { "application/json": { "schema": { "properties": { "package": { "type": "array", "items": { "type": "object" } }, "clientSecret": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Packages" ], "summary": "Create a new package", "operationId": "21a3fb57da2017aefe82bb2ca5d06082", "parameters": [ { "name": "title", "in": "query", "description": "Title of the package", "required": true, "schema": { "type": "string" } }, { "name": "price", "in": "query", "description": "Price of the package", "required": true, "schema": { "type": "number", "format": "float" } }, { "name": "interval", "in": "query", "description": "Billing interval (day, week, month, year)", "required": true, "schema": { "type": "string" } }, { "name": "interval_count", "in": "query", "description": "Number of intervals between billings", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "package": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/packages/{id}": { "get": { "tags": [ "Packages" ], "summary": "Get a specific package by ID", "operationId": "c6c990135fe04820f00c1636ebd26686", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package retrieved successfully", "content": { "application/json": { "schema": { "properties": { "package": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Packages" ], "summary": "Update a specific package", "operationId": "2acf773d5e17127d280ea497a6e2f2da", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package to update", "required": true, "schema": { "type": "integer" } }, { "name": "title", "in": "query", "description": "Title of the package", "required": false, "schema": { "type": "string" } }, { "name": "price", "in": "query", "description": "Price of the package", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "interval", "in": "query", "description": "Billing interval (day, week, month, year)", "required": false, "schema": { "type": "string" } }, { "name": "interval_count", "in": "query", "description": "Number of intervals between billings", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "package": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package not found" }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Packages" ], "summary": "Delete a specific package", "operationId": "d62a5ac40102e99a6d3879be55bacef1", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Package not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get_package_items": { "post": { "tags": [ "Package Items" ], "summary": "Get items for a specific package", "operationId": "e4b557255d6e6afa330f343be83f4a0e", "parameters": [ { "name": "package_id", "in": "query", "description": "ID of the package", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package items retrieved successfully", "content": { "application/json": { "schema": { "properties": { "package": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/add_package_item": { "post": { "tags": [ "Package Items" ], "summary": "Add an item to a package", "operationId": "9276748140608e81e1c6a155f56d2fdf", "parameters": [ { "name": "package_id", "in": "query", "description": "ID of the package", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "query", "description": "ID of the item to add", "required": true, "schema": { "type": "integer" } }, { "name": "price", "in": "query", "description": "Price of the item", "required": true, "schema": { "type": "number", "format": "float" } }, { "name": "limit", "in": "query", "description": "Limit for the item", "required": false, "schema": { "type": "integer" } }, { "name": "limit_increase", "in": "query", "description": "Limit increase for the item", "required": false, "schema": { "type": "integer" } }, { "name": "customizable", "in": "query", "description": "Whether the item is customizable", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Package item added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "package_items": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package not found" }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update_package_item": { "post": { "tags": [ "Package Items" ], "summary": "Update a package item", "operationId": "576eddc406497f34c2aace1febc29ce7", "parameters": [ { "name": "id", "in": "query", "description": "ID of the package item to update", "required": true, "schema": { "type": "integer" } }, { "name": "price", "in": "query", "description": "Price of the item", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "limit", "in": "query", "description": "Limit for the item", "required": false, "schema": { "type": "integer" } }, { "name": "limit_increase", "in": "query", "description": "Limit increase for the item", "required": false, "schema": { "type": "integer" } }, { "name": "customizable", "in": "query", "description": "Whether the item is customizable", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Package item updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "package_items": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package item not found" }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get_package_item/{id}": { "get": { "tags": [ "Package Items" ], "summary": "Get a specific package item by ID", "operationId": "f3bcc66cfabec55a2b028c1e58a36911", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package item retrieved successfully", "content": { "application/json": { "schema": { "properties": { "item": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package item not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete_package_item/{id}": { "post": { "tags": [ "Package Items" ], "summary": "Delete a specific package item", "operationId": "b2f8a98b0b915d32053b93818c5424c8", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package item deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "package_item": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package item not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/all-packages-list": { "get": { "tags": [ "Packages" ], "summary": "Get a list of all packages without items", "operationId": "bf6853d16914d930be4828d5c14edd04", "responses": { "200": { "description": "List of packages retrieved successfully", "content": { "application/json": { "schema": { "properties": { "package": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/package-list-with-packageitems": { "get": { "tags": [ "Packages" ], "summary": "Get a list of all packages with their items", "operationId": "2456348a4d3796353f56769935fc4151", "responses": { "200": { "description": "List of packages with items retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "package": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Packages not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/plan-list-with-packageitems": { "post": { "tags": [ "Packages" ], "summary": "Get a list of packages with items filtered by interval", "operationId": "7b157bd732cefb09d59070b46d57add7", "parameters": [ { "name": "interval", "in": "query", "description": "Billing interval (day, week, month, year)", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "ID of the client", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of packages with items retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "package": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Packages not found" }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-package/{id}": { "get": { "tags": [ "Packages" ], "summary": "Get a specific package with its items", "operationId": "1d1ac32c20ea36be1fcaa6b8ca4f0b64", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package with items retrieved successfully", "content": { "application/json": { "schema": { "properties": { "package": { "type": "object" }, "package_items": { "type": "array", "items": { "type": "object" } }, "clientSecret": { "type": "string" }, "subscription": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-package-data/{id}": { "get": { "tags": [ "Packages" ], "summary": "Get a specific package with its items without authentication", "operationId": "33e6f5a670995648293db13d0babb1f1", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Package with items retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "package": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package not found" }, "500": { "description": "Server error" } } } }, "/api/package_items_list": { "get": { "tags": [ "Packages" ], "summary": "Get list of package items", "operationId": "8d88163df65a25bc02ffb3232f35981c", "responses": { "200": { "description": "Package items list retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/paln-list-with-packageitems": { "post": { "tags": [ "Packages" ], "summary": "Get plans with their package items filtered by interval", "operationId": "684c2edc0dacf893f12cd85f8d82367c", "parameters": [ { "name": "interval", "in": "query", "description": "Billing interval (day, week, month, year)", "required": true, "schema": { "type": "string" } }, { "name": "client_id", "in": "query", "description": "Client ID used to filter packages by existing plan price", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Plan list retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "package": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Package not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-package-data-by-stripe-id/{id}": { "get": { "tags": [ "Packages" ], "summary": "Get package details by Stripe plan id", "operationId": "d35c5c640cb7c0873e93f70bcd708303", "parameters": [ { "name": "id", "in": "path", "description": "Stripe plan id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Package retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "package": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Package not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/performance": { "get": { "tags": [ "Performance" ], "summary": "Get all performance records for the authenticated user's client", "operationId": "3a7762927b259e8c13e84e2ae7d6d24f", "responses": { "200": { "description": "Performance records retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Get all performance successfully." }, "performance": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Performance" ], "summary": "Create a new performance record", "operationId": "ec042bf84958f375fd31afe880d46210", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "month", "in": "query", "description": "Month (1-12)", "required": true, "schema": { "type": "integer", "maximum": 12 } }, { "name": "year", "in": "query", "description": "Year (4 digits)", "required": true, "schema": { "type": "integer", "format": "int32", "example": 2023 } } ], "responses": { "200": { "description": "Performance record created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Performance Added Successfully." }, "performance": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/performance/{id}": { "get": { "tags": [ "Performance" ], "summary": "Get a specific performance record by ID", "operationId": "f93873dd06865269e2282e955a61dd89", "parameters": [ { "name": "id", "in": "path", "description": "Performance record ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Performance record retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Performance get successfully" }, "performance": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Performance record not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Performance" ], "summary": "Update a specific performance record", "operationId": "649287aab4250086e36164cd2d93bea4", "parameters": [ { "name": "id", "in": "path", "description": "Performance record ID", "required": true, "schema": { "type": "integer" } }, { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "performance", "in": "query", "description": "Performance rating", "required": true, "schema": { "type": "integer" } }, { "name": "month", "in": "query", "description": "Month (1-12)", "required": true, "schema": { "type": "integer", "maximum": 12 } }, { "name": "year", "in": "query", "description": "Year (4 digits)", "required": true, "schema": { "type": "integer", "format": "int32", "example": 2023 } } ], "responses": { "200": { "description": "Performance record updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Performance Updated Successfully" }, "performance": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Performance record not found" }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Performance" ], "summary": "Delete a specific performance record", "operationId": "bf7993cadbbebf1f3ea3ed821efea7d4", "parameters": [ { "name": "id", "in": "path", "description": "Performance record ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Performance record deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Performance Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "Performance record not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/member-performance": { "post": { "tags": [ "Performance" ], "summary": "Get performance records for a specific user", "operationId": "8c27053126e541cac128bd654b39910c", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "year", "in": "query", "description": "Year (4 digits)", "required": true, "schema": { "type": "integer", "format": "int32", "example": 2023 } }, { "name": "month", "in": "query", "description": "Month (1-12)", "required": false, "schema": { "type": "integer", "maximum": 12 } } ], "responses": { "200": { "description": "Performance records retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Get performance successfully." }, "performance": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Performance records not found" }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-twilio-purchase-phone-number": { "post": { "tags": [ "Phone Numbers" ], "summary": "Get available phone numbers from Twilio", "operationId": "2dd26973231b57982d8c52bae1ddb4ff", "parameters": [ { "name": "countryName", "in": "query", "description": "Country code (defaults to GB if not provided)", "required": false, "schema": { "type": "string", "example": "GB" } }, { "name": "searchVal", "in": "query", "description": "Search value to filter phone numbers", "required": false, "schema": { "type": "string" } }, { "name": "numberType", "in": "query", "description": "Type of phone number (mobile or local)", "required": true, "schema": { "type": "string", "enum": [ "mobile", "local" ] } } ], "responses": { "200": { "description": "Phone numbers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "phoneNumber": { "type": "array", "items": { "type": "object" } }, "prices": { "type": "number", "example": 10.99 } }, "type": "object" } } } }, "400": { "description": "Failed to retrieve phone numbers" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twilio-country-name": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get list of countries available for Twilio phone numbers", "operationId": "ab424cd7870673cdbb18a3bdfa7f9ea2", "responses": { "200": { "description": "Countries retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "countryName": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failed to retrieve countries" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/purchase-phone-number": { "post": { "tags": [ "Phone Numbers" ], "summary": "Purchase a phone number from Twilio", "operationId": "f50653c8bfcb2e76f224c138ad910896", "parameters": [ { "name": "bundle", "in": "query", "description": "Bundle ID for the phone number", "required": true, "schema": { "type": "string" } }, { "name": "payment_method", "in": "query", "description": "Payment method ID", "required": true, "schema": { "type": "string" } }, { "name": "phoneNo", "in": "query", "description": "Phone number to purchase", "required": true, "schema": { "type": "string" } }, { "name": "numberType", "in": "query", "description": "Type of phone number (mobile or local)", "required": true, "schema": { "type": "string", "enum": [ "mobile", "local" ] } }, { "name": "price", "in": "query", "description": "Price of the phone number", "required": true, "schema": { "type": "number" } }, { "name": "code", "in": "query", "description": "Coupon code", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Phone number purchased successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Phone Number Purchase Successfully..!" }, "phone": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Failed to purchase phone number" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-purchase-phone-number": { "post": { "tags": [ "Phone Numbers" ], "summary": "Update purchased phone number details", "operationId": "a33eb02189fe42d966f1e2fc68485251", "parameters": [ { "name": "purchaseNumber", "in": "query", "description": "Phone number to update", "required": true, "schema": { "type": "string" } }, { "name": "assignedTo", "in": "query", "description": "User ID to assign the phone number to", "required": true, "schema": { "type": "integer" } }, { "name": "forwardPhoneNumber", "in": "query", "description": "Forward phone number details", "required": false, "schema": { "properties": { "number": { "type": "string" }, "dialCode": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Phone number updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Phone number Updated Successfully..!" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "400": { "description": "Failed to update phone number" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-phone-number": { "post": { "tags": [ "Phone Numbers" ], "summary": "Get list of phone numbers for the client", "operationId": "053e2528e6b088db7d77b930f93e7eb8", "responses": { "200": { "description": "Phone numbers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "properties": { "client_id": { "type": "integer" }, "user_id": { "type": "integer" }, "assigned_to": { "type": "integer", "nullable": true }, "phone_number": { "type": "string" }, "capabilities": { "type": "object" }, "forward_phone_number": { "type": "string", "nullable": true }, "phone_number_sid": { "type": "string" }, "subscription_id": { "type": "string" }, "number_type": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "assigned_user": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failed to retrieve phone numbers" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-team-phone-number": { "post": { "tags": [ "Phone Numbers" ], "summary": "Get list of phone numbers for the client team", "operationId": "22029f793d9530fc7729de66e49c7fcb", "responses": { "200": { "description": "Team phone numbers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "phoneNumberData": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "client_id": { "type": "integer" }, "user_id": { "type": "integer" }, "assigned_to": { "type": "integer", "nullable": true }, "phone_number": { "type": "string" }, "capabilities": { "type": "object" }, "forward_phone_number": { "type": "string", "nullable": true }, "phone_number_sid": { "type": "string" }, "subscription_id": { "type": "string" }, "number_type": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "assigned_user": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failed to retrieve team phone numbers" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/set-team-phone-number-forward": { "post": { "tags": [ "Phone Numbers" ], "summary": "Forward phone calls to a specific user's phone number", "operationId": "d7ca2bd580987f388677af0dab671c14", "parameters": [ { "name": "phone_id", "in": "query", "description": "ID of the phone number to forward from", "required": true, "schema": { "type": "integer" } }, { "name": "user_id", "in": "query", "description": "ID of the user to forward calls to", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Phone number forwarding set successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "400": { "description": "Failed to set phone number forwarding" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-client-users": { "post": { "tags": [ "Phone Numbers" ], "summary": "Get user assigned to a specific phone number", "operationId": "f53cd63176cb1f28d84bdf29c6e1c12e", "parameters": [ { "name": "phone_number", "in": "query", "description": "Phone number to check", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Phone number user data retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "phoneNumberData": { "properties": { "id": { "type": "integer" }, "assigned_to": { "type": "integer", "nullable": true }, "forward_phone_number": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Failed to retrieve phone number user data" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/number-assign-user": { "post": { "tags": [ "Phone Numbers" ], "summary": "Assign a phone number to a specific user", "operationId": "7624a0c007a195a049f424ce852ca16f", "parameters": [ { "name": "phone_number", "in": "query", "description": "Phone number to assign", "required": true, "schema": { "type": "string" } }, { "name": "phone_number_id", "in": "query", "description": "ID of the phone number", "required": true, "schema": { "type": "integer" } }, { "name": "assigned_to", "in": "query", "description": "User ID to assign the phone number to", "required": true, "schema": { "type": "integer" } }, { "name": "incomingCallOption", "in": "query", "description": "Option for handling incoming calls (forwardNumber or other)", "required": true, "schema": { "type": "string" } }, { "name": "forwardPhoneNumber", "in": "query", "description": "Forward phone number details (required if incomingCallOption is forwardNumber)", "required": false, "schema": { "properties": { "number": { "type": "string" }, "dialCode": { "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Phone number assigned successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Phone number updated successfully..!" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "400": { "description": "Failed to assign phone number" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/release-phone-number": { "get": { "tags": [ "Phone Numbers" ], "summary": "Release a purchased phone number", "operationId": "b343104565dc7cfee45b054bb508e470", "parameters": [ { "name": "subscription_id", "in": "query", "description": "Subscription ID of the phone number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Phone number released successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Phone number release successfully..!" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "400": { "description": "Failed to release phone number" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/check-twilio-number-assign": { "get": { "tags": [ "Phone Numbers" ], "summary": "Check if the authenticated user has an assigned phone number", "operationId": "3bd5eeb9506283f3040cb9ec58779ff3", "responses": { "200": { "description": "Phone number assignment check successful", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "phone_number": { "type": "integer", "example": 1 } }, "type": "object" } } } }, "400": { "description": "Failed to check phone number assignment" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-bundle-list/{type}": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get list of bundles by type", "operationId": "fb66ff1dbd9b19e1c31e3d739cf4434c", "parameters": [ { "name": "type", "in": "path", "description": "Type of bundle (mobile or local)", "required": true, "schema": { "type": "string", "enum": [ "mobile", "local" ] } } ], "responses": { "200": { "description": "Bundles retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "bundle": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "bundle_sid": { "type": "string" }, "friendly_name": { "type": "string" }, "number_type": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Failed to retrieve bundles" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/without-payment-purchase-phone-number": { "post": { "tags": [ "Phone Numbers" ], "summary": "Purchase a free Twilio phone number from plan inclusions without payment", "operationId": "88429b660f8fc260128485fbd0ae6e2e", "parameters": [ { "name": "bundle", "in": "query", "description": "Twilio bundle SID", "required": true, "schema": { "type": "string" } }, { "name": "phoneNo", "in": "query", "description": "Phone number to purchase", "required": true, "schema": { "type": "string" } }, { "name": "numberType", "in": "query", "description": "Type of phone number (mobile or local)", "required": true, "schema": { "type": "string", "enum": [ "mobile", "local" ] } }, { "name": "countryName", "in": "query", "description": "Country code for the phone number", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Phone number purchased successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Phone Number Purchase Successfully..!" }, "phone": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Phone Number Not Purchase" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/purchase-number-confirm-payment": { "post": { "tags": [ "Phone Numbers" ], "summary": "Confirm Stripe payment for a phone number purchase and complete the order", "operationId": "aa39772caf1cde4a602bca1309f4fc4b", "parameters": [ { "name": "request_data", "in": "query", "description": "Original purchase request data including stripePrice and subscription_id", "required": true, "schema": { "type": "object" } }, { "name": "payment_info", "in": "query", "description": "Payment information with status from Stripe", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Phone number purchased successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string" }, "phone": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-purchase-phone-number-for-sms": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get purchased phone numbers with SMS capability for the authenticated client", "operationId": "d67edf2a146f355ce63bb847c3aff362", "responses": { "200": { "description": "Phone numbers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Get phone number Successfully..!" }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "phone_number": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "No phone numbers found for the client" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-purchase-phone-number-for-voice-by-user-id/{user_id}": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get purchased phone numbers with voice capability assigned to the given user", "operationId": "1e01b60772f7aa373b1f39fe0b931dd0", "parameters": [ { "name": "user_id", "in": "path", "description": "ID of the user (or comma-separated IDs) to filter assigned voice numbers", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Phone numbers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Get phone number Successfully..!" }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "phone_number": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "No phone numbers found for the client" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twilio-number-types/{country}": { "get": { "tags": [ "Phone Numbers" ], "summary": "Number types purchasable in a country", "description": "Twilio search availability for the country (cached for a day), minus toll_free, falling back to local+mobile when Twilio is unreachable or unconfigured. A type Twilio newly offers appears automatically, but its search branches / pricing rows must exist before it actually returns numbers.", "operationId": "12aec3bdf56ad1236c680a388786d976", "parameters": [ { "name": "country", "in": "path", "description": "ISO 3166-1 alpha-2 country code (e.g. GB, US)", "required": true, "schema": { "type": "string", "example": "GB" } } ], "responses": { "200": { "description": "Available number types", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "number_types": { "type": "array", "items": { "type": "string", "example": "local" }, "example": [ "local", "mobile", "national" ] } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ppc-report": { "get": { "tags": [ "PPC Reports" ], "summary": "Get a list of PPC reports", "operationId": "186e563c084621acd1539611c6317e30", "responses": { "200": { "description": "List of PPC reports retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "PPC Reports" ], "summary": "Create a new PPC report", "operationId": "3da9831108418f68b16f507b92754bb7", "parameters": [ { "name": "client_id", "in": "query", "description": "Client ID", "required": true, "schema": { "type": "integer" } }, { "name": "subject", "in": "query", "description": "Email subject", "required": true, "schema": { "type": "string" } }, { "name": "message", "in": "query", "description": "Email message content", "required": true, "schema": { "type": "string" } }, { "name": "cc_emails", "in": "query", "description": "CC email addresses (comma separated)", "required": false, "schema": { "type": "string" } }, { "name": "files[]", "in": "query", "description": "Report files to upload", "required": true, "schema": { "type": "array", "items": { "type": "file" } } } ], "responses": { "200": { "description": "PPC report created successfully" }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ppc-report/data-table": { "post": { "tags": [ "PPC Reports" ], "summary": "Get PPC reports data for datatable", "operationId": "6ccaac827bfe7548bf7723ecd50fcb65", "parameters": [ { "name": "user_id", "in": "query", "description": "Filter by user ID", "required": false, "schema": { "type": "integer" } }, { "name": "email_sent", "in": "query", "description": "Filter by email sent status", "required": false, "schema": { "type": "boolean" } }, { "name": "start_date", "in": "query", "description": "Filter by start date", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "Filter by end date", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "PPC reports data retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ppc-report/{id}": { "get": { "tags": [ "PPC Reports" ], "summary": "Get a specific PPC report", "operationId": "88733e4a9eb614f74262829e90e8df34", "parameters": [ { "name": "id", "in": "path", "description": "PPC Report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "PPC report retrieved successfully" }, "401": { "description": "Unauthenticated" }, "404": { "description": "PPC report not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "PPC Reports" ], "summary": "Send a PPC report email", "operationId": "eb80c23d56cf2cd0ac849eb0d00d9c0b", "parameters": [ { "name": "id", "in": "path", "description": "PPC Report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "PPC report sent successfully" }, "401": { "description": "Unauthenticated" }, "404": { "description": "PPC report not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "PPC Reports" ], "summary": "Delete a PPC report", "operationId": "d4ed4b932732875e9a500f0a684603e5", "parameters": [ { "name": "id", "in": "path", "description": "PPC Report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "PPC report deleted successfully" }, "401": { "description": "Unauthenticated" }, "404": { "description": "PPC report not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ppc_report_tracking/{id}": { "get": { "tags": [ "PPC Reports" ], "summary": "Track when a PPC report email is opened", "operationId": "06efebe256abfaf38b286d27d993b57a", "parameters": [ { "name": "id", "in": "path", "description": "PPC Report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Email tracking recorded successfully" }, "404": { "description": "PPC report not found" } } } }, "/api/ppc-report/download-attachment": { "get": { "tags": [ "PPC Reports" ], "summary": "Download a PPC report attachment", "operationId": "b61a5442cb391b9f7996eb07754bced1", "parameters": [ { "name": "id", "in": "query", "description": "PPC Report ID", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Index of the attachment to download", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File download" }, "401": { "description": "Unauthenticated" }, "404": { "description": "File not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/users-all": { "get": { "tags": [ "PPC Reports" ], "summary": "Get all users with their company information", "operationId": "9d9266c7f1152dd36683f95867f1e632", "responses": { "200": { "description": "List of users retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/report_view/ppc/{id}": { "get": { "tags": [ "PPC Reports" ], "summary": "View a PPC report", "operationId": "9efcde0bbfc148544c186fdf2b090df1", "parameters": [ { "name": "id", "in": "path", "description": "PPC Report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "PPC report details retrieved successfully" }, "401": { "description": "Unauthenticated" }, "404": { "description": "PPC report not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/product": { "get": { "tags": [ "Package Items List" ], "summary": "Get all package items list", "operationId": "75c603cef0922d833fd5d84e602b672c", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "package_items_list": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/product/{slug}": { "get": { "tags": [ "Package Items List" ], "summary": "Get a specific package item", "operationId": "40d09f526e349ba5a01515d03bc1aee2", "parameters": [ { "name": "id", "in": "path", "description": "ID of the package item", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "package_items_list": { "type": "object" }, "clientSecret": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found or other error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/products": { "get": { "tags": [ "Product" ], "summary": "List marketplace products grouped by internal vs external origin", "operationId": "2ef45fbb1432ebbffc8bb742c31f13a4", "responses": { "200": { "description": "Products returned", "content": { "application/json": { "schema": { "properties": { "package_items_list": { "type": "array", "items": { "type": "object" } }, "package_items_list_internal": { "type": "array", "items": { "type": "object" } }, "package_items_list_external": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Package Items Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/singal-product/{slug}": { "get": { "tags": [ "Product" ], "summary": "Get a single product by slug (with variables for variable products)", "operationId": "c0c4b7c8500ab646b87e9a664ce31270", "parameters": [ { "name": "slug", "in": "path", "description": "Product slug", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Product returned", "content": { "application/json": { "schema": { "properties": { "product": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Product Not Found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Product Not Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-attachment": { "get": { "tags": [ "Project Attachments" ], "summary": "Get all project attachments", "operationId": "3056d8bc3ec7720238d33fd312ab88cb", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "project_attachment": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Project Attachment Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Attachments" ], "summary": "Store a new project attachment", "operationId": "c3c219fbe5ab684bccac1b0b43278112", "parameters": [ { "name": "title", "in": "query", "description": "Description of the attachment", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "file", "in": "query", "description": "File to upload", "required": true, "schema": { "type": "file" } } ], "responses": { "200": { "description": "Project Attachment Added Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Project Attachment Added Successfully" }, "project_attachment": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-attachment/data-table/get": { "post": { "tags": [ "Project Attachments" ], "summary": "Get project attachments for data table", "operationId": "68824ac256208472cd560b168985af15", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-project/attachment": { "get": { "tags": [ "Project Attachments" ], "summary": "Get all project attachments", "operationId": "dc40fcaad0b0ee9b9eff11def3f3dae5", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "project_attachment": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-attachment/{id}": { "get": { "tags": [ "Project Attachments" ], "summary": "Get a specific project attachment", "operationId": "12698affdf4e20869137c98174c736b0", "parameters": [ { "name": "id", "in": "path", "description": "ID of the project attachment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "project_attachment": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Project Attachment Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Attachments" ], "summary": "Delete a project attachment", "operationId": "6f8ef878687f73b204e8156fa083224a", "parameters": [ { "name": "id", "in": "path", "description": "ID of the project attachment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project Attachment Deleted Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Project Attachment Deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Project Attachment Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-attachment/data-table/get/{id}": { "post": { "tags": [ "Project Attachment" ], "summary": "Get project attachments for a project formatted for DataTables", "operationId": "cd9c324235daf85ac91214149f68267c", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "DataTables JSON response", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-attachment/{project_attachment}": { "put": { "tags": [ "Project Attachment" ], "summary": "Update a project attachment (resource update – placeholder, not currently implemented)", "operationId": "3c50e222c0c8f2dced5f7f22c49e6fa5", "parameters": [ { "name": "project_attachment", "in": "path", "description": "Project attachment ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project_categories/data-table/get": { "post": { "tags": [ "Project Categories" ], "summary": "Get project categories for data table", "operationId": "2520c97f0b3eeed18abce3396da4773d", "responses": { "200": { "description": "Project categories retrieved successfully", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer", "example": 1 }, "recordsTotal": { "type": "integer", "example": 10 }, "recordsFiltered": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project_categories": { "get": { "tags": [ "Project Categories" ], "summary": "Get all project categories", "operationId": "5bf802efb041651747af72b151a4ca21", "responses": { "200": { "description": "Project categories retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "category": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Something went wrong" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Categories" ], "summary": "Create a new project category", "operationId": "48b7bbbe0cb10e57594b9c1ce657e5fd", "parameters": [ { "name": "title", "in": "query", "description": "Title of the project category", "required": true, "schema": { "type": "string", "example": "Web Development" } } ], "responses": { "200": { "description": "Project category created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Project Category Added Successfully" }, "category": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Something went wrong" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project_categories/{id}": { "get": { "tags": [ "Project Categories" ], "summary": "Get a specific project category", "operationId": "e70d8bce2b375b69274c09364680ad41", "parameters": [ { "name": "id", "in": "path", "description": "ID of the project category", "required": true, "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "Project category retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "category": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Project category not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Project Categories" ], "summary": "Update a specific project category", "operationId": "9712bc71d2c7e826c9331c9e1509374b", "parameters": [ { "name": "id", "in": "path", "description": "ID of the project category", "required": true, "schema": { "type": "string", "example": "1" } }, { "name": "title", "in": "query", "description": "Title of the project category", "required": true, "schema": { "type": "string", "example": "Updated Web Development" } }, { "name": "id", "in": "query", "description": "ID of the project category (for validation)", "required": true, "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "Project category updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Category Updated Successfully" }, "category": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Project category not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Categories" ], "summary": "Delete a specific project category", "operationId": "f38fa4c504179e32070ce6613d2f13a7", "parameters": [ { "name": "id", "in": "path", "description": "ID of the project category", "required": true, "schema": { "type": "string", "example": "1" } } ], "responses": { "200": { "description": "Project category deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Category Deleted Successfully" } }, "type": "object" } } } }, "400": { "description": "Cannot delete category assigned to projects", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "You can not delete this category because it is already assigned to one or more projects." } }, "type": "object" } } } }, "404": { "description": "Project category not found", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Category Not Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-comments": { "get": { "tags": [ "Project Comments" ], "summary": "List project comments", "operationId": "2692526313f1386f59c083d6977a8399", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Comments" ], "summary": "Store a new project comment", "operationId": "91a707da343159085e9463e5adbe0cd4", "parameters": [ { "name": "description", "in": "query", "description": "Comment description", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "task_id", "in": "query", "description": "Task ID (optional)", "required": false, "schema": { "type": "integer" } }, { "name": "file_name[]", "in": "query", "description": "Attachment files (optional)", "required": false, "schema": { "type": "array", "items": { "type": "file" } } } ], "responses": { "200": { "description": "Comment added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Comment Added Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-comments/{id}": { "get": { "tags": [ "Project Comments" ], "summary": "Get comments for a specific project", "operationId": "8dcda792b19330580d526aaeebe4019f", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "Comments": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Project not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Comments" ], "summary": "Delete a project comment", "operationId": "c8ed06f7389dd4c74471b9bd47c3a6f6", "parameters": [ { "name": "id", "in": "path", "description": "Comment ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Comment deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Comment Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "Comment not found", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Comment Not Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks-comment/{tid}": { "get": { "tags": [ "Project Comments" ], "summary": "Get comments for a specific task", "operationId": "1f39689b6347af61e1de6eba31c33676", "parameters": [ { "name": "tid", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "Comments": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Task not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-sub-tasks-comment/{tid}": { "get": { "tags": [ "Project Comments" ], "summary": "Get comments for a specific subtask", "operationId": "fe038dacd5520605c1263e5c1aa64651", "parameters": [ { "name": "tid", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "Comments": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Task not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks-comment/download-attachment": { "get": { "tags": [ "Project Comments" ], "summary": "Download an attachment from a comment", "operationId": "7a93afb74abd11ebc53de66b93aec1d9", "parameters": [ { "name": "comment_id", "in": "query", "description": "Comment ID", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Index of the attachment in the comment's files array", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File download response" }, "422": { "description": "Validation error" }, "404": { "description": "File not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks-comment/download-attachment-zip": { "get": { "tags": [ "Project Comments" ], "summary": "Download all attachments from a comment as a zip file", "operationId": "6d354f53d991fced690138b5c7b1a229", "parameters": [ { "name": "comment_id", "in": "query", "description": "Comment ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Zip file download response" }, "422": { "description": "Validation error" }, "404": { "description": "Files not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/comment-replies/{id}": { "get": { "tags": [ "Project Comments" ], "summary": "Get replies for a project comment", "operationId": "eb3fbea6ae0d61c9550915034ee08c30", "parameters": [ { "name": "id", "in": "path", "description": "ID of the parent project comment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Replies retrieved successfully", "content": { "application/json": { "schema": { "properties": { "replies": { "type": "array", "items": { "type": "object" } }, "replies_count": { "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/edit-project-task-comment/{id}": { "post": { "tags": [ "Project Comments" ], "summary": "Edit a project/task comment", "operationId": "c289810ca51992e0c9ece94cfec1c0b9", "parameters": [ { "name": "id", "in": "path", "description": "ID of the comment to edit", "required": true, "schema": { "type": "integer" } }, { "name": "description", "in": "query", "description": "Updated comment description", "required": true, "schema": { "type": "string" } }, { "name": "file_name", "in": "query", "description": "Files to attach to the comment", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "binary" } } } ], "responses": { "200": { "description": "Comment updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Comment Updated Successfully" }, "comment": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Comment not found or permission denied" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-task-comment-file/{taskCommentId}": { "post": { "tags": [ "Project Comments" ], "summary": "Delete a file from a task comment", "operationId": "f852fa6eee54a4bfbab54b5241b8e128", "parameters": [ { "name": "taskCommentId", "in": "path", "description": "ID of the task comment", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Index of the attachment to delete within the comment's files array", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File removed successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "File has been removed from task comment" }, "files": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Task comment not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-comments/{project_comment}": { "put": { "tags": [ "Project Comments" ], "summary": "Update the specified project comment", "operationId": "762a8e3cfb942e171c9cd31e540efa39", "parameters": [ { "name": "project_comment", "in": "path", "description": "ID of the project comment to update", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project comment updated" }, "404": { "description": "Project comment not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project": { "get": { "tags": [ "Projects" ], "summary": "Get all projects for the authenticated user's client", "operationId": "4b63e0dc6f14f12d45c4279c0e5ec655", "responses": { "200": { "description": "List of projects", "content": { "application/json": { "schema": { "properties": { "projects": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Projects" ], "summary": "Create a new project", "operationId": "4e7387e7ab8a3d995b806eebc865a068", "parameters": [ { "name": "title", "in": "query", "description": "Project title", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Project start date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "deadline", "in": "query", "description": "Project deadline (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "last_email_sent_date", "in": "query", "description": "Last email sent date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Project created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "project": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project/data-table/get": { "post": { "tags": [ "Projects" ], "summary": "Get projects data for DataTable with filtering and pagination", "operationId": "edd8e792198a566675449941b0d4edf8", "responses": { "200": { "description": "Projects data for DataTable", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project/{id}": { "get": { "tags": [ "Projects" ], "summary": "Get a specific project by ID", "operationId": "7ba87c6bb438f74b28e94787ac11207c", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project details", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Project not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Projects" ], "summary": "Update a specific project", "operationId": "05e6f45a26a48535369bb9290532e093", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "title", "in": "query", "description": "Project title", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Project start date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "deadline", "in": "query", "description": "Project deadline (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Project updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "project": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Project not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Projects" ], "summary": "Delete a specific project", "operationId": "4f7e079366b92d015358dd7e53a3fea0", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Project not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/search-project": { "post": { "tags": [ "Projects" ], "summary": "Search for projects", "operationId": "45623577be9ae2c3f3b71e9d5ec58b1f", "parameters": [ { "name": "search", "in": "query", "description": "Search term", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Search results", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "data": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "No search results found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project/activities/{id}": { "get": { "tags": [ "Projects" ], "summary": "Get activities for a specific project", "operationId": "95d72d2c1d8a3e370ee31fdbad9f1c5e", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number", "required": true, "schema": { "type": "integer" } }, { "name": "start_date", "in": "query", "description": "Start date for filtering activities (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date for filtering activities (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Project activities", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "activities": { "type": "array", "items": { "type": "object" } }, "total": { "type": "integer" }, "pages": { "type": "integer" }, "fetch_from": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-clients": { "get": { "tags": [ "Projects" ], "summary": "Get all clients for projects", "operationId": "6f7477b9441336352df8caa363e37dc3", "responses": { "200": { "description": "List of clients", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "client_id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project/statistics": { "get": { "tags": [ "Projects" ], "summary": "Get project statistics", "operationId": "94a0857dd75afcad9bf5daa451592369", "responses": { "200": { "description": "Project statistics", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "statistics": { "type": "array", "items": { "type": "integer" } }, "count": { "type": "integer" }, "projectStatusLabel": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-by-status": { "post": { "tags": [ "Projects" ], "summary": "Get projects grouped by status", "operationId": "24cf883e00ab8121d11654a479e00d17", "parameters": [ { "name": "status_id", "in": "query", "description": "Status ID to filter projects", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer" } }, { "name": "searchBy", "in": "query", "description": "Search criteria", "required": false, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Projects grouped by status", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "projects": { "type": "array", "items": { "type": "object" } }, "searchBy": { "type": "object", "nullable": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-status-update": { "post": { "tags": [ "Projects" ], "summary": "Update project status", "operationId": "86bbce4d8f2575bfd074c69d64ae40c5", "parameters": [ { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "status_id", "in": "query", "description": "Status ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project status updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "project": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-index-update": { "post": { "tags": [ "Projects" ], "summary": "Update project list index", "operationId": "31932067188163083211f9320f9887c4", "parameters": [ { "name": "project_data", "in": "query", "description": "Array of project data with project_id and index", "required": true, "schema": { "type": "array", "items": { "properties": { "project_id": { "type": "integer" }, "index": { "type": "integer" } }, "type": "object" } } } ], "responses": { "200": { "description": "Project indexes updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "result": { "type": "array", "items": { "type": "boolean" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-as-favourite": { "post": { "tags": [ "Projects" ], "summary": "Set project as favourite", "operationId": "2867bc2e6bfc61c06638bd2ee3c4a3ba", "parameters": [ { "name": "id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "is_favourite", "in": "query", "description": "Favourite status (0 or 1)", "required": true, "schema": { "type": "integer", "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "Project favourite status updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "result": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-activities-log": { "get": { "tags": [ "Activity Logs" ], "summary": "Get activity log grouped by type", "description": "Returns a list of activity logs filtered by optional start and end dates. Groups results by activity type.", "operationId": "getActivityLog", "parameters": [ { "name": "start_date", "in": "query", "description": "Start date for filtering (YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date for filtering (YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Successful response with grouped activities", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "activities": { "type": "array", "items": { "properties": { "log_name": { "type": "string", "example": "Project" }, "description": { "type": "string", "example": "Created a new project" }, "created_at": { "type": "string", "format": "date-time", "example": "2025-05-29T12:34:56" } }, "type": "object" } }, "total": { "type": "integer", "example": 5 }, "pages": { "type": "integer", "example": 1 } }, "type": "object" } } } } } } }, "/api/project/{projectId}/custom-field/{customFieldId}": { "delete": { "tags": [ "Projects" ], "summary": "Delete project custom field file type", "operationId": "d8bc710dd9d62b7fc47428e846a79b07", "parameters": [ { "name": "projectId", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "customFieldId", "in": "path", "description": "Custom Field ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Custom field value deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Project or custom field not found" }, "500": { "description": "Server error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-project-quotes/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Get quotes associated with a specific project", "operationId": "0280880a27ce137dc78356eb623e2e50", "parameters": [ { "name": "projectId", "in": "path", "description": "ID of the project", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project quotes retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "project_quotes": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Project quotes not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/associate-project-with-quote": { "post": { "tags": [ "Projects" ], "summary": "Associate a quote with a project", "operationId": "748a1732a6bd8b7dbed82026df9bdaaf", "parameters": [ { "name": "project_id", "in": "query", "description": "ID of the project", "required": true, "schema": { "type": "integer" } }, { "name": "quote_id", "in": "query", "description": "ID of the quote", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Quote associated with project successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Quote associated with project successfully." } }, "type": "object" } } } }, "404": { "description": "Project or quote not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project/client/{id}": { "get": { "tags": [ "Projects" ], "summary": "Get projects belonging to a specific client where the authenticated user is a member", "operationId": "96fa7fb14f678f57ee77401743ebaacd", "parameters": [ { "name": "id", "in": "path", "description": "Client ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Projects retrieved successfully" }, "404": { "description": "No projects found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-files": { "get": { "tags": [ "Project Files" ], "summary": "List project files (resource index – placeholder, not currently implemented)", "operationId": "234b0f6dea57be12705aab07dee6d808", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Files" ], "summary": "Store new project files", "operationId": "447b092122fd64210ec9ebcf9a7bc95d", "parameters": [ { "name": "project_id", "in": "query", "description": "ID of the project", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "description[]", "in": "query", "description": "Description for each file", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "project_files[]", "in": "query", "description": "Files to upload", "required": true, "schema": { "type": "array", "items": { "type": "file" } } } ], "responses": { "200": { "description": "Files added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Files Added Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-files/{id}": { "get": { "tags": [ "Project Files" ], "summary": "Get files for a specific project", "operationId": "89a9f54e539b76906ca2a4f09c54ed7a", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "files": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Files not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Files Not Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Files" ], "summary": "Delete a specific file", "operationId": "aea0a5ce6fead2304bcba844723bea2b", "parameters": [ { "name": "id", "in": "path", "description": "File ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "File deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "File Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "File not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "File Not Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/file-upload": { "post": { "tags": [ "Project Files" ], "summary": "Upload files without authentication", "operationId": "5e32731fb04bf525a4fa0661a66c6c94", "parameters": [ { "name": "project_files[]", "in": "query", "description": "Files to upload", "required": true, "schema": { "type": "array", "items": { "type": "file" } } } ], "responses": { "200": { "description": "Files uploaded successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "422": { "description": "Upload file not found", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "upload_file_not_found" } } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/secured-file-upload": { "post": { "tags": [ "Project Files" ], "summary": "Upload files with authentication", "operationId": "ad0e2dfa95ed4a4971fc1cb4e4522d29", "parameters": [ { "name": "project_files[]", "in": "query", "description": "Files to upload", "required": true, "schema": { "type": "array", "items": { "type": "file" } } }, { "name": "name", "in": "query", "description": "Name parameter", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Files uploaded successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "422": { "description": "Upload file not found", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "example": "upload_file_not_found" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-files/{project_file}": { "put": { "tags": [ "Project Files" ], "summary": "Update a project file (resource update – placeholder, not currently implemented)", "operationId": "5f034df58249646dd0410694c763a7be", "parameters": [ { "name": "project_file", "in": "path", "description": "Project file ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-members": { "get": { "tags": [ "Project Members" ], "summary": "Get all users from the authenticated user's client", "operationId": "5b9eb6398cbbfbd330bb182237f43b00", "responses": { "200": { "description": "List of users retrieved successfully", "content": { "application/json": { "schema": { "properties": { "users": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Members" ], "summary": "Add members to a project", "operationId": "ae22c1a422d7aab38e9638b1a2b51301", "parameters": [ { "name": "user_ids", "in": "query", "description": "Array of user IDs to add to the project", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "project_id", "in": "query", "description": "ID of the project", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Members added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Member Added Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-members/{id}": { "get": { "tags": [ "Project Members" ], "summary": "Get members of a specific project", "operationId": "055ae2b728274e043f7bfad238496cd6", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project members retrieved successfully", "content": { "application/json": { "schema": { "properties": { "members_ids": { "type": "array", "items": { "properties": { "user_id": { "type": "integer" }, "member_name": { "type": "string" }, "job_title": { "type": "string" }, "profile_img": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Project not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Members" ], "summary": "Remove a member from a project", "operationId": "eccd0e3d23d54180347d8d0dae212262", "parameters": [ { "name": "id", "in": "path", "description": "Project Member ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Member deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Member Deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Member not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Member Not Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-members/data-table/{id}": { "post": { "tags": [ "Project Members" ], "summary": "Get project members in datatable format", "operationId": "b4dc108682259ef2e986d859dd573b2d", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project members retrieved in datatable format", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/add-external-project-members": { "post": { "tags": [ "Project Members" ], "summary": "Add external members to a project", "operationId": "9590a30fb1934412ae8b765281e0bba4", "parameters": [ { "name": "external_email", "in": "query", "description": "Email of the external member", "required": true, "schema": { "type": "string", "format": "email" } }, { "name": "project_id", "in": "query", "description": "ID of the project", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Email sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "An email to join the project has been sent to the member." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Project already assigned to member", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Project has already assigned to member with this email address." } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-members/{project_member}": { "put": { "tags": [ "Project Member" ], "summary": "Update a project member (resource update – placeholder, not currently implemented)", "operationId": "70ec0e7752558dc9da69157bd6555e2b", "parameters": [ { "name": "project_member", "in": "path", "description": "Project member ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-note": { "get": { "tags": [ "Project Note" ], "summary": "List project notes (resource index – placeholder, not currently implemented)", "operationId": "4cc33d74341570eeb47208da26c2e372", "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Notes" ], "summary": "Create a new project note", "operationId": "551c24b3666aef7be7e12a9bb8eba165", "parameters": [ { "name": "title", "in": "query", "description": "Note title", "required": true, "schema": { "type": "string", "example": "Important Note" } }, { "name": "description", "in": "query", "description": "Note description", "required": true, "schema": { "type": "string", "example": "This is an important note about the project" } }, { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Project Note Added Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Project Note Added Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-note/{id}": { "get": { "tags": [ "Project Notes" ], "summary": "Get project notes for a specific project", "operationId": "5cf64e18b572f9d119242cb9c4179032", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "note": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Project not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Project Notes" ], "summary": "Update a specific project note", "operationId": "1ca16f99359edacea51f9a1df28356cc", "parameters": [ { "name": "id", "in": "path", "description": "Project Note ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Note title", "required": true, "schema": { "type": "string", "example": "Updated Note Title" } }, { "name": "description", "in": "query", "description": "Note description", "required": true, "schema": { "type": "string", "example": "Updated note description" } }, { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Project Note Updated Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Project Note Updated Successfully" }, "note": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Note Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Notes" ], "summary": "Delete a specific project note", "operationId": "77a4735a4ecef8e1c10bef041b12291a", "parameters": [ { "name": "id", "in": "path", "description": "Project Note ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Note Deleted Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Note Deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Note Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks/search-by-title": { "post": { "tags": [ "Project Tasks" ], "summary": "Search tasks by title", "operationId": "7ce71ed0590d487721ead328c7768448", "parameters": [ { "name": "title", "in": "query", "description": "Task title", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Task created successfully" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks/data-table/{id}": { "post": { "tags": [ "Project Tasks" ], "summary": "Get project tasks data for datatable", "operationId": "0078b07c6b1e659feb9bd7aa6693f6af", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "assigned_to", "in": "query", "description": "Filter by assigned user IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "status", "in": "query", "description": "Filter by status IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "collaborators", "in": "query", "description": "Filter by collaborator IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "leabls", "in": "query", "description": "Filter by labels", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-all-tasks/data-table": { "post": { "tags": [ "Project Tasks" ], "summary": "Get all project tasks data for datatable", "operationId": "2713f68a356e9a4551333858fdc1b803", "parameters": [ { "name": "search", "in": "query", "description": "Search term", "required": false, "schema": { "type": "string" } }, { "name": "start", "in": "query", "description": "Start index for pagination", "required": false, "schema": { "type": "integer" } }, { "name": "length", "in": "query", "description": "Number of records to return", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks": { "get": { "tags": [ "Project Tasks" ], "summary": "List project tasks (placeholder endpoint)", "operationId": "da8095c2e0344e678084b2203e7d6e55", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Tasks" ], "summary": "Create a new project task", "operationId": "4b035412e9809212b5a00ef7ba68ad1e", "parameters": [ { "name": "title", "in": "query", "description": "Task title", "required": true, "schema": { "type": "string" } }, { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "description", "in": "query", "description": "Task description", "required": false, "schema": { "type": "string" } }, { "name": "assigned_to", "in": "query", "description": "User ID to assign the task to", "required": false, "schema": { "type": "integer" } }, { "name": "collaborators", "in": "query", "description": "Array of user IDs as collaborators", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "start_date", "in": "query", "description": "Start date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "deadline", "in": "query", "description": "Deadline date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "status_id", "in": "query", "description": "Status ID", "required": false, "schema": { "type": "integer" } }, { "name": "labels", "in": "query", "description": "Task labels", "required": false, "schema": { "type": "string" } }, { "name": "cost", "in": "query", "description": "Task cost", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "time_estimate", "in": "query", "description": "Time estimate in hours", "required": false, "schema": { "type": "number", "format": "float" } } ], "responses": { "200": { "description": "Task created successfully" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks/{id}": { "get": { "tags": [ "Project Tasks" ], "summary": "Get details of a specific project task", "operationId": "f46bfed655dfa7306dbf8fdf5a35f888", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "tasks": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Task not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Project Tasks" ], "summary": "Update a project task", "operationId": "67a482665136638a05d5b5ab7299c592", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } }, { "name": "title", "in": "query", "description": "Task title", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Task description", "required": false, "schema": { "type": "string" } }, { "name": "assigned_to", "in": "query", "description": "User ID to assign the task to", "required": false, "schema": { "type": "integer" } }, { "name": "collaborators", "in": "query", "description": "Array of user IDs as collaborators", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "start_date", "in": "query", "description": "Start date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "deadline", "in": "query", "description": "Deadline date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "status_id", "in": "query", "description": "Status ID", "required": false, "schema": { "type": "integer" } }, { "name": "labels", "in": "query", "description": "Task labels", "required": false, "schema": { "type": "string" } }, { "name": "cost", "in": "query", "description": "Task cost", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "time_estimate", "in": "query", "description": "Time estimate in hours", "required": false, "schema": { "type": "number", "format": "float" } } ], "responses": { "200": { "description": "Task updated successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Task not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Tasks" ], "summary": "Delete a project task", "operationId": "604bdc5f663f4b48f4a206e464ae1f57", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Task deleted successfully" }, "401": { "description": "Unauthorized" }, "404": { "description": "Task not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-open-tasks-count": { "get": { "tags": [ "Project Tasks" ], "summary": "Get count of open tasks", "operationId": "06d5feb3611c408d58e558698566ac0c", "parameters": [ { "name": "start_date", "in": "query", "description": "Start date for filtering tasks", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date for filtering tasks", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "count": { "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-tasks-status-count/{id}": { "get": { "tags": [ "Project Tasks" ], "summary": "Get count of tasks by status for a project", "operationId": "4848e71fd61c28f7791ca8ed6a1ce0e2", "parameters": [ { "name": "id", "in": "path", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "to_do": { "type": "integer" }, "in_progress": { "type": "integer" }, "done": { "type": "integer" }, "new_data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks/statistics": { "get": { "tags": [ "Project Tasks" ], "summary": "Get project tasks statistics", "operationId": "ed605f427289ba4f3171edf9bcddc230", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "statistics": { "properties": { "to_do": { "type": "integer" }, "to_doTotal": { "type": "string" }, "in_progress": { "type": "integer" }, "in_progressTotal": { "type": "string" }, "done": { "type": "integer" }, "doneTotal": { "type": "string" } }, "type": "object" }, "count": { "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-task-by-status": { "post": { "tags": [ "Project Tasks" ], "summary": "Get task list by project ID", "operationId": "0b9a7cdf51f184e8d71948a3b47a6fc1", "parameters": [ { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer" } }, { "name": "status_id", "in": "query", "description": "Status ID to filter tasks", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "tasks": { "type": "array", "items": { "type": "object" } }, "pages": { "type": "integer" }, "total": { "type": "integer" }, "active_page": { "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-task-status-update": { "post": { "tags": [ "Project Tasks" ], "summary": "Update project task status", "operationId": "fb558df9419cd15eddbe4300921e6e26", "parameters": [ { "name": "task_id", "in": "query", "description": "Task ID", "required": true, "schema": { "type": "integer" } }, { "name": "status_id", "in": "query", "description": "New status ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Status updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Task not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-download-attachment": { "get": { "tags": [ "Project Comments" ], "summary": "Download an attachment from a comment", "operationId": "f0000c13599a7bf72ba7929be34d50e9", "parameters": [ { "name": "comment_id", "in": "query", "description": "Comment ID", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Index of the attachment in the comment's files array", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File download response" }, "422": { "description": "Validation error" }, "404": { "description": "File not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Tasks" ], "summary": "Download a project task attachment", "operationId": "2d710059ac6aaff5c92aeb97737739db", "parameters": [ { "name": "file_name", "in": "query", "description": "Stored file name", "required": true, "schema": { "type": "string" } }, { "name": "file_path", "in": "query", "description": "Local file path (used when storage is not S3)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File stream" }, "422": { "description": "Validation error" }, "404": { "description": "File not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/task-index-update": { "post": { "tags": [ "Project Tasks" ], "summary": "Update task list index", "operationId": "c553d8256e9178d970fcf1e6786c12ba", "parameters": [ { "name": "task_data", "in": "query", "description": "Array of task data with task_id and index", "required": true, "schema": { "type": "array", "items": { "properties": { "task_id": { "type": "integer" }, "index": { "type": "integer" } }, "type": "object" } } } ], "responses": { "200": { "description": "Task indexes updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "result": { "type": "array", "items": { "type": "boolean" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks/timer/start/{id}": { "post": { "tags": [ "Project Tasks" ], "summary": "Start the timer for a project task", "operationId": "0e38e640405ee58a42c90cfd60ecd85c", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Timer started" }, "404": { "description": "Task not found" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks/timer/stop/{id}": { "post": { "tags": [ "Project Tasks" ], "summary": "Stop the timer for a project task", "operationId": "daf548a61aeb226cdd3b10bc9b20050e", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } }, { "name": "minutes", "in": "query", "description": "Deprecated: elapsed time is now computed server-side from tracked_start_time. Ignored if sent.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Timer stopped" }, "404": { "description": "Task not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks/timer/push/{id}": { "post": { "tags": [ "Project Tasks" ], "summary": "Pause/push the timer for a project task", "operationId": "dc11b23d742140cecc24f6eeefcb4832", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } }, { "name": "minutes", "in": "query", "description": "Deprecated: elapsed time is now computed server-side from tracked_start_time. Ignored if sent.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Timer paused" }, "404": { "description": "Task not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks-activity/{id}": { "post": { "tags": [ "Project Tasks" ], "summary": "Get activity log for a project task", "operationId": "1fab109b570f3d565208edc8772c08a2", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": true, "schema": { "type": "integer" } }, { "name": "start_date", "in": "query", "description": "Start date filter (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date filter (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "log_name", "in": "query", "description": "Filter by activity log name", "required": false, "schema": { "type": "string" } }, { "name": "causer_id", "in": "query", "description": "Filter by user ID who caused the activity", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Activities retrieved successfully" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks-activity-log": { "get": { "tags": [ "Project Tasks" ], "summary": "Get aggregated activity log for project tasks", "operationId": "7f470ae21cdf447b7f112a94905bcc13", "parameters": [ { "name": "id", "in": "query", "description": "Subject ID (task ID) to filter by", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer" } }, { "name": "start_date", "in": "query", "description": "Start date filter (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date filter (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Activity log retrieved successfully" }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-tasks-update/{id}": { "post": { "tags": [ "Project Tasks" ], "summary": "Update a project task (multipart-aware update endpoint)", "operationId": "a640d24aacf78b87d4c1220351d34caf", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } }, { "name": "title", "in": "query", "description": "Task title (required when provided in payload)", "required": false, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Start date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "deadline", "in": "query", "description": "Deadline date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "assigned_to", "in": "query", "description": "User ID to assign the task to", "required": false, "schema": { "type": "integer" } }, { "name": "collaborators", "in": "query", "description": "Array of collaborator user IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "file_name", "in": "query", "description": "Attachment files to upload", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "binary" } } } ], "responses": { "200": { "description": "Project task updated successfully" }, "404": { "description": "Project task not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/estimate-download-attachment": { "post": { "tags": [ "Project Tasks" ], "summary": "Download an estimate attachment", "operationId": "d2f0e888cead05c3b8524f2105106f88", "parameters": [ { "name": "file_name", "in": "query", "description": "Stored file name", "required": true, "schema": { "type": "string" } }, { "name": "file_path", "in": "query", "description": "Local file path (used when storage is not S3)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File stream" }, "422": { "description": "Validation error" }, "404": { "description": "File not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-task-file/{id}": { "post": { "tags": [ "Project Tasks" ], "summary": "Delete an attachment file from a project task", "operationId": "45420121c1c1c14367a3f546d8fc3374", "parameters": [ { "name": "id", "in": "path", "description": "Project task ID", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Index of the attachment to remove", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Attachment deleted successfully" }, "404": { "description": "Task or attachment not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-sub-tasks/data-table/{id}": { "post": { "tags": [ "Project Sub Tasks" ], "summary": "Get project sub-tasks data in datatable format", "operationId": "62c15a5ceb0b504043bd44cfbcbbf000", "parameters": [ { "name": "id", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project sub-tasks data retrieved successfully" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Task not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-sub-tasks": { "get": { "tags": [ "Project Sub Tasks" ], "summary": "Display a listing of project sub-tasks", "operationId": "5e9665619acb62f18c9ab95dc10f241d", "responses": { "200": { "description": "Successful operation" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Project Sub Tasks" ], "summary": "Create a new project sub-task", "operationId": "fc1faa74bd59c4d9b6cc09b5e5920e32", "parameters": [ { "name": "task_id", "in": "query", "description": "Task ID", "required": true, "schema": { "type": "integer" } }, { "name": "sub_task_title", "in": "query", "description": "Sub-task title", "required": true, "schema": { "type": "string" } }, { "name": "time_in_minutes", "in": "query", "description": "Time spent on the sub-task in minutes", "required": true, "schema": { "type": "integer" } }, { "name": "project_id", "in": "query", "description": "Project ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sub-task created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Task Timing Added Successfully." }, "sub_task": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-sub-tasks/{id}": { "get": { "tags": [ "Project Sub Tasks" ], "summary": "Get a specific project sub-task", "operationId": "b600ef7989ea06d0fb03f50dae934168", "parameters": [ { "name": "id", "in": "path", "description": "Project sub-task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project sub-task retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Task Timing Found." }, "sub_task": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Project sub-task not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Project Sub Tasks" ], "summary": "Update a specific project sub-task", "operationId": "2b39ec43b4c562e72f9be4bf21083b54", "parameters": [ { "name": "id", "in": "path", "description": "Project sub-task ID", "required": true, "schema": { "type": "integer" } }, { "name": "sub_task_title", "in": "query", "description": "Sub-task title", "required": true, "schema": { "type": "string" } }, { "name": "time_in_minutes", "in": "query", "description": "Time spent on the sub-task in minutes", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project sub-task updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Task Timing Updated Successfully." }, "sub_task": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Project sub-task not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Project Sub Tasks" ], "summary": "Delete a specific project sub-task", "operationId": "7068cf9fed0cbba036ba031726e8737f", "parameters": [ { "name": "id", "in": "path", "description": "Project sub-task ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Project sub-task deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Task Timing Deleted Successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Project sub-task not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/project-sub-tasks/date-wise-sub-task-report-summary": { "post": { "tags": [ "Project Sub Tasks" ], "summary": "Get date-wise sub-task report with summary", "operationId": "98c4f206532072ad313886fc3c4a2617", "parameters": [ { "name": "date", "in": "query", "description": "Date for the report (format: Y-m-d)", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sub task report with summary retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Sub Task Report with Summary Found." }, "projects": { "type": "array", "items": { "type": "object" } }, "total_time": { "type": "string", "example": "8 hours 30 minutes" }, "date": { "type": "string", "format": "date", "example": "2023-01-01" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-subtask-file/{subtaskId}": { "post": { "tags": [ "Project Sub Tasks" ], "summary": "Delete a file attachment from a project subtask", "operationId": "53b8d340aaee9e875c873425c854b6ef", "parameters": [ { "name": "subtaskId", "in": "path", "description": "ID of the project subtask", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Index of the attachment to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subtask attachment deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Subtask Attachment Deleted successfully" }, "files": { "type": "string" }, "deleted_index": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Subtask not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-subtask-status": { "post": { "tags": [ "Project Sub Tasks" ], "summary": "Update the status of a project subtask", "operationId": "f1b0faf91ab1122370abd64fae717e2f", "parameters": [ { "name": "subtask_id", "in": "query", "description": "ID of the subtask", "required": true, "schema": { "type": "integer" } }, { "name": "subtask_status_id", "in": "query", "description": "New status ID of the subtask", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subtask status updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Subtask Status Updated Successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/add_qb_keys": { "post": { "tags": [ "QuickBooks Integration" ], "summary": "Add QuickBooks API keys", "operationId": "3d277fa5c3da4c1ee8255315144f100f", "parameters": [ { "name": "ClientID", "in": "query", "description": "QuickBooks Client ID", "required": true, "schema": { "type": "string" } }, { "name": "ClientSecret", "in": "query", "description": "QuickBooks Client Secret", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "QuickBooks keys added successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Quickbook Keys added successfully." }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get_qb_keys/{id}": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Get QuickBooks API keys for a user", "operationId": "50c6da19b0ed20bb7453ee8ffce289d8", "parameters": [ { "name": "id", "in": "path", "description": "User ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "QuickBooks keys retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Keys not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/quickbook-integration/{id}": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Set up QuickBooks integration and create authentication link", "operationId": "87e0dad8878e3fcf366add889d35e718", "parameters": [ { "name": "id", "in": "path", "description": "User ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Authentication link created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "authUrl": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Error creating authentication link" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/check-qb-connection": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Check QuickBooks connection status", "operationId": "b55f3bd96ed89dc21be9b76d42474ae6", "responses": { "200": { "description": "Connection status retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error checking connection" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/refresh": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Refresh QuickBooks access token", "operationId": "4b323b208d9cd0880499b0db76ea7c91", "responses": { "200": { "description": "Token refreshed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Token refreshed successfully" } }, "type": "object" } } } }, "422": { "description": "Error refreshing token" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-show-all-estimates": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Show all QuickBooks estimates", "operationId": "993a273d40a05309d1ba01f3d0bf97a6", "responses": { "200": { "description": "Estimates retrieved successfully", "content": { "application/json": { "schema": { "properties": { "all_estimates": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Error retrieving estimates" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-show-all-bill": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Show all QuickBooks bills", "operationId": "126f3bc018bf91a2988a904df8146bee", "responses": { "200": { "description": "Bills retrieved successfully", "content": { "application/json": { "schema": { "properties": { "bill_info": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Error retrieving bills" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-show-all-invoice/{id}/{date}": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Show all QuickBooks invoices", "operationId": "073e3c2cbe411bb8769424218ceb12cd", "parameters": [ { "name": "id", "in": "path", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "date", "in": "path", "description": "Date filter", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Invoices retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Error retrieving invoices" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb_show_all_items": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Show all QuickBooks items", "operationId": "a0c591da69b776c9f9606800119b9bc4", "responses": { "200": { "description": "Items retrieved successfully", "content": { "application/json": { "schema": { "properties": { "all_items": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Error retrieving items" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-show-all-customer": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Show all QuickBooks customers", "operationId": "5d7f7a22b6fc94086f0f03ab7e4d64a4", "responses": { "200": { "description": "Customers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "all_customers": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Error retrieving customers" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/view_qb_ind_customer/{id}": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "View individual QuickBooks customer", "operationId": "5f7b64bd5b284e97d6ac5ef8650b67a6", "parameters": [ { "name": "id", "in": "path", "description": "Customer ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Customer retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error retrieving customer" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb_delete_invoice/{id}": { "delete": { "tags": [ "QuickBooks Integration" ], "summary": "Delete a QuickBooks invoice", "operationId": "00cec008ba0c8f722bb212db9a30b1f5", "parameters": [ { "name": "id", "in": "path", "description": "Invoice ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invoice deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Invoice deleted successfully" } }, "type": "object" } } } }, "422": { "description": "Error deleting invoice" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-show-ind-invoice/{id}": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "View individual QuickBooks invoice", "operationId": "cf63fce7f3730387aa00de580fbb880d", "parameters": [ { "name": "id", "in": "path", "description": "Invoice ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invoice retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error retrieving invoice" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-show-ind-estimate/{id}": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "View individual QuickBooks estimate", "operationId": "30decd78ae465e4ce6d84ef50fa42809", "parameters": [ { "name": "id", "in": "path", "description": "Estimate ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Estimate retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error retrieving estimate" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-show-ind-bill/{id}": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "View individual QuickBooks bill", "operationId": "3c19ba9860be83104e589501035098df", "parameters": [ { "name": "id", "in": "path", "description": "Bill ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bill retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error retrieving bill" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-compnay_info": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Get QuickBooks company information", "operationId": "0705fad826cb4d21534eb07f0d1c596b", "responses": { "200": { "description": "Company information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error retrieving company information" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-account-details": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "View QuickBooks account details", "operationId": "5013a34733a9ab35d17a7fd182126e2e", "responses": { "200": { "description": "Account details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Error retrieving account details" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb-disconnect/{id}": { "delete": { "tags": [ "QuickBooks Integration" ], "summary": "Disconnect QuickBooks integration", "operationId": "bc579268c4dab0b7922bb059cc635ec8", "parameters": [ { "name": "id", "in": "path", "description": "User ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "QuickBooks disconnected successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "QuickBooks disconnected successfully" } }, "type": "object" } } } }, "422": { "description": "Error disconnecting QuickBooks" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get_qb_counts": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Get counts of QuickBooks entities", "operationId": "40c34675fa815eaa8dd2539ce325a9be", "responses": { "200": { "description": "Counts retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "invoice_count": { "type": "integer" }, "customer_count": { "type": "integer" }, "estimate_count": { "type": "integer" }, "bill_count": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error retrieving counts" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb_send_email_invoice": { "post": { "tags": [ "QuickBooks Integration" ], "summary": "Send a QuickBooks invoice via email", "operationId": "7d4e20ad32920be1e034fb0a562a67c1", "parameters": [ { "name": "invoice_id", "in": "query", "description": "Invoice ID", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email address to send the invoice to", "required": true, "schema": { "type": "string", "format": "email" } } ], "responses": { "200": { "description": "Invoice sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Invoice sent successfully" } }, "type": "object" } } } }, "422": { "description": "Error sending invoice" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb_create_customer": { "post": { "tags": [ "QuickBooks Integration" ], "summary": "Create a QuickBooks customer", "operationId": "dbc28c11c40ac5517d239ffc8fe897e2", "parameters": [ { "name": "customer_data", "in": "query", "description": "Customer data including name, email, phone, etc.", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Customer created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Customer created successfully" }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error creating customer" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb_update_customer/{id}": { "put": { "tags": [ "QuickBooks Integration" ], "summary": "Update a QuickBooks customer", "operationId": "066f684e40f3ac23e7eaf546a5232866", "parameters": [ { "name": "id", "in": "path", "description": "Customer ID", "required": true, "schema": { "type": "string" } }, { "name": "customer_data", "in": "query", "description": "Updated customer data", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Customer updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Customer updated successfully" }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error updating customer" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb_create_invoice": { "post": { "tags": [ "QuickBooks Integration" ], "summary": "Create a QuickBooks invoice", "operationId": "74d22fe96e9bc192354eb9fbc790035a", "parameters": [ { "name": "customer_id", "in": "query", "description": "Customer ID", "required": true, "schema": { "type": "string" } }, { "name": "invoice_data", "in": "query", "description": "Invoice data", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Invoice created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Invoice created successfully" }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error creating invoice" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/qb_reports": { "post": { "tags": [ "QuickBooks Integration" ], "summary": "Generate QuickBooks reports", "operationId": "59ad6d17e3950f14ef481ceb3d172be5", "parameters": [ { "name": "report_type", "in": "query", "description": "Type of report to generate", "required": true, "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "description": "Start date for the report", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date for the report", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Report generated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Error generating report" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get_all_taxcode": { "get": { "tags": [ "QuickBooks Integration" ], "summary": "Get all QuickBooks tax codes", "operationId": "e8d9c378b818a426e8e9b760f1864e0b", "responses": { "200": { "description": "Tax codes retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Error retrieving tax codes" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/remove-qb-keys/{id}": { "post": { "tags": [ "Quickbooks Integration" ], "summary": "Disconnect QuickBooks for a user", "description": "Deletes every quickbook_keys row matching `user_id={id}`.", "operationId": "quickbooksRemoveKeys", "parameters": [ { "name": "id", "in": "path", "description": "User ID whose QuickBooks keys should be removed", "required": true, "schema": { "type": "integer", "example": 42 } } ], "responses": { "200": { "description": "Disconnected", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Quickbooks diconnected." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-quote-templates": { "get": { "tags": [ "Quote Template" ], "summary": "Get all quote templates for the authenticated user's client", "operationId": "6ece19111682fe21d98d0ef9d3f918d4", "responses": { "200": { "description": "Templates retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "templates": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/save-quote-template": { "post": { "tags": [ "Quote Template" ], "summary": "Create a new quote template for the authenticated user's client", "operationId": "6b842c6a48c27d59feebb27c9a731d75", "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "Quote template fields (e.g. name, content). user_id and client_id are auto-populated from the authenticated user.", "type": "object" } } } }, "responses": { "200": { "description": "Template saved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Template saved successfully." }, "template": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Server error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-quote-template/{id}": { "post": { "tags": [ "Quote Template" ], "summary": "Overwrite a saved quote template's content", "description": "Writes the quote being edited over a template already saved, so the same name keeps holding the header, note and footer it stands for. Only header, description and footer are updated — the name stays. A template belonging to another client (or an unknown id) answers 400, not 404.", "operationId": "8ec54f4548e926a992d7d61c4ccbbfcb", "parameters": [ { "name": "id", "in": "path", "description": "Quote template ID (must belong to the caller's client)", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "header": { "description": "Quote header rich text (Quill markup)", "type": "string", "nullable": true }, "description": { "description": "Quote note rich text", "type": "string", "nullable": true }, "footer": { "description": "Quote footer rich text", "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Template updated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Template updated successfully." }, "template": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Template not found for this client, or server error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-quote-template/{id}": { "delete": { "tags": [ "Quote Template" ], "summary": "Delete a quote template", "description": "Drops a template the client no longer writes quotes from. Quotes already written from it keep the header, note and footer they were saved with. A template belonging to another client (or an unknown id) answers 400, not 404.", "operationId": "bf7b0d1d095564bfc85c932b2f68d99e", "parameters": [ { "name": "id", "in": "path", "description": "Quote template ID (must belong to the caller's client)", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Template deleted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Template deleted successfully." } }, "type": "object" } } } }, "400": { "description": "Template not found for this client, or server error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get remaining SMS credits for the authenticated user's client", "operationId": "ac8d22266cf584a20bc2cce0259a4294", "parameters": [ { "name": "json", "in": "query", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "SMS credits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "limit": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": false }, "total_limit": { "type": "integer", "example": 1000 }, "total_used": { "type": "integer", "example": 500 }, "available_limit": { "type": "integer", "example": 500 }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Your SMS credits is nearing the limit, Purchase more limit form marketplace to ensure continued messaging capability." }, "id": { "type": "integer", "example": 1 }, "excluded_from_subscription": { "type": "string", "example": "no" }, "virtualNumber": { "type": "integer", "example": 1 } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-remaining-emails": { "get": { "tags": [ "Restrictions" ], "summary": "Get remaining email credits for the authenticated user's client", "operationId": "db2924f7c6c29de7b84d651de588a07b", "parameters": [ { "name": "json", "in": "query", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Email credits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": false }, "total_limit": { "type": "integer", "example": 1000 }, "limit": { "type": "integer", "example": 1000 }, "total_used": { "type": "integer", "example": 500 }, "email_count": { "type": "integer", "example": 500 }, "available_limit": { "type": "integer", "example": 500 }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Your marketing email is nearing the limit, Purchase more limit form marketplace." }, "id": { "type": "integer", "example": 2 }, "excluded_from_subscription": { "type": "string", "example": "no" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/emails-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get remaining email credits for the authenticated user's client (alternative endpoint)", "operationId": "ae795cc10e9938c8809fc0d827ca99d3", "parameters": [ { "name": "json", "in": "query", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Email credits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": false }, "total_limit": { "type": "integer", "example": 1000 }, "limit": { "type": "integer", "example": 1000 }, "total_used": { "type": "integer", "example": 500 }, "email_count": { "type": "integer", "example": 500 }, "available_limit": { "type": "integer", "example": 500 }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Your marketing email is nearing the limit, Purchase more limit form marketplace." }, "id": { "type": "integer", "example": 2 }, "excluded_from_subscription": { "type": "string", "example": "no" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/quick-books-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get QuickBooks integration limits for the authenticated user's client", "operationId": "722ae3df67fac40131576a2db65519fc", "parameters": [ { "name": "json", "in": "query", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "QuickBooks limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "limit": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": true }, "total_limit": { "type": "integer", "example": 1 }, "total_used": { "type": "null" }, "available_limit": { "type": "null" }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "QuickBooks is not purchased yet, click the purchase button to purchase." }, "id": { "type": "integer", "example": 3 }, "excluded_from_subscription": { "type": "string", "example": "no" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/call-tracking-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get call tracking limits for the authenticated user's client", "operationId": "cd14aa25ac9b433176e898aeda43dccc", "parameters": [ { "name": "json", "in": "query", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Call tracking limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "limit": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": true }, "total_limit": { "type": "integer", "example": 1 }, "total_used": { "type": "null" }, "available_limit": { "type": "null" }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Click the button below to purchase this feature and get the insights of each call you receive." }, "id": { "type": "integer", "example": 4 }, "excluded_from_subscription": { "type": "string", "example": "no" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/lead-contacts-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get lead contacts limits for the authenticated user's client", "operationId": "ed4e46b708b97a1b91612fe006f012bc", "parameters": [ { "name": "json", "in": "query", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Lead contacts limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": false }, "total_limit": { "type": "integer", "example": 1000 }, "total_used": { "type": "integer", "example": 500 }, "available_limit": { "type": "integer", "example": 500 }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Your lead contacts is nearing the limit, Purchase more limit form marketplace." }, "id": { "type": "integer", "example": 6 }, "excluded_from_subscription": { "type": "string", "example": "no" }, "final_lead_id": { "type": "integer", "example": 0 }, "dates": { "properties": { "startDate": { "type": "string", "format": "date-time", "example": "2023-01-01 00:00:00" }, "endDate": { "type": "string", "format": "date-time", "example": "2023-12-31 23:59:59" } }, "type": "object", "nullable": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/xero-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get Xero integration limits for the authenticated user's client", "operationId": "101712ddcafcdef0c8aa5c0aa3f1b3d2", "parameters": [ { "name": "json", "in": "query", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Xero limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "limit": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": true }, "total_limit": { "type": "integer", "example": 1 }, "total_used": { "type": "null" }, "available_limit": { "type": "integer", "example": 1 }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Xero is not purchased yet, click the purchase button to purchase." }, "id": { "type": "integer", "example": 7 }, "excluded_from_subscription": { "type": "string", "example": "no" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-limit/{json}": { "get": { "tags": [ "Restrictions" ], "summary": "Get team member limits for the authenticated user's client", "operationId": "3bb28752a864a26e0531126ff9480285", "parameters": [ { "name": "json", "in": "path", "description": "Return as JSON response (true) or as array (false)", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Team member limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "limit": { "properties": { "total_limit": { "type": "integer", "example": 10 }, "total_used": { "type": "integer", "example": 5 }, "available_limit": { "type": "integer", "example": 5 }, "alert": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "" }, "id": { "type": "integer", "example": 24 }, "excluded_from_subscription": { "type": "string", "example": "no" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/client-package-item-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get client package item limits for the authenticated user's client", "operationId": "b343ea3c1d48687a6df26ed70f0c0b4c", "responses": { "200": { "description": "Client package item limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "limit": { "properties": { "remaining_emails": { "type": "object" }, "remaining_sms": { "type": "object" } }, "type": "object" }, "product": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "title": { "type": "string", "example": "SMS Credits" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-form-builder-limits": { "get": { "tags": [ "Restrictions" ], "summary": "Get form builder limits for the authenticated user's client", "operationId": "1d1da515eee3dfda724f7df1d2f92b4f", "responses": { "200": { "description": "Form builder limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "excluded_from_subscription": { "type": "string", "example": "no" }, "limit": { "type": "integer", "example": 10 }, "forms": { "type": "integer", "example": 5 } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-custom-field-limits": { "get": { "tags": [ "Restrictions" ], "summary": "Get custom field limits for the authenticated user's client", "operationId": "5666b7cc379d998afc2b18475d406fb8", "responses": { "200": { "description": "Custom field limits information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "excluded_from_subscription": { "type": "string", "example": "no" }, "limit": { "type": "integer", "example": 20 }, "custom_fields": { "type": "integer", "example": 10 } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/check-feature-integration/{slug}": { "get": { "tags": [ "Restrictions" ], "summary": "Check if a feature is integrated for the authenticated user's client", "operationId": "94fe18a14262a81d3dbe649b682d2c96", "parameters": [ { "name": "slug", "in": "path", "description": "Slug of the feature to check", "required": true, "schema": { "type": "string", "example": "email_marketing" } } ], "responses": { "200": { "description": "Feature integration information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "excluded_from_subscription": { "type": "string", "example": "no" }, "limit": { "type": "integer", "example": 1 }, "is_pro": { "type": "boolean", "example": true }, "pageVisitorConfigured": { "type": "boolean", "example": false } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-remaining-limit-by-slug/{slug}": { "get": { "tags": [ "Restrictions" ], "summary": "Get remaining package limit by slug", "operationId": "91f5bb0c0a7045e30f7a23d0ce90ec96", "parameters": [ { "name": "slug", "in": "path", "description": "Package item slug (e.g. team_member, lead_management, email_marketing)", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "query", "description": "Optional client ID; defaults to authenticated user's client", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Remaining limit retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Restrictions" ], "summary": "Get remaining package limit by slug", "operationId": "c33101507b927dda896b064fe2cebbc8", "parameters": [ { "name": "slug", "in": "path", "description": "Package item slug (e.g. team_member, lead_management, email_marketing)", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "query", "description": "Optional client ID; defaults to authenticated user's client", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Remaining limit retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/webhook-limit": { "get": { "tags": [ "Restrictions" ], "summary": "Get remaining webhook execution limit for the authenticated client", "operationId": "901a51b88eb2baf008630556b87c032c", "responses": { "200": { "description": "Webhook limit information retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "unlimited": { "type": "boolean", "example": false }, "total_limit": { "type": "integer" }, "total_used": { "type": "integer" }, "available_limit": { "type": "integer" }, "alert": { "type": "boolean" }, "message": { "type": "string" }, "id": { "type": "integer" }, "excluded_from_subscription": { "type": "string" }, "final_lead_id": { "type": "integer" }, "dates": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/role": { "get": { "tags": [ "Roles" ], "summary": "Get all roles with their permissions", "operationId": "27df314390373447ea339eaa0251cbc4", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "roles": { "type": "array", "items": { "type": "object" } }, "permissions_list": { "type": "array", "items": { "type": "string" } }, "role_wise_permissions": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Roles" ], "summary": "Update an existing role", "operationId": "88a0ee319c425c89e36268a3d3b149ae", "parameters": [ { "name": "role", "in": "query", "description": "Name of the role to update", "required": true, "schema": { "type": "string", "example": "manager" } }, { "name": "permission", "in": "query", "description": "Array of permissions to assign to the role", "required": true, "schema": { "type": "array", "items": { "type": "object" } } } ], "responses": { "200": { "description": "Role updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Role Updated Successfully" }, "role": { "type": "object" }, "allotted": { "type": "array", "items": { "type": "string" } }, "user_info": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Roles" ], "summary": "Create a new role", "operationId": "22f4587ea6b8847ee58a2b64f047c49d", "parameters": [ { "name": "name", "in": "query", "description": "Name of the role", "required": true, "schema": { "type": "string", "example": "manager" } }, { "name": "permission", "in": "query", "description": "Array of permissions to assign to the role", "required": true, "schema": { "type": "array", "items": { "type": "object" } } } ], "responses": { "200": { "description": "Role created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Role Added Successfully" }, "role": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Roles" ], "summary": "Delete a role", "operationId": "ae7f246ce0c670a24c9c8e028929ec1f", "parameters": [ { "name": "role", "in": "query", "description": "Name of the role to delete", "required": true, "schema": { "type": "string", "example": "manager" } } ], "responses": { "200": { "description": "Role deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Role Deleted Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/user-role": { "get": { "tags": [ "Roles" ], "summary": "Get user roles with their permissions", "operationId": "27acda4abea69604325484dc3f379387", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "roles": { "type": "array", "items": { "type": "object" } }, "permissions_list": { "type": "array", "items": { "type": "string" } }, "role_wise_permissions": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/role-type-delete-multiple": { "post": { "tags": [ "Roles" ], "summary": "Delete multiple roles", "operationId": "eee55c21ad3521dd8437b15bdde3ea20", "parameters": [ { "name": "ids", "in": "query", "description": "Array of role IDs to delete", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "Roles deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Role Deleted Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Internal server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-scheduled-campaign-list": { "post": { "tags": [ "Send Scheduled Campaign" ], "summary": "Get list of scheduled campaigns as a DataTables JSON response", "operationId": "2ea2d334f59f2c91e52bf4b581f7e968", "parameters": [ { "name": "type", "in": "query", "description": "Campaign type (e.g. sms, email, mms)", "required": true, "schema": { "type": "string", "enum": [ "sms", "email", "mms" ] } }, { "name": "template_id", "in": "query", "description": "Template ID associated with the campaign", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "DataTables JSON of scheduled campaigns" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/cancel-scheduled-campaign/{id}": { "get": { "tags": [ "Send Scheduled Campaign" ], "summary": "Cancel a scheduled campaign by ID", "operationId": "384253a9ca5098ac2ff613c3bfc1418f", "parameters": [ { "name": "id", "in": "path", "description": "ID of the scheduled campaign", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Scheduled campaign cancelled successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Scheduled campaign cancelled successfully." } }, "type": "object" } } } }, "404": { "description": "Scheduled campaign not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-scheduled-contacts": { "post": { "tags": [ "Send Scheduled Campaign" ], "summary": "Get contacts associated with a scheduled campaign", "operationId": "11f98f228711615a0bb0c3ac6c6f35a0", "parameters": [ { "name": "send_campaign_id", "in": "query", "description": "ID of the scheduled campaign", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "DataTables JSON of scheduled contacts" }, "404": { "description": "Record not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/cancel-scheduled-campaign-single-contact": { "get": { "tags": [ "Send Scheduled Campaign" ], "summary": "Cancel a single contact from a scheduled campaign", "operationId": "cfa5399182b05974627a6ef0ab45170b", "parameters": [ { "name": "campaign_id", "in": "query", "description": "ID of the individual campaign entry to remove", "required": true, "schema": { "type": "integer" } }, { "name": "send_scheduled_campaign_id", "in": "query", "description": "ID of the parent scheduled campaign", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Contact removed from scheduled campaign successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "scheduledCampaignDeleted": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Contact removed from scheduled campaign successfully." } }, "type": "object" } } } }, "404": { "description": "Scheduled campaign or campaign ID not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/cancel-scheduled-campaign-multiple-contact": { "post": { "tags": [ "Send Scheduled Campaign" ], "summary": "Cancel multiple contacts from a scheduled campaign", "operationId": "f6f1fe7423f6736fe3a07f8d2bbcf767", "parameters": [ { "name": "campaign_ids", "in": "query", "description": "Array of campaign IDs to remove", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "send_scheduled_campaign_id", "in": "query", "description": "ID of the parent scheduled campaign", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Contacts removed from scheduled campaign successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "scheduledCampaignDeleted": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Contacts removed from scheduled campaign successfully." } }, "type": "object" } } } }, "404": { "description": "Scheduled campaign not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/seo-report": { "get": { "tags": [ "SEO Reports" ], "summary": "Get a list of SEO reports", "operationId": "dbc78b5e9c19839d07273d6ea4b068ef", "responses": { "200": { "description": "List of SEO reports" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SEO Reports" ], "summary": "Create a new SEO report", "operationId": "636f9678de0e3f8e583e8d5fb0998422", "parameters": [ { "name": "client_id", "in": "query", "description": "Client ID", "required": true, "schema": { "type": "integer" } }, { "name": "subject", "in": "query", "description": "Report subject", "required": true, "schema": { "type": "string" } }, { "name": "message", "in": "query", "description": "Report message", "required": true, "schema": { "type": "string" } }, { "name": "cc_emails", "in": "query", "description": "CC email addresses", "required": false, "schema": { "type": "string" } }, { "name": "files[]", "in": "query", "description": "Report files", "required": true, "schema": { "type": "array", "items": { "type": "file" } } } ], "responses": { "200": { "description": "SEO report created successfully" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/seo-report/data-table": { "post": { "tags": [ "SEO Reports" ], "summary": "Get SEO reports for data table", "operationId": "a76ecf4f6be9a3b15135ab56f9e4ac7a", "parameters": [ { "name": "email_sent", "in": "query", "description": "Filter by email sent status", "required": false, "schema": { "type": "boolean" } }, { "name": "start_date", "in": "query", "description": "Filter by start date", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "Filter by end date", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "user_id", "in": "query", "description": "Filter by user ID", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SEO reports data for data table" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/seo-report/{id}": { "get": { "tags": [ "SEO Reports" ], "summary": "Get a specific SEO report", "operationId": "b0b4019897bc4697748d99a02e04c12d", "parameters": [ { "name": "id", "in": "path", "description": "SEO report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SEO report details" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "SEO report not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "SEO Reports" ], "summary": "Send a SEO report via email", "operationId": "67bbe10e6a21209064626434ba729ffb", "parameters": [ { "name": "id", "in": "path", "description": "SEO report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SEO report sent successfully" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "SEO report not found" }, "500": { "description": "Error sending report" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SEO Reports" ], "summary": "Delete a SEO report", "operationId": "96a1cf0bcb59ef2b50941f8f102c92c6", "parameters": [ { "name": "id", "in": "path", "description": "SEO report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Report deleted successfully" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "SEO report not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/seo_report_tracking/{id}": { "get": { "tags": [ "SEO Reports" ], "summary": "Track when a SEO report is viewed", "operationId": "8d3b8b9c7b76cd6b98c05dac8873e54b", "parameters": [ { "name": "id", "in": "path", "description": "SEO report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Report tracking updated" }, "401": { "description": "Unauthenticated" }, "404": { "description": "SEO report not found" } } } }, "/api/seo-report/download-attachment": { "get": { "tags": [ "SEO Reports" ], "summary": "Download a SEO report attachment", "operationId": "707dd438cee302ec669891f277ca3259", "parameters": [ { "name": "id", "in": "query", "description": "SEO report ID", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Attachment index", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File download" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "File not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/report_view/seo/{id}": { "get": { "tags": [ "SEO Reports" ], "summary": "View a SEO report", "operationId": "ceb079bfe2622d1c49ceeedf0104f719", "parameters": [ { "name": "id", "in": "path", "description": "SEO report ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SEO report details with files", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "files": { "type": "array", "items": { "type": "object" } }, "report_file_name": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" }, "404": { "description": "Report not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/short-url": { "get": { "tags": [ "Short URLs" ], "summary": "Get all short URLs", "operationId": "b9526c696e6478e20673e37a5278ccd2", "responses": { "200": { "description": "List of all short URLs", "content": { "application/json": { "schema": { "properties": { "shortUrls": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No data found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Short URLs" ], "summary": "Create a new short URL", "operationId": "09308968fb8527ecb91ee1677e289ed8", "parameters": [ { "name": "url", "in": "query", "description": "URL to be shortened", "required": true, "schema": { "type": "string", "example": "https://example.com/long-url-to-be-shortened" } } ], "responses": { "200": { "description": "Short URL created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Short Url added successfully." }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Something went wrong" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/short-url/{id}": { "get": { "tags": [ "Short URLs" ], "summary": "Get a specific short URL by ID", "operationId": "b3f557d77afd41c458e8dc668774368a", "parameters": [ { "name": "id", "in": "path", "description": "ID of the short URL", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Short URL details", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Short URL not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-short-url/{code}": { "get": { "tags": [ "Short URLs" ], "summary": "Get a short URL by its code", "operationId": "aed068f6b3ee7341837156502950d57e", "parameters": [ { "name": "code", "in": "path", "description": "Code of the short URL", "required": true, "schema": { "type": "string", "example": "abc123" } } ], "responses": { "200": { "description": "Short URL found successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Short Url has been Found sucessfully" }, "data": { "type": "object" }, "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "Short URL not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Short Url is not Found" }, "success": { "type": "boolean", "example": false } }, "type": "object" } } } } } } }, "/api/short-url/{short_url}": { "put": { "tags": [ "Short URL" ], "summary": "Update a short URL (resource update – placeholder, not currently implemented)", "operationId": "eb430646bb1ac39b4d2067c5afd251b6", "parameters": [ { "name": "short_url", "in": "path", "description": "Short URL ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Short URL" ], "summary": "Delete a short URL (resource destroy – placeholder, not currently implemented)", "operationId": "af5f74745a698644ab3a45aee1dc45ff", "parameters": [ { "name": "short_url", "in": "path", "description": "Short URL ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign": { "get": { "tags": [ "SMS Campaign" ], "summary": "Get all SMS campaigns for the authenticated user's client", "operationId": "2dbb74d560441e5737c2c7b12751b224", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 100 }, "to_mobile": { "type": "string", "example": "+1234567890" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SMS Campaign" ], "summary": "Create a new SMS campaign", "operationId": "f1e7b3e7c06a1ed1b7de8c818daac474", "parameters": [ { "name": "sms_id", "in": "query", "description": "SMS ID", "required": true, "schema": { "type": "integer" } }, { "name": "lead_id", "in": "query", "description": "Lead ID", "required": true, "schema": { "type": "integer" } }, { "name": "to_mobile", "in": "query", "description": "Recipient mobile number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SMS Campaign created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Added Successfully" }, "sms_campaign": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 100 }, "to_mobile": { "type": "string", "example": "+1234567890" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign/data-table/get": { "post": { "tags": [ "SMS Campaign" ], "summary": "Get SMS campaigns data for DataTables", "description": "Display a listing of the resource for DataTables.", "operationId": "d279bcdf6b388a233f96951feee346da", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer", "example": 1 }, "recordsTotal": { "type": "integer", "example": 10 }, "recordsFiltered": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 100 }, "to_mobile": { "type": "string", "example": "+1234567890" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign/{id}": { "get": { "tags": [ "SMS Campaign" ], "summary": "Get a specific SMS campaign by ID", "operationId": "113c5f335ff05924e7f5ea419e0adf09", "parameters": [ { "name": "id", "in": "path", "description": "SMS Campaign ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 100 }, "to_mobile": { "type": "string", "example": "+1234567890" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "SMS Campaign not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No SMS Campaign Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "SMS Campaign" ], "summary": "Update a specific SMS campaign", "operationId": "d159ee24235b4c8e0981dce281a8ff95", "parameters": [ { "name": "id", "in": "path", "description": "SMS Campaign ID", "required": true, "schema": { "type": "integer" } }, { "name": "sms_id", "in": "query", "description": "SMS ID", "required": true, "schema": { "type": "integer" } }, { "name": "lead_id", "in": "query", "description": "Lead ID", "required": true, "schema": { "type": "integer" } }, { "name": "to_mobile", "in": "query", "description": "Recipient mobile number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SMS Campaign updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Updated Successfully" }, "sms_campaign": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 100 }, "to_mobile": { "type": "string", "example": "+1234567890" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "SMS Campaign not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SMS Campaign" ], "summary": "Delete a specific SMS campaign", "operationId": "3426ec7b7815b310c1f488987ff574d1", "parameters": [ { "name": "id", "in": "path", "description": "SMS Campaign ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS Campaign deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "SMS Campaign not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Not Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign/get-list-sms-campaigns/{id}": { "post": { "tags": [ "SMS Campaign" ], "summary": "Get list of SMS campaigns by SMS ID", "description": "Get list of SMS campaigns by SMS ID", "operationId": "dc1a65cac1f15a80e4e915f8d9b7039a", "parameters": [ { "name": "id", "in": "path", "description": "SMS ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer", "example": 1 }, "recordsTotal": { "type": "integer", "example": 10 }, "recordsFiltered": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 100 }, "to_mobile": { "type": "string", "example": "+1234567890" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "sent_time": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "No search results found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No search results found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign/get-sms-campaigns-report-data/{id}": { "post": { "tags": [ "SMS Campaign" ], "summary": "Get SMS campaign report data for a given SMS", "description": "Returns DataTables-formatted SMS campaign rows for the authenticated user's client, scoped to the given SMS ID. Supports optional filters: start_date, end_date, and status (queued|delivered|failed|scheduled).", "operationId": "58e031b991931eb8d20dd1a753dabde5", "parameters": [ { "name": "id", "in": "path", "description": "SMS ID", "required": true, "schema": { "type": "integer" } }, { "name": "start_date", "in": "query", "description": "Filter campaigns created on or after this date (Y-m-d H:i:s)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "end_date", "in": "query", "description": "Filter campaigns created on or before this date (Y-m-d H:i:s)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "status", "in": "query", "description": "Filter by send status", "required": false, "schema": { "type": "string", "enum": [ "queued", "delivered", "failed", "scheduled" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer", "example": 1 }, "recordsTotal": { "type": "integer", "example": 10 }, "recordsFiltered": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 100 }, "to_mobile": { "type": "string", "example": "+1234567890" }, "first_name": { "type": "string", "example": "John" }, "last_name": { "type": "string", "example": "Doe" }, "email": { "type": "string", "example": "john.doe@example.com" }, "sent_status": { "type": "integer", "example": 1 }, "schedule_time": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign-insert-loop": { "get": { "tags": [ "SMS Campaign Insert Loop" ], "summary": "Get all SMS campaign insert loops for the authenticated user's client", "operationId": "e12eb8a02f88963337d282e5d59c3b5a", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "last_lead_id": { "type": "integer", "example": 100 }, "filters": { "type": "string", "example": "[]" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SMS Campaign Insert Loop" ], "summary": "Create a new SMS campaign insert loop", "operationId": "7b72dad33da4f86247f16654030714d2", "parameters": [ { "name": "sms_id", "in": "query", "description": "SMS ID", "required": true, "schema": { "type": "integer" } }, { "name": "last_lead_id", "in": "query", "description": "Last lead ID", "required": true, "schema": { "type": "integer" } }, { "name": "filters", "in": "query", "description": "Filters as array", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "SMS Campaign Insert Loop created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Insert Loop Added Successfully" }, "sms_campaign_insert_loop": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "last_lead_id": { "type": "integer", "example": 100 }, "filters": { "type": "string", "example": "[]" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign-insert-loop/data-table/get": { "post": { "tags": [ "SMS Campaign Insert Loop" ], "summary": "Get SMS campaign insert loops data for DataTables", "description": "Display a listing of the resource for DataTables.", "operationId": "81ea513b01cda433ba3a95619624c37d", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer", "example": 1 }, "recordsTotal": { "type": "integer", "example": 10 }, "recordsFiltered": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "last_lead_id": { "type": "integer", "example": 100 }, "filters": { "type": "string", "example": "[]" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-campaign-insert-loop/{id}": { "get": { "tags": [ "SMS Campaign Insert Loop" ], "summary": "Get a specific SMS campaign insert loop by ID", "operationId": "44b0b96ee09182f2a43e82dbd247eda3", "parameters": [ { "name": "id", "in": "path", "description": "SMS Campaign Insert Loop ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "last_lead_id": { "type": "integer", "example": 100 }, "filters": { "type": "string", "example": "[]" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "SMS Campaign Insert Loop not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No SMS Campaign Insert Loop Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "SMS Campaign Insert Loop" ], "summary": "Update a specific SMS campaign insert loop", "operationId": "bc1dc1e1b95a67c5eb13edecd3ecdea1", "parameters": [ { "name": "id", "in": "path", "description": "SMS Campaign Insert Loop ID", "required": true, "schema": { "type": "integer" } }, { "name": "sms_id", "in": "query", "description": "SMS ID", "required": true, "schema": { "type": "integer" } }, { "name": "last_lead_id", "in": "query", "description": "Last lead ID", "required": true, "schema": { "type": "integer" } }, { "name": "filters", "in": "query", "description": "Filters as array", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "SMS Campaign Insert Loop updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Insert Loop Updated Successfully" }, "sms_campaign_insert_loop": { "properties": { "id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "last_lead_id": { "type": "integer", "example": 100 }, "filters": { "type": "string", "example": "[]" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "SMS Campaign Insert Loop not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SMS Campaign Insert Loop" ], "summary": "Delete a specific SMS campaign insert loop", "operationId": "aa655be5183b1f6fce2e725264a597b9", "parameters": [ { "name": "id", "in": "path", "description": "SMS Campaign Insert Loop ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS Campaign Insert Loop deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Insert Loop Deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "SMS Campaign Insert Loop not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Campaign Insert Loop Not Found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-credits/get-available/{id}": { "get": { "tags": [ "SMS Credits" ], "summary": "Get available SMS credits and message history for a lead", "operationId": "8814d1e0c1706636fc1da36c64307f77", "parameters": [ { "name": "id", "in": "path", "description": "ID of the lead", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Available SMS credits and message data retrieved successfully", "content": { "application/json": { "schema": { "properties": { "credits_available": { "type": "number" }, "messageData": { "type": "object" }, "virtualNumber": { "type": "integer" }, "allow_postpaid_sms": { "type": "integer" }, "sms_charge": { "type": "number" }, "plan_status": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-credits/data-table/get": { "post": { "tags": [ "SMS Credits" ], "summary": "Get SMS credits as a DataTables response", "operationId": "fcda87361db10075044dc6006af9a0b1", "responses": { "200": { "description": "SMS credits retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-credits": { "get": { "tags": [ "SMS Credits" ], "summary": "Get list of SMS credits for the authenticated user's client", "operationId": "48dcabe01f2d3a96edd4e8b520a46e38", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SMS Credits" ], "summary": "Add SMS credits for a user", "operationId": "f0e3467e3a2a21fb9e9e0621d18a80db", "parameters": [ { "name": "user_id", "in": "query", "description": "ID of the user receiving the credits", "required": true, "schema": { "type": "integer" } }, { "name": "credits", "in": "query", "description": "Number of SMS credits to add", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS credits added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Credits Added Successfully" }, "sms_credits": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error or invalid user" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-credits/{sms_credit}": { "get": { "tags": [ "SMS Credits" ], "summary": "Display the specified SMS credit record", "operationId": "5c1893d29430957a01adef26d9ddf7bc", "parameters": [ { "name": "sms_credit", "in": "path", "description": "ID of the SMS credit record", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation" }, "404": { "description": "No SMS Credit Found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "SMS Credits" ], "summary": "Update the specified SMS credit record", "operationId": "a0ef00cbabac18486e1d07b58f8d117d", "parameters": [ { "name": "sms_credit", "in": "path", "description": "ID of the SMS credit record to update", "required": true, "schema": { "type": "integer" } }, { "name": "user_id", "in": "query", "description": "ID of the user the credits belong to", "required": true, "schema": { "type": "integer" } }, { "name": "credits", "in": "query", "description": "Updated number of SMS credits", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS credit updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Credit Updated Successfully" }, "sms_credits": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SMS Credits" ], "summary": "Delete the specified SMS credit record", "operationId": "6c868e5a687f6178a3adec1d975f564a", "parameters": [ { "name": "sms_credit", "in": "path", "description": "ID of the SMS credit record to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS credit deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Credit Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "SMS Credit Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-sms-credits-and-numbers": { "get": { "tags": [ "SMS Credits" ], "summary": "Get available SMS credits and the count of SMS-capable virtual numbers", "operationId": "f228cb52f737fc0352ec7b81b6013159", "responses": { "200": { "description": "SMS credits and virtual number count retrieved successfully", "content": { "application/json": { "schema": { "properties": { "credits_available": { "type": "number" }, "virtualNumber": { "type": "integer" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-credits-used/data-table/get": { "post": { "tags": [ "SMS Credits Used" ], "summary": "Get SMS credits used as a DataTables response", "operationId": "20e0750b11058405ba96a2b7b19ebec8", "responses": { "200": { "description": "SMS credits used retrieved successfully" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-credits-used": { "get": { "tags": [ "SMS Credits Used" ], "summary": "Get list of SMS credits used for the authenticated user's client", "operationId": "5a68bd0caff150014f28b5b3f5c85920", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SMS Credits Used" ], "summary": "Deduct SMS credits used for a user", "operationId": "5ec260f66e3c742965117f8d99ba960a", "parameters": [ { "name": "user_id", "in": "query", "description": "ID of the user whose credits are being used", "required": true, "schema": { "type": "integer" } }, { "name": "credits_used", "in": "query", "description": "Number of SMS credits used", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS credits used added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Credits Used Added Successfully" } }, "type": "object" } } } }, "422": { "description": "Validation error or invalid user" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-credits-used/{sms_credits_used}": { "get": { "tags": [ "SMS Credits Used" ], "summary": "Display the specified SMS credits used record", "operationId": "66d62b708efaed5d749e60dbb587ff9a", "parameters": [ { "name": "sms_credits_used", "in": "path", "description": "ID of the SMS credits used record", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation" }, "404": { "description": "No SMS Credits Used Found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "SMS Credits Used" ], "summary": "Update the specified SMS credits used record", "operationId": "3eed843a123274017d12c0f177ade717", "parameters": [ { "name": "sms_credits_used", "in": "path", "description": "ID of the SMS credits used record to update", "required": true, "schema": { "type": "integer" } }, { "name": "user_id", "in": "query", "description": "ID of the user whose credits are being updated", "required": true, "schema": { "type": "integer" } }, { "name": "credits_used", "in": "query", "description": "Updated number of SMS credits used", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS credits used updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Credit Used Updated Successfully" }, "sms_credits_used": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SMS Credits Used" ], "summary": "Delete the specified SMS credits used record", "operationId": "0e9cbcebd69b809c4fa837849d076991", "parameters": [ { "name": "sms_credits_used", "in": "path", "description": "ID of the SMS credits used record to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS credit used deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Credit Used Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "SMS Credit Used Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms": { "get": { "tags": [ "SMS" ], "summary": "Get list of SMS templates and phone numbers", "operationId": "07d64488da87cbaa458b7f75aad012f8", "responses": { "200": { "description": "List of SMS templates and phone numbers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "smsTemplate": { "type": "array", "items": { "type": "object" } }, "fromNumber": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SMS" ], "summary": "Create a new SMS template", "operationId": "8040227756ed4c361243eb8da4080807", "parameters": [ { "name": "description", "in": "query", "description": "SMS content", "required": true, "schema": { "type": "string" } }, { "name": "encoding", "in": "query", "description": "SMS encoding", "required": true, "schema": { "type": "string" } }, { "name": "no_of_sms", "in": "query", "description": "Number of SMS", "required": false, "schema": { "type": "integer" } }, { "name": "from_name", "in": "query", "description": "Sender name", "required": false, "schema": { "type": "string", "maxLength": 11 } } ], "responses": { "200": { "description": "SMS template created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "SMS template created successfully" }, "sms": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms/data-table/get": { "post": { "tags": [ "SMS" ], "summary": "Get SMS data for datatable", "operationId": "b47a0bf9ec13e8be59c13ef3b77ad5a3", "responses": { "200": { "description": "SMS data retrieved successfully for datatable", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "phoneNumber": { "type": "array", "items": { "type": "object" } }, "sms_credits": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms/{id}": { "get": { "tags": [ "SMS" ], "summary": "Get a specific SMS template", "operationId": "3fbf733530ac2a9e5691491a248f7db2", "parameters": [ { "name": "id", "in": "path", "description": "SMS template ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS template retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "sms": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "SMS template not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "SMS template not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "SMS" ], "summary": "Update an existing SMS template", "operationId": "467560c6999154b3b50dff9cf22e14c1", "parameters": [ { "name": "id", "in": "path", "description": "SMS template ID", "required": true, "schema": { "type": "integer" } }, { "name": "description", "in": "query", "description": "SMS content", "required": true, "schema": { "type": "string" } }, { "name": "encoding", "in": "query", "description": "SMS encoding", "required": true, "schema": { "type": "string" } }, { "name": "no_of_sms", "in": "query", "description": "Number of SMS", "required": false, "schema": { "type": "integer" } }, { "name": "from_name", "in": "query", "description": "Sender name", "required": false, "schema": { "type": "string", "maxLength": 11 } } ], "responses": { "200": { "description": "SMS template updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "SMS template updated successfully" }, "sms": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "SMS template not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "SMS template not found" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SMS" ], "summary": "Delete an SMS template", "operationId": "acdc095468bfa8f8cc1842b34930ad99", "parameters": [ { "name": "id", "in": "path", "description": "SMS template ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "SMS template deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "SMS template deleted successfully" } }, "type": "object" } } } }, "404": { "description": "SMS template not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "SMS template not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms/{id}/get-credits-required": { "get": { "tags": [ "SMS" ], "summary": "Get credits required for an SMS", "operationId": "ec5db79de67e3fa110d3383ae5c85940", "parameters": [ { "name": "id", "in": "path", "description": "SMS template ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Credits required retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "credits_required": { "type": "integer", "example": 1 } }, "type": "object" } } } }, "404": { "description": "SMS template not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "SMS template not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms/check-before-send": { "post": { "tags": [ "SMS" ], "summary": "Check before sending an SMS", "operationId": "cbcf210a20017c0ac9538f4179f28060", "parameters": [ { "name": "sms_id", "in": "query", "description": "SMS template ID", "required": true, "schema": { "type": "integer" } }, { "name": "from_number", "in": "query", "description": "Sender phone number", "required": true, "schema": { "type": "string" } }, { "name": "lead_ids", "in": "query", "description": "Lead IDs to send SMS to", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "Check completed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Check completed successfully" }, "credits_required": { "type": "integer", "example": 1 }, "credits_available": { "type": "integer", "example": 100 } }, "type": "object" } } } }, "400": { "description": "Not enough credits", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Not enough credits" } }, "type": "object" } } } }, "404": { "description": "SMS template not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "SMS template not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms/send": { "post": { "tags": [ "SMS" ], "summary": "Send SMS to leads", "operationId": "e67f1507e04501200ff5b076430e5049", "parameters": [ { "name": "sms_id", "in": "query", "description": "SMS template ID", "required": true, "schema": { "type": "integer" } }, { "name": "from_number", "in": "query", "description": "Sender phone number", "required": true, "schema": { "type": "string" } }, { "name": "lead_ids", "in": "query", "description": "Lead IDs to send SMS to", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "scheduled_date", "in": "query", "description": "Date to schedule SMS", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "SMS sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "SMS sent successfully" } }, "type": "object" } } } }, "400": { "description": "Not enough credits or other error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Not enough credits" } }, "type": "object" } } } }, "404": { "description": "SMS template not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "SMS template not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms/send-to-single-lead": { "post": { "tags": [ "SMS" ], "summary": "Send SMS to a single lead", "operationId": "085a25198d71f410996d57d6e14d2ca0", "parameters": [ { "name": "lead_id", "in": "query", "description": "Lead ID to send SMS to", "required": true, "schema": { "type": "integer" } }, { "name": "message", "in": "query", "description": "SMS message content", "required": true, "schema": { "type": "string" } }, { "name": "from_number", "in": "query", "description": "Sender phone number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SMS sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "SMS sent successfully" } }, "type": "object" } } } }, "400": { "description": "Not enough credits or other error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Not enough credits" } }, "type": "object" } } } }, "404": { "description": "Lead not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Lead not found" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms/lead-search": { "post": { "tags": [ "SMS" ], "summary": "Search for leads to send SMS to", "operationId": "49c8cd086955ec6561f21b3385319c5a", "parameters": [ { "name": "start_date", "in": "query", "description": "Start date for filtering leads", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "end_date", "in": "query", "description": "End date for filtering leads", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "search", "in": "query", "description": "Search term for filtering leads", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Leads retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-index-update": { "post": { "tags": [ "SMS" ], "summary": "Update SMS template index order", "operationId": "5a9fb49a05694ec0e97815f9026752cf", "parameters": [ { "name": "sms_data", "in": "query", "description": "Array of SMS IDs and their new index positions", "required": true, "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "index": { "type": "integer" } }, "type": "object" } } } ], "responses": { "200": { "description": "SMS template indexes updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "result": { "type": "array", "items": { "type": "boolean" } } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/send-sms-to-selected-leads": { "post": { "tags": [ "SMS" ], "summary": "Send an existing SMS template (or a custom message) to a set of selected leads", "description": "Validates the requested credit usage against the client's SMS balance and queues delivery. When isCustomMsg is true an existing sms_id is used; otherwise description/encoding/no_of_sms are required to create a new SMS record.", "operationId": "ee55e2d4a4c300a80f1dcc9cd384780e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "isCustomMsg": { "description": "Use an existing SMS template (true) or create a new one (false)", "type": "boolean" }, "sms_id": { "description": "Existing SMS ID (required when isCustomMsg=true)", "type": "integer" }, "lead_id": { "description": "Lead IDs to send the SMS to (required when isCustomMsg=true)", "type": "array", "items": { "type": "integer" } }, "description": { "description": "SMS body (required when isCustomMsg=false)", "type": "string" }, "encoding": { "description": "SMS encoding (e.g. GSM_7BIT, UCS2)", "type": "string" }, "no_of_sms": { "description": "Number of SMS segments per recipient", "type": "integer" }, "from_number": { "description": "Sender phone number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "SMS dispatch result", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-sms-list": { "post": { "tags": [ "SMS" ], "summary": "List SMS records for the authenticated user's client with search, filter and pagination", "operationId": "9fdc072755a5b77154a6920a0f9a3311", "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "limit": { "description": "Records per page (default 4)", "type": "integer" }, "search_text": { "description": "Free-text search across SMS fields", "type": "string" }, "created_by": { "description": "Filter by creator user ID", "type": "integer" }, "is_custom_msg": { "description": "0 for standard SMS, 1 for custom messages", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Paginated SMS list", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-tracking": { "get": { "tags": [ "SMS Tracking" ], "summary": "Get all SMS tracking records", "operationId": "ab505d99bb2f1018fd3763ea0ef807a7", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 1 }, "phone_number": { "type": "string", "example": "+1234567890" }, "delivered": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" } }, "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "SMS Tracking" ], "summary": "Create a new SMS tracking record", "operationId": "9e672ace6cade6f56b5822897b8cda7e", "parameters": [ { "name": "sms_id", "in": "query", "description": "SMS ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "sms_user_id", "in": "query", "description": "SMS User ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "phone_number", "in": "query", "description": "Phone number", "required": true, "schema": { "type": "string", "example": "+1234567890" } } ], "responses": { "200": { "description": "SMS Tracking Added Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Tracking Added Successfully" }, "sms_tracking": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "sms_user_id": { "type": "integer", "example": 1 }, "phone_number": { "type": "string", "example": "+1234567890" }, "created_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-tracking/data-table/get": { "post": { "tags": [ "SMS Tracking" ], "summary": "Get SMS tracking records for DataTables", "description": "Display a listing of the resource for DataTables.", "operationId": "077dbb5b61cf197eeb2da32171b39e09", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer", "example": 1 }, "recordsTotal": { "type": "integer", "example": 10 }, "recordsFiltered": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 1 }, "phone_number": { "type": "string", "example": "+1234567890" }, "delivered": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-tracking/{id}": { "get": { "tags": [ "SMS Tracking" ], "summary": "Get a specific SMS tracking record", "operationId": "e747f31c4173164173551be2059add2e", "parameters": [ { "name": "id", "in": "path", "description": "SMS Tracking ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "lead_id": { "type": "integer", "example": 1 }, "phone_number": { "type": "string", "example": "+1234567890" }, "delivered": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "No SMS Tracking Found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "SMS Tracking" ], "summary": "Update a specific SMS tracking record", "operationId": "e6c858cafb02f2dcdcdde5ca182e5459", "parameters": [ { "name": "id", "in": "path", "description": "SMS Tracking ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "sms_id", "in": "query", "description": "SMS ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "sms_user_id", "in": "query", "description": "SMS User ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "phone_number", "in": "query", "description": "Phone number", "required": true, "schema": { "type": "string", "example": "+1234567890" } } ], "responses": { "200": { "description": "SMS Tracking Updated Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Tracking Updated Successfully" }, "sms_tracking": { "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "client_id": { "type": "integer", "example": 1 }, "sms_id": { "type": "integer", "example": 1 }, "sms_user_id": { "type": "integer", "example": 1 }, "phone_number": { "type": "string", "example": "+1234567890" }, "created_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-01-01T00:00:00.000000Z" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "SMS Tracking" ], "summary": "Delete a specific SMS tracking record", "operationId": "2214636f3354b20f057b8cd00fc97b54", "parameters": [ { "name": "id", "in": "path", "description": "SMS Tracking ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "SMS Tracking Deleted Successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Tracking Deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "SMS Tracking Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-reply": { "post": { "tags": [ "SMS Tracking" ], "summary": "Handle SMS reply from Twilio webhook", "description": "Handle SMS reply from Twilio webhook", "operationId": "976b9a70e5c479ba2f2e8facc1664b98", "parameters": [ { "name": "From", "in": "query", "description": "Phone number that sent the SMS", "required": true, "schema": { "type": "string", "example": "+1234567890" } }, { "name": "To", "in": "query", "description": "Phone number that received the SMS", "required": true, "schema": { "type": "string", "example": "+1234567890" } }, { "name": "Body", "in": "query", "description": "SMS message body", "required": true, "schema": { "type": "string", "example": "This is a reply message" } } ], "responses": { "200": { "description": "SMS reply processed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "SMS reply processed successfully" } }, "type": "object" } } } }, "500": { "description": "Error processing SMS reply" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-sms-reply-list": { "post": { "tags": [ "SMS Tracking" ], "summary": "Get list of SMS replies", "operationId": "9784e6c213831e538764f89b158777ad", "responses": { "200": { "description": "List of SMS replies retrieved successfully", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/received-sms-reply-send": { "post": { "tags": [ "SMS Tracking" ], "summary": "Send SMS reply to a received message", "description": "Send SMS reply to a received message", "operationId": "e949b9303da0965d00997598eda88b0c", "parameters": [ { "name": "from_number", "in": "query", "description": "Phone number to send from", "required": true, "schema": { "type": "string", "example": "+1234567890" } }, { "name": "to_number", "in": "query", "description": "Phone number to send to", "required": true, "schema": { "type": "string", "example": "+1234567890" } }, { "name": "encoding", "in": "query", "description": "SMS encoding", "required": true, "schema": { "type": "string", "example": "UTF-8" } }, { "name": "no_of_sms", "in": "query", "description": "Number of SMS segments", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "sms_tracking_id", "in": "query", "description": "SMS Tracking ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "message", "in": "query", "description": "SMS message body", "required": true, "schema": { "type": "string", "example": "This is a reply message" } }, { "name": "lead_id", "in": "query", "description": "Lead ID", "required": false, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "SMS has been sent successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "SMS has been sent successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation error or Not enough credits" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/cancel-sms-schedule/{id}": { "get": { "tags": [ "SMS Tracking" ], "summary": "Cancel a scheduled SMS", "description": "Soft-deletes the SmsTracking row and, if a SmsCampaign references it via sms_tracking_id, also soft-deletes that campaign row.", "operationId": "cancelSmsSchedule", "parameters": [ { "name": "id", "in": "path", "description": "SmsTracking row ID", "required": true, "schema": { "type": "integer", "example": 42 } } ], "responses": { "200": { "description": "Schedule cancelled", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "SMS Schedule Cancelled Successfully" } }, "type": "object" } } } }, "400": { "description": "SmsTracking row not found, or save failed. Body is either {'message':'No Data Found'} or {'message':'Something Went Wrong.'}.", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No Data Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/sms-conversation-by-number": { "get": { "tags": [ "SMS Tracking" ], "summary": "The SMS conversation with one phone number (for messages with no lead)", "description": "For the inbox reply modal when a message's sender matches no lead contact. Matches on the number's last 10 digits across inbound (receive_from_number) and outbound (phone_number) rows, and returns the same messageData shape as the lead thread, keyed by the number itself. from_number is the number previously replied from, falling back to any of the client's SMS-capable numbers.", "operationId": "b384e96f91dc0f720504437ab55fa6c7", "parameters": [ { "name": "number", "in": "query", "description": "The other party's phone number", "required": true, "schema": { "type": "string", "example": "+447700900123" } } ], "responses": { "200": { "description": "Conversation keyed by the queried number", "content": { "application/json": { "schema": { "properties": { "messageData": { "description": "Map of the queried number => {from_number, messages}", "type": "object", "additionalProperties": { "properties": { "from_number": { "description": "Number to send a reply from (nullable when the client has no SMS-capable number)", "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "properties": { "from_message": { "description": "Outbound message text", "type": "string", "nullable": true }, "receive_message": { "description": "Inbound message text", "type": "string", "nullable": true }, "delivered": { "type": "integer", "nullable": true }, "received": { "type": "integer", "nullable": true }, "created_at": { "description": "Client-timezone timestamp", "type": "string" }, "send_user": { "type": "string", "nullable": true }, "send_user_id": { "type": "integer", "nullable": true }, "send_user_image": { "type": "string", "nullable": true }, "from_number": { "type": "string", "nullable": true }, "schedule_time": { "type": "string", "nullable": true }, "sms_tacking_id": { "type": "integer" }, "received_name": { "description": "Always the queried number (no contact name is known)", "type": "string" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/link-inbound-sms-to-lead": { "post": { "tags": [ "SMS Tracking" ], "summary": "Attach a lead to inbound SMS from an unknown number", "description": "The inbox's \"Add lead\" action. Every unlinked inbound message from the same sender number (matched on its last 10 digits) is attached to the lead, so the whole conversation moves across — not only the clicked row.", "operationId": "de4837eafddba5ca80e0bd45d3ffd647", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "sms_tracking_id", "lead_id" ], "properties": { "sms_tracking_id": { "description": "The clicked inbound message", "type": "integer" }, "lead_id": { "description": "Lead to attach (must belong to the caller's client)", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Messages linked", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Lead linked successfully." }, "linked_messages": { "description": "How many messages were attached", "type": "integer", "example": 3 } }, "type": "object" } } } }, "422": { "description": "Validation error, SMS message or lead not found for this client, or the message has no sender number", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/status": { "get": { "tags": [ "Status" ], "summary": "Display a listing of statuses", "operationId": "a27f26e35bade06d4054143612379672", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "status": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Status" ], "summary": "Store a newly created status", "operationId": "902401d17ea4b8103fba4a72c17c6db1", "parameters": [ { "name": "title", "in": "query", "description": "Title of the status", "required": true, "schema": { "type": "string", "example": "In Progress" } }, { "name": "for_module", "in": "query", "description": "Module for which the status is created", "required": true, "schema": { "type": "string", "example": "project_tasks" } } ], "responses": { "200": { "description": "Status created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Status Added Successfully" }, "status": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/status/{status}": { "get": { "tags": [ "Status" ], "summary": "Get a single status by ID", "operationId": "showStatus", "parameters": [ { "name": "status", "in": "path", "description": "Status ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Status row", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "No status found for the given ID", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No Status Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/status/{id}": { "put": { "tags": [ "Status" ], "summary": "Update the specified status", "operationId": "dba902708b03b53b066db36628c436b0", "parameters": [ { "name": "id", "in": "path", "description": "ID of the status", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Title of the status", "required": true, "schema": { "type": "string", "example": "Completed" } } ], "responses": { "200": { "description": "Status updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Status Updated Successfully" }, "status": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" }, "404": { "description": "Status not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Status" ], "summary": "Remove the specified status", "operationId": "d00f651b4e7b17b1ad41a346b6b6126b", "parameters": [ { "name": "id", "in": "path", "description": "ID of the status", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Status deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Status Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "Status not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string", "example": "Status Not Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/status-list": { "post": { "tags": [ "Status" ], "summary": "Get status list by module", "operationId": "d06f8837ecd5268ceaacd9841e05ad3d", "parameters": [ { "name": "for_module", "in": "query", "description": "Module for which to get status list", "required": true, "schema": { "type": "string", "example": "project_tasks" } } ], "responses": { "200": { "description": "Status list retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "status": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-status-order": { "post": { "tags": [ "Status" ], "summary": "Update status order", "operationId": "fda670e29ceb58c8e36db28dc2e30e72", "parameters": [ { "name": "status_list", "in": "query", "description": "List of statuses with their new order", "required": true, "schema": { "type": "array", "items": { "properties": { "status_id": { "type": "integer", "example": 1 }, "index": { "type": "integer", "example": 0 } }, "type": "object" } } } ], "responses": { "200": { "description": "Status order updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "result": { "type": "array", "items": { "type": "boolean" } } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-stripe-account": { "get": { "tags": [ "Stripe" ], "summary": "Get Stripe account details for the authenticated user's client", "operationId": "8580e10b3fb256f1182d77888f5f128f", "responses": { "200": { "description": "Stripe details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Stripe settings has been fetch Successfully" }, "stripe_user_id": { "type": "string", "example": "acct_123456789" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-stripe-account-invoice": { "get": { "tags": [ "Stripe" ], "summary": "Get Stripe account details for invoice processing", "operationId": "a74e646f810364d09f5fe987a3e1e2d1", "responses": { "200": { "description": "Stripe details for invoice retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Stripe settings has been fetch Successfully" }, "stripe_user_id": { "type": "string", "example": "acct_123456789" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/stripe/save-details": { "post": { "tags": [ "Stripe" ], "summary": "Store Stripe account details after OAuth authorization", "operationId": "bbd6f6268274087231107cdb82828f5f", "parameters": [ { "name": "code", "in": "query", "description": "Authorization code received from Stripe OAuth", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Stripe details saved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Stripe settings has been saved Successfully" }, "stripe_user_id": { "type": "string", "example": "acct_123456789" } }, "type": "object" } } } }, "422": { "description": "Validation error or failed to save" }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-stripe-details": { "post": { "tags": [ "Stripe" ], "summary": "Delete connected Stripe account", "operationId": "9e161a9e0a090c08c345a4d69571bea1", "responses": { "200": { "description": "Stripe account deleted successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Stripe Account deleted Successfully" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/stripe-invoice-subscription-update": { "post": { "tags": [ "Stripe" ], "summary": "Handle Stripe subscription webhook events", "operationId": "ce226b9f02a68db5aedd50d2ac269490", "parameters": [ { "name": "type", "in": "query", "description": "Event type from Stripe webhook", "required": true, "schema": { "type": "string", "example": "customer.subscription.deleted" } }, { "name": "data", "in": "query", "description": "Event data from Stripe webhook", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Webhook processed successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/connected-stripe-webhook": { "post": { "tags": [ "Stripe" ], "summary": "Handle Stripe payment webhook events", "operationId": "268094723f04ccbff7b471ffb53af75c", "parameters": [ { "name": "data", "in": "query", "description": "Event data from Stripe webhook containing payment information", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Webhook processed successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/booking/stripe/webhook": { "post": { "tags": [ "Stripe" ], "summary": "Stripe webhook receiver", "description": "Verifies the `Stripe-Signature` header against `services.stripe.webhook_secret` and dispatches a Laravel Cashier WebhookReceived event with the decoded payload. Stripe-sent webhook; the raw body is read with file_get_contents().", "operationId": "bookingStripeWebhook", "parameters": [ { "name": "Stripe-Signature", "in": "header", "description": "Signature header provided by Stripe", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Raw Stripe event JSON. Read from the raw request body, not parsed by Laravel.", "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Event accepted", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": true } }, "type": "object" } } } }, "400": { "description": "Invalid Stripe signature", "content": { "application/json": { "schema": { "properties": { "status": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Invalid signature" } }, "type": "object" } } } } } } }, "/api/subscription-addon": { "post": { "tags": [ "Subscription" ], "summary": "Create a subscription with add-ons", "operationId": "d4de55d961fe053bcb8601c488b96dd6", "parameters": [ { "name": "package_id", "in": "query", "description": "ID of the package", "required": true, "schema": { "type": "integer" } }, { "name": "plan_id", "in": "query", "description": "ID of the plan", "required": true, "schema": { "type": "string" } }, { "name": "custom_item", "in": "query", "description": "Custom items for the subscription (array of item_id => limit)", "required": true, "schema": { "type": "object" } }, { "name": "price", "in": "query", "description": "Total price of the subscription", "required": true, "schema": { "type": "number", "format": "float" } } ], "responses": { "200": { "description": "Subscription created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Subscription created successfully" }, "data": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/selected-subscription": { "get": { "tags": [ "Subscription" ], "summary": "Get the selected subscription details", "operationId": "f974ee68568bfd791a5d5108633e189a", "responses": { "200": { "description": "Selected subscription retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/plan-otp-stripe-payment": { "post": { "tags": [ "Subscription" ], "summary": "Process a payment with OTP verification for a subscription plan", "operationId": "482d82ffbf5c700c16c6e959623db8f2", "parameters": [ { "name": "register_data", "in": "query", "description": "Registration data for the user", "required": true, "schema": { "type": "object" } }, { "name": "package_items", "in": "query", "description": "Package items for the subscription", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "plan", "in": "query", "description": "Plan ID for the subscription", "required": true, "schema": { "type": "string" } }, { "name": "package", "in": "query", "description": "Package details", "required": true, "schema": { "type": "object" } }, { "name": "payment_intent", "in": "query", "description": "Payment intent ID from Stripe", "required": true, "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "description": "ID of the user", "required": true, "schema": { "type": "integer" } }, { "name": "social", "in": "query", "description": "Whether the registration is via social media", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Payment processed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "user": { "type": "object" }, "user_info": { "type": "object" }, "xero_info": { "type": "object" }, "access_token": { "type": "string" }, "columns_grid_of_custom_fields_info": { "type": "object" }, "columns_grid_of_leads_info": { "type": "object" }, "choose_module_info": { "type": "object" }, "message": { "type": "string", "example": "Your payment is successful." }, "order_id": { "type": "integer" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/subscription-payment": { "post": { "tags": [ "Subscription" ], "summary": "Process payment for a subscription with add-ons", "operationId": "9954539eee9983777e65f4020536c3b9", "parameters": [ { "name": "register_data", "in": "query", "description": "Registration data for the user", "required": true, "schema": { "type": "object" } }, { "name": "package_items", "in": "query", "description": "Package items for the subscription", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "plan", "in": "query", "description": "Plan ID for the subscription", "required": true, "schema": { "type": "string" } }, { "name": "payment_method", "in": "query", "description": "Payment method ID from Stripe", "required": true, "schema": { "type": "string" } }, { "name": "package", "in": "query", "description": "Package details", "required": true, "schema": { "type": "object" } }, { "name": "is_costomozed", "in": "query", "description": "Whether the package is customized", "required": false, "schema": { "type": "boolean" } }, { "name": "social", "in": "query", "description": "Whether the registration is via social media", "required": false, "schema": { "type": "boolean" } }, { "name": "code", "in": "query", "description": "Coupon code", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment processed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "user": { "type": "object" }, "user_info": { "type": "object" }, "xero_info": { "type": "object" }, "access_token": { "type": "string" }, "columns_grid_of_custom_fields_info": { "type": "object" }, "columns_grid_of_leads_info": { "type": "object" }, "choose_module_info": { "type": "object" }, "message": { "type": "string", "example": "Your payment is successful." }, "order_id": { "type": "integer" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/assign-free-subscription": { "post": { "tags": [ "Subscription" ], "summary": "Assign a free subscription to a user without requiring payment method", "operationId": "71f0c93f255680b3e5b9636254b086df", "parameters": [ { "name": "package_id", "in": "query", "description": "ID of the package", "required": true, "schema": { "type": "integer" } }, { "name": "plan_id", "in": "query", "description": "ID of the free plan (Stripe price ID)", "required": true, "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "description": "ID of the user to assign the free subscription to", "required": true, "schema": { "type": "integer" } }, { "name": "package_items", "in": "query", "description": "Package items for the subscription (array of item details)", "required": false, "schema": { "type": "array", "items": { "type": "object" } } } ], "responses": { "200": { "description": "Free subscription assigned successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Free subscription assigned successfully" }, "user": { "type": "object" }, "subscription_id": { "type": "string" }, "order_id": { "type": "integer" }, "subscription_status": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/otp-stripe-payment": { "post": { "tags": [ "Subscription" ], "summary": "Process a payment with OTP verification for an addon", "operationId": "b49a7948aeb7cd40b24091433159ae3e", "parameters": [ { "name": "product", "in": "query", "description": "Product type (simple or year)", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limit for the addon", "required": true, "schema": { "type": "integer" } }, { "name": "default_limit", "in": "query", "description": "Default limit for the addon", "required": true, "schema": { "type": "integer" } }, { "name": "default_rate", "in": "query", "description": "Default rate for the addon", "required": true, "schema": { "type": "number", "format": "float" } }, { "name": "item_id", "in": "query", "description": "ID of the item", "required": true, "schema": { "type": "integer" } }, { "name": "payment_method", "in": "query", "description": "Payment method ID from Stripe", "required": true, "schema": { "type": "string" } }, { "name": "item_slug", "in": "query", "description": "Slug of the item", "required": true, "schema": { "type": "string" } }, { "name": "payment_intent", "in": "query", "description": "Payment intent ID from Stripe", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment processed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Your payment is successful." }, "order_id": { "type": "integer" }, "mail": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-subscription/{clientID?}": { "post": { "tags": [ "Subscription" ], "summary": "Get subscription details for a client", "operationId": "64464b9d40f07e2741713830dca0b818", "parameters": [ { "name": "clientID", "in": "path", "description": "ID of the client to get subscription for (optional, defaults to authenticated user's client)", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "active_plan": { "type": "object" }, "addonData": { "type": "object" }, "free_plan_limits": { "type": "object" }, "client": { "type": "object" }, "upgrade_count": { "type": "integer" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/view-addon-details/{id}": { "get": { "tags": [ "Subscription" ], "summary": "View details of a specific addon", "operationId": "da05dd96163e6ddd71b9ff2603d82b7b", "parameters": [ { "name": "id", "in": "path", "description": "ID of the addon to view", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Addon details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "addonData": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Addon not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/cancel-subscription": { "get": { "tags": [ "Subscription" ], "summary": "Cancel a subscription", "operationId": "0c9adb55917b87e7856bafa1fcc124a9", "parameters": [ { "name": "subscription_id", "in": "query", "description": "ID of the subscription to cancel", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Subscription cancelled successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Subscription cancel successfully." }, "result": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-subscription-date-in-order": { "get": { "tags": [ "Subscription" ], "summary": "Update subscription dates in the database", "operationId": "e76cf7cc548636a5a7f77e3967d14a4d", "responses": { "200": { "description": "Subscription dates updated successfully" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/request-sms-credits": { "post": { "tags": [ "Subscription" ], "summary": "Request additional SMS credits", "operationId": "d8d77ffa87a50af483c4be39f69c6ccd", "parameters": [ { "name": "limit", "in": "query", "description": "Number of SMS credits requested", "required": true, "schema": { "type": "integer" } }, { "name": "item_title", "in": "query", "description": "Title of the item", "required": true, "schema": { "type": "string" } }, { "name": "item_description", "in": "query", "description": "Description of the item", "required": true, "schema": { "type": "string" } }, { "name": "price", "in": "query", "description": "Price of the SMS credits", "required": false, "schema": { "type": "number", "format": "float" } }, { "name": "rate", "in": "query", "description": "Rate of the SMS credits (used if price is not provided)", "required": false, "schema": { "type": "number", "format": "float" } } ], "responses": { "200": { "description": "Request submitted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Your request for SMS Credits has been submitted. We will contact you soon via email." } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/stripe-payment": { "post": { "tags": [ "Subscription" ], "summary": "Process a payment for an addon", "operationId": "1cacf0d1e55a493d9afc77b7937dc113", "parameters": [ { "name": "product", "in": "query", "description": "Product type (simple or year)", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limit for the addon", "required": true, "schema": { "type": "integer" } }, { "name": "default_limit", "in": "query", "description": "Default limit for the addon", "required": true, "schema": { "type": "integer" } }, { "name": "default_rate", "in": "query", "description": "Default rate for the addon", "required": true, "schema": { "type": "number", "format": "float" } }, { "name": "item_id", "in": "query", "description": "ID of the item", "required": true, "schema": { "type": "integer" } }, { "name": "payment_method", "in": "query", "description": "Payment method ID from Stripe", "required": true, "schema": { "type": "string" } }, { "name": "item_slug", "in": "query", "description": "Slug of the item", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Coupon code (optional)", "required": false, "schema": { "type": "string" } }, { "name": "stripe_prices_id", "in": "query", "description": "Stripe price ID (required for subscription products)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment processed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Your payment is successful." }, "data": { "type": "object" }, "order_id": { "type": "integer" }, "mail": { "type": "string", "nullable": true } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-subscription-plan": { "post": { "tags": [ "Subscription" ], "summary": "Get current subscription plan details for the authenticated user", "operationId": "4be1f81c78413f5533b0d9099e1be7f4", "responses": { "200": { "description": "Subscription plan details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "active": { "type": "object" }, "stripe_plan": { "type": "object" }, "order": { "type": "object" }, "interval": { "type": "string", "example": "month" } }, "type": "object" } } } }, "500": { "description": "User is not subscribed or server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-subscription-plan-details": { "post": { "tags": [ "Subscription" ], "summary": "Get details for updating a subscription plan", "operationId": "202484ac705d19135b26215608929312", "parameters": [ { "name": "plan", "in": "query", "description": "ID of the plan to get details for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Subscription plan details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "invoice": { "type": "object" }, "proration_date": { "type": "integer" }, "current_plan": { "type": "object" }, "new_plan": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/upgrade-subscription-plan-payment": { "post": { "tags": [ "Subscription" ], "summary": "Upgrade a subscription plan with add-ons", "operationId": "81c09c032b82440a0ec1cbccfbb68912", "parameters": [ { "name": "package_items", "in": "query", "description": "Package items for the subscription", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "plan", "in": "query", "description": "ID of the plan to upgrade to", "required": true, "schema": { "type": "string" } }, { "name": "package", "in": "query", "description": "Package details", "required": true, "schema": { "type": "object" } }, { "name": "is_costomozed", "in": "query", "description": "Whether the package is customized", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Subscription upgraded successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Your payment is successful." }, "order_id": { "type": "integer" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/update-card": { "post": { "tags": [ "Subscription" ], "summary": "Update the default payment card and retry any past-due subscription invoices", "operationId": "2b7f71c1a2edafa665e77ff360c29162", "parameters": [ { "name": "payment_method", "in": "query", "description": "Stripe payment method ID to set as default", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Card updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Card updated successfully." }, "retried_invoices": { "type": "array", "items": { "type": "object" } }, "card": { "type": "object" }, "user": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Payment method is required" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/subscription-payment-after-login": { "post": { "tags": [ "Subscription" ], "summary": "Create a subscription and process payment for a user after login", "operationId": "0d8797994683e6ba440a77e09c11bf84", "parameters": [ { "name": "package_items", "in": "query", "description": "Array of package items being purchased", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "plan", "in": "query", "description": "Stripe plan/price ID", "required": true, "schema": { "type": "string" } }, { "name": "payment_method", "in": "query", "description": "Stripe payment method ID", "required": true, "schema": { "type": "string" } }, { "name": "package", "in": "query", "description": "Package details to store in the order history", "required": true, "schema": { "type": "object" } }, { "name": "code", "in": "query", "description": "Coupon code to apply", "required": false, "schema": { "type": "string" } }, { "name": "is_costomozed", "in": "query", "description": "Flag indicating customized package", "required": false, "schema": { "type": "integer" } }, { "name": "return_url", "in": "query", "description": "Return URL for SCA confirmation flow", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment was successful or requires confirmation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "user": { "type": "object" }, "message": { "type": "string" }, "order_id": { "type": "integer" }, "subscription_status": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/confirm-payment": { "post": { "tags": [ "Subscription" ], "summary": "Confirm a successful Stripe payment for a package item purchase", "operationId": "660894b00d76bbc9ca7d39648f9c83ae", "parameters": [ { "name": "package_info", "in": "query", "description": "Package information including item_id, default_rate, limit, item_slug, subscription, code", "required": true, "schema": { "type": "object" } }, { "name": "payment_info", "in": "query", "description": "Stripe payment intent info including id, status and amount", "required": true, "schema": { "type": "object" } }, { "name": "package_item_buy_type", "in": "query", "description": "1 for one-time purchase, 2 for recurring/subscription", "required": true, "schema": { "type": "integer", "enum": [ 1, 2 ] } } ], "responses": { "200": { "description": "Payment confirmation processed", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string", "example": "Your payment is successful." }, "order_id": { "type": "integer" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/checkout-confirm-payment": { "post": { "tags": [ "Subscription" ], "summary": "Confirm a plan subscription after Stripe checkout completes", "operationId": "6de8491a399d65139d971c9d136912a3", "parameters": [ { "name": "request_data", "in": "query", "description": "Request data including user_id, subscription_id, package_items, package, code, is_costomozed", "required": true, "schema": { "type": "object" } }, { "name": "payment_info", "in": "query", "description": "Stripe payment info including amount and status", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Plan subscription confirmed", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Your payment is successful." }, "order_id": { "type": "integer" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/upgrade-checkout-confirm-payment": { "post": { "tags": [ "Subscription" ], "summary": "Confirm a plan upgrade after Stripe checkout completes", "operationId": "6615217880411f0a7c8a169a2345e4b5", "parameters": [ { "name": "request_data", "in": "query", "description": "Request data including subscription_id, plan, package_items, package, is_costomozed", "required": true, "schema": { "type": "object" } }, { "name": "payment_info", "in": "query", "description": "Stripe payment info including amount and status", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Plan upgrade confirmed", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Your payment is successful." }, "order_id": { "type": "integer" } }, "type": "object" } } } }, "404": { "description": "Subscription not found" }, "500": { "description": "Server error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/resume-subscription": { "get": { "tags": [ "Subscription" ], "summary": "Resume a cancelled subscription that is still on its grace period", "description": "Resumes the authenticated user's cancelled Stripe subscription while it is still on its grace period, and re-enables recurring billing on the matching order.", "operationId": "f0d5412322404f45a10b988e42578cb3", "parameters": [ { "name": "subscription_id", "in": "query", "description": "Stripe subscription ID of the subscription to resume", "required": true, "schema": { "type": "string", "example": "sub_1N4Xy2ABCDEfghij" } } ], "responses": { "200": { "description": "Subscription resumed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Subscription resumed successfully." } }, "type": "object" } } } }, "404": { "description": "Subscription not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Subscription not found." } }, "type": "object" } } } }, "422": { "description": "Validation error, subscription no longer resumable, or Stripe error", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "This subscription can no longer be resumed. Please subscribe again." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/documentation": { "get": { "tags": [ "Swagger" ], "summary": "Render the interactive Swagger UI for the API", "description": "L5-Swagger documentation viewer. Returns the Swagger UI HTML page that consumes the OpenAPI JSON spec.", "operationId": "b16660e46fee4b77b127a49f038c4866", "responses": { "200": { "description": "Swagger UI HTML page", "content": { "text/html": {} } } } } }, "/api/oauth2-callback": { "get": { "tags": [ "Swagger" ], "summary": "OAuth2 redirect handler used by Swagger UI's Try-It-Out flow", "description": "L5-Swagger's OAuth2 redirect page that completes the implicit / authorization-code flow initiated from Swagger UI.", "operationId": "102845cad1161e8d0a85de328b2eb15f", "responses": { "200": { "description": "OAuth2 callback HTML page", "content": { "text/html": {} } } } } }, "/api/tax": { "get": { "tags": [ "Tax" ], "summary": "Get list of all taxes", "operationId": "1228983966f1a4b074dc84bca8d66e0e", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "taxes": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Tax" ], "summary": "Create a new tax", "operationId": "05fe97c019ead040cf983a757ecde3b7", "parameters": [ { "name": "title", "in": "query", "description": "Tax title", "required": true, "schema": { "type": "string", "example": "GST" } }, { "name": "percentage", "in": "query", "description": "Tax percentage", "required": true, "schema": { "type": "number", "format": "float", "example": 10.5 } } ], "responses": { "200": { "description": "Tax created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Tax Added successfully." }, "tax": { "type": "object" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/tax/datatable/get": { "post": { "tags": [ "Tax" ], "summary": "Get taxes for datatable", "operationId": "8bd5afb6f2e26af1fa6ec57613884ee5", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/tax/{id}": { "get": { "tags": [ "Tax" ], "summary": "Get specific tax by ID", "operationId": "b654b3a7a42c67b0cd34af0262b9dc30", "parameters": [ { "name": "id", "in": "path", "description": "Tax ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "tax": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Tax not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "No Tax Found" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Tax" ], "summary": "Update specific tax by ID", "operationId": "1162cdaa9c3ae188306096c068a83cb9", "parameters": [ { "name": "id", "in": "path", "description": "Tax ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "Tax title", "required": true, "schema": { "type": "string", "example": "GST" } }, { "name": "percentage", "in": "query", "description": "Tax percentage", "required": true, "schema": { "type": "number", "format": "float", "example": 10.5 } } ], "responses": { "200": { "description": "Tax updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Tax Updated Successfully." }, "tax": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Tax not found", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Tax Not Found." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Tax" ], "summary": "Delete specific tax by ID", "operationId": "e353dff54364a99584b806129cea34e8", "parameters": [ { "name": "id", "in": "path", "description": "Tax ID", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Tax deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Tax Deleted Successfully." } }, "type": "object" } } } }, "404": { "description": "Tax not found", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "Tax Not Found." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team": { "get": { "tags": [ "Team" ], "summary": "Get list of teams", "operationId": "e27dfadb09d14fea8aa10b8c0dca772e", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "teams": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Team" ], "summary": "Create a new team", "operationId": "af05b6e6d1a81092b28a5a403ca2d1ea", "parameters": [ { "name": "team_name", "in": "query", "description": "Name of the team", "required": true, "schema": { "type": "string", "maxLength": 100 } } ], "responses": { "200": { "description": "Team created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Team Added Successfully..!" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-user-list-datatable": { "post": { "tags": [ "Team" ], "summary": "Get team user list for datatable", "operationId": "13a195e11fadf3528a64dc8a0253b022", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/add-team-member": { "post": { "tags": [ "Team" ], "summary": "Add members to a team", "operationId": "4f30638967410a4a379b50f0a38b0c4e", "parameters": [ { "name": "team_id", "in": "query", "description": "ID of the team", "required": true, "schema": { "type": "integer" } }, { "name": "user_ids", "in": "query", "description": "Array of user IDs to add to the team", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "Team members added successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Team Member Added Successfully..!" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/remove-team-member": { "post": { "tags": [ "Team" ], "summary": "Remove members from a team", "operationId": "6df20bb2cd8f3de96099fd8a071b4dbe", "parameters": [ { "name": "team_id", "in": "query", "description": "ID of the team", "required": true, "schema": { "type": "integer" } }, { "name": "user_ids", "in": "query", "description": "Array of user IDs to remove from the team", "required": true, "schema": { "type": "array", "items": { "type": "integer" } } } ], "responses": { "200": { "description": "Team members removed successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Team Member Removed Successfully..!" } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-users": { "get": { "tags": [ "Team" ], "summary": "Get list of active team users", "operationId": "94f6a7945a65673a4257a4b8aeac3870", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "teams": { "type": "array", "items": { "properties": { "team_id": { "type": "integer" }, "team_name": { "type": "string" }, "team_member": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team/{team}": { "get": { "tags": [ "Team" ], "summary": "Display the specified team", "operationId": "0087180eba93ca046d27627dc7ac8196", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team retrieved successfully" }, "404": { "description": "Team not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Team" ], "summary": "Update the specified team", "operationId": "0f25e4c12d7eeba0f735a17dca7d27e3", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team to update", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team updated successfully" }, "404": { "description": "Team not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Team" ], "summary": "Delete the specified team", "operationId": "5a7235b2a4f616c4eb00a9cc3e7c8867", "parameters": [ { "name": "team", "in": "path", "description": "ID of the team to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team deleted successfully" }, "404": { "description": "Team not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member": { "get": { "tags": [ "Team Members" ], "summary": "Get all team members for the authenticated user's client", "operationId": "413e892fcb8b4dc5d5b327b49ac3b098", "responses": { "200": { "description": "List of team members retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Team Members" ], "summary": "Create a new team member", "operationId": "9c88387c305c3c772994f37fb73bf721", "parameters": [ { "name": "name_title", "in": "query", "description": "Title (Mr., Mrs., etc.)", "required": true, "schema": { "type": "string", "maxLength": 55 } }, { "name": "first_name", "in": "query", "description": "First name", "required": true, "schema": { "type": "string", "maxLength": 55 } }, { "name": "last_name", "in": "query", "description": "Last name", "required": true, "schema": { "type": "string", "maxLength": 55 } }, { "name": "email", "in": "query", "description": "Email address", "required": true, "schema": { "type": "string", "format": "email" } }, { "name": "password", "in": "query", "description": "Password", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "job_title", "in": "query", "description": "Job title", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Role", "required": true, "schema": { "type": "string" } }, { "name": "date_of_hire", "in": "query", "description": "Date of hire (YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "mobile_number", "in": "query", "description": "Mobile number", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Gender", "required": false, "schema": { "type": "string" } }, { "name": "salary", "in": "query", "description": "Salary", "required": false, "schema": { "type": "number" } }, { "name": "salary_term", "in": "query", "description": "Salary term (hourly, monthly, etc.)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Team member created successfully", "content": { "application/json": { "schema": { "properties": { "user": { "type": "object" }, "other_info": { "type": "object" }, "accessToken": { "type": "string" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Team member created and email is sent successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member/datatable/get": { "post": { "tags": [ "Team Members" ], "summary": "Get team members data formatted for datatables", "operationId": "fd7487218a860c25b8c4d884408492cd", "responses": { "200": { "description": "Team members data retrieved successfully", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/client-all-member": { "post": { "tags": [ "Team Members" ], "summary": "Get all users across all clients formatted for datatables", "operationId": "eef4af59a834c5cc2bda5d0261c9003c", "responses": { "200": { "description": "All users data retrieved successfully", "content": { "application/json": { "schema": { "properties": { "draw": { "type": "integer" }, "recordsTotal": { "type": "integer" }, "recordsFiltered": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member-add": { "post": { "tags": [ "Team Members" ], "summary": "Create a new team member with different validation requirements", "operationId": "2d6a4435fdbdd938442db0d21305b402", "parameters": [ { "name": "first_name", "in": "query", "description": "First name", "required": true, "schema": { "type": "string", "maxLength": 55 } }, { "name": "last_name", "in": "query", "description": "Last name", "required": true, "schema": { "type": "string", "maxLength": 55 } }, { "name": "email", "in": "query", "description": "Email address", "required": true, "schema": { "type": "string", "format": "email" } }, { "name": "password", "in": "query", "description": "Password", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "role", "in": "query", "description": "Role", "required": true, "schema": { "type": "string" } }, { "name": "mobile_number", "in": "query", "description": "Mobile number", "required": true, "schema": { "type": "string" } }, { "name": "emergency_contact", "in": "query", "description": "Emergency contact", "required": true, "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Address", "required": true, "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "State", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Team member created successfully", "content": { "application/json": { "schema": { "properties": { "user": { "type": "object" }, "other_info": { "type": "object" }, "accessToken": { "type": "string" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Team member created and email is sent successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member-calendar-settings-save": { "post": { "tags": [ "Team Members" ], "summary": "Save calendar settings for a team member", "operationId": "3b85d2958f135a457d0e58edad6717c5", "parameters": [ { "name": "calendar_type", "in": "query", "description": "Calendar type", "required": true, "schema": { "type": "string" } }, { "name": "calendar_username", "in": "query", "description": "Calendar username", "required": true, "schema": { "type": "string" } }, { "name": "calendar_password", "in": "query", "description": "Calendar password", "required": true, "schema": { "type": "string", "format": "password" } }, { "name": "cal_user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Calendar settings saved successfully" }, "401": { "description": "Unauthenticated" }, "404": { "description": "User not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member/{id}": { "get": { "tags": [ "Team Members" ], "summary": "Get details for a specific team member", "operationId": "54a33f92b8065333846d4c5581c7248e", "parameters": [ { "name": "id", "in": "path", "description": "Team member ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team member details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "user": { "type": "object" }, "users_info": { "type": "object" }, "profile_path": { "type": "string" }, "role": { "type": "string" }, "role_list": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "404": { "description": "Team member not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member-update/{id}": { "post": { "tags": [ "Team Members" ], "summary": "Update a team member's information", "operationId": "4d2c4c49cc009ec0655da9466f250a48", "parameters": [ { "name": "id", "in": "path", "description": "Team member ID", "required": true, "schema": { "type": "integer" } }, { "name": "first_name", "in": "query", "description": "First name", "required": false, "schema": { "type": "string", "maxLength": 55 } }, { "name": "last_name", "in": "query", "description": "Last name", "required": false, "schema": { "type": "string", "maxLength": 55 } }, { "name": "email", "in": "query", "description": "Email address", "required": false, "schema": { "type": "string", "format": "email" } }, { "name": "date_of_hire", "in": "query", "description": "Date of hire (YYYY-MM-DD)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "dob", "in": "query", "description": "Date of birth", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "name_title", "in": "query", "description": "Title (Mr., Mrs., etc.)", "required": false, "schema": { "type": "string" } }, { "name": "mobile_number", "in": "query", "description": "Mobile number", "required": false, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Gender", "required": false, "schema": { "type": "string" } }, { "name": "job_title", "in": "query", "description": "Job title", "required": false, "schema": { "type": "string" } }, { "name": "timezone", "in": "query", "description": "Timezone", "required": false, "schema": { "type": "string" } }, { "name": "nickname", "in": "query", "description": "Nickname", "required": false, "schema": { "type": "string" } }, { "name": "ni_number", "in": "query", "description": "NI number", "required": false, "schema": { "type": "string" } }, { "name": "nationality", "in": "query", "description": "Nationality", "required": false, "schema": { "type": "string" } }, { "name": "emergency_contact", "in": "query", "description": "Emergency contact", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Team member updated successfully", "content": { "application/json": { "schema": { "properties": { "user": { "type": "object" }, "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Team member updated successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" }, "404": { "description": "Team member not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-today-birthday": { "get": { "tags": [ "Team Members" ], "summary": "Get team members with birthdays today", "operationId": "f0ee36086bebd1e33911966571817793", "responses": { "200": { "description": "Today's birthdays retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-today-work-anniversary": { "get": { "tags": [ "Team Members" ], "summary": "Get team members with work anniversaries today", "operationId": "4f58e684f9739bbbf41263ae373b0765", "responses": { "200": { "description": "Today's work anniversaries retrieved successfully", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member/download-attachment": { "get": { "tags": [ "Team Members" ], "summary": "Download a team member's attachment", "operationId": "792dcdc2e5df80c2d606f1814b4b8665", "parameters": [ { "name": "id", "in": "query", "description": "User info ID", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Attachment index", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File downloaded successfully" }, "404": { "description": "File not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member/delete-attachment": { "get": { "tags": [ "Team Members" ], "summary": "Delete a team member's attachment", "operationId": "dfc54cdd11548131a934776000c38f3a", "parameters": [ { "name": "id", "in": "query", "description": "User info ID", "required": true, "schema": { "type": "integer" } }, { "name": "attachment_index", "in": "query", "description": "Attachment index", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "File deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "File deleted successfully" } }, "type": "object" } } } }, "404": { "description": "File not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-password": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's password", "operationId": "dfc86b7c21448c4cbeb08c7781b44876", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "password", "in": "query", "description": "New password", "required": true, "schema": { "type": "string", "format": "password" } } ], "responses": { "200": { "description": "Password updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Password updated successfully" } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-name": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's name", "operationId": "373ba4388e868d3e73f0dff16d341559", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "first_name", "in": "query", "description": "First name", "required": true, "schema": { "type": "string" } }, { "name": "last_name", "in": "query", "description": "Last name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Name updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Name updated successfully" } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-primary-phone": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's primary phone number", "operationId": "a5226bba76d1030b44c8e1089a6e8f82", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "mobile_number", "in": "query", "description": "Mobile number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Phone number updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-emergency-phone": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's emergency contact phone number", "operationId": "593ba74edd5d6814860acf3e7c099334", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "emergency_contact", "in": "query", "description": "Emergency contact phone number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Emergency contact updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-primary-contact": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's primary contact number", "operationId": "b79ea4f42072cc43dde905d465e8ea8e", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "primary_contact_number", "in": "query", "description": "Primary contact number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Primary contact updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-address": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's address", "operationId": "61f4afdfe4545f6d24716508bb6e88fc", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "address", "in": "query", "description": "User's address", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Address updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-status": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's status (active/inactive)", "operationId": "a729d4681f39f90adb2b7e1e170e0e8c", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "user_status", "in": "query", "description": "User status (0 for inactive, 1 for active)", "required": true, "schema": { "type": "integer", "enum": [ 0, 1 ] } } ], "responses": { "200": { "description": "Status updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "user_id": { "type": "integer" }, "user_status": { "type": "integer" } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/delete-user": { "post": { "tags": [ "Team Members" ], "summary": "Delete a user if they have no assigned leads", "operationId": "18a8d85c39bf469ae1d9d7d11af51e80", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID to delete", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "User deleted successfully or deletion prevented due to assigned leads", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/change-user-role": { "post": { "tags": [ "Team Members" ], "summary": "Update a user's role", "operationId": "187d2a180742e87d91ebdadf2f39360a", "parameters": [ { "name": "user_id", "in": "query", "description": "User ID", "required": true, "schema": { "type": "integer" } }, { "name": "role", "in": "query", "description": "Role name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Role updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Role updated successfully" } }, "type": "object" } } } }, "404": { "description": "User not found" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/zapier-custom-fields-propagation-for-assigned-to": { "get": { "tags": [ "Team Members" ], "summary": "Get team members of a client by user email for Zapier 'assigned to' propagation", "operationId": "e9f3f719f084b1956c08567f6d4d11af", "parameters": [ { "name": "userName", "in": "query", "description": "Email of the user used to identify the client", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of team members retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/team-member/{team_member}": { "put": { "tags": [ "Team Members" ], "summary": "Update the specified team member", "operationId": "6eb5de021878d0c4c53e732a2e596661", "parameters": [ { "name": "team_member", "in": "path", "description": "ID of the team member to update", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team member updated successfully" }, "404": { "description": "Team member not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Team Members" ], "summary": "Delete the specified team member and reassign their work", "operationId": "0f4476a5b49722441fc19284335b5482", "parameters": [ { "name": "team_member", "in": "path", "description": "ID of the team member to delete", "required": true, "schema": { "type": "integer" } }, { "name": "assigned_to", "in": "query", "description": "ID of the user to whom the deleted member's leads, tasks, campaigns and project memberships will be reassigned", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "User deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "User Deleted Successfully" } }, "type": "object" } } } }, "404": { "description": "User not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/telsaleads/webhook": { "post": { "tags": [ "TelsaLeads Webhook" ], "summary": "TelsaLeads webhook receiver", "description": "Receives TelsaLeads visitor-tracking events (specific_page_visited, abandoned_cart). Looks up an existing Lead by telsa_visitor_id, falling back to email; creates a new Lead + LeadContact if neither matches and a client_id is resolvable. Then dispatches a TriggerAutomationJob for the event.", "operationId": "telsaLeadsHandleWebhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "event", "visitor_id" ], "properties": { "event": { "description": "Event type", "type": "string", "example": "specific_page_visited", "enum": [ "specific_page_visited", "abandoned_cart" ] }, "visitor_id": { "description": "TelsaLeads visitor identifier", "type": "string", "example": "vst_abc123" }, "client_id": { "description": "Optional explicit client scope", "type": "integer", "nullable": true }, "site_id": { "description": "Fallback to resolve client_id via CallTracking.current_site", "type": "integer", "nullable": true }, "email": { "description": "Used as a secondary key when telsa_visitor_id doesn't match", "type": "string", "format": "email", "nullable": true }, "first_name": { "description": "Used when creating a new lead contact (default 'Website')", "type": "string", "nullable": true }, "last_name": { "description": "Used when creating a new lead contact (default 'Visitor')", "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "data": { "description": "Event-specific payload", "properties": { "page_url": { "description": "Used by specific_page_visited to match automation rules", "type": "string", "nullable": true } }, "type": "object", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook processed", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Webhook processed successfully" } }, "type": "object" } } } }, "404": { "description": "No matching lead and client_id could not be resolved", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Lead not found and client_id missing" } }, "type": "object" } } } }, "422": { "description": "Validation error (missing event or visitor_id)" } } } }, "/api/ticket": { "get": { "tags": [ "Tickets" ], "summary": "Get all tickets", "operationId": "91f89830cd8e2ef054124d4f2f0b167d", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "tickets": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "description": "No data found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Tickets" ], "summary": "Create a new ticket", "operationId": "57a42931900b7ea26b87dc822429b792", "parameters": [ { "name": "title", "in": "query", "description": "Ticket title", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Ticket description", "required": true, "schema": { "type": "string" } }, { "name": "ticket_type_id", "in": "query", "description": "Ticket type ID", "required": true, "schema": { "type": "integer" } }, { "name": "client_id", "in": "query", "description": "Client ID", "required": false, "schema": { "type": "integer" } }, { "name": "assigned_to", "in": "query", "description": "User ID to assign the ticket to", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Ticket status", "required": false, "schema": { "type": "string", "enum": [ "open", "in progress", "closed" ] } }, { "name": "priority", "in": "query", "description": "Ticket priority", "required": false, "schema": { "type": "string", "enum": [ "low", "medium", "high" ] } }, { "name": "attachment", "in": "query", "description": "Ticket attachment", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket created successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Ticket created successfully" }, "data": { "type": "object" } }, "type": "object" } } } }, "400": { "description": "Error creating ticket" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket/datatable/get": { "post": { "tags": [ "Tickets" ], "summary": "Get tickets for datatable", "operationId": "69aa36e4765266f3ee2c621efcc7e139", "parameters": [ { "name": "assigned_to", "in": "query", "description": "Filter by assigned user IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "ticket_type_id", "in": "query", "description": "Filter by ticket type IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "client_id", "in": "query", "description": "Filter by client IDs", "required": false, "schema": { "type": "array", "items": { "type": "integer" } } }, { "name": "status", "in": "query", "description": "Filter by status", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket/{id}": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket details", "operationId": "c18723a4903333fcbf81e288f6dba93c", "parameters": [ { "name": "id", "in": "path", "description": "Ticket ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "ticket": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Ticket not found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Tickets" ], "summary": "Update a ticket", "operationId": "a04b47df28f5a1d94621a0681514ca5c", "parameters": [ { "name": "id", "in": "path", "description": "Ticket ID", "required": true, "schema": { "type": "integer" } }, { "name": "title", "in": "query", "description": "Ticket title", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Ticket description", "required": false, "schema": { "type": "string" } }, { "name": "ticket_type_id", "in": "query", "description": "Ticket type ID", "required": false, "schema": { "type": "integer" } }, { "name": "assigned_to", "in": "query", "description": "User ID to assign the ticket to", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Ticket status", "required": false, "schema": { "type": "string", "enum": [ "open", "in progress", "closed" ] } }, { "name": "priority", "in": "query", "description": "Ticket priority", "required": false, "schema": { "type": "string", "enum": [ "low", "medium", "high" ] } } ], "responses": { "200": { "description": "Ticket updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ticket updated successfully" } }, "type": "object" } } } }, "404": { "description": "Ticket not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Tickets" ], "summary": "Delete a ticket", "operationId": "4c5b0354ff93312725e6b8a9999ea236", "parameters": [ { "name": "id", "in": "path", "description": "Ticket ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Ticket deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ticket deleted successfully" } }, "type": "object" } } } }, "404": { "description": "Ticket not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket-comment": { "post": { "tags": [ "Tickets" ], "summary": "Add a new comment to a ticket", "operationId": "176bcd001986c68c8524c80d8f38e9ea", "parameters": [ { "name": "ticket_id", "in": "query", "description": "Ticket ID", "required": true, "schema": { "type": "integer" } }, { "name": "comment", "in": "query", "description": "Comment text", "required": true, "schema": { "type": "string" } }, { "name": "attachment", "in": "query", "description": "Comment attachment", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Comment added successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Comment added successfully" } }, "type": "object" } } } }, "400": { "description": "Error adding comment" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket-comment/{id}": { "get": { "tags": [ "Tickets" ], "summary": "Get comments for a ticket", "operationId": "9665297a1118a9c5d745fa66c5ad8dfb", "parameters": [ { "name": "id", "in": "path", "description": "Ticket ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "comments": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "Ticket not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket-comment/download-attachment": { "get": { "tags": [ "Tickets" ], "summary": "Download ticket comment attachment", "operationId": "04555f13483c852122e8e575c93add69", "parameters": [ { "name": "file_name", "in": "query", "description": "File name to download", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File downloaded successfully" }, "404": { "description": "File not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/s3-image-upload": { "post": { "tags": [ "Tickets" ], "summary": "Upload an image for a ticket", "operationId": "cd8812e34a94783f49d83bbd9f7389ab", "parameters": [ { "name": "image", "in": "query", "description": "Image file to upload", "required": true, "schema": { "type": "string", "format": "binary" } } ], "responses": { "200": { "description": "Image uploaded successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "image_name": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Error uploading image" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/tickets-update-status": { "post": { "tags": [ "Tickets" ], "summary": "Update ticket status", "operationId": "b74c198562a88b7eca91ff95385c881c", "parameters": [ { "name": "id", "in": "query", "description": "Ticket ID", "required": true, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "New status for the ticket", "required": true, "schema": { "type": "string", "enum": [ "open", "in progress", "closed" ] } } ], "responses": { "200": { "description": "Status updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Status updated successfully" } }, "type": "object" } } } }, "404": { "description": "Ticket not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket-type": { "get": { "tags": [ "Ticket Types" ], "summary": "Get all ticket types", "operationId": "f2ba2cb76aed75477b9ca949496e29b6", "responses": { "200": { "description": "List of all ticket types", "content": { "application/json": { "schema": { "properties": { "types": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "404": { "description": "No data found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Ticket Types" ], "summary": "Create a new ticket type", "operationId": "636b809d1ef584275b3819a6c2391f98", "parameters": [ { "name": "title", "in": "query", "description": "Title of the ticket type", "required": true, "schema": { "type": "string", "example": "Support" } } ], "responses": { "200": { "description": "Ticket type created successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ticket type added successfully." } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket-type/{id}": { "put": { "tags": [ "Ticket Types" ], "summary": "Update an existing ticket type", "operationId": "8d4258629b6ceba5d358dd687e53e4cd", "parameters": [ { "name": "id", "in": "path", "description": "ID of the ticket type to update", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "title", "in": "query", "description": "New title for the ticket type", "required": true, "schema": { "type": "string", "example": "Technical Support" } } ], "responses": { "200": { "description": "Ticket type updated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ticket type update successfully." } }, "type": "object" } } } }, "404": { "description": "Ticket type not found" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Ticket Types" ], "summary": "Delete a ticket type", "operationId": "96ef3cf56505c0aeeb2a49fcf0898cc1", "parameters": [ { "name": "id", "in": "path", "description": "ID of the ticket type to delete", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "Ticket type deleted successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Ticket type deleted successfully." } }, "type": "object" } } } }, "404": { "description": "Ticket type not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/ticket-type/{ticket_type}": { "get": { "tags": [ "Ticket Type" ], "summary": "Show a single ticket type (resource show – placeholder, not currently implemented)", "operationId": "f0d7322fc0894ebd740edeef693908fa", "parameters": [ { "name": "ticket_type", "in": "path", "description": "Ticket type ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/tiktok-authorization": { "get": { "tags": [ "Tiktok" ], "summary": "Connect to TikTok and return user info plus video list, or return an auth link", "operationId": "8a8512073dfefec1d6f3fdd6c743744c", "parameters": [ { "name": "cursor", "in": "query", "description": "Pagination cursor for the TikTok video list", "required": false, "schema": { "type": "integer", "example": 0 } } ], "responses": { "200": { "description": "TikTok connection details retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "token": { "type": "string" }, "user_info": { "type": "object" }, "video_list": { "type": "object" }, "auth_link": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/tiktok/callback": { "get": { "tags": [ "Tiktok" ], "summary": "Handle TikTok OAuth callback and persist access tokens", "operationId": "d6169ca80413db29dd74f90dc595d26a", "parameters": [ { "name": "code", "in": "query", "description": "Authorization code returned by TikTok", "required": false, "schema": { "type": "string" } }, { "name": "error", "in": "query", "description": "Error code returned by TikTok when authorization fails", "required": false, "schema": { "type": "string" } }, { "name": "error_description", "in": "query", "description": "Human-readable error description from TikTok", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TikTok logged in successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "TikTok logged in" } }, "type": "object" } } } }, "500": { "description": "Something went wrong" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/tiktok/upload": { "post": { "tags": [ "Tiktok" ], "summary": "Upload a video to S3 and queue an inbox upload job to TikTok", "operationId": "e6723bd5f98b5e6ffef5ee8f8b6962a2", "parameters": [ { "name": "video", "in": "query", "description": "MP4 video file (max 500MB)", "required": true, "schema": { "type": "string", "format": "binary" } }, { "name": "description", "in": "query", "description": "Optional video description (max 200 chars)", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Video uploaded to S3 and TikTok upload queued", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Video uploaded to S3. TikTok upload queued." }, "upload_id": { "type": "integer" }, "s3_path": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/tiktok/direct-post": { "post": { "tags": [ "Tiktok" ], "summary": "Upload a video to S3 and queue a direct publish job to TikTok", "operationId": "703f2db228d510d4be6c60a06758c34f", "parameters": [ { "name": "video", "in": "query", "description": "MP4 video file (max 500MB)", "required": true, "schema": { "type": "string", "format": "binary" } }, { "name": "description", "in": "query", "description": "Optional video description (max 200 chars)", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Video uploaded to S3 and TikTok publish queued", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Video uploaded to S3. TikTok upload queued." }, "upload_id": { "type": "integer" }, "s3_path": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/turnover-options": { "get": { "tags": [ "Turnover Settings" ], "summary": "Get turnover field settings for the authenticated user's client", "operationId": "abd9035fc12d8f82806bbf3420c0fc52", "responses": { "200": { "description": "Turnover settings retrieved successfully", "content": { "application/json": { "schema": { "properties": { "settings": { "type": "array", "items": { "type": "object" } }, "lead_positions": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Turnover Settings" ], "summary": "Save turnover field settings for the authenticated user's client", "operationId": "4f135d1b1ae1458304a63d2b61c107c4", "parameters": [ { "name": "settings", "in": "query", "description": "Array of turnover settings to save", "required": true, "schema": { "type": "array", "items": { "properties": { "name": { "type": "string", "example": "0-10k" }, "visibility_position_wise": { "type": "array", "items": { "type": "object" } }, "sort": { "type": "integer", "example": 1 } }, "type": "object" } } } ], "responses": { "200": { "description": "Settings saved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Settings saved successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation failed" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/turnover-options/{id}": { "put": { "tags": [ "Turnover Settings" ], "summary": "Update a specific turnover field setting", "operationId": "d91a02846a363ad1277208ac6dc0de5a", "parameters": [ { "name": "id", "in": "path", "description": "ID of the turnover setting to update", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "name", "in": "query", "description": "Name of the turnover setting", "required": true, "schema": { "type": "string", "example": "10k-50k" } }, { "name": "visibility_position_wise", "in": "query", "description": "JSON array of position-wise visibility settings", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "sort", "in": "query", "description": "Sort order of the setting", "required": false, "schema": { "type": "integer", "example": 2 } } ], "responses": { "200": { "description": "Settings updated successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Settings updated successfully." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Validation failed" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/login": { "get": { "tags": [ "Twitter" ], "summary": "Generate X (Twitter) OAuth login URL", "operationId": "270ecfc9664aae37f147223dee88f6a5", "responses": { "200": { "description": "Login URL generated successfully" }, "500": { "description": "Failed to generate login URL" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/callback": { "post": { "tags": [ "Twitter" ], "summary": "Handle X (Twitter) OAuth callback and connect account", "operationId": "7ae67f2c0f212f54baf8cf06203612b0", "parameters": [ { "name": "code", "in": "query", "description": "Authorization code returned by X", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "OAuth state parameter returned by X", "required": true, "schema": { "type": "string" } }, { "name": "code_verifier", "in": "query", "description": "PKCE code verifier", "required": true, "schema": { "type": "string" } }, { "name": "original_state", "in": "query", "description": "Original state to validate the callback", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Twitter account connected successfully" }, "404": { "description": "Invalid user ID provided" }, "500": { "description": "Twitter connection failed" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/status": { "get": { "tags": [ "Twitter" ], "summary": "Get current CRM user's Twitter connection status", "operationId": "49708e9d93dc37ea3b3619989661ca56", "responses": { "200": { "description": "Connection status retrieved successfully" }, "500": { "description": "Twitter status error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/user/me": { "get": { "tags": [ "Twitter" ], "summary": "Get authenticated Twitter user's profile", "operationId": "f82c61d27b47a8675ecbcf8ccee2c30f", "responses": { "200": { "description": "User profile retrieved successfully" }, "500": { "description": "Failed to retrieve user profile" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/disconnect": { "post": { "tags": [ "Twitter" ], "summary": "Disconnect Twitter account from CRM user", "operationId": "d1b4bd9352e93a85b1bcf378ce77a320", "responses": { "200": { "description": "Twitter account disconnected successfully" }, "500": { "description": "Failed to disconnect Twitter account" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/post": { "post": { "tags": [ "Twitter" ], "summary": "Create a new tweet (immediate or scheduled)", "operationId": "5c28bc1ef141d8ff0bbcd4db217870eb", "parameters": [ { "name": "text", "in": "query", "description": "Tweet text (max 280 characters)", "required": false, "schema": { "type": "string", "maxLength": 280 } }, { "name": "images", "in": "query", "description": "Up to 4 media files (jpg, jpeg, png, webp, bmp, tif, tiff, gif, mp4)", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "binary" }, "maxItems": 4 } }, { "name": "scheduled_at", "in": "query", "description": "Optional schedule time (must be in the future and within 160 days)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "in_reply_to_tweet_id", "in": "query", "description": "Optional tweet ID this post is replying to", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tweet posted or scheduled successfully" }, "500": { "description": "Failed to post or schedule tweet" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/share": { "post": { "tags": [ "Twitter" ], "summary": "Share (retweet) a tweet", "operationId": "66b4a4db4c70e3388d2748329a712906", "parameters": [ { "name": "tweet_id", "in": "query", "description": "ID of the tweet to share", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tweet shared successfully" }, "500": { "description": "Failed to share tweet" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/delete": { "post": { "tags": [ "Twitter" ], "summary": "Delete a tweet", "operationId": "549eb8c536107df749c35109fb6668ad", "parameters": [ { "name": "tweet_id", "in": "query", "description": "ID of the tweet to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tweet deleted successfully" }, "500": { "description": "Failed to delete tweet" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/like": { "post": { "tags": [ "Twitter" ], "summary": "Like or unlike a tweet", "operationId": "a96a2d6df264d2d8272a8f047f413946", "parameters": [ { "name": "tweet_id", "in": "query", "description": "ID of the tweet to like or unlike", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tweet liked or unliked successfully" }, "500": { "description": "Failed to like/unlike tweet" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/timeline": { "get": { "tags": [ "Twitter" ], "summary": "Get authenticated user's Twitter timeline", "operationId": "72754ac1b95adfdb705faa3f530f5ed7", "parameters": [ { "name": "max_results", "in": "query", "description": "Maximum number of tweets to return (1-100)", "required": false, "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 1 } }, { "name": "pagination_token", "in": "query", "description": "Pagination token for fetching the next page", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Timeline retrieved successfully" }, "500": { "description": "Failed to retrieve timeline" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/tweet/{id}": { "get": { "tags": [ "Twitter" ], "summary": "Get a single tweet with full details and optional replies", "operationId": "60b42434ee9118fcc3033b8010a347a4", "parameters": [ { "name": "id", "in": "path", "description": "ID of the tweet to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "include_replies", "in": "query", "description": "Whether to fetch replies (true/false/1/0)", "required": false, "schema": { "type": "string", "enum": [ "true", "false", "1", "0" ] } }, { "name": "max_replies", "in": "query", "description": "Maximum number of replies to fetch (10-100)", "required": false, "schema": { "type": "integer", "default": 10, "maximum": 100, "minimum": 10 } }, { "name": "pagination_token", "in": "query", "description": "Pagination token for fetching the next page of replies", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Tweet retrieved successfully" }, "500": { "description": "Failed to retrieve tweet" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/scheduled": { "get": { "tags": [ "Twitter" ], "summary": "Get all scheduled tweets for the authenticated user", "operationId": "972d3e2ca28cfa796dd45cc8a33a3ea9", "parameters": [ { "name": "status", "in": "query", "description": "Optional filter by scheduled tweet status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Scheduled tweets retrieved successfully" }, "500": { "description": "Failed to retrieve scheduled tweets" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/twitter/scheduled/{scheduledTweetId}": { "get": { "tags": [ "Twitter" ], "summary": "Get a single scheduled tweet's details", "operationId": "3d837d996ad6ce65f936b1266d2531bf", "parameters": [ { "name": "scheduledTweetId", "in": "path", "description": "ID of the scheduled tweet", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Scheduled tweet retrieved successfully" }, "404": { "description": "Scheduled tweet not found" }, "500": { "description": "Failed to retrieve scheduled tweet" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Twitter" ], "summary": "Cancel a scheduled tweet", "operationId": "769626af22b23f13a5fe66bd328debb4", "parameters": [ { "name": "scheduledTweetId", "in": "path", "description": "ID of the scheduled tweet to cancel", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Scheduled tweet cancelled successfully" }, "404": { "description": "Scheduled tweet not found" }, "500": { "description": "Failed to cancel scheduled tweet" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Twitter" ], "summary": "Update a scheduled tweet (only if still pending)", "operationId": "4cfa44e67504537bf0a9f0d27f9083c3", "parameters": [ { "name": "scheduledTweetId", "in": "path", "description": "ID of the scheduled tweet to update", "required": true, "schema": { "type": "integer" } }, { "name": "text", "in": "query", "description": "Updated tweet text (max 280 characters)", "required": false, "schema": { "type": "string", "maxLength": 280 } }, { "name": "images", "in": "query", "description": "Up to 4 media files (jpg, jpeg, png, webp, bmp, tif, tiff, gif, mp4)", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "binary" }, "maxItems": 4 } }, { "name": "scheduled_at", "in": "query", "description": "Updated schedule time (must be in the future and within 160 days)", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "in_reply_to_tweet_id", "in": "query", "description": "Optional tweet ID this post is replying to", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Scheduled tweet updated successfully" }, "404": { "description": "Scheduled tweet not found" }, "500": { "description": "Failed to update scheduled tweet" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/get-user-signature": { "post": { "tags": [ "User" ], "summary": "Get user signature", "operationId": "5942936e6e261370849001fc2f0df509", "parameters": [ { "name": "user_id", "in": "query", "description": "ID of the user", "required": true, "schema": { "type": "integer", "example": 1 } } ], "responses": { "200": { "description": "User signature retrieved successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": true }, "data": { "properties": { "signature_type": { "type": "string", "example": "default" }, "custom_signature": { "type": "string", "example": "John Doe
CEO
John Doe
CEO
John Doe
CEO
John Doe
CEO