{ "openapi": "3.0.0", "info": { "title": "BREEZY Application", "version": "1.0.1", "description": "BREEZY BackEnd", "contact": { "name": "Breezy TMS" } }, "paths": { "/new-driver-applications/company-info/{usdot}": { "get": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "getCompanyInfoByUsdot", "tags": [ "NewDriverApplicationController" ], "summary": "Get public company info by USDOT", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "usdot", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverApplicationController.getCompanyInfoByUsdot" } }, "/new-driver-applications/delete-document/{recruitmentId}": { "delete": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "deleteDocument", "tags": [ "NewDriverApplicationController" ], "summary": "Delete document driver application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverApplicationController.deleteDocument" } }, "/new-driver-applications/driver-application/upload-document/{recruitmentId}": { "post": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "driverApplicationUploadDocument", "tags": [ "NewDriverApplicationController" ], "summary": "upload document", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "NewDriverApplicationController.driverApplicationUploadDocument" } }, "/new-driver-applications/driver-license-prompt/{usdot}": { "post": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "driverLicensePrompt", "tags": [ "NewDriverApplicationController" ], "summary": "Generate driver license details with Gemini AI", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "usdot", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "NewDriverApplicationController.driverLicensePrompt" } }, "/new-driver-applications/driver-license-prompt-v2": { "post": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "driverLicensePromptV2", "tags": [ "NewDriverApplicationController" ], "summary": "Generate driver license details with Gemini AI", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "NewDriverApplicationController.driverLicensePromptV2" } }, "/new-driver-applications/get-consents/{recruitmentId}": { "get": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "driverConsents", "tags": [ "NewDriverApplicationController" ], "summary": "Get Consents driver application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverApplicationController.driverConsents" } }, "/new-driver-applications/get-document/view/{documentId}": { "get": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "getFileViewApplication", "tags": [ "NewDriverApplicationController" ], "summary": "Get document driver application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "NewDriverApplicationController.getFileViewApplication" } }, "/new-driver-applications/get-document/{recruitmentId}": { "get": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "getDocumentApplication", "tags": [ "NewDriverApplicationController" ], "summary": "Get document driver application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverApplicationController.getDocumentApplication" } }, "/new-driver-applications/get-dqf-documents/{recruitmentId}": { "get": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "getDocumentDqf", "tags": [ "NewDriverApplicationController" ], "summary": "Get documents dqf driver application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverApplicationController.getDocumentDqf" } }, "/new-driver-applications/send-application-link/{email}": { "post": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "sendApplicationLink", "tags": [ "NewDriverApplicationController" ], "responses": { "200": { "description": "Return value of NewDriverApplicationController.sendApplicationLink" } }, "parameters": [ { "name": "email", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverApplicationController.sendApplicationLink" } }, "/new-driver-applications/view/{recruitmentId}": { "get": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "getView", "tags": [ "NewDriverApplicationController" ], "summary": "Get driver application with Relations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverApplicationController.getView" } }, "/new-driver-applications/{usdot}": { "post": { "x-controller-name": "NewDriverApplicationController", "x-operation-name": "createApplication", "tags": [ "NewDriverApplicationController" ], "summary": "Create a new driver application", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "usdot", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDriverApplicationCreateData" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewDriverApplicationController.createApplication" } }, "/new-driver-employments/request-all/{recruitmentId}": { "post": { "x-controller-name": "NewDriverEmploymentController", "x-operation-name": "sendAllPendingXchangeRequests", "tags": [ "NewDriverEmploymentController" ], "summary": "Send xchange requests for all pending employments", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewXchangeRequestAllPendingDto" } } }, "x-parameter-index": 1 }, "operationId": "NewDriverEmploymentController.sendAllPendingXchangeRequests" } }, "/new-driver-employments/resend/{newDriverEmploymentId}": { "post": { "x-controller-name": "NewDriverEmploymentController", "x-operation-name": "resendXchangeForEmployment", "tags": [ "NewDriverEmploymentController" ], "summary": "Resend xchange request for employment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "newDriverEmploymentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewXchangeResendDto" } } }, "x-parameter-index": 1 }, "operationId": "NewDriverEmploymentController.resendXchangeForEmployment" } }, "/new-driver-employments/{newDriverEmploymentId}": { "post": { "x-controller-name": "NewDriverEmploymentController", "x-operation-name": "markEmploymentVerified", "tags": [ "NewDriverEmploymentController" ], "summary": "Mark certain employment verified", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "newDriverEmploymentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverEmploymentController.markEmploymentVerified" } }, "/new-driver-employments/{recruitmentId}": { "get": { "x-controller-name": "NewDriverEmploymentController", "x-operation-name": "getEmploymentsByRecruitment", "tags": [ "NewDriverEmploymentController" ], "summary": "List all employments of a recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverEmploymentController.getEmploymentsByRecruitment" } }, "/new-driver-licenses/{recruitmentId}": { "post": { "x-controller-name": "NewDriverLicenseController", "x-operation-name": "createDriverLicense", "tags": [ "NewDriverLicenseController" ], "summary": "Add driver license to an existing driver-sourced recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDriverLicenseCreateData" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewDriverLicenseController.createDriverLicense" }, "get": { "x-controller-name": "NewDriverLicenseController", "x-operation-name": "listDriverLicenses", "tags": [ "NewDriverLicenseController" ], "summary": "Returns all the driver licenses that belong to certain recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewDriverLicenseController.listDriverLicenses" } }, "/new-recruitment-documents/document/{id}": { "delete": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "deleteRecruitmentDocumentV2", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Delete recruitment document GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentDocumentController.deleteRecruitmentDocumentV2" } }, "/new-recruitment-documents/get-document/{documentId}": { "get": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "downloadRecruitmentDocumentV2", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Download recruitment document GRPC FILE", "responses": { "200": { "description": "The file content", "content": { "application/json": { "schema": { "type": "object" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentDocumentController.downloadRecruitmentDocumentV2" } }, "/new-recruitment-documents/preview-document/{documentId}": { "get": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "previewRecruitmentDocumentV2", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Download recruitment document GRPC FILE", "responses": { "200": { "description": "The file content", "content": { "application/json": { "schema": { "type": "object" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "NewRecruitmentDocumentController.previewRecruitmentDocumentV2" } }, "/new-recruitment-documents/request-documents/{requestId}": { "get": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "fetchRequestDocuments", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Fetch xchange request documents", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "category", "in": "query", "schema": { "type": "string" } } ], "operationId": "NewRecruitmentDocumentController.fetchRequestDocuments" } }, "/new-recruitment-documents/request-signature/{recruitmentId}/{email}": { "post": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "requestSignature", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Request a signature by sending an email to driver", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "email", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentDocumentController.requestSignature" } }, "/new-recruitment-documents/signature-data-by-token/{token}": { "get": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "signatureDataByToken", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Fetch signature-request data with token", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentDocumentController.signatureDataByToken" } }, "/new-recruitment-documents/signature-document/{usdot}": { "post": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "uploadSignatureDocument", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Upload signature document", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "usdot", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentDocumentController.uploadSignatureDocument" } }, "/new-recruitment-documents/signature-documents/{recruitmentId}": { "get": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "getSignatureDocuments", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Fetch recruitment signature documents", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentDocumentController.getSignatureDocuments" } }, "/new-recruitment-documents/upload-requested-signature": { "post": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "requestedSignatureDocumentV2", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Upload requested signature document GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "NewRecruitmentDocumentController.requestedSignatureDocumentV2" } }, "/new-recruitment-documents/{recruitmentId}": { "post": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "uploadRecruitmentDocumentV2", "tags": [ "NewRecruitmentDocumentController" ], "summary": "Upload document for a recruitment GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "query", "schema": { "enum": [ "application", "clearinghouse_consent", "clearinghouse_results", "test_result", "test_form", "psp", "employment_verifications", "driver_med_certification", "road_test", "other", "mvr", "road_test_certification_pdf", "road_test_certificate", "road_test_pdf", "road_test_signature", "road_test_certificate_signature", "cdl", "cdl_backside", "ssn_card", "agreement" ], "type": "string" }, "required": true }, { "name": "expirationDate", "in": "query", "schema": { "type": "string" } }, { "name": "issueDate", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "NewRecruitmentDocumentController.uploadRecruitmentDocumentV2" }, "get": { "x-controller-name": "NewRecruitmentDocumentController", "x-operation-name": "listRecruitmentDocuments", "tags": [ "NewRecruitmentDocumentController" ], "summary": "List documents of a recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "category", "in": "query", "schema": { "enum": [ "general", "DQF", "pre-employment" ], "type": "string" } }, { "name": "type", "in": "query", "schema": { "enum": [ "application", "clearinghouse_consent", "clearinghouse_results", "test_result", "test_form", "psp", "employment_verifications", "driver_med_certification", "road_test", "other", "mvr", "road_test_certification_pdf", "road_test_certificate", "road_test_pdf", "road_test_signature", "road_test_certificate_signature", "cdl", "cdl_backside", "ssn_card", "agreement" ], "type": "string" } }, { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "number" } }, { "name": "perPage", "in": "query", "schema": { "minimum": 1, "default": 30, "type": "number" } } ], "operationId": "NewRecruitmentDocumentController.listRecruitmentDocuments" } }, "/new-recruitment-driver-clearing-house/by-recruitment/{recruitmentId}": { "get": { "x-controller-name": "DriverClearingHouseController", "x-operation-name": "findByRecruitmentId", "tags": [ "DriverClearingHouseController" ], "responses": { "200": { "description": "Return value of DriverClearingHouseController.findByRecruitmentId" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverClearingHouseController.findByRecruitmentId" } }, "/new-recruitment-driver-clearing-house/exempt/{recruitmentId}": { "post": { "x-controller-name": "DriverClearingHouseController", "x-operation-name": "markExempt", "tags": [ "DriverClearingHouseController" ], "responses": { "200": { "description": "Return value of DriverClearingHouseController.markExempt" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverClearingHouseExemptDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverClearingHouseController.markExempt" } }, "/new-recruitment-driver-clearing-house/exempt/{driverClearingHouseId}": { "delete": { "x-controller-name": "DriverClearingHouseController", "x-operation-name": "deleteExempt", "tags": [ "DriverClearingHouseController" ], "responses": { "200": { "description": "Return value of DriverClearingHouseController.deleteExempt" } }, "parameters": [ { "name": "driverClearingHouseId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverClearingHouseController.deleteExempt" } }, "/new-recruitment-driver-clearing-house/query/{recruitmentId}": { "post": { "x-controller-name": "DriverClearingHouseController", "x-operation-name": "clearinghouseQuery", "tags": [ "DriverClearingHouseController" ], "summary": "Upload clearinghouse document for recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "issueDate", "in": "query", "schema": { "type": "string" } }, { "name": "expirationDate", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 3 }, "operationId": "DriverClearingHouseController.clearinghouseQuery" } }, "/new-recruitment-driver-clearing-house/request/{recruitmentId}": { "post": { "x-controller-name": "DriverClearingHouseController", "x-operation-name": "request", "tags": [ "DriverClearingHouseController" ], "responses": { "200": { "description": "Return value of DriverClearingHouseController.request" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverClearingHouseRequestDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverClearingHouseController.request" } }, "/new-recruitment-driver-clearing-house/{driverClearingHouseId}": { "get": { "x-controller-name": "DriverClearingHouseController", "x-operation-name": "findById", "tags": [ "DriverClearingHouseController" ], "responses": { "200": { "description": "Return value of DriverClearingHouseController.findById" } }, "parameters": [ { "name": "driverClearingHouseId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverClearingHouseController.findById" } }, "/new-recruitment-driver-drug-test/by-recruitment/{recruitmentId}": { "get": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "findByRecruitmentId", "tags": [ "DriverPreEmploymentDrugTestController" ], "responses": { "200": { "description": "Return value of DriverPreEmploymentDrugTestController.findByRecruitmentId" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPreEmploymentDrugTestController.findByRecruitmentId" } }, "/new-recruitment-driver-drug-test/info/{recruitmentId}": { "get": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "info", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPreEmploymentDrugTestController.info" } }, "/new-recruitment-driver-drug-test/pre-employer/preview-file/{documentId}": { "get": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "perEmployerFileViaPreviewGrpc", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverPreEmploymentDrugTestController.perEmployerFileViaPreviewGrpc" } }, "/new-recruitment-driver-drug-test/pre-employer/{recruitmentId}": { "post": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "create", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverPreEmploymentDrugTestDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverPreEmploymentDrugTestController.create" } }, "/new-recruitment-driver-drug-test/pre-employer/{driverDrugTestId}": { "get": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "findByIdDrugTest", "tags": [ "DriverPreEmploymentDrugTestController" ], "responses": { "200": { "description": "Return value of DriverPreEmploymentDrugTestController.findByIdDrugTest" } }, "parameters": [ { "name": "driverDrugTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPreEmploymentDrugTestController.findByIdDrugTest" } }, "/new-recruitment-driver-drug-test/pre-employer-delete/{driverDrugTestId}": { "delete": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "drugDrugTestPreEmployer", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "Order Drug Test Cancel", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverDrugTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPreEmploymentDrugTestController.drugDrugTestPreEmployer" } }, "/new-recruitment-driver-drug-test/pre-employer-document/{documentId}": { "delete": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "deletePreEmployerDrugTestDocument", "tags": [ "DriverPreEmploymentDrugTestController" ], "responses": { "200": { "description": "Return value of DriverPreEmploymentDrugTestController.deletePreEmployerDrugTestDocument" } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPreEmploymentDrugTestController.deletePreEmployerDrugTestDocument" } }, "/new-recruitment-driver-drug-test/pre-employer-edit/{driverDrugTestId}": { "patch": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "updateById", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverDrugTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverPreEmploymentDrugTestDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverPreEmploymentDrugTestController.updateById" } }, "/new-recruitment-driver-drug-test/preview-file/{documentId}": { "get": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "mvrFileViaPreviewGrpc", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverPreEmploymentDrugTestController.mvrFileViaPreviewGrpc" } }, "/new-recruitment-driver-drug-test/quest-drug-test/cancel/{driverDrugTestId}": { "delete": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "drugDrugTestCancel", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "Order Drug Test Cancel", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverDrugTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPreEmploymentDrugTestController.drugDrugTestCancel" } }, "/new-recruitment-driver-drug-test/quest-drug-test/{recruitmentId}": { "post": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "createQuestDrugTest", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "Order Drug Test Create", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestOrderDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverPreEmploymentDrugTestController.createQuestDrugTest" } }, "/new-recruitment-driver-drug-test/quest-drug-test/{driverDrugTestId}": { "patch": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "drugDrugTest", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "Order Drug Test Edit", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverDrugTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuestOrderDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverPreEmploymentDrugTestController.drugDrugTest" } }, "/new-recruitment-driver-drug-test/upload-document/chain-custody/{driverDrugTestId}": { "post": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "uploadDrugTestChainOfCustodyDocument", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "Drug Test Chain of Custody GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverDrugTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverPreEmploymentDrugTestController.uploadDrugTestChainOfCustodyDocument" } }, "/new-recruitment-driver-drug-test/upload-document/{driverDrugTestId}": { "post": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "uploadDrugTestResultDocument", "tags": [ "DriverPreEmploymentDrugTestController" ], "summary": "Drug Test Result GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverDrugTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverPreEmploymentDrugTestController.uploadDrugTestResultDocument" } }, "/new-recruitment-driver-drug-test/{documentId}": { "delete": { "x-controller-name": "DriverPreEmploymentDrugTestController", "x-operation-name": "deleteDocument", "tags": [ "DriverPreEmploymentDrugTestController" ], "responses": { "200": { "description": "Return value of DriverPreEmploymentDrugTestController.deleteDocument" } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPreEmploymentDrugTestController.deleteDocument" } }, "/new-recruitment-driver-medical-card/by-recruitment/{recruitmentId}": { "get": { "x-controller-name": "DriverMedCardController", "x-operation-name": "findByRecruitmentId", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.findByRecruitmentId" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMedCardController.findByRecruitmentId" } }, "/new-recruitment-driver-medical-card/check/phone-token/{token}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "checkMedicalCardByTokenToken", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.checkMedicalCardByTokenToken" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMedCardController.checkMedicalCardByTokenToken" } }, "/new-recruitment-driver-medical-card/check-token/{token}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "checkMedicalCardToken", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.checkMedicalCardToken" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMedCardController.checkMedicalCardToken" } }, "/new-recruitment-driver-medical-card/create/by-token/{token}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "checkTokenAndAddMedicalCard", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.checkTokenAndAddMedicalCard" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverMedicalCardByTokenDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverMedCardController.checkTokenAndAddMedicalCard" } }, "/new-recruitment-driver-medical-card/create/phone-token/{token}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "checkPhoneTokenAndAddMedicalCard", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.checkPhoneTokenAndAddMedicalCard" } }, "parameters": [ { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverMedicalCardByTokenDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverMedCardController.checkPhoneTokenAndAddMedicalCard" } }, "/new-recruitment-driver-medical-card/delete/{medicalCardId}": { "delete": { "x-controller-name": "DriverMedCardController", "x-operation-name": "deleteById", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.deleteById" } }, "parameters": [ { "name": "medicalCardId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMedCardController.deleteById" } }, "/new-recruitment-driver-medical-card/delete-file/{documentId}": { "delete": { "x-controller-name": "DriverMedCardController", "x-operation-name": "deleteDocument", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.deleteDocument" } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMedCardController.deleteDocument" } }, "/new-recruitment-driver-medical-card/exempt/{medicalCardId}": { "delete": { "x-controller-name": "DriverMedCardController", "x-operation-name": "deleteExemptById", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.deleteExemptById" } }, "parameters": [ { "name": "medicalCardId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMedCardController.deleteExemptById" } }, "/new-recruitment-driver-medical-card/preview-file/by-token/{documentId}/{token}": { "get": { "x-controller-name": "DriverMedCardController", "x-operation-name": "mvrFileViaTokenPreviewGrpc", "tags": [ "DriverMedCardController" ], "summary": "GRPC Via token FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverMedCardController.mvrFileViaTokenPreviewGrpc" } }, "/new-recruitment-driver-medical-card/preview-file/phone-token/{documentId}/{token}": { "get": { "x-controller-name": "DriverMedCardController", "x-operation-name": "mvrFileViaPhoneTokenPreviewGrpc", "tags": [ "DriverMedCardController" ], "summary": "GRPC Via phone token FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverMedCardController.mvrFileViaPhoneTokenPreviewGrpc" } }, "/new-recruitment-driver-medical-card/preview-file/{documentId}": { "get": { "x-controller-name": "DriverMedCardController", "x-operation-name": "mvrFileViaPreviewGrpc", "tags": [ "DriverMedCardController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverMedCardController.mvrFileViaPreviewGrpc" } }, "/new-recruitment-driver-medical-card/sent-email/{recruitmentId}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "sentToEmail", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.sentToEmail" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "email", "in": "query", "schema": { "format": "email", "type": "string" } } ], "operationId": "DriverMedCardController.sentToEmail" } }, "/new-recruitment-driver-medical-card/sent-phone/{recruitmentId}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "sentToPhone", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.sentToPhone" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "phone", "in": "query", "schema": { "type": "string" } } ], "operationId": "DriverMedCardController.sentToPhone" } }, "/new-recruitment-driver-medical-card/upload-document/by-token/{medicalCardId}/{token}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "uploadDocumentWithToken", "tags": [ "DriverMedCardController" ], "summary": "Medical-Card GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "medicalCardId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 2 }, "operationId": "DriverMedCardController.uploadDocumentWithToken" } }, "/new-recruitment-driver-medical-card/upload-document/phone-token/{medicalCardId}/{token}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "uploadDocumentWithPhoneToken", "tags": [ "DriverMedCardController" ], "summary": "Medical-Card phone GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "medicalCardId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "token", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 2 }, "operationId": "DriverMedCardController.uploadDocumentWithPhoneToken" } }, "/new-recruitment-driver-medical-card/upload-document/{medicalCardId}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "uploadDocumentV2", "tags": [ "DriverMedCardController" ], "summary": "Medical-Card GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "medicalCardId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverMedCardController.uploadDocumentV2" } }, "/new-recruitment-driver-medical-card/{recruitmentId}": { "post": { "x-controller-name": "DriverMedCardController", "x-operation-name": "create", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.create" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverMedicalCardDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverMedCardController.create" } }, "/new-recruitment-driver-medical-card/{medicalCardId}": { "patch": { "x-controller-name": "DriverMedCardController", "x-operation-name": "updateById", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.updateById" } }, "parameters": [ { "name": "medicalCardId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverMedicalCardDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverMedCardController.updateById" }, "get": { "x-controller-name": "DriverMedCardController", "x-operation-name": "findById", "tags": [ "DriverMedCardController" ], "responses": { "200": { "description": "Return value of DriverMedCardController.findById" } }, "parameters": [ { "name": "medicalCardId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMedCardController.findById" } }, "/new-recruitment-driver-mvr/by-recruitment/{recruitmentId}": { "get": { "x-controller-name": "DriverMvrController", "x-operation-name": "findByRecruitmentId", "tags": [ "DriverMvrController" ], "responses": { "200": { "description": "Return value of DriverMvrController.findByRecruitmentId" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMvrController.findByRecruitmentId" } }, "/new-recruitment-driver-mvr/manual-upload/{newRecruitmentId}": { "post": { "x-controller-name": "DriverMvrController", "x-operation-name": "manualUploadMvr", "tags": [ "DriverMvrController" ], "responses": { "200": { "description": "Return value of DriverMvrController.manualUploadMvr" } }, "parameters": [ { "name": "newRecruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "newDriverLicenseId", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "notes", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverMvrController.manualUploadMvr" } }, "/new-recruitment-driver-mvr/order/{recruitmentId}": { "post": { "x-controller-name": "DriverMvrController", "x-operation-name": "orderMvrNow", "tags": [ "DriverMvrController" ], "responses": { "200": { "description": "Return value of DriverMvrController.orderMvrNow" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverMvrNowOrderDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverMvrController.orderMvrNow" } }, "/new-recruitment-driver-mvr/preview-file/{documentId}": { "get": { "x-controller-name": "DriverMvrController", "x-operation-name": "mvrFileViaPreviewGrpc", "tags": [ "DriverMvrController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverMvrController.mvrFileViaPreviewGrpc" } }, "/new-recruitment-driver-mvr/price-by-state/{state}": { "get": { "x-controller-name": "DriverMvrController", "x-operation-name": "getMvrPriceByState", "tags": [ "DriverMvrController" ], "responses": { "200": { "description": "Return value of DriverMvrController.getMvrPriceByState" } }, "parameters": [ { "name": "state", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMvrController.getMvrPriceByState" } }, "/new-recruitment-driver-mvr/view-report-file/{mvrId}": { "get": { "x-controller-name": "DriverMvrController", "x-operation-name": "mvrViewReportFile", "tags": [ "DriverMvrController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "mvrId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverMvrController.mvrViewReportFile" } }, "/new-recruitment-driver-mvr/{driverMvrId}": { "get": { "x-controller-name": "DriverMvrController", "x-operation-name": "findById", "tags": [ "DriverMvrController" ], "responses": { "200": { "description": "Return value of DriverMvrController.findById" } }, "parameters": [ { "name": "driverMvrId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverMvrController.findById" } }, "/new-recruitment-driver-psp/by-recruitment/{recruitmentId}": { "get": { "x-controller-name": "DriverPspController", "x-operation-name": "byRecruitment", "tags": [ "DriverPspController" ], "responses": { "200": { "description": "Return value of DriverPspController.byRecruitment" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPspController.byRecruitment" } }, "/new-recruitment-driver-psp/download/{driverPspId}": { "post": { "x-controller-name": "DriverPspController", "x-operation-name": "download", "tags": [ "DriverPspController" ], "responses": { "200": { "description": "Return value of DriverPspController.download" } }, "parameters": [ { "name": "driverPspId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPspController.download" } }, "/new-recruitment-driver-psp/manual-upload/{newRecruitmentId}": { "post": { "x-controller-name": "DriverPspController", "x-operation-name": "manualUploadPsp", "tags": [ "DriverPspController" ], "responses": { "200": { "description": "Return value of DriverPspController.manualUploadPsp" } }, "parameters": [ { "name": "newRecruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "newDriverLicenseId", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "notes", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverPspController.manualUploadPsp" } }, "/new-recruitment-driver-psp/order/{recruitmentId}": { "post": { "x-controller-name": "DriverPspController", "x-operation-name": "order", "tags": [ "DriverPspController" ], "responses": { "200": { "description": "Return value of DriverPspController.order" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverPspOrderDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverPspController.order" } }, "/new-recruitment-driver-psp/{driverPspId}": { "get": { "x-controller-name": "DriverPspController", "x-operation-name": "byId", "tags": [ "DriverPspController" ], "responses": { "200": { "description": "Return value of DriverPspController.byId" } }, "parameters": [ { "name": "driverPspId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverPspController.byId" } }, "/new-recruitment-driver-road-test/by-recruitment/{recruitmentId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "findByRecruitmentId", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.findByRecruitmentId" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.findByRecruitmentId" } }, "/new-recruitment-driver-road-test/certificate/generate-pdf/{certificateId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "certificateGenerate", "tags": [ "DriverRoadTestController" ], "summary": "GRPC Certificate-pdf FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.certificateGenerate" } }, "/new-recruitment-driver-road-test/certificate/mark-as-delete/{driverRoadTestCertificateId}": { "delete": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "deleteDriverRoadTestCertificateMarkAsDelete", "tags": [ "DriverRoadTestController" ], "summary": "driver Road Test Certificate Data delete", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverRoadTestCertificateId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.deleteDriverRoadTestCertificateMarkAsDelete" } }, "/new-recruitment-driver-road-test/certificate/preview-file/{documentId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "mvrFileViaPreviewGrpc", "tags": [ "DriverRoadTestController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverRoadTestController.mvrFileViaPreviewGrpc" } }, "/new-recruitment-driver-road-test/certificate/{recruitmentId}": { "post": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "createDriverRoadTestCertificate", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.createDriverRoadTestCertificate" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRoadTestCertificateDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverRoadTestController.createDriverRoadTestCertificate" } }, "/new-recruitment-driver-road-test/certificate/{driverRoadTestCertificateId}": { "patch": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "editDriverRoadTestCertificate", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.editDriverRoadTestCertificate" } }, "parameters": [ { "name": "driverRoadTestCertificateId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRoadTestCertificateDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverRoadTestController.editDriverRoadTestCertificate" }, "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "getDriverRoadTestCertificate", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.getDriverRoadTestCertificate" } }, "parameters": [ { "name": "driverRoadTestCertificateId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.getDriverRoadTestCertificate" }, "delete": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "deleteDriverRoadTestCertificate", "tags": [ "DriverRoadTestController" ], "summary": "driver Road Test Certificate Data delete", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverRoadTestCertificateId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.deleteDriverRoadTestCertificate" } }, "/new-recruitment-driver-road-test/certificate-document/{documentId}": { "delete": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "deleteDocument", "tags": [ "DriverRoadTestController" ], "summary": "driver Road Test Certificate file GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.deleteDocument" } }, "/new-recruitment-driver-road-test/certificate-info/{recruitmentId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "certificateRecruitmentInfo", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.certificateRecruitmentInfo" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.certificateRecruitmentInfo" } }, "/new-recruitment-driver-road-test/delete-by-recruitment/{recruitmentId}": { "delete": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "deleteDriverRoadTestByRecruitment", "tags": [ "DriverRoadTestController" ], "summary": "Delete Driver Road Test By recruitment GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.deleteDriverRoadTestByRecruitment" } }, "/new-recruitment-driver-road-test/document/{documentId}": { "delete": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "deleteRoadTestDocument", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.deleteRoadTestDocument" } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.deleteRoadTestDocument" } }, "/new-recruitment-driver-road-test/mark-as-complete/{recruitmentId}": { "post": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "markAsComplete", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.markAsComplete" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.markAsComplete" } }, "/new-recruitment-driver-road-test/preview-file/by-recruitment/{recruitmentId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "roadTestFileByRecruitmentViaPreviewGrpc", "tags": [ "DriverRoadTestController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverRoadTestController.roadTestFileByRecruitmentViaPreviewGrpc" } }, "/new-recruitment-driver-road-test/preview-file/{documentId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "roadTestFileViaPreviewGrpc", "tags": [ "DriverRoadTestController" ], "summary": "GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "isCompress", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "DriverRoadTestController.roadTestFileViaPreviewGrpc" } }, "/new-recruitment-driver-road-test/remove-complete/{driverRoadTestId}": { "delete": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "removeComplete", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.removeComplete" } }, "parameters": [ { "name": "driverRoadTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.removeComplete" } }, "/new-recruitment-driver-road-test/road-test-empty-generate-pdf/{recruiterId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "emptyTestGenerate", "tags": [ "DriverRoadTestController" ], "summary": "GRPC ROAD TEST PDF-EMPTY FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruiterId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.emptyTestGenerate" } }, "/new-recruitment-driver-road-test/road-test-generate-pdf/{roadTestId}": { "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "testGenerate", "tags": [ "DriverRoadTestController" ], "summary": "GRPC ROAD TEST PDF-GENERATE FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "roadTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.testGenerate" } }, "/new-recruitment-driver-road-test/upload/certificate-signature/{driverRoadTestCertificateId}": { "post": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "uploadDocumentV2", "tags": [ "DriverRoadTestController" ], "summary": "driver Road Test Certificate GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverRoadTestCertificateId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverRoadTestController.uploadDocumentV2" } }, "/new-recruitment-driver-road-test/upload-document/signature/{driverRoadTestId}": { "post": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "uploadDocumentSignature", "tags": [ "DriverRoadTestController" ], "summary": "Driver Road Test GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "driverRoadTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverRoadTestController.uploadDocumentSignature" } }, "/new-recruitment-driver-road-test/upload-document/{recruitmentId}": { "post": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "uploadDocument", "tags": [ "DriverRoadTestController" ], "summary": "Driver Road Test By recruitment GRPC FILE", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "DriverRoadTestController.uploadDocument" } }, "/new-recruitment-driver-road-test/{recruitmentId}": { "post": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "createDriverRoadTest", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.createDriverRoadTest" } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRoadTestDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverRoadTestController.createDriverRoadTest" } }, "/new-recruitment-driver-road-test/{driverRoadTestId}": { "patch": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "editDriverRoadTest", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.editDriverRoadTest" } }, "parameters": [ { "name": "driverRoadTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRoadTestDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "DriverRoadTestController.editDriverRoadTest" }, "get": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "getDriverRoadTest", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.getDriverRoadTest" } }, "parameters": [ { "name": "driverRoadTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.getDriverRoadTest" }, "delete": { "x-controller-name": "DriverRoadTestController", "x-operation-name": "deleteDriverRoadTest", "tags": [ "DriverRoadTestController" ], "responses": { "200": { "description": "Return value of DriverRoadTestController.deleteDriverRoadTest" } }, "parameters": [ { "name": "driverRoadTestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DriverRoadTestController.deleteDriverRoadTest" } }, "/new-recruitment-history/create-note": { "post": { "x-controller-name": "NewRecruitmentHistoryController", "x-operation-name": "createRecruitmentHistory", "tags": [ "NewRecruitmentHistoryController" ], "summary": "Create history entry for a recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRecruitmentHistoryCreateDto" } } }, "required": true }, "operationId": "NewRecruitmentHistoryController.createRecruitmentHistory" } }, "/new-recruitment-history/{recruitmentId}": { "get": { "x-controller-name": "NewRecruitmentHistoryController", "x-operation-name": "getRecruitmentHistory", "tags": [ "NewRecruitmentHistoryController" ], "summary": "List history of a recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "number" } }, { "name": "perPage", "in": "query", "schema": { "minimum": 1, "default": 30, "type": "number" } } ], "operationId": "NewRecruitmentHistoryController.getRecruitmentHistory" } }, "/new-recruitment-xchange-logs/phone-attempt/{xchangeId}": { "post": { "x-controller-name": "NewRecruitmentXchangeLogController", "x-operation-name": "xchangeLogPhoneAttempt", "tags": [ "NewRecruitmentXchangeLogController" ], "summary": "Log phone attempt for xchange", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "xchangeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XchangeLogPhoneData" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentXchangeLogController.xchangeLogPhoneAttempt" } }, "/new-recruitment-xchange-logs/{recruitmentXchangeId}": { "get": { "x-controller-name": "NewRecruitmentXchangeLogController", "x-operation-name": "getXchangeLogs", "tags": [ "NewRecruitmentXchangeLogController" ], "summary": "List recruitment xchange logs", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentXchangeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentXchangeLogController.getXchangeLogs" } }, "/new-recruitment-xchanges/link/{linkCode}/document/{documentId}": { "get": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "getConsentDocumentFileByLinkCode", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Download a consent document for xchange by link code", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "linkCode", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "documentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentXchangeController.getConsentDocumentFileByLinkCode" } }, "/new-recruitment-xchanges/link/{linkCode}": { "get": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "getXchangeDataByLinkCode", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Fetch xchange request data by link code", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "linkCode", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentXchangeController.getXchangeDataByLinkCode" } }, "/new-recruitment-xchanges/provide-response/{requestId}": { "post": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "provideXchangeResponse", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Provide response for recruitment xchange", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewXchangeResponseCreateDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentXchangeController.provideXchangeResponse" } }, "/new-recruitment-xchanges/resend/{id}": { "post": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "resendXchangeRequest", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Resend recruitment xchange", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewXchangeResendDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentXchangeController.resendXchangeRequest" } }, "/new-recruitment-xchanges/send/{recruitmentId}": { "post": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "sendXchangeRequests", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Send recruitment xchange(s)", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewXchangeRequestSendDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentXchangeController.sendXchangeRequests" } }, "/new-recruitment-xchanges/{xchangeId}/close": { "post": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "closeXchangeRequest", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Close xchange request", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "xchangeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentXchangeController.closeXchangeRequest" } }, "/new-recruitment-xchanges/{xchangeId}/link": { "get": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "getXchangeLink", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Get shareable link for xchange request", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "xchangeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentXchangeController.getXchangeLink" } }, "/new-recruitment-xchanges/{xchangeId}/no-response": { "post": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "markNoResponse", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Mark xchange request as no response", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "xchangeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentXchangeController.markNoResponse" } }, "/new-recruitment-xchanges/{xchangeId}/upload-response": { "post": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "uploadXchangeResponse", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Upload response document for xchange request", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "xchangeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "array", "items": { "type": "string", "format": "binary" } } } } } }, "x-parameter-index": 1 }, "operationId": "NewRecruitmentXchangeController.uploadXchangeResponse" } }, "/new-recruitment-xchanges/{recruitmentXchangeId}": { "get": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "getRecruitmentXchange", "tags": [ "NewRecruitmentXchangeController" ], "summary": "Fetch recruitment xchange by its ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentXchangeId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentXchangeController.getRecruitmentXchange" } }, "/new-recruitment-xchanges": { "get": { "x-controller-name": "NewRecruitmentXchangeController", "x-operation-name": "getRecruitmentXchanges", "tags": [ "NewRecruitmentXchangeController" ], "summary": "List all xchanges of a recruitment", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "awaiting_authorization", "pending", "submitted", "response_received", "complete", "refused", "canceled" ], "type": "string" } }, { "name": "page", "in": "query", "schema": { "minimum": 1, "type": "number" } }, { "name": "perPage", "in": "query", "schema": { "minimum": 1, "default": 30, "type": "number" } } ], "operationId": "NewRecruitmentXchangeController.getRecruitmentXchanges" } }, "/new-recruitments/hired": { "get": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "listHiredRecruitments", "tags": [ "NewRecruitmentController" ], "summary": "List Hired recruitments of a company", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "perPage", "in": "query", "schema": { "type": "number" } } ], "operationId": "NewRecruitmentController.listHiredRecruitments" } }, "/new-recruitments/invite-hired-driver/{recruitmentId}": { "post": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "inviteHiredDriver", "tags": [ "NewRecruitmentController" ], "summary": "invite hired driver", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInviteHiredDriverDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentController.inviteHiredDriver" } }, "/new-recruitments/random-program/{recruitmentId}": { "post": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "randomProgram", "tags": [ "NewRecruitmentController" ], "summary": "Placed in Random Program", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRandomProgramDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentController.randomProgram" } }, "/new-recruitments/recruitment-cards": { "get": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "getRecruitmentCards", "tags": [ "NewRecruitmentController" ], "summary": "List recruitments of a company", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "NewRecruitmentController.getRecruitmentCards" } }, "/new-recruitments/rejected": { "get": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "listRejectedRecruitments", "tags": [ "NewRecruitmentController" ], "summary": "List Rejected recruitments of a company", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "perPage", "in": "query", "schema": { "type": "number" } } ], "operationId": "NewRecruitmentController.listRejectedRecruitments" } }, "/new-recruitments/sent-application-link/sms/{phone}": { "post": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "sentLinkToPhone", "tags": [ "NewRecruitmentController" ], "summary": "Edit a driver application within company's scope", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "phone", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentController.sentLinkToPhone" } }, "/new-recruitments/sent-application-link/{email}": { "post": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "sendApplicationLink", "tags": [ "NewRecruitmentController" ], "responses": { "200": { "description": "Return value of NewRecruitmentController.sendApplicationLink" } }, "parameters": [ { "name": "email", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentController.sendApplicationLink" } }, "/new-recruitments/terminated": { "get": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "listTerminatedRecruitments", "tags": [ "NewRecruitmentController" ], "summary": "List Terminated recruitments of a company", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "perPage", "in": "query", "schema": { "type": "number" } } ], "operationId": "NewRecruitmentController.listTerminatedRecruitments" } }, "/new-recruitments/{id}": { "patch": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "updateRecruitment", "tags": [ "NewRecruitmentController" ], "summary": "Update a recruitment by its ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRecruitmentUpdateDto" } } }, "required": true, "x-parameter-index": 1 }, "operationId": "NewRecruitmentController.updateRecruitment" } }, "/new-recruitments/{recruitmentId}": { "get": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "getRecruitment", "tags": [ "NewRecruitmentController" ], "summary": "Fetch one recruitment by its ID", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "recruitmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NewRecruitmentController.getRecruitment" } }, "/new-recruitments": { "get": { "x-controller-name": "NewRecruitmentController", "x-operation-name": "listRecruitments", "tags": [ "NewRecruitmentController" ], "summary": "List recruitments of a company", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "new", "processing", "hired", "no_response", "terminated", "rejected" ], "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "perPage", "in": "query", "schema": { "type": "number" } } ], "operationId": "NewRecruitmentController.listRecruitments" } } }, "components": { "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "companyId": { "type": "apiKey", "name": "companyId", "in": "header" }, "developerApiKey": { "type": "apiKey", "name": "x-api-key", "in": "header" }, "ProtruxApiKey": { "type": "apiKey", "name": "X-Protrux-Api-Key", "in": "header" } }, "schemas": { "CityDto": { "title": "CityDto", "type": "object", "properties": { "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "lat": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lat must be number or null", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lng must be number or null", "exclusiveMinimum": "Lng must be greater than undefined" } } }, "additionalProperties": false }, "VendorCreateDto": { "title": "VendorCreateDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "type": { "type": "string", "enum": [ "repair_shop", "tire_shop", "roadside", "parts_supplier", "fuel", "trailer_service", "insurance", "factoring", "parking", "carrier", "broker", "other" ], "maxLength": 50, "errorMessage": { "enum": "Type must be one of these options: \nrepair_shop, tire_shop, roadside, parts_supplier, fuel, trailer_service, insurance, factoring, parking, carrier, broker, other", "maxLength": "Type must not exceed 50 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "city": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "zipCodes": { "type": "string", "maxLength": 32, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed 32 characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string " } }, "placeId": { "type": "string", "maxLength": 512, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed 512 characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string " } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "phone": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least 4 characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "driverId": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Driver Id must be one of these options: \nundefined", "maxLength": "Driver Id must not exceed 36 characters", "minLength": "Driver Id must contain at least undefined characters", "type": "Driver Id must be string " } } }, "additionalProperties": false, "required": [ "name", "type", "address", "city", "state" ], "errorMessage": { "required": { "name": "Name is required", "type": "Type is required", "address": "Address is required", "city": "City is required", "state": "State is required" } } }, "VendorCreateForServiceOrderDto": { "title": "VendorCreateForServiceOrderDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "type": { "type": "string", "enum": [ "repair_shop", "tire_shop", "roadside", "parts_supplier", "fuel", "trailer_service", "insurance", "factoring", "parking", "carrier", "broker", "other" ], "maxLength": 50, "errorMessage": { "enum": "Type must be one of these options: \nrepair_shop, tire_shop, roadside, parts_supplier, fuel, trailer_service, insurance, factoring, parking, carrier, broker, other", "maxLength": "Type must not exceed 50 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "city": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "zipCodes": { "type": "string", "maxLength": 32, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed 32 characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string " } }, "placeId": { "type": "string", "maxLength": 512, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed 512 characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string " } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "phone": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least 4 characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "driverId": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Driver Id must be one of these options: \nundefined", "maxLength": "Driver Id must not exceed 36 characters", "minLength": "Driver Id must contain at least undefined characters", "type": "Driver Id must be string " } } }, "additionalProperties": false, "required": [ "name", "type", "address", "city", "state" ], "errorMessage": { "required": { "name": "Name is required", "type": "Type is required", "address": "Address is required", "city": "City is required", "state": "State is required" } } }, "BaseVendorContactDto": { "title": "BaseVendorContactDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "phone": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least 4 characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } } }, "additionalProperties": false }, "VendorEditDto": { "title": "VendorEditDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "type": { "type": "string", "enum": [ "repair_shop", "tire_shop", "roadside", "parts_supplier", "fuel", "trailer_service", "insurance", "factoring", "parking", "carrier", "broker", "other" ], "maxLength": 50, "errorMessage": { "enum": "Type must be one of these options: \nrepair_shop, tire_shop, roadside, parts_supplier, fuel, trailer_service, insurance, factoring, parking, carrier, broker, other", "maxLength": "Type must not exceed 50 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "city": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "zipCodes": { "type": "string", "maxLength": 32, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed 32 characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string " } }, "placeId": { "type": "string", "maxLength": 512, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed 512 characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string " } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "phone": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least 4 characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "contact": { "type": "array", "items": { "$ref": "#/components/schemas/BaseVendorContactDto" } } }, "additionalProperties": false, "required": [ "name", "type" ], "errorMessage": { "required": { "name": "Name is required", "type": "Type is required" } } }, "VendorContactDto": { "title": "VendorContactDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "phone": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least 4 characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "phone", "fullName", "vendorId" ], "errorMessage": { "required": { "phone": "Phone is required", "fullName": "Full name is required", "vendorId": "Vendor is required" } } }, "VendorContactEditDto": { "title": "VendorContactEditDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "phone": { "type": "string", "minLength": 4, "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least 4 characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } } }, "additionalProperties": false, "required": [ "phone", "fullName" ], "errorMessage": { "required": { "phone": "Phone is required", "fullName": "Full name is required" } } }, "VehicleEditDtoV2": { "title": "VehicleEditDtoV2", "type": "object", "properties": { "year": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Year must be one of these options: \nundefined", "maxLength": "Year must not exceed 36 characters", "minLength": "Year must contain at least undefined characters", "type": "Year must be string or null" } }, "truckNumber": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Truck Number must be one of these options: \nundefined", "maxLength": "Truck Number must not exceed 72 characters", "minLength": "Truck Number must contain at least undefined characters", "type": "Truck Number must be string " } }, "licenseNumber": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Number must be one of these options: \nundefined", "maxLength": "License Number must not exceed 255 characters", "minLength": "License Number must contain at least undefined characters", "type": "License Number must be string or null" } }, "licenseIssuePlace": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Issue Place must be one of these options: \nundefined", "maxLength": "License Issue Place must not exceed 255 characters", "minLength": "License Issue Place must contain at least undefined characters", "type": "License Issue Place must be string or null" } }, "type": { "type": "string", "enum": [ "power_only", "dry_van", "reefer", "car_hauler", "flatbed", "stepdeck", "cargo_van", "box_truck" ], "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \npower_only, dry_van, reefer, car_hauler, flatbed, stepdeck, cargo_van, box_truck", "maxLength": "Type must not exceed 72 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "vin": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Vin must be one of these options: \nundefined", "maxLength": "Vin must not exceed 72 characters", "minLength": "Vin must contain at least undefined characters", "type": "Vin must be string or null" } }, "vinType": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Vin Type must be one of these options: \nundefined", "maxLength": "Vin Type must not exceed 72 characters", "minLength": "Vin Type must contain at least undefined characters", "type": "Vin Type must be string or null" } }, "fuelType": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Fuel Type must be one of these options: \nundefined", "maxLength": "Fuel Type must not exceed 72 characters", "minLength": "Fuel Type must contain at least undefined characters", "type": "Fuel Type must be string or null" } }, "eldNumber": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Eld Number must be one of these options: \nundefined", "maxLength": "Eld Number must not exceed 72 characters", "minLength": "Eld Number must contain at least undefined characters", "type": "Eld Number must be string " } }, "notes": { "type": "string", "maxLength": 1200, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "fleetStatus": { "type": "string", "enum": [ "assigned", "unassigned", "in-shop", "out-of-service" ], "maxLength": 25, "nullable": true, "errorMessage": { "enum": "Fleet Status must be one of these options: \nassigned, unassigned, in-shop, out-of-service", "maxLength": "Fleet Status must not exceed 25 characters", "minLength": "Fleet Status must contain at least undefined characters", "type": "Fleet Status must be string or null" } }, "odometerOffset": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Odometer Offset must be number or null", "exclusiveMinimum": "Odometer Offset must be greater than undefined" } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "makeId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Make Id must be a valid UUID" } }, "modelId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Model Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "truckNumber" ], "errorMessage": { "required": { "truckNumber": "Truck number is required" } } }, "VehicleDto": { "title": "VehicleDto", "type": "object", "properties": { "year": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Year must be one of these options: \nundefined", "maxLength": "Year must not exceed 36 characters", "minLength": "Year must contain at least undefined characters", "type": "Year must be string or null" } }, "truckNumber": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Truck Number must be one of these options: \nundefined", "maxLength": "Truck Number must not exceed 72 characters", "minLength": "Truck Number must contain at least undefined characters", "type": "Truck Number must be string " } }, "licenseNumber": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Number must be one of these options: \nundefined", "maxLength": "License Number must not exceed 255 characters", "minLength": "License Number must contain at least undefined characters", "type": "License Number must be string or null" } }, "licenseIssuePlace": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Issue Place must be one of these options: \nundefined", "maxLength": "License Issue Place must not exceed 255 characters", "minLength": "License Issue Place must contain at least undefined characters", "type": "License Issue Place must be string or null" } }, "type": { "type": "string", "enum": [ "power_only", "dry_van", "reefer", "car_hauler", "flatbed", "stepdeck", "cargo_van", "box_truck" ], "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \npower_only, dry_van, reefer, car_hauler, flatbed, stepdeck, cargo_van, box_truck", "maxLength": "Type must not exceed 72 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "vin": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Vin must be one of these options: \nundefined", "maxLength": "Vin must not exceed 72 characters", "minLength": "Vin must contain at least undefined characters", "type": "Vin must be string or null" } }, "vinType": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Vin Type must be one of these options: \nundefined", "maxLength": "Vin Type must not exceed 72 characters", "minLength": "Vin Type must contain at least undefined characters", "type": "Vin Type must be string or null" } }, "fuelType": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Fuel Type must be one of these options: \nundefined", "maxLength": "Fuel Type must not exceed 72 characters", "minLength": "Fuel Type must contain at least undefined characters", "type": "Fuel Type must be string or null" } }, "eldNumber": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Eld Number must be one of these options: \nundefined", "maxLength": "Eld Number must not exceed 72 characters", "minLength": "Eld Number must contain at least undefined characters", "type": "Eld Number must be string " } }, "notes": { "type": "string", "maxLength": 1200, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "fleetStatus": { "type": "string", "enum": [ "assigned", "unassigned", "in-shop", "out-of-service" ], "maxLength": 25, "nullable": true, "errorMessage": { "enum": "Fleet Status must be one of these options: \nassigned, unassigned, in-shop, out-of-service", "maxLength": "Fleet Status must not exceed 25 characters", "minLength": "Fleet Status must contain at least undefined characters", "type": "Fleet Status must be string or null" } }, "odometerOffset": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Odometer Offset must be number or null", "exclusiveMinimum": "Odometer Offset must be greater than undefined" } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "makeId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Make Id must be a valid UUID" } }, "modelId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Model Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "truckNumber", "modelId", "makeId", "type" ], "errorMessage": { "required": { "truckNumber": "Truck number is required", "modelId": "Model is required", "makeId": "Make is required", "type": "Type is required" } } }, "VehicleDocumentEditDto": { "title": "VehicleDocumentEditDto", "type": "object", "properties": { "expireDate": { "type": "string", "errorMessage": { "type": "Expire Date must be date " } }, "issueDate": { "type": "string", "errorMessage": { "type": "Issue Date must be date " } }, "documentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Document Id must be a valid UUID" } }, "attachmentType": { "type": "string", "enum": [ "registration", "coi", "permit_license_nm", "permit_license_ky", "permit_license_pa", "permit_license_ny", "permit_license_ct", "permit_license_or", "ifta_license", "cab_card", "annual_inspection", "eld_manual", "mc_certificate", "dvir", "lease_agreement", "insurance", "repairs_and_maintenance", "other_document" ], "errorMessage": { "enum": "Attachment Type must be one of these options: \nregistration, coi, permit_license_nm, permit_license_ky, permit_license_pa, permit_license_ny, permit_license_ct, permit_license_or, ifta_license, cab_card, annual_inspection, eld_manual, mc_certificate, dvir, lease_agreement, insurance, repairs_and_maintenance, other_document", "maxLength": "Attachment Type must not exceed undefined characters", "minLength": "Attachment Type must contain at least undefined characters", "type": "Attachment Type must be string " } } }, "additionalProperties": false, "required": [ "documentId" ], "errorMessage": { "required": { "documentId": "Document is required" } } }, "TrailerUnitStatusBoardDto": { "title": "TrailerUnitStatusBoardDto", "type": "object", "properties": { "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } }, "pickupDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Pickup Date must be date or null", "format": "PickupDate must be a valid date (YYYY-MM-DD)" } }, "dropDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Drop Date must be date or null", "format": "DropDate must be a valid date (YYYY-MM-DD)" } }, "pickupAddress": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Pickup Address must be one of these options: \nundefined", "maxLength": "Pickup Address must not exceed 255 characters", "minLength": "Pickup Address must contain at least undefined characters", "type": "Pickup Address must be string or null" } }, "dropAddress": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Drop Address must be one of these options: \nundefined", "maxLength": "Drop Address must not exceed 255 characters", "minLength": "Drop Address must contain at least undefined characters", "type": "Drop Address must be string or null" } } }, "additionalProperties": false }, "UnitBoardDto": { "title": "UnitBoardDto", "type": "object", "properties": { "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "manualLocation": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Manual Location must be one of these options: \nundefined", "maxLength": "Manual Location must not exceed 255 characters", "minLength": "Manual Location must contain at least undefined characters", "type": "Manual Location must be string or null" } }, "status": { "type": "string", "enum": [ "ready", "reserved", "covered", "office", "enroute", "enroute2", "pending", "cycle", "dispatched", "shift", "rest", "deadheading", "service", "vacation", "hold", "stay", "duty", "home" ], "maxLength": 25, "errorMessage": { "enum": "Status must be one of these options: \nready, reserved, covered, office, enroute, enroute2, pending, cycle, dispatched, shift, rest, deadheading, service, vacation, hold, stay, duty, home", "maxLength": "Status must not exceed 25 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "origin": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Origin must be one of these options: \nundefined", "maxLength": "Origin must not exceed 255 characters", "minLength": "Origin must contain at least undefined characters", "type": "Origin must be string or null" } }, "fleetStatus": { "type": "string", "enum": [ "assigned", "unassigned", "in-shop", "out-of-service" ], "maxLength": 25, "nullable": true, "errorMessage": { "enum": "Fleet Status must be one of these options: \nassigned, unassigned, in-shop, out-of-service", "maxLength": "Fleet Status must not exceed 25 characters", "minLength": "Fleet Status must contain at least undefined characters", "type": "Fleet Status must be string or null" } }, "destination": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Destination must be one of these options: \nundefined", "maxLength": "Destination must not exceed 255 characters", "minLength": "Destination must contain at least undefined characters", "type": "Destination must be string or null" } }, "deliveryAt": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "Delivery At must be one of these options: \nundefined", "maxLength": "Delivery At must not exceed undefined characters", "minLength": "Delivery At must contain at least undefined characters", "type": "Delivery At must be string or null", "format": "DeliveryAt must be a valid date-time (ISO 8601)" } }, "pickupAt": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "Pickup At must be one of these options: \nundefined", "maxLength": "Pickup At must not exceed undefined characters", "minLength": "Pickup At must contain at least undefined characters", "type": "Pickup At must be string or null", "format": "PickupAt must be a valid date-time (ISO 8601)" } }, "readyAt": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "Ready At must be one of these options: \nundefined", "maxLength": "Ready At must not exceed undefined characters", "minLength": "Ready At must contain at least undefined characters", "type": "Ready At must be string or null", "format": "ReadyAt must be a valid date-time (ISO 8601)" } }, "eta": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "Eta must be one of these options: \nundefined", "maxLength": "Eta must not exceed undefined characters", "minLength": "Eta must contain at least undefined characters", "type": "Eta must be string or null", "format": "Eta must be a valid date-time (ISO 8601)" } }, "location": { "type": "object", "nullable": true }, "noteUpdatedDate": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Note Updated Date must be one of these options: \nundefined", "maxLength": "Note Updated Date must not exceed 255 characters", "minLength": "Note Updated Date must contain at least undefined characters", "type": "Note Updated Date must be string or null" } }, "trailer": { "$ref": "#/components/schemas/TrailerUnitStatusBoardDto" } }, "additionalProperties": false, "required": [ "status" ], "errorMessage": { "required": { "status": "Status is required" } } }, "Date": {}, "UnitBoardTrailerUpdateDto": { "title": "UnitBoardTrailerUpdateDto", "type": "object", "properties": { "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } }, "temporaryTrailerDropDate": { "type": "string", "errorMessage": { "type": "Temporary Trailer Drop Date must be date " } }, "temporaryTrailerNumber": { "type": "string", "maxLength": 155, "errorMessage": { "enum": "Temporary Trailer Number must be one of these options: \nundefined", "maxLength": "Temporary Trailer Number must not exceed 155 characters", "minLength": "Temporary Trailer Number must contain at least undefined characters", "type": "Temporary Trailer Number must be string " } }, "temporaryTrailerLocation": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Temporary Trailer Location must be one of these options: \nundefined", "maxLength": "Temporary Trailer Location must not exceed 255 characters", "minLength": "Temporary Trailer Location must contain at least undefined characters", "type": "Temporary Trailer Location must be string " } }, "unassign": { "type": "boolean" } }, "additionalProperties": false }, "UnitBoardCoDriverUpdateDto": { "title": "UnitBoardCoDriverUpdateDto", "type": "object", "properties": { "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } } }, "additionalProperties": false }, "UnitLocationDto": { "title": "UnitLocationDto", "type": "object", "properties": { "lat": { "type": "string", "nullable": true, "errorMessage": { "enum": "Lat must be one of these options: \nundefined", "maxLength": "Lat must not exceed undefined characters", "minLength": "Lat must contain at least undefined characters", "type": "Lat must be string or null" } }, "lng": { "type": "string", "nullable": true, "errorMessage": { "enum": "Lng must be one of these options: \nundefined", "maxLength": "Lng must not exceed undefined characters", "minLength": "Lng must contain at least undefined characters", "type": "Lng must be string or null" } }, "city": { "type": "string", "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed undefined characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "address": { "type": "string", "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "heading": { "type": "string", "nullable": true, "errorMessage": { "enum": "Heading must be one of these options: \nundefined", "maxLength": "Heading must not exceed undefined characters", "minLength": "Heading must contain at least undefined characters", "type": "Heading must be string or null" } }, "speed": { "type": "string", "nullable": true, "errorMessage": { "enum": "Speed must be one of these options: \nundefined", "maxLength": "Speed must not exceed undefined characters", "minLength": "Speed must contain at least undefined characters", "type": "Speed must be string or null" } }, "source": { "type": "string", "nullable": true, "errorMessage": { "enum": "Source must be one of these options: \nundefined", "maxLength": "Source must not exceed undefined characters", "minLength": "Source must contain at least undefined characters", "type": "Source must be string or null" } } }, "additionalProperties": false }, "UnitBoardUpdateLocationDto": { "title": "UnitBoardUpdateLocationDto", "type": "object", "properties": { "manualLocation": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Manual Location must be one of these options: \nundefined", "maxLength": "Manual Location must not exceed 255 characters", "minLength": "Manual Location must contain at least undefined characters", "type": "Manual Location must be string or null" } }, "location": { "$ref": "#/components/schemas/UnitLocationDto" } }, "additionalProperties": false, "required": [ "manualLocation", "location" ] }, "UnitBoardModifyDto": { "title": "UnitBoardModifyDto", "type": "object", "properties": { "status": { "type": "string", "enum": [ "ready", "reserved", "covered", "office", "enroute", "enroute2", "pending", "cycle", "dispatched", "shift", "rest", "deadheading", "service", "vacation", "hold", "stay", "duty", "home" ], "maxLength": 25, "errorMessage": { "enum": "Status must be one of these options: \nready, reserved, covered, office, enroute, enroute2, pending, cycle, dispatched, shift, rest, deadheading, service, vacation, hold, stay, duty, home", "maxLength": "Status must not exceed 25 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "driverReturnDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "enum": "Driver Return Date must be one of these options: \nundefined", "maxLength": "Driver Return Date must not exceed undefined characters", "minLength": "Driver Return Date must contain at least undefined characters", "type": "Driver Return Date must be string or null", "format": "DriverReturnDate must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false, "required": [ "status" ] }, "UnitBoardNoteDto": { "title": "UnitBoardNoteDto", "type": "object", "properties": { "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "notes" ] }, "FactoringConnectDto": { "title": "FactoringConnectDto", "type": "object", "properties": { "login": { "type": "string", "maxLength": 256, "errorMessage": { "enum": "Login must be one of these options: \nundefined", "maxLength": "Login must not exceed 256 characters", "minLength": "Login must contain at least undefined characters", "type": "Login must be string " } }, "password": { "type": "string", "maxLength": 256, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 256 characters", "minLength": "Password must contain at least undefined characters", "type": "Password must be string " } }, "factoringFeeRate": { "type": "number", "format": "float", "errorMessage": { "type": "Factoring Fee Rate must be number ", "exclusiveMinimum": "Factoring Fee Rate must be greater than undefined" } } }, "additionalProperties": false, "required": [ "login", "password", "factoringFeeRate" ], "errorMessage": { "required": { "login": "Login is required", "password": "Password is required", "factoringFeeRate": "Factoring fee rate is required" } } }, "DriverPaymentObj": { "title": "DriverPaymentObj", "type": "object", "properties": { "perMile": { "type": "number", "errorMessage": { "minimum": "Per Mile cannot be lower than undefined", "maximum": "Per Mile cannot be lower than undefined", "type": "Per Mile must be number ", "exclusiveMinimum": "Per Mile must be greater than undefined" } }, "perEmptyMile": { "type": "number", "errorMessage": { "minimum": "Per Empty Mile cannot be lower than undefined", "maximum": "Per Empty Mile cannot be lower than undefined", "type": "Per Empty Mile must be number ", "exclusiveMinimum": "Per Empty Mile must be greater than undefined" } }, "perHour": { "type": "number", "errorMessage": { "minimum": "Per Hour cannot be lower than undefined", "maximum": "Per Hour cannot be lower than undefined", "type": "Per Hour must be number ", "exclusiveMinimum": "Per Hour must be greater than undefined" } }, "percentage": { "type": "number", "errorMessage": { "minimum": "Percentage cannot be lower than undefined", "maximum": "Percentage cannot be lower than undefined", "type": "Percentage must be number ", "exclusiveMinimum": "Percentage must be greater than undefined" } }, "perExtraStop": { "type": "number", "errorMessage": { "minimum": "Per Extra Stop cannot be lower than undefined", "maximum": "Per Extra Stop cannot be lower than undefined", "type": "Per Extra Stop must be number ", "exclusiveMinimum": "Per Extra Stop must be greater than undefined" } }, "flatPay": { "type": "number", "errorMessage": { "minimum": "Flat Pay cannot be lower than undefined", "maximum": "Flat Pay cannot be lower than undefined", "type": "Flat Pay must be number ", "exclusiveMinimum": "Flat Pay must be greater than undefined" } }, "type": { "type": "number", "enum": [ 1, 2, 3 ], "errorMessage": { "minimum": "Type cannot be lower than undefined", "maximum": "Type cannot be lower than undefined", "type": "Type must be number ", "exclusiveMinimum": "Type must be greater than undefined" } } }, "additionalProperties": false, "required": [ "type" ], "if": { "properties": { "type": { "const": 1 } }, "required": [ "type" ] }, "then": { "properties": { "percentage": { "minimum": 1, "maximum": 100, "errorMessage": "Percentage must be between 1 and 100" } } }, "errorMessage": { "required": { "type": "Type is required" } } }, "WeeklyDeduction": { "title": "WeeklyDeduction", "type": "object", "properties": { "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "TransparentCreateDriverDto": { "title": "TransparentCreateDriverDto", "type": "object", "properties": { "transparentRemoteId": { "type": "string", "errorMessage": { "enum": "Transparent Remote Id must be one of these options: \nundefined", "maxLength": "Transparent Remote Id must not exceed undefined characters", "minLength": "Transparent Remote Id must contain at least undefined characters", "type": "Transparent Remote Id must be string " } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "payment": { "$ref": "#/components/schemas/DriverPaymentObj" }, "driverType": { "type": "string", "enum": [ "owner", "company" ], "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Driver Type must be one of these options: \nowner, company", "maxLength": "Driver Type must not exceed 72 characters", "minLength": "Driver Type must contain at least undefined characters", "type": "Driver Type must be string or null" } }, "firstName": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string or null" } }, "lastName": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Last Name must be one of these options: \nundefined", "maxLength": "Last Name must not exceed 255 characters", "minLength": "Last Name must contain at least undefined characters", "type": "Last Name must be string or null" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 2, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 2 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "zipCode": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 24 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string or null" } }, "weeklyDeductions": { "type": "array", "items": { "$ref": "#/components/schemas/WeeklyDeduction" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "transparentRemoteId", "email", "payment" ], "errorMessage": { "required": { "transparentRemoteId": "Transparent driver ID is required", "email": "Email is required", "payment": "Payment is required" } } }, "TransparentCreateDriversRequest": { "title": "TransparentCreateDriversRequest", "type": "object", "properties": { "drivers": { "type": "array", "items": { "$ref": "#/components/schemas/TransparentCreateDriverDto" } } }, "additionalProperties": false, "required": [ "drivers" ], "errorMessage": { "required": { "drivers": "Drivers array is required" } } }, "TrailerCreateDto": { "title": "TrailerCreateDto", "type": "object", "properties": { "trailerNumber": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Trailer Number must be one of these options: \nundefined", "maxLength": "Trailer Number must not exceed 255 characters", "minLength": "Trailer Number must contain at least undefined characters", "type": "Trailer Number must be string " } }, "make": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Make must be one of these options: \nundefined", "maxLength": "Make must not exceed 255 characters", "minLength": "Make must contain at least undefined characters", "type": "Make must be string " } }, "model": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Model must be one of these options: \nundefined", "maxLength": "Model must not exceed 255 characters", "minLength": "Model must contain at least undefined characters", "type": "Model must be string or null" } }, "year": { "type": "string", "maxLength": 16, "errorMessage": { "enum": "Year must be one of these options: \nundefined", "maxLength": "Year must not exceed 16 characters", "minLength": "Year must contain at least undefined characters", "type": "Year must be string " } }, "vin": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Vin must be one of these options: \nundefined", "maxLength": "Vin must not exceed 72 characters", "minLength": "Vin must contain at least undefined characters", "type": "Vin must be string " } }, "licenseNumber": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Number must be one of these options: \nundefined", "maxLength": "License Number must not exceed 255 characters", "minLength": "License Number must contain at least undefined characters", "type": "License Number must be string or null" } }, "licenseIssuePlace": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Issue Place must be one of these options: \nundefined", "maxLength": "License Issue Place must not exceed 255 characters", "minLength": "License Issue Place must contain at least undefined characters", "type": "License Issue Place must be string or null" } }, "type": { "type": "string", "enum": [ "dry_van", "reefer", "flatbed", "step_deck", "lowboy", "container" ], "maxLength": 75, "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \ndry_van, reefer, flatbed, step_deck, lowboy, container", "maxLength": "Type must not exceed 75 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "plateNumber": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Plate Number must be one of these options: \nundefined", "maxLength": "Plate Number must not exceed 72 characters", "minLength": "Plate Number must contain at least undefined characters", "type": "Plate Number must be string or null" } }, "plateState": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "maxLength": 2, "nullable": true, "errorMessage": { "enum": "Plate State must be one of these options: \nAL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY", "maxLength": "Plate State must not exceed 2 characters", "minLength": "Plate State must contain at least undefined characters", "type": "Plate State must be string or null" } }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false, "required": [ "trailerNumber", "vin", "type", "year", "make", "model" ], "errorMessage": { "required": { "trailerNumber": "Trailer number is required", "vin": "VIN is required", "type": "Type is required", "year": "Year is required", "make": "Make is required", "model": "Model is required" } } }, "TrailerEditDto": { "title": "TrailerEditDto", "type": "object", "properties": { "trailerNumber": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Trailer Number must be one of these options: \nundefined", "maxLength": "Trailer Number must not exceed 255 characters", "minLength": "Trailer Number must contain at least undefined characters", "type": "Trailer Number must be string " } }, "make": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Make must be one of these options: \nundefined", "maxLength": "Make must not exceed 255 characters", "minLength": "Make must contain at least undefined characters", "type": "Make must be string " } }, "model": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Model must be one of these options: \nundefined", "maxLength": "Model must not exceed 255 characters", "minLength": "Model must contain at least undefined characters", "type": "Model must be string or null" } }, "year": { "type": "string", "maxLength": 16, "errorMessage": { "enum": "Year must be one of these options: \nundefined", "maxLength": "Year must not exceed 16 characters", "minLength": "Year must contain at least undefined characters", "type": "Year must be string " } }, "vin": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Vin must be one of these options: \nundefined", "maxLength": "Vin must not exceed 72 characters", "minLength": "Vin must contain at least undefined characters", "type": "Vin must be string " } }, "licenseNumber": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Number must be one of these options: \nundefined", "maxLength": "License Number must not exceed 255 characters", "minLength": "License Number must contain at least undefined characters", "type": "License Number must be string or null" } }, "licenseIssuePlace": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "License Issue Place must be one of these options: \nundefined", "maxLength": "License Issue Place must not exceed 255 characters", "minLength": "License Issue Place must contain at least undefined characters", "type": "License Issue Place must be string or null" } }, "type": { "type": "string", "enum": [ "dry_van", "reefer", "flatbed", "step_deck", "lowboy", "container" ], "maxLength": 75, "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \ndry_van, reefer, flatbed, step_deck, lowboy, container", "maxLength": "Type must not exceed 75 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "plateState": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "maxLength": 2, "nullable": true, "errorMessage": { "enum": "Plate State must be one of these options: \nAL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY", "maxLength": "Plate State must not exceed 2 characters", "minLength": "Plate State must contain at least undefined characters", "type": "Plate State must be string or null" } }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false }, "TrailerAttachedToUnitDto": { "title": "TrailerAttachedToUnitDto", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "pickupDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Pickup Date must be date or null", "format": "PickupDate must be a valid date (YYYY-MM-DD)" } }, "dropDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Drop Date must be date or null", "format": "DropDate must be a valid date (YYYY-MM-DD)" } }, "pickupAddress": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Pickup Address must be one of these options: \nundefined", "maxLength": "Pickup Address must not exceed 255 characters", "minLength": "Pickup Address must contain at least undefined characters", "type": "Pickup Address must be string or null" } }, "dropAddress": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Drop Address must be one of these options: \nundefined", "maxLength": "Drop Address must not exceed 255 characters", "minLength": "Drop Address must contain at least undefined characters", "type": "Drop Address must be string or null" } }, "belongToCompany": { "type": "boolean", "default": true }, "isPermanent": { "type": "boolean", "default": true } }, "additionalProperties": false }, "TollDto": { "title": "TollDto", "type": "object", "properties": { "tagCost": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Tag Cost must be number or null", "exclusiveMinimum": "Tag Cost must be greater than undefined" } }, "cashCost": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Cash Cost must be number or null", "exclusiveMinimum": "Cash Cost must be greater than undefined" } }, "licensePlateCost": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "License Plate Cost must be number or null", "exclusiveMinimum": "License Plate Cost must be greater than undefined" } }, "prepaidCardCost": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Prepaid Card Cost must be number or null", "exclusiveMinimum": "Prepaid Card Cost must be greater than undefined" } }, "creditCardCost": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Credit Card Cost must be number or null", "exclusiveMinimum": "Credit Card Cost must be greater than undefined" } }, "tag": { "type": "boolean", "nullable": true }, "cash": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TollPaymentDto": { "title": "TollPaymentDto", "type": "object", "properties": { "isTag": { "type": "boolean", "nullable": true }, "isCash": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Locations": { "title": "Locations", "type": "object", "properties": { "lat": { "type": "number", "errorMessage": { "minimum": "Lat cannot be lower than undefined", "maximum": "Lat cannot be lower than undefined", "type": "Lat must be number ", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "errorMessage": { "minimum": "Lng cannot be lower than undefined", "maximum": "Lng cannot be lower than undefined", "type": "Lng must be number ", "exclusiveMinimum": "Lng must be greater than undefined" } }, "address": { "type": "string", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } } }, "additionalProperties": false }, "TollCalculatorDto": { "title": "TollCalculatorDto", "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/Locations" } }, "isHazmat": { "type": "boolean" }, "isStateMileage": { "type": "boolean" }, "fuelCostUnit": { "type": "string", "errorMessage": { "enum": "Fuel Cost Unit must be one of these options: \nundefined", "maxLength": "Fuel Cost Unit must not exceed undefined characters", "minLength": "Fuel Cost Unit must contain at least undefined characters", "type": "Fuel Cost Unit must be string " } }, "fuelCostCurrency": { "type": "string", "errorMessage": { "enum": "Fuel Cost Currency must be one of these options: \nundefined", "maxLength": "Fuel Cost Currency must not exceed undefined characters", "minLength": "Fuel Cost Currency must contain at least undefined characters", "type": "Fuel Cost Currency must be string " } }, "fuelCostUnits": { "type": "string", "errorMessage": { "enum": "Fuel Cost Units must be one of these options: \nundefined", "maxLength": "Fuel Cost Units must not exceed undefined characters", "minLength": "Fuel Cost Units must contain at least undefined characters", "type": "Fuel Cost Units must be string " } }, "vehicleType": { "type": "string", "errorMessage": { "enum": "Vehicle Type must be one of these options: \nundefined", "maxLength": "Vehicle Type must not exceed undefined characters", "minLength": "Vehicle Type must contain at least undefined characters", "type": "Vehicle Type must be string " } }, "vehicleAxles": { "type": "number", "errorMessage": { "minimum": "Vehicle Axles cannot be lower than undefined", "maximum": "Vehicle Axles cannot be lower than undefined", "type": "Vehicle Axles must be number ", "exclusiveMinimum": "Vehicle Axles must be greater than undefined" } }, "departureTime": { "type": "string", "errorMessage": { "type": "Departure Time must be date " } } }, "additionalProperties": false, "required": [ "locations" ] }, "TollTransactionCreateData": { "title": "TollTransactionCreateData", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "licensePlate": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "License Plate must be one of these options: \nundefined", "maxLength": "License Plate must not exceed 36 characters", "minLength": "License Plate must contain at least undefined characters", "type": "License Plate must be string or null" } }, "agency": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Agency must be one of these options: \nundefined", "maxLength": "Agency must not exceed 24 characters", "minLength": "Agency must contain at least undefined characters", "type": "Agency must be string or null" } }, "tollTagNumber": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Toll Tag Number must be one of these options: \nundefined", "maxLength": "Toll Tag Number must not exceed 36 characters", "minLength": "Toll Tag Number must contain at least undefined characters", "type": "Toll Tag Number must be string or null" } }, "postingDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "type": "Posting Date must be date or null", "format": "PostingDate must be a valid date-time (ISO 8601)" } }, "exitDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "type": "Exit Date must be date or null", "format": "ExitDate must be a valid date-time (ISO 8601)" } }, "payAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Pay Amount must be number or null", "exclusiveMinimum": "Pay Amount must be greater than undefined" } }, "exitPlaza": { "type": "string", "nullable": true, "errorMessage": { "enum": "Exit Plaza must be one of these options: \nundefined", "maxLength": "Exit Plaza must not exceed undefined characters", "minLength": "Exit Plaza must contain at least undefined characters", "type": "Exit Plaza must be string or null" } }, "entryPlaza": { "type": "string", "nullable": true, "errorMessage": { "enum": "Entry Plaza must be one of these options: \nundefined", "maxLength": "Entry Plaza must not exceed undefined characters", "minLength": "Entry Plaza must contain at least undefined characters", "type": "Entry Plaza must be string or null" } }, "readType": { "type": "string", "nullable": true, "errorMessage": { "enum": "Read Type must be one of these options: \nundefined", "maxLength": "Read Type must not exceed undefined characters", "minLength": "Read Type must contain at least undefined characters", "type": "Read Type must be string or null" } }, "equipmentId": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Equipment Id must be one of these options: \nundefined", "maxLength": "Equipment Id must not exceed 24 characters", "minLength": "Equipment Id must contain at least undefined characters", "type": "Equipment Id must be string or null" } }, "source": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Source must be one of these options: \nundefined", "maxLength": "Source must not exceed 24 characters", "minLength": "Source must contain at least undefined characters", "type": "Source must be string or null" } } }, "additionalProperties": false, "required": [ "driverId", "payAmount", "unitId" ] }, "TollTransactionImportData": { "title": "TollTransactionImportData", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "licensePlate": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "License Plate must be one of these options: \nundefined", "maxLength": "License Plate must not exceed 36 characters", "minLength": "License Plate must contain at least undefined characters", "type": "License Plate must be string or null" } }, "agency": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Agency must be one of these options: \nundefined", "maxLength": "Agency must not exceed 24 characters", "minLength": "Agency must contain at least undefined characters", "type": "Agency must be string or null" } }, "tollTagNumber": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Toll Tag Number must be one of these options: \nundefined", "maxLength": "Toll Tag Number must not exceed 36 characters", "minLength": "Toll Tag Number must contain at least undefined characters", "type": "Toll Tag Number must be string or null" } }, "postingDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "type": "Posting Date must be date or null", "format": "PostingDate must be a valid date-time (ISO 8601)" } }, "exitDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "type": "Exit Date must be date or null", "format": "ExitDate must be a valid date-time (ISO 8601)" } }, "payAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Pay Amount must be number or null", "exclusiveMinimum": "Pay Amount must be greater than undefined" } }, "exitPlaza": { "type": "string", "nullable": true, "errorMessage": { "enum": "Exit Plaza must be one of these options: \nundefined", "maxLength": "Exit Plaza must not exceed undefined characters", "minLength": "Exit Plaza must contain at least undefined characters", "type": "Exit Plaza must be string or null" } }, "entryPlaza": { "type": "string", "nullable": true, "errorMessage": { "enum": "Entry Plaza must be one of these options: \nundefined", "maxLength": "Entry Plaza must not exceed undefined characters", "minLength": "Entry Plaza must contain at least undefined characters", "type": "Entry Plaza must be string or null" } }, "readType": { "type": "string", "nullable": true, "errorMessage": { "enum": "Read Type must be one of these options: \nundefined", "maxLength": "Read Type must not exceed undefined characters", "minLength": "Read Type must contain at least undefined characters", "type": "Read Type must be string or null" } }, "equipmentId": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Equipment Id must be one of these options: \nundefined", "maxLength": "Equipment Id must not exceed 24 characters", "minLength": "Equipment Id must contain at least undefined characters", "type": "Equipment Id must be string or null" } }, "source": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Source must be one of these options: \nundefined", "maxLength": "Source must not exceed 24 characters", "minLength": "Source must contain at least undefined characters", "type": "Source must be string or null" } } }, "additionalProperties": false, "required": [ "driverId", "postingDate" ], "errorMessage": { "required": { "driverId": "Driver required", "postingDate": "Posting date required" } } }, "TollImportedData": { "title": "TollImportedData", "type": "object", "properties": { "fileKey": { "type": "string", "nullable": true, "errorMessage": { "enum": "File Key must be one of these options: \nundefined", "maxLength": "File Key must not exceed undefined characters", "minLength": "File Key must contain at least undefined characters", "type": "File Key must be string or null" } }, "platform": { "type": "string", "enum": [ "prepass_plus" ], "maxLength": 12, "errorMessage": { "enum": "Platform must be one of these options: \nprepass_plus", "maxLength": "Platform must not exceed 12 characters", "minLength": "Platform must contain at least undefined characters", "type": "Platform must be string " } }, "tollTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/TollTransactionImportData" } }, "postingFromDate": { "type": "string", "nullable": true, "errorMessage": { "type": "Posting From Date must be date or null" } }, "postingToDate": { "type": "string", "nullable": true, "errorMessage": { "type": "Posting To Date must be date or null" } }, "exitFromDate": { "type": "string", "nullable": true, "errorMessage": { "type": "Exit From Date must be date or null" } }, "exitToDate": { "type": "string", "nullable": true, "errorMessage": { "type": "Exit To Date must be date or null" } } }, "additionalProperties": false, "required": [ "platform", "tollTransactions" ] }, "TollTransactionUpdateData": { "title": "TollTransactionUpdateData", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "licensePlate": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "License Plate must be one of these options: \nundefined", "maxLength": "License Plate must not exceed 36 characters", "minLength": "License Plate must contain at least undefined characters", "type": "License Plate must be string or null" } }, "agency": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Agency must be one of these options: \nundefined", "maxLength": "Agency must not exceed 24 characters", "minLength": "Agency must contain at least undefined characters", "type": "Agency must be string or null" } }, "tollTagNumber": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Toll Tag Number must be one of these options: \nundefined", "maxLength": "Toll Tag Number must not exceed 36 characters", "minLength": "Toll Tag Number must contain at least undefined characters", "type": "Toll Tag Number must be string or null" } }, "postingDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "type": "Posting Date must be date or null", "format": "PostingDate must be a valid date-time (ISO 8601)" } }, "exitDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "type": "Exit Date must be date or null", "format": "ExitDate must be a valid date-time (ISO 8601)" } }, "payAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Pay Amount must be number or null", "exclusiveMinimum": "Pay Amount must be greater than undefined" } }, "exitPlaza": { "type": "string", "nullable": true, "errorMessage": { "enum": "Exit Plaza must be one of these options: \nundefined", "maxLength": "Exit Plaza must not exceed undefined characters", "minLength": "Exit Plaza must contain at least undefined characters", "type": "Exit Plaza must be string or null" } }, "entryPlaza": { "type": "string", "nullable": true, "errorMessage": { "enum": "Entry Plaza must be one of these options: \nundefined", "maxLength": "Entry Plaza must not exceed undefined characters", "minLength": "Entry Plaza must contain at least undefined characters", "type": "Entry Plaza must be string or null" } }, "readType": { "type": "string", "nullable": true, "errorMessage": { "enum": "Read Type must be one of these options: \nundefined", "maxLength": "Read Type must not exceed undefined characters", "minLength": "Read Type must contain at least undefined characters", "type": "Read Type must be string or null" } }, "equipmentId": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Equipment Id must be one of these options: \nundefined", "maxLength": "Equipment Id must not exceed 24 characters", "minLength": "Equipment Id must contain at least undefined characters", "type": "Equipment Id must be string or null" } }, "source": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Source must be one of these options: \nundefined", "maxLength": "Source must not exceed 24 characters", "minLength": "Source must contain at least undefined characters", "type": "Source must be string or null" } } }, "additionalProperties": false }, "TollTransactionUpdateTruckDriverCoDriverDto": { "title": "TollTransactionUpdateTruckDriverCoDriverDto", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } } }, "additionalProperties": false }, "TollTagCreateData": { "title": "TollTagCreateData", "type": "object", "properties": { "tagNumber": { "type": "string", "maxLength": 24, "errorMessage": { "enum": "Tag Number must be one of these options: \nundefined", "maxLength": "Tag Number must not exceed 24 characters", "minLength": "Tag Number must contain at least undefined characters", "type": "Tag Number must be string " } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "tollTagProviderId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Toll Tag Provider Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "tagNumber" ] }, "TollTagEditData": { "title": "TollTagEditData", "type": "object", "properties": { "tagNumber": { "type": "string", "maxLength": 24, "errorMessage": { "enum": "Tag Number must be one of these options: \nundefined", "maxLength": "Tag Number must not exceed 24 characters", "minLength": "Tag Number must contain at least undefined characters", "type": "Tag Number must be string " } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "tollTagProviderId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Toll Tag Provider Id must be a valid UUID" } } }, "additionalProperties": false }, "TollTagProviderCreateData": { "title": "TollTagProviderCreateData", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } } }, "additionalProperties": false, "required": [ "name" ], "errorMessage": { "required": { "name": "Name is required" } } }, "TicketDto": { "title": "TicketDto", "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 255 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string or null" } }, "description": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1000 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "status": { "type": "string", "enum": [ "open", "closed" ], "maxLength": 10, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nopen, closed", "maxLength": "Status must not exceed 10 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "unitId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Unit Id must be one of these options: \nundefined", "maxLength": "Unit Id must not exceed 36 characters", "minLength": "Unit Id must contain at least undefined characters", "type": "Unit Id must be string or null" } }, "trailerId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Trailer Id must be one of these options: \nundefined", "maxLength": "Trailer Id must not exceed 36 characters", "minLength": "Trailer Id must contain at least undefined characters", "type": "Trailer Id must be string or null" } } }, "additionalProperties": false, "required": [ "title", "description" ], "errorMessage": { "required": { "title": "Title is required", "description": "Description is required" } } }, "TicketDtoV2": { "title": "TicketDtoV2", "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 255 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string or null" } }, "description": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1000 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "status": { "type": "string", "enum": [ "NEW", "ACKNOWLEDGED", "IN_PROGRESS", "WAITING_ON_VENDOR", "WAITING_ON_DRIVER", "RESOLVED", "CLOSED" ], "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nNEW, ACKNOWLEDGED, IN_PROGRESS, WAITING_ON_VENDOR, WAITING_ON_DRIVER, RESOLVED, CLOSED", "maxLength": "Status must not exceed 20 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "category": { "type": "string", "enum": [ "TIRE", "ENGINE", "ELECTRICAL", "TRAILER", "DOT", "BREAKDOWN", "OTHER" ], "maxLength": 10, "nullable": true, "errorMessage": { "enum": "Category must be one of these options: \nTIRE, ENGINE, ELECTRICAL, TRAILER, DOT, BREAKDOWN, OTHER", "maxLength": "Category must not exceed 10 characters", "minLength": "Category must contain at least undefined characters", "type": "Category must be string or null" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "city": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 255 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 255 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "zipCode": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 255 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string or null" } }, "trailerId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Trailer Id must be one of these options: \nundefined", "maxLength": "Trailer Id must not exceed 36 characters", "minLength": "Trailer Id must contain at least undefined characters", "type": "Trailer Id must be string or null" } }, "unitId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Unit Id must be one of these options: \nundefined", "maxLength": "Unit Id must not exceed 36 characters", "minLength": "Unit Id must contain at least undefined characters", "type": "Unit Id must be string or null" } } }, "additionalProperties": false, "required": [ "title", "description" ], "errorMessage": { "required": { "title": "Title is required", "description": "Description is required" } } }, "TicketUpdateDto": { "title": "TicketUpdateDto", "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 255 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string or null" } }, "description": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1000 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "status": { "type": "string", "enum": [ "open", "closed" ], "maxLength": 10, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nopen, closed", "maxLength": "Status must not exceed 10 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "unitId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Unit Id must be one of these options: \nundefined", "maxLength": "Unit Id must not exceed 36 characters", "minLength": "Unit Id must contain at least undefined characters", "type": "Unit Id must be string or null" } }, "trailerId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Trailer Id must be one of these options: \nundefined", "maxLength": "Trailer Id must not exceed 36 characters", "minLength": "Trailer Id must contain at least undefined characters", "type": "Trailer Id must be string or null" } } }, "additionalProperties": false }, "TicketUpdateDtoV2": { "title": "TicketUpdateDtoV2", "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 255 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string or null" } }, "description": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1000 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "status": { "type": "string", "enum": [ "NEW", "ACKNOWLEDGED", "IN_PROGRESS", "WAITING_ON_VENDOR", "WAITING_ON_DRIVER", "RESOLVED", "CLOSED" ], "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nNEW, ACKNOWLEDGED, IN_PROGRESS, WAITING_ON_VENDOR, WAITING_ON_DRIVER, RESOLVED, CLOSED", "maxLength": "Status must not exceed 20 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "category": { "type": "string", "enum": [ "TIRE", "ENGINE", "ELECTRICAL", "TRAILER", "DOT", "BREAKDOWN", "OTHER" ], "maxLength": 10, "nullable": true, "errorMessage": { "enum": "Category must be one of these options: \nTIRE, ENGINE, ELECTRICAL, TRAILER, DOT, BREAKDOWN, OTHER", "maxLength": "Category must not exceed 10 characters", "minLength": "Category must contain at least undefined characters", "type": "Category must be string or null" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "city": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 255 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 255 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "zipCode": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 255 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string or null" } }, "trailerId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Trailer Id must be one of these options: \nundefined", "maxLength": "Trailer Id must not exceed 36 characters", "minLength": "Trailer Id must contain at least undefined characters", "type": "Trailer Id must be string or null" } }, "unitId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Unit Id must be one of these options: \nundefined", "maxLength": "Unit Id must not exceed 36 characters", "minLength": "Unit Id must contain at least undefined characters", "type": "Unit Id must be string or null" } } }, "additionalProperties": false }, "TicketCommentDto": { "title": "TicketCommentDto", "type": "object", "properties": { "ticketId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Ticket Id must be a valid UUID" } }, "text": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1000 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } } }, "additionalProperties": false, "required": [ "ticketId" ], "errorMessage": { "required": { "ticketId": "Ticket is required" } } }, "TicketCommentEditDto": { "title": "TicketCommentEditDto", "type": "object", "properties": { "ticketId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Ticket Id must be a valid UUID" } }, "text": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1000 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } } }, "additionalProperties": false, "required": [ "ticketId" ], "errorMessage": { "required": { "ticketId": "Ticket is required" } } }, "Tax1099PdfGenerateDto": { "title": "Tax1099PdfGenerateDto", "type": "object", "properties": { "totalAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Amount must be number or null", "exclusiveMinimum": "Total Amount must be greater than undefined" } }, "year": { "type": "string", "errorMessage": { "enum": "Year must be one of these options: \nundefined", "maxLength": "Year must not exceed undefined characters", "minLength": "Year must contain at least undefined characters", "type": "Year must be string " } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } } }, "additionalProperties": false }, "Tax1099PdfGenerateArrayDto": { "title": "Tax1099PdfGenerateArrayDto", "type": "object", "properties": { "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/Tax1099PdfGenerateDto" } } }, "additionalProperties": false, "required": [ "taxes" ], "errorMessage": { "required": { "taxes": "Taxes is required" } } }, "StripeAttachCardDto": { "title": "StripeAttachCardDto", "type": "object", "properties": { "paymentMethodId": { "type": "string", "errorMessage": { "enum": "Payment Method Id must be one of these options: \nundefined", "maxLength": "Payment Method Id must not exceed undefined characters", "minLength": "Payment Method Id must contain at least undefined characters", "type": "Payment Method Id must be string " } }, "makeDefault": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "StopCreateDto": { "title": "StopCreateDto", "type": "object", "properties": { "stopNo": { "type": "number", "errorMessage": { "minimum": "Stop No cannot be lower than undefined", "maximum": "Stop No cannot be lower than undefined", "type": "Stop No must be number ", "exclusiveMinimum": "Stop No must be greater than undefined" } }, "address": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least 1 characters", "type": "Address must be string or null", "pattern": "must not be blank" } }, "city": { "type": "string", "minLength": 1, "maxLength": 120, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least 1 characters", "type": "City must be string or null", "pattern": "must not be blank" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Customer Id must be a valid UUID" } }, "puNumber": { "type": "string", "nullable": true, "errorMessage": { "enum": "Pu Number must be one of these options: \nundefined", "maxLength": "Pu Number must not exceed undefined characters", "minLength": "Pu Number must contain at least undefined characters", "type": "Pu Number must be string or null" } }, "state": { "type": "string", "minLength": 1, "maxLength": 55, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least 1 characters", "type": "State must be string or null", "pattern": "must not be blank" } }, "type": { "type": "string", "enum": [ "shipper", "consignee", "consignee/shipper" ], "maxLength": 25, "errorMessage": { "enum": "Type must be one of these options: \nshipper, consignee, consignee/shipper", "maxLength": "Type must not exceed 25 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "contactId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Contact Id must be one of these options: \nundefined", "maxLength": "Contact Id must not exceed undefined characters", "minLength": "Contact Id must contain at least undefined characters", "type": "Contact Id must be string or null" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "stopTrailer": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Stop Trailer must be one of these options: \nundefined", "maxLength": "Stop Trailer must not exceed 255 characters", "minLength": "Stop Trailer must contain at least undefined characters", "type": "Stop Trailer must be string or null" } }, "fromDate": { "type": "string", "format": "date-time", "errorMessage": { "enum": "From Date must be one of these options: \nundefined", "maxLength": "From Date must not exceed undefined characters", "minLength": "From Date must contain at least undefined characters", "type": "From Date must be string ", "format": "FromDate must be a valid date-time (ISO 8601)" } }, "toDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "To Date must be one of these options: \nundefined", "maxLength": "To Date must not exceed undefined characters", "minLength": "To Date must contain at least undefined characters", "type": "To Date must be string or null", "format": "ToDate must be a valid date-time (ISO 8601)" } }, "loadId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Load Id must be a valid UUID" } }, "addresses": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Addresses must be one of these options: \nundefined", "maxLength": "Addresses must not exceed 255 characters", "minLength": "Addresses must contain at least undefined characters", "type": "Addresses must be string or null" } }, "lat": { "type": "number", "format": "float", "errorMessage": { "type": "Lat must be number ", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "format": "float", "errorMessage": { "type": "Lng must be number ", "exclusiveMinimum": "Lng must be greater than undefined" } }, "zipCodes": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed 255 characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string or null" } } }, "additionalProperties": false, "required": [ "stopNo", "customerId", "fromDate", "type", "loadId" ], "errorMessage": { "required": { "stopNo": "Stop number is required", "customerId": "Customer is required", "fromDate": "From Date is required", "type": "Type is required", "loadId": "Load is required" } } }, "StopEditDto": { "title": "StopEditDto", "type": "object", "properties": { "stopNo": { "type": "number", "errorMessage": { "minimum": "Stop No cannot be lower than undefined", "maximum": "Stop No cannot be lower than undefined", "type": "Stop No must be number ", "exclusiveMinimum": "Stop No must be greater than undefined" } }, "address": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least 1 characters", "type": "Address must be string or null", "pattern": "must not be blank" } }, "city": { "type": "string", "minLength": 1, "maxLength": 120, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least 1 characters", "type": "City must be string or null", "pattern": "must not be blank" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Customer Id must be a valid UUID" } }, "puNumber": { "type": "string", "nullable": true, "errorMessage": { "enum": "Pu Number must be one of these options: \nundefined", "maxLength": "Pu Number must not exceed undefined characters", "minLength": "Pu Number must contain at least undefined characters", "type": "Pu Number must be string or null" } }, "state": { "type": "string", "minLength": 1, "maxLength": 55, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least 1 characters", "type": "State must be string or null", "pattern": "must not be blank" } }, "type": { "type": "string", "enum": [ "shipper", "consignee", "consignee/shipper" ], "maxLength": 25, "errorMessage": { "enum": "Type must be one of these options: \nshipper, consignee, consignee/shipper", "maxLength": "Type must not exceed 25 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "contactId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Contact Id must be one of these options: \nundefined", "maxLength": "Contact Id must not exceed undefined characters", "minLength": "Contact Id must contain at least undefined characters", "type": "Contact Id must be string or null" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "stopTrailer": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Stop Trailer must be one of these options: \nundefined", "maxLength": "Stop Trailer must not exceed 255 characters", "minLength": "Stop Trailer must contain at least undefined characters", "type": "Stop Trailer must be string or null" } }, "fromDate": { "type": "string", "format": "date-time", "errorMessage": { "enum": "From Date must be one of these options: \nundefined", "maxLength": "From Date must not exceed undefined characters", "minLength": "From Date must contain at least undefined characters", "type": "From Date must be string ", "format": "FromDate must be a valid date-time (ISO 8601)" } }, "toDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "To Date must be one of these options: \nundefined", "maxLength": "To Date must not exceed undefined characters", "minLength": "To Date must contain at least undefined characters", "type": "To Date must be string or null", "format": "ToDate must be a valid date-time (ISO 8601)" } }, "loadId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Load Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "stopNo", "customerId", "fromDate", "type", "loadId" ], "errorMessage": { "required": { "stopNo": "Stop number is required", "customerId": "Customer is required", "fromDate": "From Date is required", "type": "Type is required", "loadId": "Load is required" } } }, "StopsUpdatePositionStatusDto": { "title": "StopsUpdatePositionStatusDto", "type": "object", "properties": { "currentStop": { "type": "number", "errorMessage": { "minimum": "Current Stop cannot be lower than undefined", "maximum": "Current Stop cannot be lower than undefined", "type": "Current Stop must be number ", "exclusiveMinimum": "Current Stop must be greater than undefined" } }, "status": { "type": "string", "enum": [ "checkIn", "checkOut" ], "errorMessage": { "enum": "Status must be one of these options: \ncheckIn, checkOut", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } } }, "additionalProperties": false, "required": [ "currentStop", "status" ], "errorMessage": { "required": { "currentStop": "Stop number is required", "status": "Stop status is required" } } }, "ServiceTaskDto": { "title": "ServiceTaskDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "system": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "System must be one of these options: \nundefined", "maxLength": "System must not exceed 255 characters", "minLength": "System must contain at least undefined characters", "type": "System must be string " } }, "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } } }, "additionalProperties": false }, "ServiceTaskEditDto": { "title": "ServiceTaskEditDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "system": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "System must be one of these options: \nundefined", "maxLength": "System must not exceed 255 characters", "minLength": "System must contain at least undefined characters", "type": "System must be string " } }, "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } } }, "additionalProperties": false }, "ServiceScheduleDto": { "title": "ServiceScheduleDto", "type": "object", "properties": { "timeInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Interval cannot be lower than undefined", "maximum": "Time Interval cannot be lower than undefined", "type": "Time Interval must be number or null", "exclusiveMinimum": "Time Interval must be greater than undefined" } }, "timeIntervalFrequency": { "type": "string", "enum": [ "day(s)", "week(s)", "month(s)", "year(s)" ], "maxLength": 12, "nullable": true, "errorMessage": { "enum": "Time Interval Frequency must be one of these options: \nday(s), week(s), month(s), year(s)", "maxLength": "Time Interval Frequency must not exceed 12 characters", "minLength": "Time Interval Frequency must contain at least undefined characters", "type": "Time Interval Frequency must be string or null" } }, "timeDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Due Soon Threshold cannot be lower than undefined", "maximum": "Time Due Soon Threshold cannot be lower than undefined", "type": "Time Due Soon Threshold must be number or null", "exclusiveMinimum": "Time Due Soon Threshold must be greater than undefined" } }, "timeDueSoonThresholdFrequency": { "type": "string", "enum": [ "day(s)", "week(s)", "month(s)", "year(s)" ], "maxLength": 12, "nullable": true, "errorMessage": { "enum": "Time Due Soon Threshold Frequency must be one of these options: \nday(s), week(s), month(s), year(s)", "maxLength": "Time Due Soon Threshold Frequency must not exceed 12 characters", "minLength": "Time Due Soon Threshold Frequency must contain at least undefined characters", "type": "Time Due Soon Threshold Frequency must be string or null" } }, "primaryMeterInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Interval cannot be lower than undefined", "maximum": "Primary Meter Interval cannot be lower than undefined", "type": "Primary Meter Interval must be number or null", "exclusiveMinimum": "Primary Meter Interval must be greater than undefined" } }, "primaryMeterDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "maximum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "type": "Primary Meter Due Soon Threshold must be number or null", "exclusiveMinimum": "Primary Meter Due Soon Threshold must be greater than undefined" } }, "serviceTaskIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Service Task Ids items must be a valid UUID" } } } }, "additionalProperties": false }, "ServiceScheduleV2Dto": { "title": "ServiceScheduleV2Dto", "type": "object", "properties": { "serviceTaskIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Service Task Ids items must be a valid UUID" } } }, "timeInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Interval cannot be lower than undefined", "maximum": "Time Interval cannot be lower than undefined", "type": "Time Interval must be number or null", "exclusiveMinimum": "Time Interval must be greater than undefined" } }, "timeDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Due Soon Threshold cannot be lower than undefined", "maximum": "Time Due Soon Threshold cannot be lower than undefined", "type": "Time Due Soon Threshold must be number or null", "exclusiveMinimum": "Time Due Soon Threshold must be greater than undefined" } }, "primaryMeterInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Interval cannot be lower than undefined", "maximum": "Primary Meter Interval cannot be lower than undefined", "type": "Primary Meter Interval must be number or null", "exclusiveMinimum": "Primary Meter Interval must be greater than undefined" } }, "primaryMeterDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "maximum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "type": "Primary Meter Due Soon Threshold must be number or null", "exclusiveMinimum": "Primary Meter Due Soon Threshold must be greater than undefined" } } }, "additionalProperties": false, "required": [ "serviceTaskIds" ], "errorMessage": { "required": { "serviceTaskIds": "Service tasks are required" } } }, "UnitOdometerDto": { "title": "UnitOdometerDto", "type": "object", "properties": { "unitId": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Unit Id must be one of these options: \nundefined", "maxLength": "Unit Id must not exceed 36 characters", "minLength": "Unit Id must contain at least undefined characters", "type": "Unit Id must be string " } }, "lastRepairOdometer": { "type": "number", "errorMessage": { "minimum": "Last Repair Odometer cannot be lower than undefined", "maximum": "Last Repair Odometer cannot be lower than undefined", "type": "Last Repair Odometer must be number ", "exclusiveMinimum": "Last Repair Odometer must be greater than undefined" } }, "lastRepairDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Last Repair Date must be date or null", "format": "LastRepairDate must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false }, "ServiceProgramV2Dto": { "title": "ServiceProgramV2Dto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string or null" } }, "description": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 255 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "status": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nundefined", "maxLength": "Status must not exceed 24 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "automationAction": { "type": "string", "maxLength": 64, "nullable": true, "errorMessage": { "enum": "Automation Action must be one of these options: \nundefined", "maxLength": "Automation Action must not exceed 64 characters", "minLength": "Automation Action must contain at least undefined characters", "type": "Automation Action must be string or null" } }, "serviceTaskIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Service Task Ids items must be a valid UUID" } } }, "unitIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Ids items must be a valid UUID" } } }, "unitOdometers": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOdometerDto" } }, "timeInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Interval cannot be lower than undefined", "maximum": "Time Interval cannot be lower than undefined", "type": "Time Interval must be number or null", "exclusiveMinimum": "Time Interval must be greater than undefined" } }, "timeDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Due Soon Threshold cannot be lower than undefined", "maximum": "Time Due Soon Threshold cannot be lower than undefined", "type": "Time Due Soon Threshold must be number or null", "exclusiveMinimum": "Time Due Soon Threshold must be greater than undefined" } }, "primaryMeterInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Interval cannot be lower than undefined", "maximum": "Primary Meter Interval cannot be lower than undefined", "type": "Primary Meter Interval must be number or null", "exclusiveMinimum": "Primary Meter Interval must be greater than undefined" } }, "primaryMeterDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "maximum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "type": "Primary Meter Due Soon Threshold must be number or null", "exclusiveMinimum": "Primary Meter Due Soon Threshold must be greater than undefined" } } }, "additionalProperties": false, "required": [ "serviceTaskIds" ], "errorMessage": { "required": { "serviceTaskIds": "Service tasks are required" } } }, "ServiceProgramEditDto": { "title": "ServiceProgramEditDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "unitIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Ids items must be a valid UUID" } } }, "unitOdometers": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOdometerDto" } } }, "additionalProperties": false }, "ServiceProgramEditV2Dto": { "title": "ServiceProgramEditV2Dto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string or null" } }, "description": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 255 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "status": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nundefined", "maxLength": "Status must not exceed 24 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "automationAction": { "type": "string", "maxLength": 64, "nullable": true, "errorMessage": { "enum": "Automation Action must be one of these options: \nundefined", "maxLength": "Automation Action must not exceed 64 characters", "minLength": "Automation Action must contain at least undefined characters", "type": "Automation Action must be string or null" } }, "serviceTaskIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Service Task Ids items must be a valid UUID" } } }, "unitIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Ids items must be a valid UUID" } } }, "unitOdometers": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOdometerDto" } }, "timeInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Interval cannot be lower than undefined", "maximum": "Time Interval cannot be lower than undefined", "type": "Time Interval must be number or null", "exclusiveMinimum": "Time Interval must be greater than undefined" } }, "timeDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Time Due Soon Threshold cannot be lower than undefined", "maximum": "Time Due Soon Threshold cannot be lower than undefined", "type": "Time Due Soon Threshold must be number or null", "exclusiveMinimum": "Time Due Soon Threshold must be greater than undefined" } }, "primaryMeterInterval": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Interval cannot be lower than undefined", "maximum": "Primary Meter Interval cannot be lower than undefined", "type": "Primary Meter Interval must be number or null", "exclusiveMinimum": "Primary Meter Interval must be greater than undefined" } }, "primaryMeterDueSoonThreshold": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "maximum": "Primary Meter Due Soon Threshold cannot be lower than undefined", "type": "Primary Meter Due Soon Threshold must be number or null", "exclusiveMinimum": "Primary Meter Due Soon Threshold must be greater than undefined" } } }, "additionalProperties": false }, "UnitsForServiceProgramDto": { "title": "UnitsForServiceProgramDto", "type": "object", "properties": { "unitIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Ids items must be a valid UUID" } } } }, "additionalProperties": false }, "ServiceTaskLaborForOrderDto": { "title": "ServiceTaskLaborForOrderDto", "type": "object", "properties": { "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "costPerHour": { "type": "number", "format": "float", "errorMessage": { "type": "Cost Per Hour must be number ", "exclusiveMinimum": "Cost Per Hour must be greater than undefined" } }, "laborHours": { "type": "number", "errorMessage": { "minimum": "Labor Hours cannot be lower than undefined", "maximum": "Labor Hours cannot be lower than undefined", "type": "Labor Hours must be number ", "exclusiveMinimum": "Labor Hours must be greater than undefined" } }, "laborCost": { "type": "number", "format": "float", "errorMessage": { "type": "Labor Cost must be number ", "exclusiveMinimum": "Labor Cost must be greater than undefined" } } }, "additionalProperties": false }, "ServiceTaskPartForOrderDto": { "title": "ServiceTaskPartForOrderDto", "type": "object", "properties": { "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "perUnitCost": { "type": "number", "format": "float", "errorMessage": { "type": "Per Unit Cost must be number ", "exclusiveMinimum": "Per Unit Cost must be greater than undefined" } }, "quantity": { "type": "number", "errorMessage": { "minimum": "Quantity cannot be lower than undefined", "maximum": "Quantity cannot be lower than undefined", "type": "Quantity must be number ", "exclusiveMinimum": "Quantity must be greater than undefined" } }, "subtotal": { "type": "number", "format": "float", "errorMessage": { "type": "Subtotal must be number ", "exclusiveMinimum": "Subtotal must be greater than undefined" } } }, "additionalProperties": false }, "ServiceTaskWithPartAndLabors": { "title": "ServiceTaskWithPartAndLabors", "type": "object", "properties": { "serviceTaskIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Service Task Ids items must be a valid UUID" } } }, "serviceTaskLabors": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTaskLaborForOrderDto" } }, "serviceTaskParts": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTaskPartForOrderDto" } } }, "additionalProperties": false }, "OrderVendor": { "title": "OrderVendor", "type": "object", "properties": { "name": { "type": "string", "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed undefined characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "email": { "type": "string", "format": "email", "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed undefined characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "tin": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Tin must be one of these options: \nundefined", "maxLength": "Tin must not exceed 255 characters", "minLength": "Tin must contain at least undefined characters", "type": "Tin must be string or null" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "zipCodes": { "type": "string", "maxLength": 32, "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed 32 characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string or null" } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } } }, "additionalProperties": false }, "ServiceOrderDto": { "title": "ServiceOrderDto", "type": "object", "properties": { "type": { "type": "string", "enum": [ "preventive-maintenance", "repair", "roadside", "towing" ], "maxLength": 50, "errorMessage": { "enum": "Type must be one of these options: \npreventive-maintenance, repair, roadside, towing", "maxLength": "Type must not exceed 50 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "billingStatus": { "type": "string", "enum": [ "invoice_received", "approved", "disputed", "paid", "unbilled" ], "errorMessage": { "enum": "Billing Status must be one of these options: \ninvoice_received, approved, disputed, paid, unbilled", "maxLength": "Billing Status must not exceed undefined characters", "minLength": "Billing Status must contain at least undefined characters", "type": "Billing Status must be string " } }, "invoiceNumber": { "type": "string", "errorMessage": { "enum": "Invoice Number must be one of these options: \nundefined", "maxLength": "Invoice Number must not exceed undefined characters", "minLength": "Invoice Number must contain at least undefined characters", "type": "Invoice Number must be string " } }, "tax": { "type": "number", "format": "float", "errorMessage": { "type": "Tax must be number ", "exclusiveMinimum": "Tax must be greater than undefined" } }, "fee": { "type": "number", "format": "float", "errorMessage": { "type": "Fee must be number ", "exclusiveMinimum": "Fee must be greater than undefined" } }, "issueDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Issue Date must be date or null", "format": "IssueDate must be a valid date (YYYY-MM-DD)" } }, "actualStartDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Actual Start Date must be date or null", "format": "ActualStartDate must be a valid date (YYYY-MM-DD)" } }, "scheduledStartDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Scheduled Start Date must be date or null", "format": "ScheduledStartDate must be a valid date (YYYY-MM-DD)" } }, "actualCompletionDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Actual Completion Date must be date or null", "format": "ActualCompletionDate must be a valid date (YYYY-MM-DD)" } }, "status": { "type": "string", "enum": [ "open", "waiting-parts", "in-service", "completed", "draft", "closed" ], "errorMessage": { "enum": "Status must be one of these options: \nopen, waiting-parts, in-service, completed, draft, closed", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "totalCost": { "type": "number", "format": "float", "errorMessage": { "type": "Total Cost must be number ", "exclusiveMinimum": "Total Cost must be greater than undefined" } }, "assignedToId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Assigned To Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } }, "issuedById": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Issued By Id must be a valid UUID" } }, "serviceTask": { "$ref": "#/components/schemas/ServiceTaskWithPartAndLabors" }, "other": { "type": "object", "nullable": true }, "vendor": { "$ref": "#/components/schemas/OrderVendor" }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } }, "reminderId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Reminder Id must be a valid UUID" } }, "paymentResponsibility": { "type": "string", "errorMessage": { "enum": "Payment Responsibility must be one of these options: \nundefined", "maxLength": "Payment Responsibility must not exceed undefined characters", "minLength": "Payment Responsibility must contain at least undefined characters", "type": "Payment Responsibility must be string " } }, "responsibleForPaymentIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Responsible For Payment Ids items must be a valid UUID" } } }, "split": { "type": "number", "errorMessage": { "minimum": "Split cannot be lower than undefined", "maximum": "Split cannot be lower than undefined", "type": "Split must be number ", "exclusiveMinimum": "Split must be greater than undefined" } }, "notes": { "type": "string", "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "contractorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Contractor Id must be a valid UUID" } }, "currentOdometer": { "type": "number", "format": "float", "errorMessage": { "type": "Current Odometer must be number ", "exclusiveMinimum": "Current Odometer must be greater than undefined" } }, "from": { "type": "string", "nullable": true, "errorMessage": { "enum": "From must be one of these options: \nundefined", "maxLength": "From must not exceed undefined characters", "minLength": "From must contain at least undefined characters", "type": "From must be string or null" } } }, "additionalProperties": false }, "ServiceOrderEditDto": { "title": "ServiceOrderEditDto", "type": "object", "properties": { "type": { "type": "string", "enum": [ "preventive-maintenance", "repair", "roadside", "towing" ], "maxLength": 50, "errorMessage": { "enum": "Type must be one of these options: \npreventive-maintenance, repair, roadside, towing", "maxLength": "Type must not exceed 50 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "billingStatus": { "type": "string", "enum": [ "invoice_received", "approved", "disputed", "paid", "unbilled" ], "errorMessage": { "enum": "Billing Status must be one of these options: \ninvoice_received, approved, disputed, paid, unbilled", "maxLength": "Billing Status must not exceed undefined characters", "minLength": "Billing Status must contain at least undefined characters", "type": "Billing Status must be string " } }, "invoiceNumber": { "type": "string", "errorMessage": { "enum": "Invoice Number must be one of these options: \nundefined", "maxLength": "Invoice Number must not exceed undefined characters", "minLength": "Invoice Number must contain at least undefined characters", "type": "Invoice Number must be string " } }, "tax": { "type": "number", "format": "float", "errorMessage": { "type": "Tax must be number ", "exclusiveMinimum": "Tax must be greater than undefined" } }, "fee": { "type": "number", "format": "float", "errorMessage": { "type": "Fee must be number ", "exclusiveMinimum": "Fee must be greater than undefined" } }, "issueDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Issue Date must be date or null", "format": "IssueDate must be a valid date (YYYY-MM-DD)" } }, "actualStartDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Actual Start Date must be date or null", "format": "ActualStartDate must be a valid date (YYYY-MM-DD)" } }, "scheduledStartDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Scheduled Start Date must be date or null", "format": "ScheduledStartDate must be a valid date (YYYY-MM-DD)" } }, "actualCompletionDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Actual Completion Date must be date or null", "format": "ActualCompletionDate must be a valid date (YYYY-MM-DD)" } }, "status": { "type": "string", "enum": [ "open", "waiting-parts", "in-service", "completed", "draft", "closed" ], "errorMessage": { "enum": "Status must be one of these options: \nopen, waiting-parts, in-service, completed, draft, closed", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "totalCost": { "type": "number", "format": "float", "errorMessage": { "type": "Total Cost must be number ", "exclusiveMinimum": "Total Cost must be greater than undefined" } }, "assignedToId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Assigned To Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } }, "issuedById": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Issued By Id must be a valid UUID" } }, "paymentResponsibility": { "type": "string", "errorMessage": { "enum": "Payment Responsibility must be one of these options: \nundefined", "maxLength": "Payment Responsibility must not exceed undefined characters", "minLength": "Payment Responsibility must contain at least undefined characters", "type": "Payment Responsibility must be string " } }, "serviceTask": { "$ref": "#/components/schemas/ServiceTaskWithPartAndLabors" }, "other": { "type": "object", "nullable": true }, "vendor": { "$ref": "#/components/schemas/OrderVendor" }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } }, "responsibleForPaymentIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Responsible For Payment Ids items must be a valid UUID" } } }, "split": { "type": "number", "errorMessage": { "minimum": "Split cannot be lower than undefined", "maximum": "Split cannot be lower than undefined", "type": "Split must be number ", "exclusiveMinimum": "Split must be greater than undefined" } }, "notes": { "type": "string", "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "contractorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Contractor Id must be a valid UUID" } }, "currentOdometer": { "type": "number", "format": "float", "errorMessage": { "type": "Current Odometer must be number ", "exclusiveMinimum": "Current Odometer must be greater than undefined" } }, "from": { "type": "string", "nullable": true, "errorMessage": { "enum": "From must be one of these options: \nundefined", "maxLength": "From must not exceed undefined characters", "minLength": "From must contain at least undefined characters", "type": "From must be string or null" } } }, "additionalProperties": false }, "AiReportQueryDto": { "title": "AiReportQueryDto", "type": "object", "properties": { "prompt": { "type": "string", "minLength": 3, "maxLength": 1000, "errorMessage": { "enum": "Prompt must be one of these options: \nundefined", "maxLength": "Prompt must not exceed 1000 characters", "minLength": "Prompt must contain at least 3 characters", "type": "Prompt must be string " } } }, "additionalProperties": false }, "CSO": { "title": "CSO", "type": "object", "properties": { "csoNumber": { "type": "number" }, "csoPrompt": { "type": "string" }, "csoText": { "type": "string" } }, "additionalProperties": false }, "QuestOrderDto": { "title": "QuestOrderDto", "type": "object", "properties": { "collectionSiteCode": { "type": "string", "maxLength": 6, "errorMessage": { "enum": "Collection Site Code must be one of these options: \nundefined", "maxLength": "Collection Site Code must not exceed 6 characters", "minLength": "Collection Site Code must contain at least undefined characters", "type": "Collection Site Code must be string " } }, "emailAddress": { "type": "array", "items": { "type": "string", "format": "email", "maxLength": 254, "minItems": 1 } }, "endDateTime": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "type": "End Date Time must be date or null", "format": "EndDateTime must be a valid date-time (ISO 8601)" } }, "endDateTimeZoneId": { "type": "number", "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "nullable": true }, "firstName": { "type": "string", "maxLength": 20, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 20 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "middleName": { "type": "string", "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Middle Name must be one of these options: \nundefined", "maxLength": "Middle Name must not exceed 20 characters", "minLength": "Middle Name must contain at least undefined characters", "type": "Middle Name must be string or null" } }, "lastName": { "type": "string", "maxLength": 20, "errorMessage": { "enum": "Last Name must be one of these options: \nundefined", "maxLength": "Last Name must not exceed 20 characters", "minLength": "Last Name must contain at least undefined characters", "type": "Last Name must be string " } }, "primaryId": { "type": "string", "default": "TEST123", "maxLength": 25 }, "dateOfBirth": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date Of Birth must be date or null", "format": "DateOfBirth must be a valid date (YYYY-MM-DD)" } }, "primaryPhone": { "type": "string", "maxLength": 24, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Primary Phone must be one of these options: \nundefined", "maxLength": "Primary Phone must not exceed 24 characters", "minLength": "Primary Phone must contain at least undefined characters", "type": "Primary Phone must be string or null", "pattern": "Primary phone should follow '(###) ###-####' pattern" } }, "secondaryPhone": { "type": "string", "maxLength": 24, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Secondary Phone must be one of these options: \nundefined", "maxLength": "Secondary Phone must not exceed 24 characters", "minLength": "Secondary Phone must contain at least undefined characters", "type": "Secondary Phone must be string or null", "pattern": "Secondary phone should follow '(###) ###-####' pattern" } }, "contactName": { "type": "string", "maxLength": 45, "nullable": true, "errorMessage": { "enum": "Contact Name must be one of these options: \nundefined", "maxLength": "Contact Name must not exceed 45 characters", "minLength": "Contact Name must contain at least undefined characters", "type": "Contact Name must be string or null" } }, "csl": { "type": "string", "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Csl must be one of these options: \nundefined", "maxLength": "Csl must not exceed 20 characters", "minLength": "Csl must contain at least undefined characters", "type": "Csl must be string or null" } }, "unitCodesIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Codes Ids items must be a valid UUID" } } }, "unitCodes": { "type": "array", "items": { "type": "string", "minItems": 1, "maxLength": 15 } }, "clientReferenceId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Client Reference Id must be one of these options: \nundefined", "maxLength": "Client Reference Id must not exceed 36 characters", "minLength": "Client Reference Id must contain at least undefined characters", "type": "Client Reference Id must be string or null" } }, "paymentMethodId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Payment Method Id must be one of these options: \nundefined", "maxLength": "Payment Method Id must not exceed undefined characters", "minLength": "Payment Method Id must contain at least undefined characters", "type": "Payment Method Id must be string or null" } }, "testingAuthority": { "type": "string", "enum": [ "FMCSA", "PHMSA", "FAA", "FTA", "FRA", "USCG" ], "maxLength": 5, "nullable": true, "errorMessage": { "enum": "Testing Authority must be one of these options: \nFMCSA, PHMSA, FAA, FTA, FRA, USCG", "maxLength": "Testing Authority must not exceed 5 characters", "minLength": "Testing Authority must contain at least undefined characters", "type": "Testing Authority must be string or null" } }, "reasonForTestId": { "type": "number", "enum": [ 1, 2, 3, 5, 6, 23, 99 ], "nullable": true }, "observedRequested": { "type": "string", "enum": [ "Y", "N" ], "maxLength": 1, "nullable": true, "errorMessage": { "enum": "Observed Requested must be one of these options: \nY, N", "maxLength": "Observed Requested must not exceed 1 characters", "minLength": "Observed Requested must contain at least undefined characters", "type": "Observed Requested must be string or null" } }, "splitSpecimenRequested": { "type": "string", "enum": [ "Y", "N" ], "maxLength": 1, "nullable": true, "errorMessage": { "enum": "Split Specimen Requested must be one of these options: \nY, N", "maxLength": "Split Specimen Requested must not exceed 1 characters", "minLength": "Split Specimen Requested must contain at least undefined characters", "type": "Split Specimen Requested must be string or null" } }, "orderComments": { "type": "string", "maxLength": 250, "nullable": true, "errorMessage": { "enum": "Order Comments must be one of these options: \nundefined", "maxLength": "Order Comments must not exceed 250 characters", "minLength": "Order Comments must contain at least undefined characters", "type": "Order Comments must be string or null" } }, "cso": { "$ref": "#/components/schemas/CSO" } }, "additionalProperties": false, "required": [ "firstName", "lastName", "primaryId", "testingAuthority", "unitCodesIds" ], "errorMessage": { "required": { "firstName": "First name is required", "lastName": "Last name is required", "primaryId": "Primary ID is required", "testingAuthority": "Testing Authority is required" } } }, "SendEmailData": { "title": "SendEmailData", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 255 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } } }, "additionalProperties": false, "required": [ "email" ], "errorMessage": { "required": { "email": "Email is required" } } }, "PlacesDto": { "title": "PlacesDto", "type": "object", "properties": { "stateNumber": { "type": "number", "nullable": true, "errorMessage": { "minimum": "State Number cannot be lower than undefined", "maximum": "State Number cannot be lower than undefined", "type": "State Number must be number or null", "exclusiveMinimum": "State Number must be greater than undefined" } }, "lng": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lng must be number or null", "exclusiveMinimum": "Lng must be greater than undefined" } }, "lat": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lat must be number or null", "exclusiveMinimum": "Lat must be greater than undefined" } }, "milePost": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Mile Post must be number or null", "exclusiveMinimum": "Mile Post must be greater than undefined" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "highwayRoute": { "type": "string", "nullable": true, "errorMessage": { "enum": "Highway Route must be one of these options: \nundefined", "maxLength": "Highway Route must not exceed undefined characters", "minLength": "Highway Route must contain at least undefined characters", "type": "Highway Route must be string or null" } }, "municipal": { "type": "string", "nullable": true, "errorMessage": { "enum": "Municipal must be one of these options: \nundefined", "maxLength": "Municipal must not exceed undefined characters", "minLength": "Municipal must contain at least undefined characters", "type": "Municipal must be string or null" } }, "county": { "type": "string", "nullable": true, "errorMessage": { "enum": "County must be one of these options: \nundefined", "maxLength": "County must not exceed undefined characters", "minLength": "County must contain at least undefined characters", "type": "County must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "phoneNumber": { "type": "string", "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Phone Number must be one of these options: \nundefined", "maxLength": "Phone Number must not exceed 20 characters", "minLength": "Phone Number must contain at least undefined characters", "type": "Phone Number must be string or null" } } }, "additionalProperties": false }, "Make": { "title": "Make", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "type": { "type": "string" }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "NotificationCreateDto": { "title": "NotificationCreateDto", "type": "object", "properties": { "description": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1200 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "title": { "type": "string", "maxLength": 512, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 512 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string " } }, "type": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed 55 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } } }, "additionalProperties": false }, "StopsForLoadDto": { "title": "StopsForLoadDto", "type": "object", "properties": { "stopNo": { "type": "number", "errorMessage": { "minimum": "Stop No cannot be lower than undefined", "maximum": "Stop No cannot be lower than undefined", "type": "Stop No must be number ", "exclusiveMinimum": "Stop No must be greater than undefined" } }, "address": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least 1 characters", "type": "Address must be string or null", "pattern": "must not be blank" } }, "city": { "type": "string", "minLength": 1, "maxLength": 120, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least 1 characters", "type": "City must be string or null", "pattern": "must not be blank" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Customer Id must be a valid UUID" } }, "puNumber": { "type": "string", "nullable": true, "errorMessage": { "enum": "Pu Number must be one of these options: \nundefined", "maxLength": "Pu Number must not exceed undefined characters", "minLength": "Pu Number must contain at least undefined characters", "type": "Pu Number must be string or null" } }, "state": { "type": "string", "minLength": 1, "maxLength": 55, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least 1 characters", "type": "State must be string or null", "pattern": "must not be blank" } }, "type": { "type": "string", "enum": [ "shipper", "consignee", "consignee/shipper" ], "maxLength": 25, "errorMessage": { "enum": "Type must be one of these options: \nshipper, consignee, consignee/shipper", "maxLength": "Type must not exceed 25 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "contactId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Contact Id must be one of these options: \nundefined", "maxLength": "Contact Id must not exceed undefined characters", "minLength": "Contact Id must contain at least undefined characters", "type": "Contact Id must be string or null" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "stopTrailer": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Stop Trailer must be one of these options: \nundefined", "maxLength": "Stop Trailer must not exceed 255 characters", "minLength": "Stop Trailer must contain at least undefined characters", "type": "Stop Trailer must be string or null" } }, "fromDate": { "type": "string", "format": "date-time", "errorMessage": { "enum": "From Date must be one of these options: \nundefined", "maxLength": "From Date must not exceed undefined characters", "minLength": "From Date must contain at least undefined characters", "type": "From Date must be string ", "format": "FromDate must be a valid date-time (ISO 8601)" } }, "toDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "To Date must be one of these options: \nundefined", "maxLength": "To Date must not exceed undefined characters", "minLength": "To Date must contain at least undefined characters", "type": "To Date must be string or null", "format": "ToDate must be a valid date-time (ISO 8601)" } } }, "additionalProperties": false, "required": [ "stopNo", "customerId" ], "errorMessage": { "required": { "stopNo": "Stop number is required", "customerId": "Customer is required" } } }, "LoadDto": { "title": "LoadDto", "type": "object", "properties": { "orderNumber": { "type": "string", "maxLength": 255, "pattern": "^[^\\p{Extended_Pictographic}\\u{1F1E6}-\\u{1F1FF}\\uFE0F\\u200D\\u20E3]*$", "errorMessage": { "enum": "Order Number must be one of these options: \nundefined", "maxLength": "Order Number must not exceed 255 characters", "minLength": "Order Number must contain at least undefined characters", "type": "Order Number must be string ", "pattern": "must not contain emoji" } }, "price": { "type": "number", "minimum": 0, "maximum": 1000000000, "notNegativeZero": true, "nullable": true, "format": "float", "errorMessage": { "type": "Price must be number or null", "exclusiveMinimum": "Price must be greater than undefined", "minimum": "Price cannot be negative", "maximum": "Price cannot exceed 1,000,000,000", "notNegativeZero": "Price cannot be negative" } }, "mile": { "type": "number", "exclusiveMinimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Mile must be number or null", "exclusiveMinimum": "Mile must be greater than 0" } }, "emptyMile": { "type": "number", "exclusiveMinimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Empty Mile must be number or null", "exclusiveMinimum": "Empty Mile must be greater than 0" } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "brokerCompanyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Broker Company Id must be a valid UUID" } }, "roundTrip": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "brokerEmails": { "type": "array", "items": { "type": "string", "nullable": true, "errorMessage": { "type": "Broker Emails must be array or null" } } }, "tollParamDto": { "type": "object", "nullable": true }, "stops": { "type": "array", "items": { "$ref": "#/components/schemas/StopsForLoadDto" } }, "gpt_id": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Gpt_id cannot be lower than undefined", "maximum": "Gpt_id cannot be lower than undefined", "type": "Gpt_id must be number or null", "exclusiveMinimum": "Gpt_id must be greater than undefined" } }, "rate": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Rate cannot be lower than undefined", "maximum": "Rate cannot be lower than undefined", "type": "Rate must be number or null", "exclusiveMinimum": "Rate must be greater than undefined" } }, "comment": { "type": "string", "nullable": true, "errorMessage": { "enum": "Comment must be one of these options: \nundefined", "maxLength": "Comment must not exceed undefined characters", "minLength": "Comment must contain at least undefined characters", "type": "Comment must be string or null" } } }, "additionalProperties": false, "required": [ "orderNumber" ], "errorMessage": { "required": { "orderNumber": "Load ID is required" } } }, "LoadEditDto": { "title": "LoadEditDto", "type": "object", "properties": { "status": { "type": "string", "enum": [ "upcoming", "dispatched", "in-progress", "completed", "rejected", "imported" ], "errorMessage": { "enum": "Status must be one of these options: \nupcoming, dispatched, in-progress, completed, rejected, imported", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "orderNumber": { "type": "string", "maxLength": 255, "pattern": "^[^\\p{Extended_Pictographic}\\u{1F1E6}-\\u{1F1FF}\\uFE0F\\u200D\\u20E3]*$", "errorMessage": { "enum": "Order Number must be one of these options: \nundefined", "maxLength": "Order Number must not exceed 255 characters", "minLength": "Order Number must contain at least undefined characters", "type": "Order Number must be string ", "pattern": "must not contain emoji" } }, "price": { "type": "number", "minimum": 0, "maximum": 1000000000, "pattern": "\\S", "notNegativeZero": true, "nullable": true, "format": "float", "errorMessage": { "type": "Price must be number or null", "exclusiveMinimum": "Price must be greater than undefined", "minimum": "Price cannot be negative", "maximum": "Price cannot exceed 1,000,000,000", "notNegativeZero": "Price cannot be negative", "pattern": "must not be blank" } }, "mile": { "type": "number", "minimum": 0, "pattern": "\\S", "nullable": true, "format": "float", "errorMessage": { "type": "Mile must be number or null", "exclusiveMinimum": "Mile must be greater than undefined", "minimum": "Mile cannot be negative", "pattern": "must not be blank" } }, "emptyMile": { "type": "number", "minimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Empty Mile must be number or null", "exclusiveMinimum": "Empty Mile must be greater than undefined", "minimum": "Empty Mile cannot be negative" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "brokerEmails": { "type": "array", "items": { "type": "string", "nullable": true, "errorMessage": { "type": "Broker Emails must be array or null" } } }, "dispatcherId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Dispatcher Id must be one of these options: \nundefined", "maxLength": "Dispatcher Id must not exceed 36 characters", "minLength": "Dispatcher Id must contain at least undefined characters", "type": "Dispatcher Id must be string or null" } }, "unitId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Unit Id must be one of these options: \nundefined", "maxLength": "Unit Id must not exceed 36 characters", "minLength": "Unit Id must contain at least undefined characters", "type": "Unit Id must be string or null" } }, "brokerCompanyId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Broker Company Id must be one of these options: \nundefined", "maxLength": "Broker Company Id must not exceed 36 characters", "minLength": "Broker Company Id must contain at least undefined characters", "type": "Broker Company Id must be string or null" } } }, "additionalProperties": false }, "LoadFilesPostDto": { "title": "LoadFilesPostDto", "type": "object", "properties": { "attachType": { "type": "string", "errorMessage": { "enum": "Attach Type must be one of these options: \nundefined", "maxLength": "Attach Type must not exceed undefined characters", "minLength": "Attach Type must contain at least undefined characters", "type": "Attach Type must be string " } } }, "additionalProperties": false }, "CancelledLoadV2Dto": { "title": "CancelledLoadV2Dto", "type": "object", "properties": { "price": { "type": "number", "minimum": 0, "maximum": 1000000000, "notNegativeZero": true, "nullable": true, "format": "float", "errorMessage": { "type": "Price must be number or null", "exclusiveMinimum": "Price must be greater than undefined", "minimum": "Price cannot be negative", "maximum": "Price cannot exceed 1,000,000,000", "notNegativeZero": "Price cannot be negative" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "brokerEmails": { "type": "array", "items": { "type": "string", "nullable": true, "errorMessage": { "type": "Broker Emails must be array or null" } } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "reason": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Reason must be one of these options: \nundefined", "maxLength": "Reason must not exceed 1000 characters", "minLength": "Reason must contain at least undefined characters", "type": "Reason must be string " } }, "brokerCompanyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Broker Company Id must be a valid UUID" } }, "driverPay": { "type": "number", "minimum": 0, "format": "float", "errorMessage": { "type": "Driver Pay must be number ", "exclusiveMinimum": "Driver Pay must be greater than undefined", "minimum": "Driver pay cannot be negative" } }, "isCompensation": { "type": "boolean" }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "price", "driverPay" ], "errorMessage": { "required": { "price": "Price is required", "driverPay": "Driver pay is required" } } }, "LoadOverWrite": { "title": "LoadOverWrite", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "priceOverridden": { "type": "number", "minimum": 0, "format": "float", "errorMessage": { "type": "Price Overridden must be number ", "exclusiveMinimum": "Price Overridden must be greater than undefined", "minimum": "Price cannot be negative" } }, "percentageOverridden": { "type": "number", "minimum": 0, "format": "float", "errorMessage": { "type": "Percentage Overridden must be number ", "exclusiveMinimum": "Percentage Overridden must be greater than undefined", "minimum": "Percentage cannot be negative" } }, "perMileOverridden": { "type": "number", "minimum": 0, "format": "float", "errorMessage": { "type": "Per Mile Overridden must be number ", "exclusiveMinimum": "Per Mile Overridden must be greater than undefined", "minimum": "Per mile cannot be negative" } }, "perEmptyMileOverridden": { "type": "number", "minimum": 0, "format": "float", "errorMessage": { "type": "Per Empty Mile Overridden must be number ", "exclusiveMinimum": "Per Empty Mile Overridden must be greater than undefined", "minimum": "Per empty mile cannot be negative" } }, "driverPayOverriddenType": { "type": "string", "enum": [ "fixed", "mile", "percent", "none" ], "errorMessage": { "enum": "Driver Pay Overridden Type must be one of these options: \nfixed, mile, percent, none", "maxLength": "Driver Pay Overridden Type must not exceed undefined characters", "minLength": "Driver Pay Overridden Type must contain at least undefined characters", "type": "Driver Pay Overridden Type must be string " } }, "isOverridden": { "type": "boolean" } }, "additionalProperties": false, "required": [ "unitId", "driverPayOverriddenType" ], "errorMessage": { "required": { "unitId": "Truck required", "driverPayOverriddenType": "Overridden type required" } } }, "LoadAdjustmentDtoV3": { "title": "LoadAdjustmentDtoV3", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "adjustmentPrice": { "type": "number", "format": "float", "errorMessage": { "type": "Adjustment Price must be number ", "exclusiveMinimum": "Adjustment Price must be greater than undefined" } }, "isAdjustment": { "type": "boolean" }, "type": { "type": "number", "enum": [ "DEDUCT", "BONUS", 200, 100 ], "nullable": true, "errorMessage": { "minimum": "Type cannot be lower than undefined", "maximum": "Type cannot be lower than undefined", "type": "Type must be number or null", "exclusiveMinimum": "Type must be greater than undefined" } } }, "additionalProperties": false, "required": [ "unitId" ], "errorMessage": { "required": { "unitId": "Truck required" } } }, "AdjustmentDto": { "title": "AdjustmentDto", "type": "object", "properties": { "loadId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Load Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "date": { "type": "string", "format": "date", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date (YYYY-MM-DD)" } }, "price": { "type": "number", "format": "float", "errorMessage": { "type": "Price must be number ", "exclusiveMinimum": "Price must be greater than undefined" } }, "type": { "type": "number", "enum": [ "DEDUCT", "BONUS", 200, 100 ], "errorMessage": { "minimum": "Type cannot be lower than undefined", "maximum": "Type cannot be lower than undefined", "type": "Type must be number ", "exclusiveMinimum": "Type must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 2000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 2000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "loadId", "driverId", "price", "date", "type" ], "errorMessage": { "required": { "loadId": "Load is required", "driverId": "Driver is required", "price": "Price is required", "date": "Date is required", "type": "Type is required" } } }, "StopsForAmazonLoadDto": { "title": "StopsForAmazonLoadDto", "type": "object", "properties": { "stopNo": { "type": "number", "errorMessage": { "minimum": "Stop No cannot be lower than undefined", "maximum": "Stop No cannot be lower than undefined", "type": "Stop No must be number ", "exclusiveMinimum": "Stop No must be greater than undefined" } }, "address": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least 1 characters", "type": "Address must be string or null", "pattern": "must not be blank" } }, "city": { "type": "string", "minLength": 1, "maxLength": 120, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least 1 characters", "type": "City must be string or null", "pattern": "must not be blank" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Customer Id must be a valid UUID" } }, "puNumber": { "type": "string", "nullable": true, "errorMessage": { "enum": "Pu Number must be one of these options: \nundefined", "maxLength": "Pu Number must not exceed undefined characters", "minLength": "Pu Number must contain at least undefined characters", "type": "Pu Number must be string or null" } }, "state": { "type": "string", "minLength": 1, "maxLength": 55, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least 1 characters", "type": "State must be string or null", "pattern": "must not be blank" } }, "type": { "type": "string", "enum": [ "shipper", "consignee", "consignee/shipper" ], "maxLength": 25, "errorMessage": { "enum": "Type must be one of these options: \nshipper, consignee, consignee/shipper", "maxLength": "Type must not exceed 25 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "contactId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Contact Id must be one of these options: \nundefined", "maxLength": "Contact Id must not exceed undefined characters", "minLength": "Contact Id must contain at least undefined characters", "type": "Contact Id must be string or null" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "stopTrailer": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Stop Trailer must be one of these options: \nundefined", "maxLength": "Stop Trailer must not exceed 255 characters", "minLength": "Stop Trailer must contain at least undefined characters", "type": "Stop Trailer must be string or null" } }, "fromDate": { "type": "string", "format": "date-time", "errorMessage": { "enum": "From Date must be one of these options: \nundefined", "maxLength": "From Date must not exceed undefined characters", "minLength": "From Date must contain at least undefined characters", "type": "From Date must be string ", "format": "FromDate must be a valid date-time (ISO 8601)" } }, "toDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "To Date must be one of these options: \nundefined", "maxLength": "To Date must not exceed undefined characters", "minLength": "To Date must contain at least undefined characters", "type": "To Date must be string or null", "format": "ToDate must be a valid date-time (ISO 8601)" } } }, "additionalProperties": false, "required": [ "stopNo" ], "errorMessage": { "required": { "stopNo": "Stop number required" } } }, "AmazonLoadDto": { "title": "AmazonLoadDto", "type": "object", "properties": { "orderNumber": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Order Number must be one of these options: \nundefined", "maxLength": "Order Number must not exceed 255 characters", "minLength": "Order Number must contain at least undefined characters", "type": "Order Number must be string " } }, "price": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Price must be number or null", "exclusiveMinimum": "Price must be greater than undefined" } }, "mile": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Mile must be number or null", "exclusiveMinimum": "Mile must be greater than undefined" } }, "emptyMile": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Empty Mile must be number or null", "exclusiveMinimum": "Empty Mile must be greater than undefined" } }, "brokerCompanyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Broker Company Id must be a valid UUID" } }, "roundTrip": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "stops": { "type": "array", "items": { "$ref": "#/components/schemas/StopsForAmazonLoadDto" } }, "amazonLoadId": { "type": "string", "maxLength": 256, "errorMessage": { "enum": "Amazon Load Id must be one of these options: \nundefined", "maxLength": "Amazon Load Id must not exceed 256 characters", "minLength": "Amazon Load Id must contain at least undefined characters", "type": "Amazon Load Id must be string " } } }, "additionalProperties": false, "required": [ "orderNumber" ], "errorMessage": { "required": { "orderNumber": "Load ID is required" } } }, "StopForImportedLoadDto": { "title": "StopForImportedLoadDto", "type": "object", "properties": { "stopNo": { "type": "number", "errorMessage": { "minimum": "Stop No cannot be lower than undefined", "maximum": "Stop No cannot be lower than undefined", "type": "Stop No must be number ", "exclusiveMinimum": "Stop No must be greater than undefined" } }, "address": { "type": "string", "minLength": 1, "maxLength": 255, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least 1 characters", "type": "Address must be string or null", "pattern": "must not be blank" } }, "city": { "type": "string", "minLength": 1, "maxLength": 120, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 120 characters", "minLength": "City must contain at least 1 characters", "type": "City must be string or null", "pattern": "must not be blank" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Customer Id must be a valid UUID" } }, "puNumber": { "type": "string", "nullable": true, "errorMessage": { "enum": "Pu Number must be one of these options: \nundefined", "maxLength": "Pu Number must not exceed undefined characters", "minLength": "Pu Number must contain at least undefined characters", "type": "Pu Number must be string or null" } }, "state": { "type": "string", "minLength": 1, "maxLength": 55, "nullable": true, "pattern": "\\S", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least 1 characters", "type": "State must be string or null", "pattern": "must not be blank" } }, "type": { "type": "string", "enum": [ "shipper", "consignee", "consignee/shipper" ], "maxLength": 25, "errorMessage": { "enum": "Type must be one of these options: \nshipper, consignee, consignee/shipper", "maxLength": "Type must not exceed 25 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "contactId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Contact Id must be one of these options: \nundefined", "maxLength": "Contact Id must not exceed undefined characters", "minLength": "Contact Id must contain at least undefined characters", "type": "Contact Id must be string or null" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "stopTrailer": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Stop Trailer must be one of these options: \nundefined", "maxLength": "Stop Trailer must not exceed 255 characters", "minLength": "Stop Trailer must contain at least undefined characters", "type": "Stop Trailer must be string or null" } }, "fromDate": { "type": "string", "format": "date-time", "errorMessage": { "enum": "From Date must be one of these options: \nundefined", "maxLength": "From Date must not exceed undefined characters", "minLength": "From Date must contain at least undefined characters", "type": "From Date must be string ", "format": "FromDate must be a valid date-time (ISO 8601)" } }, "toDate": { "type": "string", "format": "date-time", "nullable": true, "errorMessage": { "enum": "To Date must be one of these options: \nundefined", "maxLength": "To Date must not exceed undefined characters", "minLength": "To Date must contain at least undefined characters", "type": "To Date must be string or null", "format": "ToDate must be a valid date-time (ISO 8601)" } }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "id" ], "errorMessage": { "required": { "id": "Stop ID required" } } }, "ImportedLoadCreateDto": { "title": "ImportedLoadCreateDto", "type": "object", "properties": { "orderNumber": { "type": "string", "maxLength": 255, "pattern": "^[^\\p{Extended_Pictographic}\\u{1F1E6}-\\u{1F1FF}\\uFE0F\\u200D\\u20E3]*$", "errorMessage": { "enum": "Order Number must be one of these options: \nundefined", "maxLength": "Order Number must not exceed 255 characters", "minLength": "Order Number must contain at least undefined characters", "type": "Order Number must be string ", "pattern": "must not contain emoji" } }, "price": { "type": "number", "minimum": 0, "maximum": 1000000000, "notNegativeZero": true, "nullable": true, "format": "float", "errorMessage": { "type": "Price must be number or null", "exclusiveMinimum": "Price must be greater than undefined", "minimum": "Price cannot be negative", "maximum": "Price cannot exceed 1,000,000,000", "notNegativeZero": "Price cannot be negative" } }, "mile": { "type": "number", "exclusiveMinimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Mile must be number or null", "exclusiveMinimum": "Mile must be greater than 0" } }, "emptyMile": { "type": "number", "exclusiveMinimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Empty Mile must be number or null", "exclusiveMinimum": "Empty Mile must be greater than 0" } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "brokerCompanyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Broker Company Id must be a valid UUID" } }, "roundTrip": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "brokerEmails": { "type": "array", "items": { "type": "string", "nullable": true, "errorMessage": { "type": "Broker Emails must be array or null" } } }, "changedStops": { "type": "array", "items": { "$ref": "#/components/schemas/StopForImportedLoadDto" } } }, "additionalProperties": false, "required": [ "orderNumber" ], "errorMessage": { "required": { "orderNumber": "Load ID is required" } } }, "LoadNoteCreateDto": { "title": "LoadNoteCreateDto", "type": "object", "properties": { "currentLocation": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "Current Location must be one of these options: \nundefined", "maxLength": "Current Location must not exceed 150 characters", "minLength": "Current Location must contain at least undefined characters", "type": "Current Location must be string or null" } }, "status": { "type": "string", "enum": [ "assigned", "at-origin", "loading", "moving", "at-destination", "unloading", "dropped", "hold", "hook-up" ], "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nassigned, at-origin, loading, moving, at-destination, unloading, dropped, hold, hook-up", "maxLength": "Status must not exceed 72 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "note": { "type": "string", "nullable": true, "errorMessage": { "enum": "Note must be one of these options: \nundefined", "maxLength": "Note must not exceed undefined characters", "minLength": "Note must contain at least undefined characters", "type": "Note must be string or null" } }, "driverNotification": { "type": "boolean", "nullable": true }, "brokerNotification": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "LoadFilesDto": { "title": "LoadFilesDto", "type": "object", "properties": { "fileId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "File Id must be a valid UUID" } }, "stopId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Stop Id must be a valid UUID" } }, "driverToVisibility": { "type": "boolean" } }, "additionalProperties": false, "required": [ "fileId" ], "errorMessage": { "required": { "fileId": "File is required" } } }, "Equipment": { "title": "Equipment", "type": "object", "properties": { "types": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Types must be array " } } }, "classes": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Classes must be array " } } } }, "additionalProperties": false }, "Place": { "title": "Place", "type": "object", "properties": { "placeId": { "type": "number", "errorMessage": { "minimum": "Place Id cannot be lower than undefined", "maximum": "Place Id cannot be lower than undefined", "type": "Place Id must be number ", "exclusiveMinimum": "Place Id must be greater than undefined" } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "stateProv": { "type": "string", "errorMessage": { "enum": "State Prov must be one of these options: \nundefined", "maxLength": "State Prov must not exceed undefined characters", "minLength": "State Prov must contain at least undefined characters", "type": "State Prov must be string " } }, "longitude": { "type": "number", "errorMessage": { "minimum": "Longitude cannot be lower than undefined", "maximum": "Longitude cannot be lower than undefined", "type": "Longitude must be number ", "exclusiveMinimum": "Longitude must be greater than undefined" } }, "latitude": { "type": "number", "errorMessage": { "minimum": "Latitude cannot be lower than undefined", "maximum": "Latitude cannot be lower than undefined", "type": "Latitude must be number ", "exclusiveMinimum": "Latitude must be greater than undefined" } }, "postalCode": { "type": "string", "errorMessage": { "enum": "Postal Code must be one of these options: \nundefined", "maxLength": "Postal Code must not exceed undefined characters", "minLength": "Postal Code must contain at least undefined characters", "type": "Postal Code must be string " } } }, "additionalProperties": false }, "Origin": { "title": "Origin", "type": "object", "properties": { "place": { "$ref": "#/components/schemas/Place" } }, "additionalProperties": false }, "Destination": { "title": "Destination", "type": "object", "properties": { "place": { "$ref": "#/components/schemas/Place" }, "open": { "type": "string", "enum": [ "everywhere", "anywhere" ], "errorMessage": { "enum": "Open must be one of these options: \nundefined", "maxLength": "Open must not exceed undefined characters", "minLength": "Open must contain at least undefined characters", "type": "Open must be string " } } }, "additionalProperties": false }, "Lane": { "title": "Lane", "type": "object", "properties": { "assetType": { "type": "string", "enum": [ "SHIPMENT", "TRUCK" ], "errorMessage": { "enum": "Asset Type must be one of these options: \nundefined", "maxLength": "Asset Type must not exceed undefined characters", "minLength": "Asset Type must contain at least undefined characters", "type": "Asset Type must be string " } }, "equipment": { "$ref": "#/components/schemas/Equipment" }, "origin": { "$ref": "#/components/schemas/Origin" }, "destination": { "$ref": "#/components/schemas/Destination" } }, "additionalProperties": false }, "Availability": { "title": "Availability", "type": "object", "properties": { "earliestWhen": { "type": "string", "format": "date", "errorMessage": { "type": "Earliest When must be date ", "format": "EarliestWhen must be a valid date (YYYY-MM-DD)" } }, "latestWhen": { "type": "string", "format": "date", "errorMessage": { "type": "Latest When must be date ", "format": "LatestWhen must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false }, "Capacity": { "title": "Capacity", "type": "object", "properties": { "fullPartial": { "type": "string", "enum": [ "FULL", "PARTIAL", "BOTH" ], "errorMessage": { "enum": "Full Partial must be one of these options: \nundefined", "maxLength": "Full Partial must not exceed undefined characters", "minLength": "Full Partial must contain at least undefined characters", "type": "Full Partial must be string " } }, "maximumLengthFeet": { "type": "number", "errorMessage": { "minimum": "Maximum Length Feet cannot be lower than undefined", "maximum": "Maximum Length Feet cannot be lower than undefined", "type": "Maximum Length Feet must be number ", "exclusiveMinimum": "Maximum Length Feet must be greater than undefined" } }, "maximumWeightPounds": { "type": "number", "errorMessage": { "minimum": "Maximum Weight Pounds cannot be lower than undefined", "maximum": "Maximum Weight Pounds cannot be lower than undefined", "type": "Maximum Weight Pounds must be number ", "exclusiveMinimum": "Maximum Weight Pounds must be greater than undefined" } } }, "additionalProperties": false }, "Delivery": { "title": "Delivery", "type": "object", "properties": { "notify": { "type": "boolean" }, "includeSimilarResults": { "type": "boolean" } }, "additionalProperties": false }, "AssetSearchCriteria": { "title": "AssetSearchCriteria", "type": "object", "properties": { "lane": { "$ref": "#/components/schemas/Lane" }, "maxOriginDeadheadMiles": { "type": "number", "errorMessage": { "minimum": "Max Origin Deadhead Miles cannot be lower than undefined", "maximum": "Max Origin Deadhead Miles cannot be lower than undefined", "type": "Max Origin Deadhead Miles must be number ", "exclusiveMinimum": "Max Origin Deadhead Miles must be greater than undefined" } }, "maxDestinationDeadheadMiles": { "type": "number", "errorMessage": { "minimum": "Max Destination Deadhead Miles cannot be lower than undefined", "maximum": "Max Destination Deadhead Miles cannot be lower than undefined", "type": "Max Destination Deadhead Miles must be number ", "exclusiveMinimum": "Max Destination Deadhead Miles must be greater than undefined" } }, "availability": { "$ref": "#/components/schemas/Availability" }, "capacity": { "$ref": "#/components/schemas/Capacity" }, "orderBy": { "type": "string", "enum": [ "AGE_ASC", "RATE_DESC", "DISTANCE_ASC" ], "errorMessage": { "enum": "Order By must be one of these options: \nundefined", "maxLength": "Order By must not exceed undefined characters", "minLength": "Order By must contain at least undefined characters", "type": "Order By must be string " } }, "limit": { "type": "number", "errorMessage": { "minimum": "Limit cannot be lower than undefined", "maximum": "Limit cannot be lower than undefined", "type": "Limit must be number ", "exclusiveMinimum": "Limit must be greater than undefined" } }, "countsOnly": { "type": "boolean" }, "delivery": { "$ref": "#/components/schemas/Delivery" } }, "additionalProperties": false }, "LoadBoardCredentials": { "title": "LoadBoardCredentials", "type": "object", "properties": { "orgEmail": { "type": "string", "errorMessage": { "enum": "Org Email must be one of these options: \nundefined", "maxLength": "Org Email must not exceed undefined characters", "minLength": "Org Email must contain at least undefined characters", "type": "Org Email must be string " } }, "orgPassword": { "type": "string", "errorMessage": { "enum": "Org Password must be one of these options: \nundefined", "maxLength": "Org Password must not exceed undefined characters", "minLength": "Org Password must contain at least undefined characters", "type": "Org Password must be string " } }, "userEmail": { "type": "string", "errorMessage": { "enum": "User Email must be one of these options: \nundefined", "maxLength": "User Email must not exceed undefined characters", "minLength": "User Email must contain at least undefined characters", "type": "User Email must be string " } } }, "additionalProperties": false }, "Comment": { "title": "Comment", "type": "object", "properties": { "comment": { "type": "string", "errorMessage": { "enum": "Comment must be one of these options: \nundefined", "maxLength": "Comment must not exceed undefined characters", "minLength": "Comment must contain at least undefined characters", "type": "Comment must be string " } } }, "additionalProperties": false }, "Truck": { "title": "Truck", "type": "object", "properties": { "type": { "type": "string", "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "fullOrPartial": { "type": "string", "errorMessage": { "enum": "Full Or Partial must be one of these options: \nundefined", "maxLength": "Full Or Partial must not exceed undefined characters", "minLength": "Full Or Partial must contain at least undefined characters", "type": "Full Or Partial must be string " } }, "lengthFeet": { "type": "number", "errorMessage": { "minimum": "Length Feet cannot be lower than undefined", "maximum": "Length Feet cannot be lower than undefined", "type": "Length Feet must be number ", "exclusiveMinimum": "Length Feet must be greater than undefined" } }, "weightPounds": { "type": "number", "errorMessage": { "minimum": "Weight Pounds cannot be lower than undefined", "maximum": "Weight Pounds cannot be lower than undefined", "type": "Weight Pounds must be number ", "exclusiveMinimum": "Weight Pounds must be greater than undefined" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } } }, "additionalProperties": false }, "ContactMethod": { "title": "ContactMethod", "type": "object", "properties": { "method": { "type": "string", "errorMessage": { "enum": "Method must be one of these options: \nundefined", "maxLength": "Method must not exceed undefined characters", "minLength": "Method must contain at least undefined characters", "type": "Method must be string " } } }, "additionalProperties": false }, "PosterInfo": { "title": "PosterInfo", "type": "object", "properties": { "contactMethods": { "type": "array", "items": { "$ref": "#/components/schemas/ContactMethod" } } }, "additionalProperties": false }, "Exposure": { "title": "Exposure", "type": "object", "properties": { "isExposed": { "type": "boolean" }, "startWhen": { "type": "string", "errorMessage": { "type": "Start When must be date " } }, "endWhen": { "type": "string", "errorMessage": { "type": "End When must be date " } }, "earliestAvailabilityWhen": { "type": "string", "errorMessage": { "type": "Earliest Availability When must be date " } }, "latestAvailabilityWhen": { "type": "string", "errorMessage": { "type": "Latest Availability When must be date " } } }, "additionalProperties": false }, "Location": { "title": "Location", "type": "object", "properties": { "stateOrProvince": { "type": "string", "errorMessage": { "enum": "State Or Province must be one of these options: \nundefined", "maxLength": "State Or Province must not exceed undefined characters", "minLength": "State Or Province must contain at least undefined characters", "type": "State Or Province must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "postalCode": { "type": "string", "errorMessage": { "enum": "Postal Code must be one of these options: \nundefined", "maxLength": "Postal Code must not exceed undefined characters", "minLength": "Postal Code must contain at least undefined characters", "type": "Postal Code must be string " } } }, "additionalProperties": false }, "PostingDestination": { "title": "PostingDestination", "type": "object", "properties": { "stateOrProvince": { "type": "string", "errorMessage": { "enum": "State Or Province must be one of these options: \nundefined", "maxLength": "State Or Province must not exceed undefined characters", "minLength": "State Or Province must contain at least undefined characters", "type": "State Or Province must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "postalCode": { "type": "string", "errorMessage": { "enum": "Postal Code must be one of these options: \nundefined", "maxLength": "Postal Code must not exceed undefined characters", "minLength": "Postal Code must contain at least undefined characters", "type": "Postal Code must be string " } }, "statesOrProvinces": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "States Or Provinces must be array " } } }, "type": { "type": "string", "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } } }, "additionalProperties": false }, "PostingLane": { "title": "PostingLane", "type": "object", "properties": { "origin": { "$ref": "#/components/schemas/Location" }, "destination": { "$ref": "#/components/schemas/PostingDestination" } }, "additionalProperties": false }, "TruckPostingCreate": { "title": "TruckPostingCreate", "type": "object", "properties": { "truck": { "$ref": "#/components/schemas/Truck" }, "posterInfo": { "$ref": "#/components/schemas/PosterInfo" }, "exposure": { "$ref": "#/components/schemas/Exposure" }, "lane": { "$ref": "#/components/schemas/PostingLane" }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } } }, "additionalProperties": false }, "TruckForEdit": { "title": "TruckForEdit", "type": "object", "properties": { "fullOrPartial": { "type": "string", "errorMessage": { "enum": "Full Or Partial must be one of these options: \nundefined", "maxLength": "Full Or Partial must not exceed undefined characters", "minLength": "Full Or Partial must contain at least undefined characters", "type": "Full Or Partial must be string " } }, "lengthFeet": { "type": "number", "errorMessage": { "minimum": "Length Feet cannot be lower than undefined", "maximum": "Length Feet cannot be lower than undefined", "type": "Length Feet must be number ", "exclusiveMinimum": "Length Feet must be greater than undefined" } }, "weightPounds": { "type": "number", "errorMessage": { "minimum": "Weight Pounds cannot be lower than undefined", "maximum": "Weight Pounds cannot be lower than undefined", "type": "Weight Pounds must be number ", "exclusiveMinimum": "Weight Pounds must be greater than undefined" } }, "minimumRatePerMileUsd": { "type": "number", "errorMessage": { "minimum": "Minimum Rate Per Mile Usd cannot be lower than undefined", "maximum": "Minimum Rate Per Mile Usd cannot be lower than undefined", "type": "Minimum Rate Per Mile Usd must be number ", "exclusiveMinimum": "Minimum Rate Per Mile Usd must be greater than undefined" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } } }, "additionalProperties": false }, "TruckPostingEdit": { "title": "TruckPostingEdit", "type": "object", "properties": { "truck": { "$ref": "#/components/schemas/TruckForEdit" }, "exposure": { "$ref": "#/components/schemas/Exposure" }, "posterInfo": { "$ref": "#/components/schemas/PosterInfo" } }, "additionalProperties": false }, "AssetSearchCriteriaForPosting": { "title": "AssetSearchCriteriaForPosting", "type": "object", "properties": { "lane": { "$ref": "#/components/schemas/Lane" }, "capacity": { "$ref": "#/components/schemas/Capacity" }, "availability": { "$ref": "#/components/schemas/Availability" } }, "additionalProperties": false }, "TrimbleCoords": { "title": "TrimbleCoords", "type": "object", "properties": { "startLong": { "type": "number", "format": "float", "errorMessage": { "type": "Start Long must be number ", "exclusiveMinimum": "Start Long must be greater than undefined" } }, "startLat": { "type": "number", "format": "float", "errorMessage": { "type": "Start Lat must be number ", "exclusiveMinimum": "Start Lat must be greater than undefined" } }, "endLong": { "type": "number", "format": "float", "errorMessage": { "type": "End Long must be number ", "exclusiveMinimum": "End Long must be greater than undefined" } }, "endLat": { "type": "number", "format": "float", "errorMessage": { "type": "End Lat must be number ", "exclusiveMinimum": "End Lat must be greater than undefined" } } }, "additionalProperties": false }, "DatAccountRequest": { "title": "DatAccountRequest", "type": "object", "properties": { "companyName": { "type": "string", "errorMessage": { "enum": "Company Name must be one of these options: \nundefined", "maxLength": "Company Name must not exceed undefined characters", "minLength": "Company Name must contain at least undefined characters", "type": "Company Name must be string " } }, "contactName": { "type": "string", "errorMessage": { "enum": "Contact Name must be one of these options: \nundefined", "maxLength": "Contact Name must not exceed undefined characters", "minLength": "Contact Name must contain at least undefined characters", "type": "Contact Name must be string " } }, "mc": { "type": "string", "errorMessage": { "enum": "Mc must be one of these options: \nundefined", "maxLength": "Mc must not exceed undefined characters", "minLength": "Mc must contain at least undefined characters", "type": "Mc must be string " } }, "serviceAccountEmail": { "type": "string", "errorMessage": { "enum": "Service Account Email must be one of these options: \nundefined", "maxLength": "Service Account Email must not exceed undefined characters", "minLength": "Service Account Email must contain at least undefined characters", "type": "Service Account Email must be string " } } }, "additionalProperties": false }, "DispatcherLoadAiUpdateCreateDto": { "title": "DispatcherLoadAiUpdateCreateDto", "type": "object", "properties": { "status": { "type": "string", "enum": [ "driving", "stopped", "at_stop" ], "errorMessage": { "enum": "Status must be one of these options: \ndriving, stopped, at_stop", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "locationText": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Location Text must be one of these options: \nundefined", "maxLength": "Location Text must not exceed 255 characters", "minLength": "Location Text must contain at least undefined characters", "type": "Location Text must be string " } }, "lat": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lat must be number or null", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lng must be number or null", "exclusiveMinimum": "Lng must be greater than undefined" } }, "driverMessage": { "type": "string", "maxLength": 2000, "errorMessage": { "enum": "Driver Message must be one of these options: \nundefined", "maxLength": "Driver Message must not exceed 2000 characters", "minLength": "Driver Message must contain at least undefined characters", "type": "Driver Message must be string " } }, "stopReason": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "Stop Reason must be one of these options: \nundefined", "maxLength": "Stop Reason must not exceed 150 characters", "minLength": "Stop Reason must contain at least undefined characters", "type": "Stop Reason must be string or null" } } }, "additionalProperties": false }, "ComdataConnectDto": { "title": "ComdataConnectDto", "type": "object", "properties": { "sysAccountId": { "type": "string", "maxLength": 64, "errorMessage": { "enum": "Sys Account Id must be one of these options: \nundefined", "maxLength": "Sys Account Id must not exceed 64 characters", "minLength": "Sys Account Id must contain at least undefined characters", "type": "Sys Account Id must be string " } } }, "additionalProperties": false, "required": [ "sysAccountId" ], "errorMessage": { "required": { "sysAccountId": "Corpay Account ID is required" } } }, "FuelTransactionCreateData": { "title": "FuelTransactionCreateData", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "transactionDate": { "type": "string", "format": "date-time", "errorMessage": { "type": "Transaction Date must be date ", "format": "TransactionDate must be a valid date-time (ISO 8601)" } }, "cardNumber": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Card Number must be one of these options: \nundefined", "maxLength": "Card Number must not exceed 24 characters", "minLength": "Card Number must contain at least undefined characters", "type": "Card Number must be string or null" } }, "merchantName": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant Name must be one of these options: \nundefined", "maxLength": "Merchant Name must not exceed 256 characters", "minLength": "Merchant Name must contain at least undefined characters", "type": "Merchant Name must be string or null" } }, "merchantCity": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant City must be one of these options: \nundefined", "maxLength": "Merchant City must not exceed 256 characters", "minLength": "Merchant City must contain at least undefined characters", "type": "Merchant City must be string or null" } }, "invoiceNumber": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Invoice Number must be one of these options: \nundefined", "maxLength": "Invoice Number must not exceed 72 characters", "minLength": "Invoice Number must contain at least undefined characters", "type": "Invoice Number must be string " } }, "fuelType": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Fuel Type must be one of these options: \nundefined", "maxLength": "Fuel Type must not exceed 24 characters", "minLength": "Fuel Type must contain at least undefined characters", "type": "Fuel Type must be string or null" } }, "merchantState": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant State must be one of these options: \nundefined", "maxLength": "Merchant State must not exceed 256 characters", "minLength": "Merchant State must contain at least undefined characters", "type": "Merchant State must be string or null" } }, "notDiesel": { "type": "boolean" }, "quantity": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Quantity must be number or null", "exclusiveMinimum": "Quantity must be greater than undefined" } }, "totalDieselAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Diesel Amount must be number or null", "exclusiveMinimum": "Total Diesel Amount must be greater than undefined" } }, "discountAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Discount Amount must be number or null", "exclusiveMinimum": "Discount Amount must be greater than undefined" } }, "feeAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Fee Amount must be number or null", "exclusiveMinimum": "Fee Amount must be greater than undefined" } }, "totalDefAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Def Amount must be number or null", "exclusiveMinimum": "Total Def Amount must be greater than undefined" } }, "cashAdvanceAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Cash Advance Amount must be number or null", "exclusiveMinimum": "Cash Advance Amount must be greater than undefined" } } }, "additionalProperties": false, "required": [ "driverId", "transactionDate", "notDiesel", "invoiceNumber", "unitId" ], "errorMessage": { "required": { "driverId": "Driver required", "transactionDate": "Transaction date required", "notDiesel": "Diesel required", "invoiceNumber": "Invoice Number required", "unitId": "Truck required" } } }, "FuelTransactionImportData": { "title": "FuelTransactionImportData", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "transactionDate": { "type": "string", "format": "date-time", "errorMessage": { "type": "Transaction Date must be date ", "format": "TransactionDate must be a valid date-time (ISO 8601)" } }, "cardNumber": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Card Number must be one of these options: \nundefined", "maxLength": "Card Number must not exceed 24 characters", "minLength": "Card Number must contain at least undefined characters", "type": "Card Number must be string or null" } }, "merchantName": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant Name must be one of these options: \nundefined", "maxLength": "Merchant Name must not exceed 256 characters", "minLength": "Merchant Name must contain at least undefined characters", "type": "Merchant Name must be string or null" } }, "merchantCity": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant City must be one of these options: \nundefined", "maxLength": "Merchant City must not exceed 256 characters", "minLength": "Merchant City must contain at least undefined characters", "type": "Merchant City must be string or null" } }, "invoiceNumber": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Invoice Number must be one of these options: \nundefined", "maxLength": "Invoice Number must not exceed 72 characters", "minLength": "Invoice Number must contain at least undefined characters", "type": "Invoice Number must be string " } }, "fuelType": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Fuel Type must be one of these options: \nundefined", "maxLength": "Fuel Type must not exceed 24 characters", "minLength": "Fuel Type must contain at least undefined characters", "type": "Fuel Type must be string or null" } }, "merchantState": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant State must be one of these options: \nundefined", "maxLength": "Merchant State must not exceed 256 characters", "minLength": "Merchant State must contain at least undefined characters", "type": "Merchant State must be string or null" } }, "notDiesel": { "type": "boolean" }, "quantity": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Quantity must be number or null", "exclusiveMinimum": "Quantity must be greater than undefined" } }, "totalDieselAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Diesel Amount must be number or null", "exclusiveMinimum": "Total Diesel Amount must be greater than undefined" } }, "discountAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Discount Amount must be number or null", "exclusiveMinimum": "Discount Amount must be greater than undefined" } }, "feeAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Fee Amount must be number or null", "exclusiveMinimum": "Fee Amount must be greater than undefined" } }, "totalDefAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Def Amount must be number or null", "exclusiveMinimum": "Total Def Amount must be greater than undefined" } }, "cashAdvanceAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Cash Advance Amount must be number or null", "exclusiveMinimum": "Cash Advance Amount must be greater than undefined" } }, "debit": { "type": "boolean", "nullable": true }, "unitPrice": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Unit Price must be number or null", "exclusiveMinimum": "Unit Price must be greater than undefined" } }, "discountPPU": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Discount P P U must be number or null", "exclusiveMinimum": "Discount P P U must be greater than undefined" } }, "discountCost": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Discount Cost must be number or null", "exclusiveMinimum": "Discount Cost must be greater than undefined" } }, "discountType": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Discount Type must be one of these options: \nundefined", "maxLength": "Discount Type must not exceed 24 characters", "minLength": "Discount Type must contain at least undefined characters", "type": "Discount Type must be string or null" } }, "currency": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Currency must be one of these options: \nundefined", "maxLength": "Currency must not exceed 72 characters", "minLength": "Currency must contain at least undefined characters", "type": "Currency must be string or null" } }, "odometer": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Odometer must be number or null", "exclusiveMinimum": "Odometer must be greater than undefined" } }, "totalPayAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Pay Amount must be number or null", "exclusiveMinimum": "Total Pay Amount must be greater than undefined" } } }, "additionalProperties": false, "required": [ "driverId", "transactionDate", "unitId" ], "errorMessage": { "required": { "driverId": "Driver is required", "transactionDate": "Transaction date is required", "unitId": "Truck required" } } }, "FuelImportedData": { "title": "FuelImportedData", "type": "object", "properties": { "fileKey": { "type": "string", "nullable": true, "errorMessage": { "enum": "File Key must be one of these options: \nundefined", "maxLength": "File Key must not exceed undefined characters", "minLength": "File Key must contain at least undefined characters", "type": "File Key must be string or null" } }, "platform": { "type": "string", "enum": [ "efs", "ufs" ], "maxLength": 12, "errorMessage": { "enum": "Platform must be one of these options: \nefs, ufs", "maxLength": "Platform must not exceed 12 characters", "minLength": "Platform must contain at least undefined characters", "type": "Platform must be string " } }, "fromDate": { "type": "string", "nullable": true, "errorMessage": { "type": "From Date must be date or null" } }, "toDate": { "type": "string", "nullable": true, "errorMessage": { "type": "To Date must be date or null" } }, "fuelTransactions": { "type": "array", "items": { "$ref": "#/components/schemas/FuelTransactionImportData" } } }, "additionalProperties": false, "required": [ "platform", "fuelTransactions" ], "errorMessage": { "required": { "platform": "Platform required", "fuelTransactions": "Fuel Transactions required" } } }, "FuelTransactionUpdateData": { "title": "FuelTransactionUpdateData", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } }, "transactionDate": { "type": "string", "format": "date-time", "errorMessage": { "type": "Transaction Date must be date ", "format": "TransactionDate must be a valid date-time (ISO 8601)" } }, "cardNumber": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Card Number must be one of these options: \nundefined", "maxLength": "Card Number must not exceed 24 characters", "minLength": "Card Number must contain at least undefined characters", "type": "Card Number must be string or null" } }, "merchantName": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant Name must be one of these options: \nundefined", "maxLength": "Merchant Name must not exceed 256 characters", "minLength": "Merchant Name must contain at least undefined characters", "type": "Merchant Name must be string or null" } }, "merchantCity": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant City must be one of these options: \nundefined", "maxLength": "Merchant City must not exceed 256 characters", "minLength": "Merchant City must contain at least undefined characters", "type": "Merchant City must be string or null" } }, "invoiceNumber": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Invoice Number must be one of these options: \nundefined", "maxLength": "Invoice Number must not exceed 72 characters", "minLength": "Invoice Number must contain at least undefined characters", "type": "Invoice Number must be string " } }, "fuelType": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Fuel Type must be one of these options: \nundefined", "maxLength": "Fuel Type must not exceed 24 characters", "minLength": "Fuel Type must contain at least undefined characters", "type": "Fuel Type must be string or null" } }, "merchantState": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Merchant State must be one of these options: \nundefined", "maxLength": "Merchant State must not exceed 256 characters", "minLength": "Merchant State must contain at least undefined characters", "type": "Merchant State must be string or null" } }, "notDiesel": { "type": "boolean" }, "quantity": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Quantity must be number or null", "exclusiveMinimum": "Quantity must be greater than undefined" } }, "totalDieselAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Diesel Amount must be number or null", "exclusiveMinimum": "Total Diesel Amount must be greater than undefined" } }, "discountAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Discount Amount must be number or null", "exclusiveMinimum": "Discount Amount must be greater than undefined" } }, "feeAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Fee Amount must be number or null", "exclusiveMinimum": "Fee Amount must be greater than undefined" } }, "totalDefAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Total Def Amount must be number or null", "exclusiveMinimum": "Total Def Amount must be greater than undefined" } }, "cashAdvanceAmount": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Cash Advance Amount must be number or null", "exclusiveMinimum": "Cash Advance Amount must be greater than undefined" } }, "debit": { "type": "boolean", "nullable": true }, "discountType": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Discount Type must be one of these options: \nundefined", "maxLength": "Discount Type must not exceed 24 characters", "minLength": "Discount Type must contain at least undefined characters", "type": "Discount Type must be string or null" } }, "odometer": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Odometer must be number or null", "exclusiveMinimum": "Odometer must be greater than undefined" } } }, "additionalProperties": false, "required": [ "driverId", "transactionDate", "notDiesel", "invoiceNumber", "unitId" ], "errorMessage": { "required": { "driverId": "Driver required", "transactionDate": "Transaction date required", "notDiesel": "Diesel required", "invoiceNumber": "Invoice Number required", "unitId": "Truck required" } } }, "FuelTransactionUpdateTruckDriverCoDriverDto": { "title": "FuelTransactionUpdateTruckDriverCoDriverDto", "type": "object", "properties": { "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "coDriverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Co Driver Id must be a valid UUID" } } }, "additionalProperties": false }, "FuelCardCreateData": { "title": "FuelCardCreateData", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least 1 characters", "type": "Name must be string " } }, "expirationDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Expiration Date must be date or null", "format": "ExpirationDate must be a valid date (YYYY-MM-DD)" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "number": { "type": "string", "maxLength": 16, "pattern": "^[0-9]+$", "errorMessage": { "enum": "Number must be one of these options: \nundefined", "maxLength": "Number must not exceed 16 characters", "minLength": "Number must contain at least undefined characters", "type": "Number must be string ", "pattern": "Number must contain only digits" } } }, "additionalProperties": false, "required": [ "name", "number" ], "errorMessage": { "required": { "name": "Card name required", "number": "Card number required" } } }, "FuelCardEditData": { "title": "FuelCardEditData", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least 1 characters", "type": "Name must be string " } }, "expirationDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Expiration Date must be date or null", "format": "ExpirationDate must be a valid date (YYYY-MM-DD)" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "number": { "type": "string", "maxLength": 16, "nullable": true, "pattern": "^[0-9]+$", "errorMessage": { "enum": "Number must be one of these options: \nundefined", "maxLength": "Number must not exceed 16 characters", "minLength": "Number must contain at least undefined characters", "type": "Number must be string or null", "pattern": "Number must contain only digits" } } }, "additionalProperties": false }, "EquipmentStatusUpdateDto": { "title": "EquipmentStatusUpdateDto", "type": "object", "properties": { "equipmentStatus": { "type": "string", "enum": [ "active", "in_service", "accident" ], "errorMessage": { "enum": "Equipment Status must be one of these options: \nactive, in_service, accident", "maxLength": "Equipment Status must not exceed undefined characters", "minLength": "Equipment Status must contain at least undefined characters", "type": "Equipment Status must be string " } }, "equipmentNotes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Equipment Notes must be one of these options: \nundefined", "maxLength": "Equipment Notes must not exceed undefined characters", "minLength": "Equipment Notes must contain at least undefined characters", "type": "Equipment Notes must be string or null" } } }, "additionalProperties": false }, "VehicleInspectionCreateDto": { "title": "VehicleInspectionCreateDto", "type": "object", "properties": { "type": { "type": "string", "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "currentOdometer": { "type": "number", "errorMessage": { "minimum": "Current Odometer cannot be lower than undefined", "maximum": "Current Odometer cannot be lower than undefined", "type": "Current Odometer must be number ", "exclusiveMinimum": "Current Odometer must be greater than undefined" } }, "result": { "type": "string", "errorMessage": { "enum": "Result must be one of these options: \nundefined", "maxLength": "Result must not exceed undefined characters", "minLength": "Result must contain at least undefined characters", "type": "Result must be string " } }, "notes": { "type": "string", "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "defectReasons": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Defect Reasons must be array " } } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } } }, "additionalProperties": false }, "VehicleInspectionUpdateDto": { "title": "VehicleInspectionUpdateDto", "type": "object", "properties": { "type": { "type": "string", "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "currentOdometer": { "type": "number", "errorMessage": { "minimum": "Current Odometer cannot be lower than undefined", "maximum": "Current Odometer cannot be lower than undefined", "type": "Current Odometer must be number ", "exclusiveMinimum": "Current Odometer must be greater than undefined" } }, "result": { "type": "string", "errorMessage": { "enum": "Result must be one of these options: \nundefined", "maxLength": "Result must not exceed undefined characters", "minLength": "Result must contain at least undefined characters", "type": "Result must be string " } }, "notes": { "type": "string", "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "defectReasons": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Defect Reasons must be array " } } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } } }, "additionalProperties": false }, "AddressData": { "title": "AddressData", "type": "object", "properties": { "address1": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Address1 must be one of these options: \nundefined", "maxLength": "Address1 must not exceed 50 characters", "minLength": "Address1 must contain at least undefined characters", "type": "Address1 must be string " } }, "address2": { "type": "string", "maxLength": 50, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 50 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "address3": { "type": "string", "maxLength": 50, "nullable": true, "errorMessage": { "enum": "Address3 must be one of these options: \nundefined", "maxLength": "Address3 must not exceed 50 characters", "minLength": "Address3 must contain at least undefined characters", "type": "Address3 must be string or null" } }, "city": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 50 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "stateProvinceRegion": { "type": "string", "maxLength": 2, "errorMessage": { "enum": "State Province Region must be one of these options: \nundefined", "maxLength": "State Province Region must not exceed 2 characters", "minLength": "State Province Region must contain at least undefined characters", "type": "State Province Region must be string " } }, "postalCode": { "type": "string", "maxLength": 12, "errorMessage": { "enum": "Postal Code must be one of these options: \nundefined", "maxLength": "Postal Code must not exceed 12 characters", "minLength": "Postal Code must contain at least undefined characters", "type": "Postal Code must be string " } }, "country": { "type": "string", "maxLength": 2, "errorMessage": { "enum": "Country must be one of these options: \nundefined", "maxLength": "Country must not exceed 2 characters", "minLength": "Country must contain at least undefined characters", "type": "Country must be string " } } }, "additionalProperties": false, "required": [ "address1", "city", "stateProvinceRegion", "postalCode", "country" ], "errorMessage": { "required": { "address1": "Address 1 required", "city": "City required", "stateProvinceRegion": "State Province Region required", "postalCode": "Postal Code required", "country": "Country required" } } }, "ControllerData": { "title": "ControllerData", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 50 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "lastName": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Last Name must be one of these options: \nundefined", "maxLength": "Last Name must not exceed 50 characters", "minLength": "Last Name must contain at least undefined characters", "type": "Last Name must be string " } }, "title": { "type": "string", "maxLength": 100, "pattern": "^(?!.*\\d)[A-Za-z\\s]{1,100}$", "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 100 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string ", "pattern": "cannot contain numbers or special characters" } }, "dateOfBirth": { "type": "string", "format": "date", "errorMessage": { "type": "Date Of Birth must be date ", "format": "DateOfBirth must be a valid date (YYYY-MM-DD)" } }, "ssn": { "type": "string", "maxLength": 10, "pattern": "^\\d+$", "errorMessage": { "enum": "Ssn must be one of these options: \nundefined", "maxLength": "Ssn must not exceed 10 characters", "minLength": "Ssn must contain at least undefined characters", "type": "Ssn must be string ", "pattern": "must contain only numbers" } }, "address": { "$ref": "#/components/schemas/AddressData" } }, "additionalProperties": false, "required": [ "firstName", "lastName", "title", "dateOfBirth", "address", "ssn" ], "errorMessage": { "required": { "firstName": "First name required", "lastName": "Last name required", "title": "Title required", "dateOfBirth": "Date of Birth required", "address": "Address required", "passport": "Passport required if SSN is missing", "ssn": "SSN required" } } }, "CustomerCreateData": { "title": "CustomerCreateData", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 50 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "lastName": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Last Name must be one of these options: \nundefined", "maxLength": "Last Name must not exceed 50 characters", "minLength": "Last Name must contain at least undefined characters", "type": "Last Name must be string " } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "dateOfBirth": { "type": "string", "format": "date", "errorMessage": { "type": "Date Of Birth must be date ", "format": "DateOfBirth must be a valid date (YYYY-MM-DD)" } }, "ssn": { "type": "string", "maxLength": 10, "pattern": "^\\d+$", "errorMessage": { "enum": "Ssn must be one of these options: \nundefined", "maxLength": "Ssn must not exceed 10 characters", "minLength": "Ssn must contain at least undefined characters", "type": "Ssn must be string ", "pattern": "must contain only numbers" } }, "address1": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Address1 must be one of these options: \nundefined", "maxLength": "Address1 must not exceed 50 characters", "minLength": "Address1 must contain at least undefined characters", "type": "Address1 must be string " } }, "address2": { "type": "string", "maxLength": 50, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 50 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "city": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 50 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 2, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 2 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "postalCode": { "type": "string", "maxLength": 12, "errorMessage": { "enum": "Postal Code must be one of these options: \nundefined", "maxLength": "Postal Code must not exceed 12 characters", "minLength": "Postal Code must contain at least undefined characters", "type": "Postal Code must be string " } }, "businessName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Business Name must be one of these options: \nundefined", "maxLength": "Business Name must not exceed 255 characters", "minLength": "Business Name must contain at least undefined characters", "type": "Business Name must be string " } }, "doingBusinessAs": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Doing Business As must be one of these options: \nundefined", "maxLength": "Doing Business As must not exceed 255 characters", "minLength": "Doing Business As must contain at least undefined characters", "type": "Doing Business As must be string or null" } }, "businessType": { "type": "string", "enum": [ "soleProprietorship", "corporation", "llc", "partnership" ], "maxLength": 18, "errorMessage": { "enum": "Business Type must be one of these options: \nsoleProprietorship, corporation, llc, partnership", "maxLength": "Business Type must not exceed 18 characters", "minLength": "Business Type must contain at least undefined characters", "type": "Business Type must be string " } }, "ein": { "type": "string", "maxLength": 12, "pattern": "^[\\d-]+$", "errorMessage": { "enum": "Ein must be one of these options: \nundefined", "maxLength": "Ein must not exceed 12 characters", "minLength": "Ein must contain at least undefined characters", "type": "Ein must be string ", "pattern": "EIN must contain only numbers" } }, "website": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Website must be one of these options: \nundefined", "maxLength": "Website must not exceed 72 characters", "minLength": "Website must contain at least undefined characters", "type": "Website must be string or null" } }, "phone": { "type": "string", "maxLength": 24, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 24 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "controller": { "$ref": "#/components/schemas/ControllerData" } }, "additionalProperties": false, "if": { "properties": { "businessType": { "not": { "const": "soleProprietorship" } } } }, "then": { "required": [ "controller" ] }, "else": { "required": [ "dateOfBirth", "ssn" ] }, "required": [ "firstName", "lastName", "email", "address1", "city", "state", "postalCode", "businessName", "ein" ], "errorMessage": { "required": { "firstName": "First name required", "lastName": "Last name required", "dateOfBirth": "Date of birth required", "ssn": "SSN required", "address1": "Address required", "city": "City required", "state": "State required", "postalCode": "Postal Code required", "businessName": "Business name required", "ein": "EIN required" } } }, "CompanyDwollaSecurityDetails": { "title": "CompanyDwollaSecurityDetails", "type": "object", "properties": { "dwollaEmail": { "type": "string", "format": "email", "maxLength": 255, "errorMessage": { "enum": "Dwolla Email must be one of these options: \nundefined", "maxLength": "Dwolla Email must not exceed 255 characters", "minLength": "Dwolla Email must contain at least undefined characters", "type": "Dwolla Email must be string ", "format": "DwollaEmail must be a valid email address" } } }, "additionalProperties": false, "required": [ "dwollaEmail" ], "errorMessage": { "dwollaEmail": "Security Email required" } }, "BeneficialOwnerCreateData": { "title": "BeneficialOwnerCreateData", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "lastName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Last Name must be one of these options: \nundefined", "maxLength": "Last Name must not exceed 255 characters", "minLength": "Last Name must contain at least undefined characters", "type": "Last Name must be string " } }, "ssn": { "type": "string", "maxLength": 12, "pattern": "^\\d+$", "errorMessage": { "enum": "Ssn must be one of these options: \nundefined", "maxLength": "Ssn must not exceed 12 characters", "minLength": "Ssn must contain at least undefined characters", "type": "Ssn must be string ", "pattern": "must contain only numbers" } }, "dateOfBirth": { "type": "string", "format": "date", "errorMessage": { "type": "Date Of Birth must be date ", "format": "DateOfBirth must be a valid date (YYYY-MM-DD)" } }, "address": { "$ref": "#/components/schemas/AddressData" } }, "additionalProperties": false, "required": [ "firstName", "lastName", "dateOfBirth", "ssn" ], "errorMessage": { "required": { "firstName": "First name required", "lastName": "Last name required", "dateOfBirth": "Date of Birth required", "ssn": "SSN required" } } }, "FundingSourceCreateData": { "title": "FundingSourceCreateData", "type": "object", "properties": { "name": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 50 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "routingNumber": { "type": "string", "errorMessage": { "enum": "Routing Number must be one of these options: \nundefined", "maxLength": "Routing Number must not exceed undefined characters", "minLength": "Routing Number must contain at least undefined characters", "type": "Routing Number must be string " } }, "accountNumber": { "type": "string", "errorMessage": { "enum": "Account Number must be one of these options: \nundefined", "maxLength": "Account Number must not exceed undefined characters", "minLength": "Account Number must contain at least undefined characters", "type": "Account Number must be string " } }, "accountNumberVerify": { "type": "string", "errorMessage": { "enum": "Account Number Verify must be one of these options: \nundefined", "maxLength": "Account Number Verify must not exceed undefined characters", "minLength": "Account Number Verify must contain at least undefined characters", "type": "Account Number Verify must be string " } }, "default": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "required": [ "routingNumber", "accountNumber", "accountNumberVerify", "name" ], "errorMessage": { "required": { "accountNumber": "Account Number required", "accountNumberVerify": "Account Number must be verified", "name": "Bank Account Name required", "routingNumber": "Routing Number required" } } }, "DriverFundingSourceUpdateData": { "title": "DriverFundingSourceUpdateData", "type": "object", "properties": { "name": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 50 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "routingNumber": { "type": "string", "errorMessage": { "enum": "Routing Number must be one of these options: \nundefined", "maxLength": "Routing Number must not exceed undefined characters", "minLength": "Routing Number must contain at least undefined characters", "type": "Routing Number must be string " } }, "accountNumber": { "type": "string", "errorMessage": { "enum": "Account Number must be one of these options: \nundefined", "maxLength": "Account Number must not exceed undefined characters", "minLength": "Account Number must contain at least undefined characters", "type": "Account Number must be string " } }, "accountNumberVerify": { "type": "string", "errorMessage": { "enum": "Account Number Verify must be one of these options: \nundefined", "maxLength": "Account Number Verify must not exceed undefined characters", "minLength": "Account Number Verify must contain at least undefined characters", "type": "Account Number Verify must be string " } } }, "additionalProperties": false, "required": [ "name" ] }, "PrePayrollTransferDetailsData": { "title": "PrePayrollTransferDetailsData", "type": "object", "properties": { "amount": { "type": "string", "maxLength": 12, "pattern": "^\\d+(\\.\\d{1,2})?$", "errorMessage": { "enum": "Amount must be one of these options: \nundefined", "maxLength": "Amount must not exceed 12 characters", "minLength": "Amount must contain at least undefined characters", "type": "Amount must be string ", "pattern": "Amount must be a valid positive number with up to 2 decimal places" } } }, "additionalProperties": false, "required": [ "amount" ] }, "SettlementsMassPaymentData": { "title": "SettlementsMassPaymentData", "type": "object", "properties": { "settlementIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Settlement Ids items must be a valid UUID" } } } }, "additionalProperties": false, "required": [ "settlementIds" ], "errorMessage": { "required": { "settlementIds": "Settlements are required" } } }, "OtpCodeVerificationData": { "title": "OtpCodeVerificationData", "type": "object", "properties": { "event": { "type": "string", "enum": [ "driver", "security-email", "transfer" ], "errorMessage": { "enum": "Event must be one of these options: \ndriver, security-email, transfer", "maxLength": "Event must not exceed undefined characters", "minLength": "Event must contain at least undefined characters", "type": "Event must be string " } }, "code": { "type": "string", "errorMessage": { "enum": "Code must be one of these options: \nundefined", "maxLength": "Code must not exceed undefined characters", "minLength": "Code must contain at least undefined characters", "type": "Code must be string " } } }, "additionalProperties": false, "required": [ "code", "event" ], "errorMessage": { "required": { "code": "Code required", "event": "Event required" } } }, "OtpCodeResendData": { "title": "OtpCodeResendData", "type": "object", "properties": { "event": { "type": "string", "enum": [ "driver", "security-email", "transfer" ], "errorMessage": { "enum": "Event must be one of these options: \ndriver, security-email, transfer", "maxLength": "Event must not exceed undefined characters", "minLength": "Event must contain at least undefined characters", "type": "Event must be string " } } }, "additionalProperties": false, "required": [ "event" ], "errorMessage": { "required": { "event": "Event required" } } }, "PlaidAccountItem": { "title": "PlaidAccountItem", "type": "object", "properties": { "id": { "type": "string", "errorMessage": { "enum": "Id must be one of these options: \nundefined", "maxLength": "Id must not exceed undefined characters", "minLength": "Id must contain at least undefined characters", "type": "Id must be string " } }, "mask": { "type": "string", "errorMessage": { "enum": "Mask must be one of these options: \nundefined", "maxLength": "Mask must not exceed undefined characters", "minLength": "Mask must contain at least undefined characters", "type": "Mask must be string " } }, "name": { "type": "string", "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed undefined characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "type": { "type": "string", "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "subtype": { "type": "string", "errorMessage": { "enum": "Subtype must be one of these options: \nundefined", "maxLength": "Subtype must not exceed undefined characters", "minLength": "Subtype must contain at least undefined characters", "type": "Subtype must be string " } }, "verification_status": { "type": "string", "errorMessage": { "enum": "Verification_status must be one of these options: \nundefined", "maxLength": "Verification_status must not exceed undefined characters", "minLength": "Verification_status must contain at least undefined characters", "type": "Verification_status must be string " } }, "class_type": { "type": "string", "errorMessage": { "enum": "Class_type must be one of these options: \nundefined", "maxLength": "Class_type must not exceed undefined characters", "minLength": "Class_type must contain at least undefined characters", "type": "Class_type must be string " } } }, "additionalProperties": false }, "PlaidInstitutionItem": { "title": "PlaidInstitutionItem", "type": "object", "properties": { "name": { "type": "string", "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed undefined characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "institution_id": { "type": "string", "errorMessage": { "enum": "Institution_id must be one of these options: \nundefined", "maxLength": "Institution_id must not exceed undefined characters", "minLength": "Institution_id must contain at least undefined characters", "type": "Institution_id must be string " } } }, "additionalProperties": false }, "FundingSourceViaPlaidData": { "title": "FundingSourceViaPlaidData", "type": "object", "properties": { "plaidPublicToken": { "type": "string", "errorMessage": { "enum": "Plaid Public Token must be one of these options: \nundefined", "maxLength": "Plaid Public Token must not exceed undefined characters", "minLength": "Plaid Public Token must contain at least undefined characters", "type": "Plaid Public Token must be string " } }, "account": { "$ref": "#/components/schemas/PlaidAccountItem" }, "institution": { "$ref": "#/components/schemas/PlaidInstitutionItem" }, "name": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 50 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } } }, "additionalProperties": false, "required": [ "plaidPublicToken", "account", "name" ], "errorMessage": { "required": { "account": "Account required", "name": "Bank Account name required", "plaidPublicToken": "Plaid Public Token required" } } }, "CompanyFundingSourceUpdateData": { "title": "CompanyFundingSourceUpdateData", "type": "object", "properties": { "name": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 50 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "routingNumber": { "type": "string", "nullable": true, "errorMessage": { "enum": "Routing Number must be one of these options: \nundefined", "maxLength": "Routing Number must not exceed undefined characters", "minLength": "Routing Number must contain at least undefined characters", "type": "Routing Number must be string or null" } }, "accountNumber": { "type": "string", "nullable": true, "errorMessage": { "enum": "Account Number must be one of these options: \nundefined", "maxLength": "Account Number must not exceed undefined characters", "minLength": "Account Number must contain at least undefined characters", "type": "Account Number must be string or null" } }, "bankAccountType": { "type": "string", "enum": [ "checking", "savings", "general-ledger", "loan" ], "errorMessage": { "enum": "Bank Account Type must be one of these options: \nchecking, savings, general-ledger, loan", "maxLength": "Bank Account Type must not exceed undefined characters", "minLength": "Bank Account Type must contain at least undefined characters", "type": "Bank Account Type must be string " } } }, "additionalProperties": false, "required": [ "name" ] }, "AmountData": { "title": "AmountData", "type": "object", "properties": { "currency": { "type": "string", "errorMessage": { "enum": "Currency must be one of these options: \nundefined", "maxLength": "Currency must not exceed undefined characters", "minLength": "Currency must contain at least undefined characters", "type": "Currency must be string " } }, "value": { "type": "string", "errorMessage": { "enum": "Value must be one of these options: \nundefined", "maxLength": "Value must not exceed undefined characters", "minLength": "Value must contain at least undefined characters", "type": "Value must be string " } } }, "additionalProperties": false, "required": [ "currency", "value" ], "errorMessage": { "currency": "Amount currency required", "value": "Amount value required" } }, "FundingSourceVerifyMicroDepositData": { "title": "FundingSourceVerifyMicroDepositData", "type": "object", "properties": { "amount1": { "$ref": "#/components/schemas/AmountData" }, "amount2": { "$ref": "#/components/schemas/AmountData" } }, "additionalProperties": false, "required": [ "amount1", "amount2" ], "errorMessage": { "required": { "amount1": "Amount 1 required", "amount2": "Amount 2 required" } } }, "DriverInviteDto": { "title": "DriverInviteDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "driverType": { "type": "string", "enum": [ "owner", "company" ], "maxLength": 72, "errorMessage": { "enum": "Driver Type must be one of these options: \nowner, company", "maxLength": "Driver Type must not exceed 72 characters", "minLength": "Driver Type must contain at least undefined characters", "type": "Driver Type must be string " } }, "payment": { "$ref": "#/components/schemas/DriverPaymentObj" } }, "additionalProperties": false, "required": [ "email", "driverType", "payment" ], "errorMessage": { "required": { "email": "Email is required", "driverType": "Driver type is required", "payment": "Payment is required" } } }, "DriverOwnCompany": { "title": "DriverOwnCompany", "type": "object", "properties": { "name": { "type": "string" }, "tin": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "state": { "type": "string" }, "email": { "type": "string" }, "logo": { "type": "string" } }, "additionalProperties": false }, "DriverCreateDtoV3": { "title": "DriverCreateDtoV3", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "middleName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Middle Name must be one of these options: \nundefined", "maxLength": "Middle Name must not exceed 255 characters", "minLength": "Middle Name must contain at least undefined characters", "type": "Middle Name must be string " } }, "driverType": { "type": "string", "enum": [ "owner", "company" ], "maxLength": 72, "errorMessage": { "enum": "Driver Type must be one of these options: \nowner, company", "maxLength": "Driver Type must not exceed 72 characters", "minLength": "Driver Type must contain at least undefined characters", "type": "Driver Type must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "address1": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address1 must be one of these options: \nundefined", "maxLength": "Address1 must not exceed 255 characters", "minLength": "Address1 must contain at least undefined characters", "type": "Address1 must be string or null" } }, "address2": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "zipCode": { "type": "string", "maxLength": 32, "nullable": true, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 32 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string or null" } }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "payment": { "$ref": "#/components/schemas/DriverPaymentObj" }, "driverOwnCompany": { "$ref": "#/components/schemas/DriverOwnCompany" }, "payPeriod": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "maxLength": 55, "errorMessage": { "enum": "Pay Period must be one of these options: \ndaily, weekly, monthly", "maxLength": "Pay Period must not exceed 55 characters", "minLength": "Pay Period must contain at least undefined characters", "type": "Pay Period must be string " } }, "TWICCard": { "type": "boolean" }, "tankerEndorsed": { "type": "boolean" }, "HazMatCertified": { "type": "boolean" }, "emergencyName": { "type": "string", "nullable": true, "errorMessage": { "enum": "Emergency Name must be one of these options: \nundefined", "maxLength": "Emergency Name must not exceed undefined characters", "minLength": "Emergency Name must contain at least undefined characters", "type": "Emergency Name must be string or null" } }, "emergencyContact": { "type": "string", "nullable": true, "errorMessage": { "enum": "Emergency Contact must be one of these options: \nundefined", "maxLength": "Emergency Contact must not exceed undefined characters", "minLength": "Emergency Contact must contain at least undefined characters", "type": "Emergency Contact must be string or null" } }, "showNetPay": { "type": "boolean" } }, "additionalProperties": false, "required": [ "email", "driverType", "payment" ], "errorMessage": { "required": { "email": "Email is required", "driverType": "Driver type is required", "payment": "Payment is required" } } }, "DriverEditDtoV2": { "title": "DriverEditDtoV2", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "middleName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Middle Name must be one of these options: \nundefined", "maxLength": "Middle Name must not exceed 255 characters", "minLength": "Middle Name must contain at least undefined characters", "type": "Middle Name must be string " } }, "driverType": { "type": "string", "enum": [ "owner", "company" ], "maxLength": 72, "errorMessage": { "enum": "Driver Type must be one of these options: \nowner, company", "maxLength": "Driver Type must not exceed 72 characters", "minLength": "Driver Type must contain at least undefined characters", "type": "Driver Type must be string " } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "address1": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address1 must be one of these options: \nundefined", "maxLength": "Address1 must not exceed 255 characters", "minLength": "Address1 must contain at least undefined characters", "type": "Address1 must be string or null" } }, "address2": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "zipCode": { "type": "string", "maxLength": 32, "nullable": true, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 32 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string or null" } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "eldUsername": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Eld Username must be one of these options: \nundefined", "maxLength": "Eld Username must not exceed 255 characters", "minLength": "Eld Username must contain at least undefined characters", "type": "Eld Username must be string or null" } }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "payment": { "$ref": "#/components/schemas/DriverPaymentObj" }, "driverOwnCompany": { "$ref": "#/components/schemas/DriverOwnCompany" }, "payPeriod": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "maxLength": 55, "errorMessage": { "enum": "Pay Period must be one of these options: \ndaily, weekly, monthly", "maxLength": "Pay Period must not exceed 55 characters", "minLength": "Pay Period must contain at least undefined characters", "type": "Pay Period must be string " } }, "TWICCard": { "type": "boolean" }, "tankerEndorsed": { "type": "boolean" }, "HazMatCertified": { "type": "boolean" }, "emergencyName": { "type": "string", "nullable": true, "errorMessage": { "enum": "Emergency Name must be one of these options: \nundefined", "maxLength": "Emergency Name must not exceed undefined characters", "minLength": "Emergency Name must contain at least undefined characters", "type": "Emergency Name must be string or null" } }, "emergencyContact": { "type": "string", "nullable": true, "errorMessage": { "enum": "Emergency Contact must be one of these options: \nundefined", "maxLength": "Emergency Contact must not exceed undefined characters", "minLength": "Emergency Contact must contain at least undefined characters", "type": "Emergency Contact must be string or null" } }, "showNetPay": { "type": "boolean" } }, "additionalProperties": false, "required": [ "email" ], "errorMessage": { "required": { "email": "Email is required" } } }, "EditOwnCompany": { "title": "EditOwnCompany", "type": "object", "properties": { "name": { "type": "string" }, "tin": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "state": { "type": "string" }, "email": { "type": "string" }, "logo": { "type": "string" } }, "additionalProperties": false, "required": [ "name" ], "errorMessage": { "required": { "email": "Name is required" } } }, "DriverEditPassDto": { "title": "DriverEditPassDto", "type": "object", "properties": { "password": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least undefined characters", "type": "Password must be string " } }, "confirmPassword": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least undefined characters", "type": "Confirm Password must be string " } } }, "additionalProperties": false, "required": [ "password", "confirmPassword" ], "errorMessage": { "required": { "password": "Password is required", "confirmPassword": "Password confirmation is required" } } }, "Escrow": { "title": "Escrow", "type": "object", "properties": { "escrowAmount": { "type": "number", "format": "float", "errorMessage": { "type": "Escrow Amount must be number ", "exclusiveMinimum": "Escrow Amount must be greater than undefined" } }, "chargeAmount": { "type": "number", "format": "float", "errorMessage": { "type": "Charge Amount must be number ", "exclusiveMinimum": "Charge Amount must be greater than undefined" } }, "split": { "type": "number", "errorMessage": { "minimum": "Split cannot be lower than undefined", "maximum": "Split cannot be lower than undefined", "type": "Split must be number ", "exclusiveMinimum": "Split must be greater than undefined" } }, "refundAfter": { "type": "number", "errorMessage": { "minimum": "Refund After cannot be lower than undefined", "maximum": "Refund After cannot be lower than undefined", "type": "Refund After must be number ", "exclusiveMinimum": "Refund After must be greater than undefined" } } }, "additionalProperties": false }, "DriverWeeklyDeductions": { "title": "DriverWeeklyDeductions", "type": "object", "properties": { "weeklyDeductions": { "type": "array", "items": { "$ref": "#/components/schemas/WeeklyDeduction" } }, "escrow": { "$ref": "#/components/schemas/Escrow" } }, "additionalProperties": false }, "NewEndorsements": { "title": "NewEndorsements", "type": "object", "properties": { "placardedHazmat": { "type": "boolean" }, "tankVehicles": { "type": "boolean" }, "passengers": { "type": "boolean" }, "doubleOrTripleTrailers": { "type": "boolean" }, "schoolBus": { "type": "boolean" }, "placardedHazmatAndTankVehicles": { "type": "boolean" }, "hazmatExpirationDate": { "type": "string", "format": "date", "nullable": true } }, "additionalProperties": false }, "NewDriverLicenseCreateData": { "title": "NewDriverLicenseCreateData", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 72 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 72 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "issueDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Issue Date must be date or null", "format": "IssueDate must be a valid date (YYYY-MM-DD)" } }, "expirationDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Expiration Date must be date or null", "format": "ExpirationDate must be a valid date (YYYY-MM-DD)" } }, "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "maxLength": 2, "errorMessage": { "enum": "State must be one of these options: \nAL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY", "maxLength": "State must not exceed 2 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "class": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Class must be one of these options: \nundefined", "maxLength": "Class must not exceed 24 characters", "minLength": "Class must contain at least undefined characters", "type": "Class must be string or null" } }, "licenseNumber": { "type": "string", "maxLength": 24, "errorMessage": { "enum": "License Number must be one of these options: \nundefined", "maxLength": "License Number must not exceed 24 characters", "minLength": "License Number must contain at least undefined characters", "type": "License Number must be string " } }, "endorsements": { "$ref": "#/components/schemas/NewEndorsements" }, "cdlDocumentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Cdl Document Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "firstName", "secondName", "state", "licenseNumber" ], "errorMessage": { "required": { "firstName": "First name required", "secondName": "Second name required", "state": "State required", "licenseNumber": "License number required" } } }, "DriverEditDocumentDateDto": { "title": "DriverEditDocumentDateDto", "type": "object", "properties": { "documentId": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Document Id must be one of these options: \nundefined", "maxLength": "Document Id must not exceed 36 characters", "minLength": "Document Id must contain at least undefined characters", "type": "Document Id must be string " } }, "expireDate": { "type": "string", "errorMessage": { "type": "Expire Date must be date " } }, "issueDate": { "type": "string", "errorMessage": { "type": "Issue Date must be date " } } }, "additionalProperties": false, "required": [ "expireDate", "issueDate", "documentId" ], "errorMessage": { "required": { "expireDate": "Expire Date is required", "issueDate": "Issue Date is required", "documentId": "Document Date is required" } } }, "DriverMedicalCardDto": { "title": "DriverMedicalCardDto", "type": "object", "properties": { "medicalExaminerName": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Medical Examiner Name must be one of these options: \nundefined", "maxLength": "Medical Examiner Name must not exceed 120 characters", "minLength": "Medical Examiner Name must contain at least undefined characters", "type": "Medical Examiner Name must be string or null" } }, "nationalRegistryNumber": { "type": "string", "maxLength": 20, "errorMessage": { "enum": "National Registry Number must be one of these options: \nundefined", "maxLength": "National Registry Number must not exceed 20 characters", "minLength": "National Registry Number must contain at least undefined characters", "type": "National Registry Number must be string " } }, "issueDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Issue Date must be date or null", "format": "IssueDate must be a valid date (YYYY-MM-DD)" } }, "expirationDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Expiration Date must be date or null", "format": "ExpirationDate must be a valid date (YYYY-MM-DD)" } }, "isExempt": { "type": "boolean" } }, "additionalProperties": false }, "DriverPreEmploymentDrugTestDto": { "title": "DriverPreEmploymentDrugTestDto", "type": "object", "properties": { "result": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Result must be one of these options: \nundefined", "maxLength": "Result must not exceed 36 characters", "minLength": "Result must contain at least undefined characters", "type": "Result must be string " } }, "resultDateTime": { "type": "string", "format": "date", "errorMessage": { "type": "Result Date Time must be date ", "format": "ResultDateTime must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false, "required": [ "resultDateTime", "result" ], "errorMessage": { "required": { "resultDateTime": "Result Date-Time is required", "result": "Drug Test Result required" } } }, "CompanyApproveAccessRequestDto": { "title": "CompanyApproveAccessRequestDto", "type": "object", "properties": { "roleId": { "type": "number", "nullable": false, "errorMessage": { "minimum": "Role Id cannot be lower than undefined", "maximum": "Role Id cannot be lower than undefined", "type": "Role Id must be number ", "exclusiveMinimum": "Role Id must be greater than undefined" } }, "permissionIds": { "type": "array", "items": { "type": "number", "nullable": false, "errorMessage": { "type": "Permission Ids must be array " } } } }, "additionalProperties": false, "required": [ "roleId", "permissionIds" ], "errorMessage": { "required": { "roleId": "Role is required", "permissionIds": "Permissions are required" } } }, "DispatcherResentInviteDtoV2": { "title": "DispatcherResentInviteDtoV2", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "roleId": { "type": "number", "nullable": false, "errorMessage": { "minimum": "Role Id cannot be lower than undefined", "maximum": "Role Id cannot be lower than undefined", "type": "Role Id must be number ", "exclusiveMinimum": "Role Id must be greater than undefined" } }, "permissionIds": { "type": "array", "items": { "type": "number", "nullable": false, "errorMessage": { "type": "Permission Ids must be array " } } } }, "additionalProperties": false, "required": [ "email", "roleId", "permissionIds", "firstName", "secondName" ], "errorMessage": { "required": { "email": "Email is required", "role": "Role is required", "permissionIds": "permissions required" } } }, "DispatcherUpdateRoleAndPermissionsDto": { "title": "DispatcherUpdateRoleAndPermissionsDto", "type": "object", "properties": { "roleId": { "type": "number", "nullable": false, "errorMessage": { "minimum": "Role Id cannot be lower than undefined", "maximum": "Role Id cannot be lower than undefined", "type": "Role Id must be number ", "exclusiveMinimum": "Role Id must be greater than undefined" } }, "permissionIds": { "type": "array", "items": { "type": "number", "nullable": false, "errorMessage": { "type": "Permission Ids must be array " } } } }, "additionalProperties": false, "required": [ "roleId", "permissionIds" ] }, "DispatcherEditPasswordDto": { "title": "DispatcherEditPasswordDto", "type": "object", "properties": { "password": { "type": "string", "minLength": 8, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).+$", "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least 8 characters", "type": "Password must be string ", "pattern": "Password must include at least one uppercase letter (A–Z), one lowercase letter (a–z), and one number (0–9)" } }, "confirmPassword": { "type": "string", "minLength": 8, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).+$", "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least 8 characters", "type": "Confirm Password must be string ", "pattern": "Password must include at least one uppercase letter (A–Z), one lowercase letter (a–z), and one number (0–9)" } } }, "additionalProperties": false, "required": [ "password", "confirmPassword" ], "errorMessage": { "required": { "password": "Password is required", "confirmPassword": "Password confirmation is required" } } }, "DispatcherEditDto": { "title": "DispatcherEditDto", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "driverId": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Driver Id must be array " } } } }, "additionalProperties": false, "required": [ "firstName", "secondName" ], "errorMessage": { "required": { "firstName": "First name is required", "secondName": "Last name is required" } } }, "BrokerTmsConnectionApproveDto": { "title": "BrokerTmsConnectionApproveDto", "type": "object", "properties": { "granted_scopes": { "type": "array", "items": { "type": "string", "enum": [ "trucks:read", "trucks:location", "drivers:read", "drivers:location", "drivers:contact", "loads:write", "messages:read", "messages:write" ], "minItems": 1 } } }, "additionalProperties": false, "required": [ "granted_scopes" ] }, "BrokerTmsConnectionRejectDto": { "title": "BrokerTmsConnectionRejectDto", "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "BrokerTmsConnectionSuspendDto": { "title": "BrokerTmsConnectionSuspendDto", "type": "object", "properties": { "reason": { "type": "string" }, "suspended_until": { "type": "string", "format": "date-time" } }, "required": [ "reason" ], "additionalProperties": false }, "RedeemReferralPointsDto": { "title": "RedeemReferralPointsDto", "type": "object", "properties": { "points": { "type": "number", "minimum": 100, "errorMessage": { "minimum": "Points cannot be lower than 100", "maximum": "Points cannot be lower than undefined", "type": "Points must be number ", "exclusiveMinimum": "Points must be greater than undefined" } }, "method": { "type": "string", "errorMessage": { "enum": "Method must be one of these options: \nundefined", "maxLength": "Method must not exceed undefined characters", "minLength": "Method must contain at least undefined characters", "type": "Method must be string " } }, "companyId": { "type": "string", "errorMessage": { "enum": "Company Id must be one of these options: \nundefined", "maxLength": "Company Id must not exceed undefined characters", "minLength": "Company Id must contain at least undefined characters", "type": "Company Id must be string " } } }, "additionalProperties": false, "required": [ "points", "method", "companyId" ], "errorMessage": { "required": { "points": "Points amount is required", "method": "Redemption method is required", "companyId": "Company ID is required" } } }, "SignInBody": { "title": "SignInBody", "type": "object", "properties": { "email": { "type": "string", "format": "email", "minLength": 4, "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least 4 characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "password": { "type": "string", "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed undefined characters", "minLength": "Password must contain at least undefined characters", "type": "Password must be string " } } }, "additionalProperties": false, "required": [ "email", "password" ], "errorMessage": { "required": { "email": "Email is required", "password": "Password is required" } } }, "Verify": { "title": "Verify", "type": "object", "properties": { "jwtToken": { "type": "string", "errorMessage": { "enum": "Jwt Token must be one of these options: \nundefined", "maxLength": "Jwt Token must not exceed undefined characters", "minLength": "Jwt Token must contain at least undefined characters", "type": "Jwt Token must be string " } }, "token": { "type": "string", "errorMessage": { "enum": "Token must be one of these options: \nundefined", "maxLength": "Token must not exceed undefined characters", "minLength": "Token must contain at least undefined characters", "type": "Token must be string " } } }, "additionalProperties": false }, "CompanyAccessRequestDto": { "title": "CompanyAccessRequestDto", "type": "object", "properties": { "note": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Note must be one of these options: \nundefined", "maxLength": "Note must not exceed 1000 characters", "minLength": "Note must contain at least undefined characters", "type": "Note must be string or null" } } }, "additionalProperties": false }, "DispatcherResetPasswordDto": { "title": "DispatcherResetPasswordDto", "type": "object", "properties": { "password": { "type": "string", "minLength": 8, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).+$", "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least 8 characters", "type": "Password must be string ", "pattern": "Password must include at least one uppercase letter (A–Z), one lowercase letter (a–z), and one number (0–9)" } }, "confirmPassword": { "type": "string", "minLength": 8, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).+$", "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least 8 characters", "type": "Confirm Password must be string ", "pattern": "Password must include at least one uppercase letter (A–Z), one lowercase letter (a–z), and one number (0–9)" } } }, "additionalProperties": false }, "DeviceDto": { "title": "DeviceDto", "type": "object", "properties": { "id": { "type": "string", "errorMessage": { "enum": "Id must be one of these options: \nundefined", "maxLength": "Id must not exceed undefined characters", "minLength": "Id must contain at least undefined characters", "type": "Id must be string " } }, "fcmToken": { "type": "string", "errorMessage": { "enum": "Fcm Token must be one of these options: \nundefined", "maxLength": "Fcm Token must not exceed undefined characters", "minLength": "Fcm Token must contain at least undefined characters", "type": "Fcm Token must be string " } }, "type": { "type": "string", "enum": [ "android", "ios" ], "errorMessage": { "enum": "Type must be one of these options: \nandroid, ios", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "model": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "Model must be one of these options: \nundefined", "maxLength": "Model must not exceed 55 characters", "minLength": "Model must contain at least undefined characters", "type": "Model must be string or null" } }, "osVersion": { "type": "string", "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Os Version must be one of these options: \nundefined", "maxLength": "Os Version must not exceed 20 characters", "minLength": "Os Version must contain at least undefined characters", "type": "Os Version must be string or null" } }, "appVersion": { "type": "string", "maxLength": 50, "nullable": true, "errorMessage": { "enum": "App Version must be one of these options: \nundefined", "maxLength": "App Version must not exceed 50 characters", "minLength": "App Version must contain at least undefined characters", "type": "App Version must be string or null" } } }, "additionalProperties": false, "required": [ "id", "fcmToken", "type", "model", "osVersion", "appVersion" ] }, "SignInBodyToDispatcherApp": { "title": "SignInBodyToDispatcherApp", "type": "object", "properties": { "email": { "type": "string", "format": "email", "minLength": 4, "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least 4 characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "password": { "type": "string", "minLength": 12, "maxLength": 32, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).+$", "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 32 characters", "minLength": "Password must contain at least 12 characters", "type": "Password must be string ", "pattern": "Password must include at least one letter, one number, and one symbol" } }, "device": { "$ref": "#/components/schemas/DeviceDto" } }, "additionalProperties": false, "required": [ "email", "password" ], "errorMessage": { "required": { "email": "Email is required", "password": "Password is required" } } }, "InviteDto": { "title": "InviteDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "minLength": 4, "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least 4 characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "password": { "type": "string", "minLength": 12, "maxLength": 32, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).+$", "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 32 characters", "minLength": "Password must contain at least 12 characters", "type": "Password must be string ", "pattern": "Password must include at least one letter, one number, and one symbol" } }, "confirmPassword": { "type": "string", "minLength": 8, "maxLength": 32, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d).+$", "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 32 characters", "minLength": "Confirm Password must contain at least 8 characters", "type": "Confirm Password must be string ", "pattern": "Password must include at least one uppercase letter (A–Z),\n one lowercase letter (a–z),\n and one number (0–9)" } }, "phone": { "type": "string", "minLength": 4, "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least 4 characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "firstName": { "type": "string", "minLength": 2, "maxLength": 255, "pattern": "^[^а-яА-ЯёЁ]*$", "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least 2 characters", "type": "First Name must be string ", "pattern": "First name must not contain any cyrillic character" } }, "secondName": { "type": "string", "minLength": 2, "maxLength": 255, "pattern": "^[^а-яА-ЯёЁ]*$", "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least 2 characters", "type": "Second Name must be string ", "pattern": "Second name must not contain any cyrillic character" } } }, "additionalProperties": false, "required": [ "password", "firstName", "secondName", "confirmPassword" ], "errorMessage": { "required": { "password": "Password is required", "firstName": "First name is required", "secondName": "Last name is required", "confirmPassword": "Password confirmation is required" } } }, "DisPatcherEditConfirmPasswordDto": { "title": "DisPatcherEditConfirmPasswordDto", "type": "object", "properties": { "confirmPassword": { "type": "string", "minLength": 12, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).+$", "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least 12 characters", "type": "Confirm Password must be string ", "pattern": "Password must include at least one letter, one number, and one symbol" } }, "newPassword": { "type": "string", "minLength": 12, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).+$", "errorMessage": { "enum": "New Password must be one of these options: \nundefined", "maxLength": "New Password must not exceed 255 characters", "minLength": "New Password must contain at least 12 characters", "type": "New Password must be string ", "pattern": "Password must include at least one letter, one number, and one symbol" } } }, "additionalProperties": false, "required": [ "confirmPassword", "newPassword" ], "errorMessage": { "required": { "confirmPassword": "Password confirmation is required", "newPassword": "New password is required" } } }, "DispatcherDisableNotification": { "title": "DispatcherDisableNotification", "type": "object", "properties": { "notification": { "type": "boolean" } }, "additionalProperties": false, "required": [ "notification" ], "errorMessage": { "required": { "notification": "Notification is required" } } }, "CurrentUserEditDto": { "title": "CurrentUserEditDto", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } } }, "additionalProperties": false, "required": [ "firstName", "secondName" ], "errorMessage": { "required": { "firstName": "First name is required", "secondName": "Last name is required" } } }, "UserOauthEmailEdit": { "title": "UserOauthEmailEdit", "type": "object", "properties": { "isMainEmail": { "type": "boolean" }, "readAllRC": { "type": "boolean" } }, "additionalProperties": false }, "EmailForm": { "title": "EmailForm", "type": "object", "properties": { "to": { "type": "string", "errorMessage": { "enum": "To must be one of these options: \nundefined", "maxLength": "To must not exceed undefined characters", "minLength": "To must contain at least undefined characters", "type": "To must be string " } } }, "additionalProperties": false }, "Attachments": { "title": "Attachments", "type": "object", "properties": { "data": { "type": "string", "errorMessage": { "enum": "Data must be one of these options: \nundefined", "maxLength": "Data must not exceed undefined characters", "minLength": "Data must contain at least undefined characters", "type": "Data must be string " } }, "name": { "type": "string", "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed undefined characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "type": { "type": "string", "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } } }, "additionalProperties": false }, "ReplyOptions": { "title": "ReplyOptions", "type": "object", "properties": { "threadId": { "type": "string", "errorMessage": { "enum": "Thread Id must be one of these options: \nundefined", "maxLength": "Thread Id must not exceed undefined characters", "minLength": "Thread Id must contain at least undefined characters", "type": "Thread Id must be string " } }, "messageId": { "type": "string", "errorMessage": { "enum": "Message Id must be one of these options: \nundefined", "maxLength": "Message Id must not exceed undefined characters", "minLength": "Message Id must contain at least undefined characters", "type": "Message Id must be string " } }, "replyText": { "type": "string", "errorMessage": { "enum": "Reply Text must be one of these options: \nundefined", "maxLength": "Reply Text must not exceed undefined characters", "minLength": "Reply Text must contain at least undefined characters", "type": "Reply Text must be string " } }, "replyHtml": { "type": "string", "errorMessage": { "enum": "Reply Html must be one of these options: \nundefined", "maxLength": "Reply Html must not exceed undefined characters", "minLength": "Reply Html must contain at least undefined characters", "type": "Reply Html must be string " } }, "brokerEmail": { "type": "string", "errorMessage": { "enum": "Broker Email must be one of these options: \nundefined", "maxLength": "Broker Email must not exceed undefined characters", "minLength": "Broker Email must contain at least undefined characters", "type": "Broker Email must be string " } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachments" } } }, "additionalProperties": false }, "EmailTemplateCreateForm": { "title": "EmailTemplateCreateForm", "type": "object", "properties": { "templateName": { "type": "string", "errorMessage": { "enum": "Template Name must be one of these options: \nundefined", "maxLength": "Template Name must not exceed undefined characters", "minLength": "Template Name must contain at least undefined characters", "type": "Template Name must be string " } }, "subject": { "type": "string", "errorMessage": { "enum": "Subject must be one of these options: \nundefined", "maxLength": "Subject must not exceed undefined characters", "minLength": "Subject must contain at least undefined characters", "type": "Subject must be string " } }, "body": { "type": "string", "errorMessage": { "enum": "Body must be one of these options: \nundefined", "maxLength": "Body must not exceed undefined characters", "minLength": "Body must contain at least undefined characters", "type": "Body must be string " } }, "footer": { "type": "string", "errorMessage": { "enum": "Footer must be one of these options: \nundefined", "maxLength": "Footer must not exceed undefined characters", "minLength": "Footer must contain at least undefined characters", "type": "Footer must be string " } } }, "additionalProperties": false }, "TgForm": { "title": "TgForm", "type": "object", "properties": { "text": { "type": "string", "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed undefined characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } } }, "additionalProperties": false }, "CustomerContactForCustomerDto": { "title": "CustomerContactForCustomerDto", "type": "object", "properties": { "email": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string or null" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Customer Id must be a valid UUID" } }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "phone", "fullName" ], "errorMessage": { "required": { "phone": "Phone is required", "fullName": "Full name is required" } } }, "CustomerDto": { "title": "CustomerDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "lat": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lat must be number or null", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lng must be number or null", "exclusiveMinimum": "Lng must be greater than undefined" } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCodes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed undefined characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string or null" } }, "placeId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed undefined characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string or null" } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "notes": { "type": "string", "maxLength": 1200, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "customerContact": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContactForCustomerDto" } } }, "additionalProperties": false, "required": [ "name", "address", "city", "state" ], "errorMessage": { "required": { "name": "Name is required", "address": "Address is required", "city": "City is required", "state": "State is required" } } }, "CustomerEditDto": { "title": "CustomerEditDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "lat": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lat must be number or null", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lng must be number or null", "exclusiveMinimum": "Lng must be greater than undefined" } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCodes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed undefined characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string or null" } }, "placeId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed undefined characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string or null" } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "notes": { "type": "string", "maxLength": 1200, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false, "required": [ "name", "address", "city", "state" ], "errorMessage": { "required": { "name": "Name is required", "address": "Address is required", "city": "City is required", "state": "State is required" } } }, "CustomerContactDto": { "title": "CustomerContactDto", "type": "object", "properties": { "email": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string or null" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Customer Id must be a valid UUID" } }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "phone", "fullName", "customerId" ], "errorMessage": { "required": { "phone": "Phone is required", "fullName": "Full name is required", "customerId": "Customer is required" } } }, "CustomerContactEditDto": { "title": "CustomerContactEditDto", "type": "object", "properties": { "email": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string or null" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Customer Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "phone", "fullName" ], "errorMessage": { "required": { "phone": "Phone is required", "fullName": "Full name is required" } } }, "EmergencyContact": { "title": "EmergencyContact", "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" } }, "additionalProperties": false }, "ContractTrucks": { "title": "ContractTrucks", "type": "object", "properties": { "truckId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Truck Id must be a valid UUID" } }, "grossPercentage": { "type": "number", "format": "float", "errorMessage": { "type": "Gross Percentage must be number ", "exclusiveMinimum": "Gross Percentage must be greater than undefined" } }, "netPayShare": { "type": "number", "format": "float", "errorMessage": { "type": "Net Pay Share must be number ", "exclusiveMinimum": "Net Pay Share must be greater than undefined" } } }, "additionalProperties": false }, "ContractorDto": { "title": "ContractorDto", "type": "object", "properties": { "companyName": { "type": "string", "errorMessage": { "enum": "Company Name must be one of these options: \nundefined", "maxLength": "Company Name must not exceed undefined characters", "minLength": "Company Name must contain at least undefined characters", "type": "Company Name must be string " } }, "tin": { "type": "string", "errorMessage": { "enum": "Tin must be one of these options: \nundefined", "maxLength": "Tin must not exceed undefined characters", "minLength": "Tin must contain at least undefined characters", "type": "Tin must be string " } }, "middleName": { "type": "string", "errorMessage": { "enum": "Middle Name must be one of these options: \nundefined", "maxLength": "Middle Name must not exceed undefined characters", "minLength": "Middle Name must contain at least undefined characters", "type": "Middle Name must be string " } }, "firstName": { "type": "string", "pattern": "^.+$", "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed undefined characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string ", "pattern": "First name must not be empty or whitespace" } }, "secondName": { "type": "string", "pattern": "^.+$", "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed undefined characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string ", "pattern": "Second name must not be empty or whitespace" } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "email": { "type": "string", "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed undefined characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string " } }, "address": { "type": "string", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed undefined characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed undefined characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed undefined characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "emergencyContact": { "$ref": "#/components/schemas/EmergencyContact" }, "contractorTrucks": { "type": "array", "items": { "$ref": "#/components/schemas/ContractTrucks" } } }, "additionalProperties": false }, "ContractorEditDto": { "title": "ContractorEditDto", "type": "object", "properties": { "companyName": { "type": "string", "errorMessage": { "enum": "Company Name must be one of these options: \nundefined", "maxLength": "Company Name must not exceed undefined characters", "minLength": "Company Name must contain at least undefined characters", "type": "Company Name must be string " } }, "tin": { "type": "string", "errorMessage": { "enum": "Tin must be one of these options: \nundefined", "maxLength": "Tin must not exceed undefined characters", "minLength": "Tin must contain at least undefined characters", "type": "Tin must be string " } }, "firstName": { "type": "string", "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed undefined characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "middleName": { "type": "string", "errorMessage": { "enum": "Middle Name must be one of these options: \nundefined", "maxLength": "Middle Name must not exceed undefined characters", "minLength": "Middle Name must contain at least undefined characters", "type": "Middle Name must be string " } }, "secondName": { "type": "string", "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed undefined characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "email": { "type": "string", "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed undefined characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string " } }, "address": { "type": "string", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed undefined characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed undefined characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed undefined characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "emergencyContact": { "$ref": "#/components/schemas/EmergencyContact" }, "contractorTrucks": { "type": "array", "items": { "$ref": "#/components/schemas/ContractTrucks" } } }, "additionalProperties": false }, "Weekly": { "title": "Weekly", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WeeklyDeduction" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } } }, "additionalProperties": false }, "ContractorWeeklyDeduction": { "title": "ContractorWeeklyDeduction", "type": "object", "properties": { "weeklyDeductions": { "type": "array", "items": { "$ref": "#/components/schemas/Weekly" } }, "escrow": { "$ref": "#/components/schemas/Escrow" } }, "additionalProperties": false }, "SettlementContractorBulkCreateDto": { "title": "SettlementContractorBulkCreateDto", "type": "object", "properties": { "contractorIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Contractor Ids items must be a valid UUID" } } }, "startDate": { "type": "string", "nullable": true, "errorMessage": { "type": "Start Date must be date or null" } }, "endDate": { "type": "string", "nullable": true, "errorMessage": { "type": "End Date must be date or null" } } }, "additionalProperties": false, "required": [ "contractorIds" ], "errorMessage": { "required": { "contractorIds": "Contractor's required" } } }, "Time": { "title": "Time", "type": "object", "properties": { "label": { "type": "string", "default": "Eastern Daylight Time", "errorMessage": { "enum": "Label must be one of these options: \nundefined", "maxLength": "Label must not exceed undefined characters", "minLength": "Label must contain at least undefined characters", "type": "Label must be string " } }, "value": { "type": "string", "default": "America/New_York", "errorMessage": { "enum": "Value must be one of these options: \nundefined", "maxLength": "Value must not exceed undefined characters", "minLength": "Value must contain at least undefined characters", "type": "Value must be string " } } }, "additionalProperties": false }, "CompanyLimitedEditDto": { "title": "CompanyLimitedEditDto", "type": "object", "properties": { "fax": { "type": "string", "maxLength": 512, "nullable": true, "pattern": "^\\d+$", "errorMessage": { "enum": "Fax must be one of these options: \nundefined", "maxLength": "Fax must not exceed 512 characters", "minLength": "Fax must contain at least undefined characters", "type": "Fax must be string or null", "pattern": "Fax number must contain only numbers" } }, "accountingEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Accounting Email must be one of these options: \nundefined", "maxLength": "Accounting Email must not exceed 120 characters", "minLength": "Accounting Email must contain at least undefined characters", "type": "Accounting Email must be string or null", "format": "AccountingEmail must be a valid email address" } }, "safetyEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Safety Email must be one of these options: \nundefined", "maxLength": "Safety Email must not exceed 120 characters", "minLength": "Safety Email must contain at least undefined characters", "type": "Safety Email must be string or null", "format": "SafetyEmail must be a valid email address" } }, "logo": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Logo must be one of these options: \nundefined", "maxLength": "Logo must not exceed 255 characters", "minLength": "Logo must contain at least undefined characters", "type": "Logo must be string or null" } }, "tz": { "$ref": "#/components/schemas/Time" }, "startOfWeek": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday", null ], "maxLength": 50, "nullable": true, "errorMessage": { "enum": "Start Of Week must be one of these options: \nmonday, tuesday, wednesday, thursday, friday, saturday, sunday, ", "maxLength": "Start Of Week must not exceed 50 characters", "minLength": "Start Of Week must contain at least undefined characters", "type": "Start Of Week must be string or null" } }, "taxId": { "type": "string", "maxLength": 120, "nullable": true, "pattern": "^\\d+$", "errorMessage": { "enum": "Tax Id must be one of these options: \nundefined", "maxLength": "Tax Id must not exceed 120 characters", "minLength": "Tax Id must contain at least undefined characters", "type": "Tax Id must be string or null", "pattern": "Tax ID must contain only numbers" } }, "minimumDrivingExperienceMonths": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Minimum Driving Experience Months cannot be lower than undefined", "maximum": "Minimum Driving Experience Months cannot be lower than undefined", "type": "Minimum Driving Experience Months must be number or null", "exclusiveMinimum": "Minimum Driving Experience Months must be greater than undefined" } }, "minimumDriverAge": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Minimum Driver Age cannot be lower than undefined", "maximum": "Minimum Driver Age cannot be lower than undefined", "type": "Minimum Driver Age must be number or null", "exclusiveMinimum": "Minimum Driver Age must be greater than undefined" } } }, "additionalProperties": false }, "SendCarrierRequirementsSampleDto": { "title": "SendCarrierRequirementsSampleDto", "type": "object", "properties": { "documentIds": { "type": "array", "items": { "type": "string" } }, "driverName": { "type": "string", "nullable": false, "errorMessage": { "enum": "Driver Name must be one of these options: \nundefined", "maxLength": "Driver Name must not exceed undefined characters", "minLength": "Driver Name must contain at least undefined characters", "type": "Driver Name must be string " } }, "driverEmail": { "type": "string", "nullable": false, "errorMessage": { "enum": "Driver Email must be one of these options: \nundefined", "maxLength": "Driver Email must not exceed undefined characters", "minLength": "Driver Email must contain at least undefined characters", "type": "Driver Email must be string " } } }, "required": [ "documentIds" ], "additionalProperties": false }, "CompanyInviteTDispatcherV3": { "title": "CompanyInviteTDispatcherV3", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "roleId": { "type": "number", "nullable": false, "errorMessage": { "minimum": "Role Id cannot be lower than undefined", "maximum": "Role Id cannot be lower than undefined", "type": "Role Id must be number ", "exclusiveMinimum": "Role Id must be greater than undefined" } }, "permissionIds": { "type": "array", "items": { "type": "number", "errorMessage": { "type": "Permission Ids must be array " } } } }, "additionalProperties": false, "required": [ "email", "roleId", "permissionIds", "secondName", "firstName" ], "errorMessage": { "required": { "email": "Email is required", "role": "Role is required", "permissionIds": "Permissions is required" } } }, "CompanySignupSendCodeDto": { "title": "CompanySignupSendCodeDto", "type": "object", "properties": { "usdot": { "type": "string", "maxLength": 20, "pattern": "^\\d+$", "errorMessage": { "enum": "Usdot must be one of these options: \nundefined", "maxLength": "Usdot must not exceed 20 characters", "minLength": "Usdot must contain at least undefined characters", "type": "Usdot must be string ", "pattern": "USDOT must contain only digits" } } }, "additionalProperties": false, "required": [ "usdot" ], "errorMessage": { "required": { "usdot": "USDOT is required" } } }, "CompanySignupResendCodeDto": { "title": "CompanySignupResendCodeDto", "type": "object", "properties": { "signupToken": { "type": "string", "minLength": 10, "maxLength": 255, "errorMessage": { "enum": "Signup Token must be one of these options: \nundefined", "maxLength": "Signup Token must not exceed 255 characters", "minLength": "Signup Token must contain at least 10 characters", "type": "Signup Token must be string " } } }, "additionalProperties": false, "required": [ "signupToken" ], "errorMessage": { "required": { "signupToken": "Signup token is required" } } }, "CompanySignupVerifyDto": { "title": "CompanySignupVerifyDto", "type": "object", "properties": { "signupToken": { "type": "string", "minLength": 10, "maxLength": 255, "errorMessage": { "enum": "Signup Token must be one of these options: \nundefined", "maxLength": "Signup Token must not exceed 255 characters", "minLength": "Signup Token must contain at least 10 characters", "type": "Signup Token must be string " } }, "code": { "type": "string", "minLength": 6, "maxLength": 6, "errorMessage": { "enum": "Code must be one of these options: \nundefined", "maxLength": "Code must not exceed 6 characters", "minLength": "Code must contain at least 6 characters", "type": "Code must be string " } } }, "additionalProperties": false, "required": [ "signupToken", "code" ], "errorMessage": { "required": { "signupToken": "Signup token is required", "code": "Verification code is required" } } }, "CompanySignupCompleteDto": { "title": "CompanySignupCompleteDto", "type": "object", "properties": { "signupToken": { "type": "string", "minLength": 10, "maxLength": 255, "errorMessage": { "enum": "Signup Token must be one of these options: \nundefined", "maxLength": "Signup Token must not exceed 255 characters", "minLength": "Signup Token must contain at least 10 characters", "type": "Signup Token must be string " } }, "firstName": { "type": "string", "minLength": 2, "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least 2 characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "minLength": 2, "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least 2 characters", "type": "Second Name must be string " } }, "password": { "type": "string", "minLength": 12, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).+$", "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least 12 characters", "type": "Password must be string ", "pattern": "Password must include at least one letter, one number, and one symbol" } }, "confirmPassword": { "type": "string", "minLength": 12, "maxLength": 255, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[^A-Za-z0-9]).+$", "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least 12 characters", "type": "Confirm Password must be string ", "pattern": "Password must include at least one letter, one number, and one symbol" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "tz": { "$ref": "#/components/schemas/Time" }, "startOfWeek": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday", null ], "maxLength": 50, "nullable": true, "errorMessage": { "enum": "Start Of Week must be one of these options: \nmonday, tuesday, wednesday, thursday, friday, saturday, sunday, ", "maxLength": "Start Of Week must not exceed 50 characters", "minLength": "Start Of Week must contain at least undefined characters", "type": "Start Of Week must be string or null" } }, "taxId": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Tax Id must be one of these options: \nundefined", "maxLength": "Tax Id must not exceed 512 characters", "minLength": "Tax Id must contain at least undefined characters", "type": "Tax Id must be string or null" } }, "accountingEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Accounting Email must be one of these options: \nundefined", "maxLength": "Accounting Email must not exceed 120 characters", "minLength": "Accounting Email must contain at least undefined characters", "type": "Accounting Email must be string or null", "format": "AccountingEmail must be a valid email address" } }, "mainContactPerson": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Main Contact Person must be one of these options: \nundefined", "maxLength": "Main Contact Person must not exceed 255 characters", "minLength": "Main Contact Person must contain at least undefined characters", "type": "Main Contact Person must be string or null" } }, "contactTitle": { "type": "string", "enum": [ "owner", "company_manager", "operation_manager", "dispatcher", "accounting", "safety", "maintenance", "recruitment", "read_only" ], "maxLength": 50, "nullable": true, "errorMessage": { "enum": "Contact Title must be one of these options: \nowner, company_manager, operation_manager, dispatcher, accounting, safety, maintenance, recruitment, read_only", "maxLength": "Contact Title must not exceed 50 characters", "minLength": "Contact Title must contain at least undefined characters", "type": "Contact Title must be string or null" } }, "dispatchEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Dispatch Email must be one of these options: \nundefined", "maxLength": "Dispatch Email must not exceed 120 characters", "minLength": "Dispatch Email must contain at least undefined characters", "type": "Dispatch Email must be string or null", "format": "DispatchEmail must be a valid email address" } }, "supportEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Support Email must be one of these options: \nundefined", "maxLength": "Support Email must not exceed 120 characters", "minLength": "Support Email must contain at least undefined characters", "type": "Support Email must be string or null", "format": "SupportEmail must be a valid email address" } }, "website": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Website must be one of these options: \nundefined", "maxLength": "Website must not exceed 512 characters", "minLength": "Website must contain at least undefined characters", "type": "Website must be string or null" } }, "logo": { "type": "string" }, "einLetterDocumentId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Ein Letter Document Id must be one of these options: \nundefined", "maxLength": "Ein Letter Document Id must not exceed 36 characters", "minLength": "Ein Letter Document Id must contain at least undefined characters", "type": "Ein Letter Document Id must be string or null" } }, "referralCode": { "type": "string", "maxLength": 24, "nullable": true, "errorMessage": { "enum": "Referral Code must be one of these options: \nundefined", "maxLength": "Referral Code must not exceed 24 characters", "minLength": "Referral Code must contain at least undefined characters", "type": "Referral Code must be string or null" } }, "referralToken": { "type": "string", "maxLength": 2048, "nullable": true, "errorMessage": { "enum": "Referral Token must be one of these options: \nundefined", "maxLength": "Referral Token must not exceed 2048 characters", "minLength": "Referral Token must contain at least undefined characters", "type": "Referral Token must be string or null" } } }, "additionalProperties": false, "required": [ "signupToken", "firstName", "secondName", "password", "confirmPassword", "tz" ], "errorMessage": { "required": { "signupToken": "Signup token is required", "firstName": "First name is required", "secondName": "Last name is required", "password": "Password is required", "confirmPassword": "Password confirmation is required", "tz": "Time zone is required" } } }, "CarrierRequirementsDto": { "title": "CarrierRequirementsDto", "type": "object", "properties": { "minimumDrivingExperienceMonths": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Minimum Driving Experience Months cannot be lower than undefined", "maximum": "Minimum Driving Experience Months cannot be lower than undefined", "type": "Minimum Driving Experience Months must be number or null", "exclusiveMinimum": "Minimum Driving Experience Months must be greater than undefined" } }, "minimumDriverAge": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Minimum Driver Age cannot be lower than undefined", "maximum": "Minimum Driver Age cannot be lower than undefined", "type": "Minimum Driver Age must be number or null", "exclusiveMinimum": "Minimum Driver Age must be greater than undefined" } } }, "additionalProperties": false }, "CreateCompanyCertificationDto": { "title": "CreateCompanyCertificationDto", "type": "object", "properties": { "certificationType": { "type": "string", "enum": [ "smartway", "hazmat", "twic", "carb", "bonded" ], "maxLength": 50, "errorMessage": { "enum": "Certification Type must be one of these options: \nsmartway, hazmat, twic, carb, bonded", "maxLength": "Certification Type must not exceed 50 characters", "minLength": "Certification Type must contain at least undefined characters", "type": "Certification Type must be string " } }, "status": { "type": "string", "enum": [ "active", "inactive" ], "maxLength": 20, "errorMessage": { "enum": "Status must be one of these options: \nactive, inactive", "maxLength": "Status must not exceed 20 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "issuedAt": { "type": "string", "format": "date", "maxLength": 30, "nullable": true, "errorMessage": { "enum": "Issued At must be one of these options: \nundefined", "maxLength": "Issued At must not exceed 30 characters", "minLength": "Issued At must contain at least undefined characters", "type": "Issued At must be string or null", "format": "IssuedAt must be a valid date (YYYY-MM-DD)" } }, "expiresAt": { "type": "string", "format": "date", "maxLength": 30, "nullable": true, "errorMessage": { "enum": "Expires At must be one of these options: \nundefined", "maxLength": "Expires At must not exceed 30 characters", "minLength": "Expires At must contain at least undefined characters", "type": "Expires At must be string or null", "format": "ExpiresAt must be a valid date (YYYY-MM-DD)" } }, "notes": { "type": "string", "maxLength": 500, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 500 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false, "required": [ "certificationType", "status" ], "errorMessage": { "required": { "certificationType": "Certification type is required", "status": "Status is required" } } }, "UpdateCompanyCertificationDto": { "title": "UpdateCompanyCertificationDto", "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "inactive" ], "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nactive, inactive", "maxLength": "Status must not exceed 20 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } }, "issuedAt": { "type": "string", "format": "date", "maxLength": 30, "nullable": true, "errorMessage": { "enum": "Issued At must be one of these options: \nundefined", "maxLength": "Issued At must not exceed 30 characters", "minLength": "Issued At must contain at least undefined characters", "type": "Issued At must be string or null", "format": "IssuedAt must be a valid date (YYYY-MM-DD)" } }, "expiresAt": { "type": "string", "format": "date", "maxLength": 30, "nullable": true, "errorMessage": { "enum": "Expires At must be one of these options: \nundefined", "maxLength": "Expires At must not exceed 30 characters", "minLength": "Expires At must contain at least undefined characters", "type": "Expires At must be string or null", "format": "ExpiresAt must be a valid date (YYYY-MM-DD)" } }, "notes": { "type": "string", "maxLength": 500, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 500 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false }, "ClaimAdjuster": { "title": "ClaimAdjuster", "type": "object", "properties": { "name": { "type": "string" }, "secondName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "phoneExtension": { "type": "number" }, "companyName": { "type": "string" }, "companyAddress": { "type": "string" }, "initialDescription": { "type": "string" } }, "additionalProperties": false }, "ClaimBillingDto": { "title": "ClaimBillingDto", "type": "object", "properties": { "towingEstimated": { "type": "number", "format": "float", "errorMessage": { "type": "Towing Estimated must be number ", "exclusiveMinimum": "Towing Estimated must be greater than undefined" } }, "towingDeductible": { "type": "number", "format": "float", "errorMessage": { "type": "Towing Deductible must be number ", "exclusiveMinimum": "Towing Deductible must be greater than undefined" } }, "towingNote": { "type": "string", "errorMessage": { "enum": "Towing Note must be one of these options: \nundefined", "maxLength": "Towing Note must not exceed undefined characters", "minLength": "Towing Note must contain at least undefined characters", "type": "Towing Note must be string " } }, "damageEstimated": { "type": "number", "format": "float", "errorMessage": { "type": "Damage Estimated must be number ", "exclusiveMinimum": "Damage Estimated must be greater than undefined" } }, "damageDeductible": { "type": "number", "format": "float", "errorMessage": { "type": "Damage Deductible must be number ", "exclusiveMinimum": "Damage Deductible must be greater than undefined" } }, "damageNote": { "type": "string", "errorMessage": { "enum": "Damage Note must be one of these options: \nundefined", "maxLength": "Damage Note must not exceed undefined characters", "minLength": "Damage Note must contain at least undefined characters", "type": "Damage Note must be string " } }, "otherEstimated": { "type": "number", "format": "float", "errorMessage": { "type": "Other Estimated must be number ", "exclusiveMinimum": "Other Estimated must be greater than undefined" } }, "otherDeductible": { "type": "number", "format": "float", "errorMessage": { "type": "Other Deductible must be number ", "exclusiveMinimum": "Other Deductible must be greater than undefined" } }, "otherNote": { "type": "string", "errorMessage": { "enum": "Other Note must be one of these options: \nundefined", "maxLength": "Other Note must not exceed undefined characters", "minLength": "Other Note must contain at least undefined characters", "type": "Other Note must be string " } }, "deductibleTotal": { "type": "number", "format": "float", "errorMessage": { "type": "Deductible Total must be number ", "exclusiveMinimum": "Deductible Total must be greater than undefined" } }, "estimatedTotal": { "type": "number", "format": "float", "errorMessage": { "type": "Estimated Total must be number ", "exclusiveMinimum": "Estimated Total must be greater than undefined" } }, "isOverride": { "type": "boolean" }, "startDate": { "type": "string", "errorMessage": { "type": "Start Date must be date " } }, "dailyRate": { "type": "number", "format": "float", "errorMessage": { "type": "Daily Rate must be number ", "exclusiveMinimum": "Daily Rate must be greater than undefined" } }, "daysDown": { "type": "number", "errorMessage": { "minimum": "Days Down cannot be lower than undefined", "maximum": "Days Down cannot be lower than undefined", "type": "Days Down must be number ", "exclusiveMinimum": "Days Down must be greater than undefined" } }, "estimatedLossOfUse": { "type": "number", "format": "float", "errorMessage": { "type": "Estimated Loss Of Use must be number ", "exclusiveMinimum": "Estimated Loss Of Use must be greater than undefined" } } }, "additionalProperties": false }, "ClaimPaymentDto": { "title": "ClaimPaymentDto", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Id must be a valid UUID" } }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "date": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date must be date or null", "format": "Date must be a valid date (YYYY-MM-DD)" } }, "method": { "type": "string", "enum": [ "ach", "check", "wire", "other" ], "maxLength": 25, "errorMessage": { "enum": "Method must be one of these options: \nach, check, wire, other", "maxLength": "Method must not exceed 25 characters", "minLength": "Method must contain at least undefined characters", "type": "Method must be string " } }, "referenceNumber": { "type": "string", "maxLength": 100, "nullable": true, "errorMessage": { "enum": "Reference Number must be one of these options: \nundefined", "maxLength": "Reference Number must not exceed 100 characters", "minLength": "Reference Number must contain at least undefined characters", "type": "Reference Number must be string or null" } }, "notes": { "type": "string", "maxLength": 100, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 100 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false }, "ClaimDto": { "title": "ClaimDto", "type": "object", "properties": { "accidentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Accident Id must be a valid UUID" } }, "insuranceCompany": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Insurance Company must be one of these options: \nundefined", "maxLength": "Insurance Company must not exceed 50 characters", "minLength": "Insurance Company must contain at least undefined characters", "type": "Insurance Company must be string " } }, "policyNumber": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Policy Number must be one of these options: \nundefined", "maxLength": "Policy Number must not exceed 50 characters", "minLength": "Policy Number must contain at least undefined characters", "type": "Policy Number must be string " } }, "status": { "type": "string", "enum": [ "open", "submitted", "in-progress", "paid", "cancelled", "closed" ], "maxLength": 50, "errorMessage": { "enum": "Status must be one of these options: \nopen, submitted, in-progress, paid, cancelled, closed", "maxLength": "Status must not exceed 50 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "claimNumber": { "type": "string", "maxLength": 100, "errorMessage": { "enum": "Claim Number must be one of these options: \nundefined", "maxLength": "Claim Number must not exceed 100 characters", "minLength": "Claim Number must contain at least undefined characters", "type": "Claim Number must be string " } }, "followUpDate": { "type": "string", "errorMessage": { "type": "Follow Up Date must be date " } }, "faultParty": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Fault Party must be one of these options: \nundefined", "maxLength": "Fault Party must not exceed 255 characters", "minLength": "Fault Party must contain at least undefined characters", "type": "Fault Party must be string " } }, "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "adjuster": { "$ref": "#/components/schemas/ClaimAdjuster" }, "loss": { "$ref": "#/components/schemas/ClaimBillingDto" }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimPaymentDto" } } }, "additionalProperties": false }, "ClaimCommentDto": { "title": "ClaimCommentDto", "type": "object", "properties": { "text": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1000 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } } }, "additionalProperties": false }, "NotesDto": { "title": "NotesDto", "type": "object", "properties": { "fromDate": { "type": "string", "format": "date", "errorMessage": { "type": "From Date must be date ", "format": "FromDate must be a valid date (YYYY-MM-DD)" } }, "toDate": { "type": "string", "format": "date", "errorMessage": { "type": "To Date must be date ", "format": "ToDate must be a valid date (YYYY-MM-DD)" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "text": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1000 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } }, "status": { "type": "string", "enum": [ "ready", "reserved", "covered", "office", "enroute", "enroute2", "pending", "cycle", "dispatched", "shift", "rest", "deadheading", "service", "vacation", "hold", "stay", "duty", "home" ], "maxLength": 25, "errorMessage": { "enum": "Status must be one of these options: \nready, reserved, covered, office, enroute, enroute2, pending, cycle, dispatched, shift, rest, deadheading, service, vacation, hold, stay, duty, home", "maxLength": "Status must not exceed 25 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } } }, "additionalProperties": false, "required": [ "fromDate", "toDate" ], "errorMessage": { "required": { "fromDate": "From date is required", "toDate": "To date is required" } } }, "BrokerContactForBrokerCompanyDto": { "title": "BrokerContactForBrokerCompanyDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "role": { "type": "string", "enum": [ "dispatch", "accounting", "claims", "after_hours", "sales", "management", "other" ], "maxLength": 50, "errorMessage": { "enum": "Role must be one of these options: \ndispatch, accounting, claims, after_hours, sales, management, other", "maxLength": "Role must not exceed 50 characters", "minLength": "Role must contain at least undefined characters", "type": "Role must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "brokerCompanyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Broker Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "email", "fullName" ], "errorMessage": { "required": { "email": "Email is required", "fullName": "Full name is required" } } }, "BrokerCreateDto": { "title": "BrokerCreateDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "address2": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "notes": { "type": "string", "maxLength": 1200, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "zipCodes": { "type": "string", "maxLength": 32, "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed 32 characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string or null" } }, "placeId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed undefined characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string or null" } }, "email": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string or null" } }, "website": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Website must be one of these options: \nundefined", "maxLength": "Website must not exceed 120 characters", "minLength": "Website must contain at least undefined characters", "type": "Website must be string or null" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "mc": { "type": "string", "maxLength": 8, "nullable": true, "pattern": "^\\d+$", "errorMessage": { "enum": "Mc must be one of these options: \nundefined", "maxLength": "Mc must not exceed 8 characters", "minLength": "Mc must contain at least undefined characters", "type": "Mc must be string or null", "pattern": "MC must contain only digits" } }, "dot": { "type": "string", "maxLength": 55, "nullable": true, "pattern": "^\\d+$", "errorMessage": { "enum": "Dot must be one of these options: \nundefined", "maxLength": "Dot must not exceed 55 characters", "minLength": "Dot must contain at least undefined characters", "type": "Dot must be string or null", "pattern": "MC must contain only digits" } }, "brokerContacts": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerContactForBrokerCompanyDto" } } }, "additionalProperties": false, "required": [ "name", "address", "state", "city" ], "errorMessage": { "required": { "name": "Name is required" } } }, "BrokerEditDto": { "title": "BrokerEditDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "address2": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "notes": { "type": "string", "maxLength": 1200, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "zipCodes": { "type": "string", "maxLength": 32, "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed 32 characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string or null" } }, "placeId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed undefined characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string or null" } }, "email": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string or null" } }, "website": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Website must be one of these options: \nundefined", "maxLength": "Website must not exceed 120 characters", "minLength": "Website must contain at least undefined characters", "type": "Website must be string or null" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "mc": { "type": "string", "maxLength": 8, "nullable": true, "pattern": "^\\d+$", "errorMessage": { "enum": "Mc must be one of these options: \nundefined", "maxLength": "Mc must not exceed 8 characters", "minLength": "Mc must contain at least undefined characters", "type": "Mc must be string or null", "pattern": "MC must contain only digits" } }, "dot": { "type": "string", "maxLength": 55, "nullable": true, "pattern": "^\\d+$", "errorMessage": { "enum": "Dot must be one of these options: \nundefined", "maxLength": "Dot must not exceed 55 characters", "minLength": "Dot must contain at least undefined characters", "type": "Dot must be string or null", "pattern": "MC must contain only digits" } } }, "additionalProperties": false, "required": [ "name" ], "errorMessage": { "required": { "name": "Name is required" } } }, "BrokerContactDto": { "title": "BrokerContactDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "role": { "type": "string", "enum": [ "dispatch", "accounting", "claims", "after_hours", "sales", "management", "other" ], "maxLength": 50, "errorMessage": { "enum": "Role must be one of these options: \ndispatch, accounting, claims, after_hours, sales, management, other", "maxLength": "Role must not exceed 50 characters", "minLength": "Role must contain at least undefined characters", "type": "Role must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "brokerCompanyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Broker Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "email", "brokerCompanyId" ], "errorMessage": { "required": { "email": "Email is required", "brokerCompanyId": "Broker company is required" } } }, "BrokerContactEditDto": { "title": "BrokerContactEditDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "fullName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Full Name must be one of these options: \nundefined", "maxLength": "Full Name must not exceed 255 characters", "minLength": "Full Name must contain at least undefined characters", "type": "Full Name must be string " } }, "role": { "type": "string", "enum": [ "dispatch", "accounting", "claims", "after_hours", "sales", "management", "other" ], "maxLength": 50, "errorMessage": { "enum": "Role must be one of these options: \ndispatch, accounting, claims, after_hours, sales, management, other", "maxLength": "Role must not exceed 50 characters", "minLength": "Role must contain at least undefined characters", "type": "Role must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "brokerCompanyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Broker Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "email", "fullName" ], "errorMessage": { "required": { "email": "Email is required", "fullName": "Full name is required" } } }, "BrokerTmsConnectionRequestDto": { "title": "BrokerTmsConnectionRequestDto", "type": "object", "properties": { "carrier_usdot": { "type": "string" }, "broker_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Broker_id must be a valid UUID" } }, "contact_user_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Contact_user_id must be a valid UUID" } }, "requested_scopes": { "type": "array", "items": { "type": "string", "enum": [ "trucks:read", "trucks:location", "drivers:read", "drivers:location", "drivers:contact", "loads:write", "messages:read", "messages:write" ], "minItems": 1 } }, "note": { "type": "string" } }, "additionalProperties": false, "required": [ "carrier_usdot", "broker_id", "contact_user_id", "requested_scopes" ] }, "BrokerTmsDisconnectDto": { "title": "BrokerTmsDisconnectDto", "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "BrokerTmsRevokeTokenDto": { "title": "BrokerTmsRevokeTokenDto", "type": "object", "properties": { "token": { "type": "string" } }, "additionalProperties": false, "required": [ "token" ] }, "BrokerTmsLoadOfferDto": { "title": "BrokerTmsLoadOfferDto", "type": "object", "properties": { "broker_reference": { "type": "string" }, "origin": { "type": "object" }, "destination": { "type": "object" }, "intermediate_stops": { "type": "array", "items": { "type": "object" } }, "equipment_type": { "type": "string" }, "weight_lbs": { "type": "number" }, "commodity": { "type": "string" }, "commodity_class": { "type": "string" }, "dimensions": { "type": "object" }, "hazmat": { "type": "boolean" }, "hazmat_class": { "type": "string" }, "rate_usd": { "type": "number" }, "rate_per_mile_usd": { "type": "number" }, "fuel_surcharge_usd": { "type": "number" }, "detention_rate_per_hour_usd": { "type": "number" }, "pickup_window": { "type": "object" }, "delivery_window": { "type": "object" }, "required_endorsements": { "type": "array", "items": { "type": "string" } }, "special_instructions": { "type": "string" }, "offer_expires_at": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "required": [ "broker_reference", "origin", "destination", "equipment_type", "weight_lbs", "pickup_window", "delivery_window", "rate_usd" ] }, "BrokerTmsWithdrawLoadDto": { "title": "BrokerTmsWithdrawLoadDto", "type": "object", "properties": { "reason": { "type": "string" } }, "additionalProperties": false }, "BrokerTmsSendMessageDto": { "title": "BrokerTmsSendMessageDto", "type": "object", "properties": { "recipient_type": { "type": "string", "enum": [ "CARRIER_DISPATCH", "DRIVER" ] }, "recipient_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Recipient_id must be a valid UUID" } }, "load_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Load_id must be a valid UUID" } }, "body": { "type": "string", "maxLength": 4000 }, "attachments": { "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "required": [ "recipient_type", "body" ] }, "FeedBackSendToBotDto": { "title": "FeedBackSendToBotDto", "type": "object", "properties": { "type": { "type": "string", "enum": [ "bug_report", "feature_request", "compliment", "general_comment" ], "errorMessage": { "enum": "Type must be one of these options: \nbug_report, feature_request, compliment, general_comment", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "rate": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Rate must be number or null", "exclusiveMinimum": "Rate must be greater than undefined" } }, "text": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1200 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } } }, "additionalProperties": false }, "RecentPagesDto": { "title": "RecentPagesDto", "type": "object", "properties": { "pages": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Pages must be array " } } } }, "additionalProperties": false }, "AmazonRequestDto": { "title": "AmazonRequestDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "minLength": 4, "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least 4 characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "password": { "type": "string", "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed undefined characters", "minLength": "Password must contain at least undefined characters", "type": "Password must be string " } } }, "additionalProperties": false, "required": [ "email", "password" ], "errorMessage": { "required": { "email": "Email is required", "password": "Password is required" } } }, "AiAssistantQueryDto": { "title": "AiAssistantQueryDto", "type": "object", "properties": { "prompt": { "type": "string", "minLength": 3, "maxLength": 1000, "errorMessage": { "enum": "Prompt must be one of these options: \nundefined", "maxLength": "Prompt must not exceed 1000 characters", "minLength": "Prompt must contain at least 3 characters", "type": "Prompt must be string " } } }, "additionalProperties": false }, "AccidentDto": { "title": "AccidentDto", "type": "object", "properties": { "accidentDate": { "type": "string", "format": "date-time", "errorMessage": { "type": "Accident Date must be date ", "format": "AccidentDate must be a valid date-time (ISO 8601)" } }, "date": { "type": "string", "format": "date-time", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date-time (ISO 8601)" } }, "withHazmat": { "type": "boolean" }, "policeInvolved": { "type": "boolean" }, "towingInvolved": { "type": "boolean" }, "emergencyInvolved": { "type": "boolean" }, "fatalInjuries": { "type": "number", "errorMessage": { "minimum": "Fatal Injuries cannot be lower than undefined", "maximum": "Fatal Injuries cannot be lower than undefined", "type": "Fatal Injuries must be number ", "exclusiveMinimum": "Fatal Injuries must be greater than undefined" } }, "nonFatalInjuries": { "type": "number", "errorMessage": { "minimum": "Non Fatal Injuries cannot be lower than undefined", "maximum": "Non Fatal Injuries cannot be lower than undefined", "type": "Non Fatal Injuries must be number ", "exclusiveMinimum": "Non Fatal Injuries must be greater than undefined" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "address": { "type": "string", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed undefined characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed undefined characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "note": { "type": "string", "errorMessage": { "enum": "Note must be one of these options: \nundefined", "maxLength": "Note must not exceed undefined characters", "minLength": "Note must contain at least undefined characters", "type": "Note must be string " } } }, "additionalProperties": false }, "AccidentDtoV2": { "title": "AccidentDtoV2", "type": "object", "properties": { "accidentDate": { "type": "string", "format": "date-time", "errorMessage": { "type": "Accident Date must be date ", "format": "AccidentDate must be a valid date-time (ISO 8601)" } }, "date": { "type": "string", "format": "date-time", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date-time (ISO 8601)" } }, "withHazmat": { "type": "boolean" }, "policeInvolved": { "type": "boolean" }, "towingInvolved": { "type": "boolean" }, "emergencyInvolved": { "type": "boolean" }, "fatalInjuries": { "type": "number", "errorMessage": { "minimum": "Fatal Injuries cannot be lower than undefined", "maximum": "Fatal Injuries cannot be lower than undefined", "type": "Fatal Injuries must be number ", "exclusiveMinimum": "Fatal Injuries must be greater than undefined" } }, "nonFatalInjuries": { "type": "number", "errorMessage": { "minimum": "Non Fatal Injuries cannot be lower than undefined", "maximum": "Non Fatal Injuries cannot be lower than undefined", "type": "Non Fatal Injuries must be number ", "exclusiveMinimum": "Non Fatal Injuries must be greater than undefined" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "address": { "type": "string", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed undefined characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed undefined characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "note": { "type": "string", "errorMessage": { "enum": "Note must be one of these options: \nundefined", "maxLength": "Note must not exceed undefined characters", "minLength": "Note must contain at least undefined characters", "type": "Note must be string " } }, "policeReportNumber": { "type": "string", "errorMessage": { "enum": "Police Report Number must be one of these options: \nundefined", "maxLength": "Police Report Number must not exceed undefined characters", "minLength": "Police Report Number must contain at least undefined characters", "type": "Police Report Number must be string " } }, "atFault": { "type": "string", "errorMessage": { "enum": "At Fault must be one of these options: \nundefined", "maxLength": "At Fault must not exceed undefined characters", "minLength": "At Fault must contain at least undefined characters", "type": "At Fault must be string " } }, "otherPartyInsurance": { "type": "string", "errorMessage": { "enum": "Other Party Insurance must be one of these options: \nundefined", "maxLength": "Other Party Insurance must not exceed undefined characters", "minLength": "Other Party Insurance must contain at least undefined characters", "type": "Other Party Insurance must be string " } }, "otherPartyName": { "type": "string", "errorMessage": { "enum": "Other Party Name must be one of these options: \nundefined", "maxLength": "Other Party Name must not exceed undefined characters", "minLength": "Other Party Name must contain at least undefined characters", "type": "Other Party Name must be string " } }, "damagedAreas": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Damaged Areas must be array " } } }, "otherDamageDetails": { "type": "string", "errorMessage": { "enum": "Other Damage Details must be one of these options: \nundefined", "maxLength": "Other Damage Details must not exceed undefined characters", "minLength": "Other Damage Details must contain at least undefined characters", "type": "Other Damage Details must be string " } }, "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "status": { "type": "string", "errorMessage": { "enum": "Status must be one of these options: \nundefined", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "otherPartyEmail": { "type": "string", "errorMessage": { "enum": "Other Party Email must be one of these options: \nundefined", "maxLength": "Other Party Email must not exceed undefined characters", "minLength": "Other Party Email must contain at least undefined characters", "type": "Other Party Email must be string " } }, "otherPartyPhone": { "type": "string", "errorMessage": { "enum": "Other Party Phone must be one of these options: \nundefined", "maxLength": "Other Party Phone must not exceed undefined characters", "minLength": "Other Party Phone must contain at least undefined characters", "type": "Other Party Phone must be string " } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } } }, "additionalProperties": false }, "AccidentUpdateDtoV2": { "title": "AccidentUpdateDtoV2", "type": "object", "properties": { "accidentDate": { "type": "string", "format": "date-time", "errorMessage": { "type": "Accident Date must be date ", "format": "AccidentDate must be a valid date-time (ISO 8601)" } }, "date": { "type": "string", "format": "date-time", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date-time (ISO 8601)" } }, "withHazmat": { "type": "boolean" }, "policeInvolved": { "type": "boolean" }, "towingInvolved": { "type": "boolean" }, "emergencyInvolved": { "type": "boolean" }, "fatalInjuries": { "type": "number", "errorMessage": { "minimum": "Fatal Injuries cannot be lower than undefined", "maximum": "Fatal Injuries cannot be lower than undefined", "type": "Fatal Injuries must be number ", "exclusiveMinimum": "Fatal Injuries must be greater than undefined" } }, "nonFatalInjuries": { "type": "number", "errorMessage": { "minimum": "Non Fatal Injuries cannot be lower than undefined", "maximum": "Non Fatal Injuries cannot be lower than undefined", "type": "Non Fatal Injuries must be number ", "exclusiveMinimum": "Non Fatal Injuries must be greater than undefined" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "address": { "type": "string", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed undefined characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed undefined characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "note": { "type": "string", "errorMessage": { "enum": "Note must be one of these options: \nundefined", "maxLength": "Note must not exceed undefined characters", "minLength": "Note must contain at least undefined characters", "type": "Note must be string " } }, "policeReportNumber": { "type": "string", "errorMessage": { "enum": "Police Report Number must be one of these options: \nundefined", "maxLength": "Police Report Number must not exceed undefined characters", "minLength": "Police Report Number must contain at least undefined characters", "type": "Police Report Number must be string " } }, "atFault": { "type": "string", "errorMessage": { "enum": "At Fault must be one of these options: \nundefined", "maxLength": "At Fault must not exceed undefined characters", "minLength": "At Fault must contain at least undefined characters", "type": "At Fault must be string " } }, "otherPartyInsurance": { "type": "string", "errorMessage": { "enum": "Other Party Insurance must be one of these options: \nundefined", "maxLength": "Other Party Insurance must not exceed undefined characters", "minLength": "Other Party Insurance must contain at least undefined characters", "type": "Other Party Insurance must be string " } }, "otherPartyName": { "type": "string", "errorMessage": { "enum": "Other Party Name must be one of these options: \nundefined", "maxLength": "Other Party Name must not exceed undefined characters", "minLength": "Other Party Name must contain at least undefined characters", "type": "Other Party Name must be string " } }, "damagedAreas": { "type": "array", "items": { "type": "string", "errorMessage": { "type": "Damaged Areas must be array " } } }, "otherDamageDetails": { "type": "string", "errorMessage": { "enum": "Other Damage Details must be one of these options: \nundefined", "maxLength": "Other Damage Details must not exceed undefined characters", "minLength": "Other Damage Details must contain at least undefined characters", "type": "Other Damage Details must be string " } }, "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "status": { "type": "string", "errorMessage": { "enum": "Status must be one of these options: \nundefined", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "otherPartyEmail": { "type": "string", "errorMessage": { "enum": "Other Party Email must be one of these options: \nundefined", "maxLength": "Other Party Email must not exceed undefined characters", "minLength": "Other Party Email must contain at least undefined characters", "type": "Other Party Email must be string " } }, "otherPartyPhone": { "type": "string", "errorMessage": { "enum": "Other Party Phone must be one of these options: \nundefined", "maxLength": "Other Party Phone must not exceed undefined characters", "minLength": "Other Party Phone must contain at least undefined characters", "type": "Other Party Phone must be string " } }, "trailerId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Trailer Id must be a valid UUID" } } }, "additionalProperties": false }, "SignInBodyForUser": { "title": "SignInBodyForUser", "type": "object", "properties": { "login": { "type": "string", "minLength": 4, "errorMessage": { "enum": "Login must be one of these options: \nundefined", "maxLength": "Login must not exceed undefined characters", "minLength": "Login must contain at least 4 characters", "type": "Login must be string " } }, "password": { "type": "string", "minLength": 6, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed undefined characters", "minLength": "Password must contain at least 6 characters", "type": "Password must be string " } }, "device": { "$ref": "#/components/schemas/DeviceDto" } }, "additionalProperties": false, "required": [ "login", "password", "device" ], "errorMessage": { "required": { "login": "Login is required", "password": "Password is required", "device": "Device is required" } } }, "RefreshTokenBody": { "title": "RefreshTokenBody", "type": "object", "properties": { "refreshToken": { "type": "string", "errorMessage": { "enum": "Refresh Token must be one of these options: \nundefined", "maxLength": "Refresh Token must not exceed undefined characters", "minLength": "Refresh Token must contain at least undefined characters", "type": "Refresh Token must be string " } }, "deviceId": { "type": "string", "errorMessage": { "enum": "Device Id must be one of these options: \nundefined", "maxLength": "Device Id must not exceed undefined characters", "minLength": "Device Id must contain at least undefined characters", "type": "Device Id must be string " } } }, "additionalProperties": false, "required": [ "refreshToken" ], "errorMessage": { "required": { "refreshToken": "Refresh token is required" } } }, "SignOutBodyForUser": { "title": "SignOutBodyForUser", "type": "object", "properties": { "deviceId": { "type": "string", "errorMessage": { "enum": "Device Id must be one of these options: \nundefined", "maxLength": "Device Id must not exceed undefined characters", "minLength": "Device Id must contain at least undefined characters", "type": "Device Id must be string " } } }, "additionalProperties": false, "required": [ "deviceId" ], "errorMessage": { "required": { "deviceId": "Device ID is required" } } }, "SignUpBodyForUser": { "title": "SignUpBodyForUser", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "maxLength": 32, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 32 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "password": { "type": "string", "minLength": 6, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed undefined characters", "minLength": "Password must contain at least 6 characters", "type": "Password must be string " } }, "passwordConfirm": { "type": "string", "minLength": 6, "errorMessage": { "enum": "Password Confirm must be one of these options: \nundefined", "maxLength": "Password Confirm must not exceed undefined characters", "minLength": "Password Confirm must contain at least 6 characters", "type": "Password Confirm must be string " } } }, "additionalProperties": false, "required": [ "email", "password" ], "errorMessage": { "required": { "email": "Email is required", "password": "Password is required" } } }, "AppPasswordChangeDto": { "title": "AppPasswordChangeDto", "type": "object", "properties": { "newPassword": { "type": "string", "minLength": 6, "maxLength": 255, "errorMessage": { "enum": "New Password must be one of these options: \nundefined", "maxLength": "New Password must not exceed undefined characters", "minLength": "New Password must contain at least undefined characters", "type": "New Password must be string " } }, "confirmPassword": { "type": "string", "minLength": 6, "maxLength": 255, "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed undefined characters", "minLength": "Confirm Password must contain at least undefined characters", "type": "Confirm Password must be string " } } }, "additionalProperties": false, "required": [ "newPassword", "confirmPassword" ], "errorMessage": { "required": { "newPassword": "New password is required", "confirmPassword": "Confirm password is required" } } }, "ForgotPasswordDto": { "title": "ForgotPasswordDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 256, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 256 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } } }, "additionalProperties": false, "required": [ "email" ], "errorMessage": { "required": { "email": "Email required" } } }, "VerificationCodeCheckDto": { "title": "VerificationCodeCheckDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 256, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 256 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "code": { "type": "string", "maxLength": 6, "errorMessage": { "enum": "Code must be one of these options: \nundefined", "maxLength": "Code must not exceed 6 characters", "minLength": "Code must contain at least undefined characters", "type": "Code must be string " } } }, "additionalProperties": false, "required": [ "code", "email" ], "errorMessage": { "required": { "code": "Code required", "email": "Email required" } } }, "UserResetDto": { "title": "UserResetDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 256, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 256 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "password": { "type": "string", "minLength": 6, "maxLength": 255, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least 6 characters", "type": "Password must be string " } }, "confirmPassword": { "type": "string", "minLength": 6, "maxLength": 255, "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least 6 characters", "type": "Confirm Password must be string " } } }, "additionalProperties": false, "required": [ "password", "confirmPassword" ], "errorMessage": { "required": { "password": "Password is required", "confirmPassword": "Password confirmation is required" } } }, "AuthInvitedTDriver": { "title": "AuthInvitedTDriver", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "middleName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Middle Name must be one of these options: \nundefined", "maxLength": "Middle Name must not exceed 255 characters", "minLength": "Middle Name must contain at least undefined characters", "type": "Middle Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "password": { "type": "string", "minLength": 6, "maxLength": 32, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 32 characters", "minLength": "Password must contain at least 6 characters", "type": "Password must be string " } }, "passwordConfirm": { "type": "string", "minLength": 6, "maxLength": 32, "errorMessage": { "enum": "Password Confirm must be one of these options: \nundefined", "maxLength": "Password Confirm must not exceed 32 characters", "minLength": "Password Confirm must contain at least 6 characters", "type": "Password Confirm must be string " } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "maxLength": 32, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 32 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "address1": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address1 must be one of these options: \nundefined", "maxLength": "Address1 must not exceed 255 characters", "minLength": "Address1 must contain at least undefined characters", "type": "Address1 must be string " } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "TWICCard": { "type": "boolean" }, "tankerEndorsed": { "type": "boolean" }, "HazMatCertified": { "type": "boolean" } }, "additionalProperties": false, "required": [ "email", "city", "state", "zipCode" ], "errorMessage": { "required": { "email": "Email is required", "city": "City is required", "state": "State is required", "zipCode": "Zipcode is required" } } }, "AppLoadNoteCreateDto": { "title": "AppLoadNoteCreateDto", "type": "object", "properties": { "currentLocation": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "Current Location must be one of these options: \nundefined", "maxLength": "Current Location must not exceed 150 characters", "minLength": "Current Location must contain at least undefined characters", "type": "Current Location must be string or null" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false }, "AppLoadAiUpdateCreateDto": { "title": "AppLoadAiUpdateCreateDto", "type": "object", "properties": { "status": { "type": "string", "enum": [ "driving", "stopped", "at_stop" ], "errorMessage": { "enum": "Status must be one of these options: \ndriving, stopped, at_stop", "maxLength": "Status must not exceed undefined characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "locationText": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Location Text must be one of these options: \nundefined", "maxLength": "Location Text must not exceed 255 characters", "minLength": "Location Text must contain at least undefined characters", "type": "Location Text must be string " } }, "lat": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lat must be number or null", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Lng must be number or null", "exclusiveMinimum": "Lng must be greater than undefined" } }, "driverMessage": { "type": "string", "maxLength": 2000, "errorMessage": { "enum": "Driver Message must be one of these options: \nundefined", "maxLength": "Driver Message must not exceed 2000 characters", "minLength": "Driver Message must contain at least undefined characters", "type": "Driver Message must be string " } }, "stopReason": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "Stop Reason must be one of these options: \nundefined", "maxLength": "Stop Reason must not exceed 150 characters", "minLength": "Stop Reason must contain at least undefined characters", "type": "Stop Reason must be string or null" } } }, "additionalProperties": false }, "SettlementRejectDto": { "title": "SettlementRejectDto", "type": "object", "properties": { "reason": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Reason must be one of these options: \nundefined", "maxLength": "Reason must not exceed 1000 characters", "minLength": "Reason must contain at least undefined characters", "type": "Reason must be string or null" } } }, "additionalProperties": false }, "DriverAppFeedbackDto": { "title": "DriverAppFeedbackDto", "type": "object", "properties": { "text": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1200 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } } }, "additionalProperties": false }, "Ticket": { "title": "Ticket", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "closedDate": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "readByDriver": { "type": "boolean" }, "locationId": { "type": "string" }, "category": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dispatcherId": { "type": "string" }, "driverId": { "type": "string" }, "unitId": { "type": "string" }, "trailerId": { "type": "string" }, "companyId": { "type": "string" } }, "additionalProperties": false }, "DriverTicketCreateDto": { "title": "DriverTicketCreateDto", "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 255 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string " } }, "description": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1000 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } } }, "additionalProperties": false, "required": [ "title", "description" ], "errorMessage": { "required": { "title": "Title is required", "description": "Description is required" } } }, "DriverCommentForTicketDto": { "title": "DriverCommentForTicketDto", "type": "object", "properties": { "comment": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Comment must be one of these options: \nundefined", "maxLength": "Comment must not exceed 1000 characters", "minLength": "Comment must contain at least undefined characters", "type": "Comment must be string " } } }, "additionalProperties": false, "required": [ "comment" ], "errorMessage": { "required": { "comment": "Comment is required" } } }, "DriverTicketEditDto": { "title": "DriverTicketEditDto", "type": "object", "properties": { "title": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 255 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string or null" } }, "description": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1000 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "status": { "type": "string", "enum": [ "open", "closed" ], "maxLength": 10, "nullable": true, "errorMessage": { "enum": "Status must be one of these options: \nopen, closed", "maxLength": "Status must not exceed 10 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string or null" } } }, "additionalProperties": false }, "UpdateFcmDto": { "title": "UpdateFcmDto", "type": "object", "properties": { "fcmToken": { "type": "string", "errorMessage": { "enum": "Fcm Token must be one of these options: \nundefined", "maxLength": "Fcm Token must not exceed undefined characters", "minLength": "Fcm Token must contain at least undefined characters", "type": "Fcm Token must be string " } } }, "additionalProperties": false, "required": [ "fcmToken" ] }, "StatusChangeData": { "title": "StatusChangeData", "type": "object", "properties": { "activityStatus": { "type": "string", "enum": [ "active", "sleeping" ], "maxLength": 12, "errorMessage": { "enum": "Activity Status must be one of these options: \nactive, sleeping", "maxLength": "Activity Status must not exceed 12 characters", "minLength": "Activity Status must contain at least undefined characters", "type": "Activity Status must be string " } } }, "additionalProperties": false, "required": [ "activityStatus" ], "errorMessage": { "required": { "status": "Activity status is required" } } }, "CollectionSiteSelectDto": { "title": "CollectionSiteSelectDto", "type": "object", "properties": { "collectionSiteCode": { "type": "string", "maxLength": 6, "errorMessage": { "enum": "Collection Site Code must be one of these options: \nundefined", "maxLength": "Collection Site Code must not exceed 6 characters", "minLength": "Collection Site Code must contain at least undefined characters", "type": "Collection Site Code must be string " } } }, "additionalProperties": false, "required": [ "collectionSiteCode" ] }, "SendTrackingData": { "title": "SendTrackingData", "type": "object", "properties": { "lat": { "type": "number", "format": "float", "errorMessage": { "type": "Lat must be number ", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "format": "float", "errorMessage": { "type": "Lng must be number ", "exclusiveMinimum": "Lng must be greater than undefined" } }, "speed": { "type": "number", "format": "float", "errorMessage": { "type": "Speed must be number ", "exclusiveMinimum": "Speed must be greater than undefined" } } }, "additionalProperties": false, "required": [ "lat", "lng", "speed" ] }, "DriverRandomProgramDto": { "title": "DriverRandomProgramDto", "type": "object", "properties": { "randomProgramDate": { "type": "string", "format": "date", "errorMessage": { "type": "Random Program Date must be date ", "format": "RandomProgramDate must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false, "required": [ "randomProgramDate" ], "errorMessage": { "required": { "randomProgramDate": "Random program date is required" } } }, "NewRecruitmentUpdateDto": { "title": "NewRecruitmentUpdateDto", "type": "object", "properties": { "status": { "type": "string", "enum": [ "new", "processing", "hired", "no_response", "terminated", "rejected" ], "maxLength": 24, "errorMessage": { "enum": "Status must be one of these options: \nnew, processing, hired, no_response, terminated, rejected", "maxLength": "Status must not exceed 24 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "recruiterId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Recruiter Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "status" ], "errorMessage": { "required": { "status": "Status is required" } } }, "NewInviteHiredDriverDto": { "title": "NewInviteHiredDriverDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "driverType": { "type": "string", "enum": [ "owner", "company" ], "maxLength": 72, "errorMessage": { "enum": "Driver Type must be one of these options: \nowner, company", "maxLength": "Driver Type must not exceed 72 characters", "minLength": "Driver Type must contain at least undefined characters", "type": "Driver Type must be string " } }, "payment": { "$ref": "#/components/schemas/DriverPaymentObj" }, "payPeriod": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "maxLength": 55, "errorMessage": { "enum": "Pay Period must be one of these options: \ndaily, weekly, monthly", "maxLength": "Pay Period must not exceed 55 characters", "minLength": "Pay Period must contain at least undefined characters", "type": "Pay Period must be string " } } }, "additionalProperties": false, "required": [ "email" ] }, "NewXchangeRequestSendDto": { "title": "NewXchangeRequestSendDto", "type": "object", "properties": { "requestMethod": { "type": "string", "enum": [ "email", "phone", "other" ], "maxLength": 24, "errorMessage": { "enum": "Request Method must be one of these options: \nemail, phone, other", "maxLength": "Request Method must not exceed 24 characters", "minLength": "Request Method must contain at least undefined characters", "type": "Request Method must be string " } }, "newDriverEmploymentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "New Driver Employment Id must be a valid UUID" } }, "receiverEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Receiver Email must be one of these options: \nundefined", "maxLength": "Receiver Email must not exceed 120 characters", "minLength": "Receiver Email must contain at least undefined characters", "type": "Receiver Email must be string or null", "format": "ReceiverEmail must be a valid email address" } } }, "additionalProperties": false, "required": [ "requestMethod", "newDriverEmploymentId" ], "errorMessage": { "required": { "newDriverEmploymentId": "Employer is required" } }, "if": { "properties": { "requestMethod": { "const": "email" } }, "required": [ "requestMethod" ] }, "then": { "required": [ "receiverEmail" ], "properties": { "receiverEmail": { "minLength": 1 } } } }, "NewXchangeResendDto": { "title": "NewXchangeResendDto", "type": "object", "properties": { "receiverEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Receiver Email must be one of these options: \nundefined", "maxLength": "Receiver Email must not exceed 120 characters", "minLength": "Receiver Email must contain at least undefined characters", "type": "Receiver Email must be string or null", "format": "ReceiverEmail must be a valid email address" } }, "requestMethod": { "type": "string", "enum": [ "email", "phone", "other" ], "maxLength": 24, "errorMessage": { "enum": "Request Method must be one of these options: \nemail, phone, other", "maxLength": "Request Method must not exceed 24 characters", "minLength": "Request Method must contain at least undefined characters", "type": "Request Method must be string " } } }, "additionalProperties": false, "required": [ "requestMethod" ], "if": { "properties": { "requestMethod": { "const": "email" } }, "required": [ "requestMethod" ] }, "then": { "required": [ "receiverEmail" ], "properties": { "receiverEmail": { "minLength": 1 } } } }, "XchangeAccidentDto": { "title": "XchangeAccidentDto", "type": "object", "properties": { "date": { "type": "string", "format": "date", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date (YYYY-MM-DD)" } }, "location": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Location must be one of these options: \nundefined", "maxLength": "Location must not exceed 255 characters", "minLength": "Location must contain at least undefined characters", "type": "Location must be string " } }, "numberOfInjuries": { "type": "number", "errorMessage": { "minimum": "Number Of Injuries cannot be lower than undefined", "maximum": "Number Of Injuries cannot be lower than undefined", "type": "Number Of Injuries must be number ", "exclusiveMinimum": "Number Of Injuries must be greater than undefined" } }, "numberOfFatalities": { "type": "number", "errorMessage": { "minimum": "Number Of Fatalities cannot be lower than undefined", "maximum": "Number Of Fatalities cannot be lower than undefined", "type": "Number Of Fatalities must be number ", "exclusiveMinimum": "Number Of Fatalities must be greater than undefined" } }, "hazmatSpill": { "type": "boolean" } }, "additionalProperties": false }, "NewXchangeResponseCreateDto": { "title": "NewXchangeResponseCreateDto", "type": "object", "properties": { "linkCode": { "type": "string", "maxLength": 64, "errorMessage": { "enum": "Link Code must be one of these options: \nundefined", "maxLength": "Link Code must not exceed 64 characters", "minLength": "Link Code must contain at least undefined characters", "type": "Link Code must be string " } }, "wasEmployed": { "type": "boolean" }, "positionHeld": { "type": "string", "maxLength": 56, "nullable": true, "errorMessage": { "enum": "Position Held must be one of these options: \nundefined", "maxLength": "Position Held must not exceed 56 characters", "minLength": "Position Held must contain at least undefined characters", "type": "Position Held must be string or null" } }, "actualServicePeriodStart": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Actual Service Period Start must be date or null", "format": "ActualServicePeriodStart must be a valid date (YYYY-MM-DD)" } }, "actualServicePeriodEnd": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Actual Service Period End must be date or null", "format": "ActualServicePeriodEnd must be a valid date (YYYY-MM-DD)" } }, "reasonForLeaving": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Reason For Leaving must be one of these options: \nundefined", "maxLength": "Reason For Leaving must not exceed 255 characters", "minLength": "Reason For Leaving must contain at least undefined characters", "type": "Reason For Leaving must be string or null" } }, "noAccident": { "type": "boolean" }, "accidents": { "type": "array", "items": { "$ref": "#/components/schemas/XchangeAccidentDto" } }, "verifiedPositive": { "type": "boolean" }, "refusedTest": { "type": "boolean" }, "otherDOTViolations": { "type": "boolean" }, "responderName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Responder Name must be one of these options: \nundefined", "maxLength": "Responder Name must not exceed 255 characters", "minLength": "Responder Name must contain at least undefined characters", "type": "Responder Name must be string " } }, "responderTitle": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Responder Title must be one of these options: \nundefined", "maxLength": "Responder Title must not exceed 255 characters", "minLength": "Responder Title must contain at least undefined characters", "type": "Responder Title must be string or null" } }, "responderPhone": { "type": "string", "maxLength": 20, "errorMessage": { "enum": "Responder Phone must be one of these options: \nundefined", "maxLength": "Responder Phone must not exceed 20 characters", "minLength": "Responder Phone must contain at least undefined characters", "type": "Responder Phone must be string " } }, "responderEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Responder Email must be one of these options: \nundefined", "maxLength": "Responder Email must not exceed 120 characters", "minLength": "Responder Email must contain at least undefined characters", "type": "Responder Email must be string or null", "format": "ResponderEmail must be a valid email address" } }, "confirmationDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Confirmation Date must be date or null", "format": "ConfirmationDate must be a valid date (YYYY-MM-DD)" } }, "certified": { "type": "boolean" } }, "additionalProperties": false, "required": [ "linkCode", "wasEmployed", "noAccident", "verifiedPositive", "refusedTest", "otherDOTViolations", "responderName", "responderPhone", "certified" ] }, "XchangeLogPhoneData": { "title": "XchangeLogPhoneData", "type": "object", "properties": { "note": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Note must be one of these options: \nundefined", "maxLength": "Note must not exceed 1000 characters", "minLength": "Note must contain at least undefined characters", "type": "Note must be string " } } }, "additionalProperties": false, "required": [ "note" ], "errorMessage": { "required": { "note": "Note is required" } } }, "NewRecruitmentHistoryCreateDto": { "title": "NewRecruitmentHistoryCreateDto", "type": "object", "properties": { "newRecruitmentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "New Recruitment Id must be a valid UUID" } }, "description": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 255 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } } }, "additionalProperties": false, "required": [ "newRecruitmentId", "description" ], "errorMessage": { "required": { "newRecruitmentId": "Recruitment is required", "description": "Description is required" } } }, "NewXchangeRequestAllPendingItemDto": { "title": "NewXchangeRequestAllPendingItemDto", "type": "object", "properties": { "requestMethod": { "type": "string", "enum": [ "email", "phone", "other" ], "maxLength": 24, "errorMessage": { "enum": "Request Method must be one of these options: \nemail, phone, other", "maxLength": "Request Method must not exceed 24 characters", "minLength": "Request Method must contain at least undefined characters", "type": "Request Method must be string " } }, "newDriverEmploymentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "New Driver Employment Id must be a valid UUID" } }, "receiverEmail": { "type": "string", "format": "email", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Receiver Email must be one of these options: \nundefined", "maxLength": "Receiver Email must not exceed 120 characters", "minLength": "Receiver Email must contain at least undefined characters", "type": "Receiver Email must be string or null", "format": "ReceiverEmail must be a valid email address" } } }, "additionalProperties": false, "required": [ "requestMethod", "newDriverEmploymentId" ], "if": { "properties": { "requestMethod": { "const": "email" } }, "required": [ "requestMethod" ] }, "then": { "required": [ "receiverEmail" ], "properties": { "receiverEmail": { "minLength": 1 } } } }, "NewXchangeRequestAllPendingDto": { "title": "NewXchangeRequestAllPendingDto", "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NewXchangeRequestAllPendingItemDto" } } }, "additionalProperties": false, "required": [ "items" ] }, "DriverResidenceCreateData": { "title": "DriverResidenceCreateData", "type": "object", "properties": { "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "maxLength": 2, "errorMessage": { "enum": "State must be one of these options: \nAL, AK, AZ, AR, CA, CO, CT, DE, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY", "maxLength": "State must not exceed 2 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipcode": { "type": "string", "maxLength": 24, "pattern": "^\\d{5}(-\\d{4})?$", "errorMessage": { "enum": "Zipcode must be one of these options: \nundefined", "maxLength": "Zipcode must not exceed 24 characters", "minLength": "Zipcode must contain at least undefined characters", "type": "Zipcode must be string ", "pattern": "Zip code must be a valid 5-digit or ZIP+4 code (e.g. 12345 or 12345-6789)" } } }, "additionalProperties": false, "required": [ "address", "city", "state", "zipcode" ], "errorMessage": { "required": { "address": "Address required", "city": "City required", "state": "State required", "zipcode": "Zipcode required" } } }, "DriverExperienceCreateData": { "title": "DriverExperienceCreateData", "type": "object", "properties": { "type": { "type": "string", "enum": [ "straight", "truck-tractor", "semi-trailer", "doubles-or-triples", "flatbed", "bus", "other" ], "maxLength": 20, "errorMessage": { "enum": "Type must be one of these options: \nstraight, truck-tractor, semi-trailer, doubles-or-triples, flatbed, bus, other", "maxLength": "Type must not exceed 20 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "startDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Start Date must be date or null", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "miles": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Miles must be number or null", "exclusiveMinimum": "Miles must be greater than undefined" } } }, "additionalProperties": false }, "NewDriverAccidentCreateData": { "title": "NewDriverAccidentCreateData", "type": "object", "properties": { "date": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date must be date or null", "format": "Date must be a valid date (YYYY-MM-DD)" } }, "location": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Location must be one of these options: \nundefined", "maxLength": "Location must not exceed 256 characters", "minLength": "Location must contain at least undefined characters", "type": "Location must be string or null" } }, "numberOfInjuries": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Number Of Injuries cannot be lower than undefined", "maximum": "Number Of Injuries cannot be lower than undefined", "type": "Number Of Injuries must be number or null", "exclusiveMinimum": "Number Of Injuries must be greater than undefined" } }, "numberOfFatalities": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Number Of Fatalities cannot be lower than undefined", "maximum": "Number Of Fatalities cannot be lower than undefined", "type": "Number Of Fatalities must be number or null", "exclusiveMinimum": "Number Of Fatalities must be greater than undefined" } }, "hazmatSpill": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "required": [ "date" ], "errorMessage": { "required": { "date": "Date is required" } } }, "NewDriverViolationCreateData": { "title": "NewDriverViolationCreateData", "type": "object", "properties": { "date": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date must be date or null", "format": "Date must be a valid date (YYYY-MM-DD)" } }, "location": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Location must be one of these options: \nundefined", "maxLength": "Location must not exceed 256 characters", "minLength": "Location must contain at least undefined characters", "type": "Location must be string or null" } }, "offense": { "type": "string", "maxLength": 256, "nullable": true, "errorMessage": { "enum": "Offense must be one of these options: \nundefined", "maxLength": "Offense must not exceed 256 characters", "minLength": "Offense must contain at least undefined characters", "type": "Offense must be string or null" } }, "vehicleType": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Vehicle Type must be one of these options: \nundefined", "maxLength": "Vehicle Type must not exceed 36 characters", "minLength": "Vehicle Type must contain at least undefined characters", "type": "Vehicle Type must be string or null" } } }, "additionalProperties": false }, "NewDriverEmploymentCreateData": { "title": "NewDriverEmploymentCreateData", "type": "object", "properties": { "employerName": { "type": "string", "maxLength": 256, "errorMessage": { "enum": "Employer Name must be one of these options: \nundefined", "maxLength": "Employer Name must not exceed 256 characters", "minLength": "Employer Name must contain at least undefined characters", "type": "Employer Name must be string " } }, "contactPerson": { "type": "string", "maxLength": 256, "errorMessage": { "enum": "Contact Person must be one of these options: \nundefined", "maxLength": "Contact Person must not exceed 256 characters", "minLength": "Contact Person must contain at least undefined characters", "type": "Contact Person must be string " } }, "address": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 150 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 2, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 2 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipcode": { "type": "string", "maxLength": 32, "pattern": "^\\d{5}(-\\d{4})?$", "errorMessage": { "enum": "Zipcode must be one of these options: \nundefined", "maxLength": "Zipcode must not exceed 32 characters", "minLength": "Zipcode must contain at least undefined characters", "type": "Zipcode must be string ", "pattern": "Zip code must be a valid 5-digit or ZIP+4 code (e.g. 12345 or 12345-6789)" } }, "phone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "fax": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Fax must be one of these options: \nundefined", "maxLength": "Fax must not exceed 72 characters", "minLength": "Fax must contain at least undefined characters", "type": "Fax must be string " } }, "email": { "type": "string", "format": "email", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 72 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string or null", "format": "Email must be a valid email address" } }, "dateFrom": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date From must be date or null", "format": "DateFrom must be a valid date (YYYY-MM-DD)" } }, "dateTo": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date To must be date or null", "format": "DateTo must be a valid date (YYYY-MM-DD)" } }, "positionHeld": { "type": "string", "maxLength": 56, "errorMessage": { "enum": "Position Held must be one of these options: \nundefined", "maxLength": "Position Held must not exceed 56 characters", "minLength": "Position Held must contain at least undefined characters", "type": "Position Held must be string " } }, "reasonForLeaving": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Reason For Leaving must be one of these options: \nundefined", "maxLength": "Reason For Leaving must not exceed 1000 characters", "minLength": "Reason For Leaving must contain at least undefined characters", "type": "Reason For Leaving must be string " } }, "wasSubjectToFMCSA": { "type": "boolean", "nullable": true }, "wasDesignatedAsSensitiveFunction": { "type": "boolean" }, "gaps": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Gaps must be one of these options: \nundefined", "maxLength": "Gaps must not exceed 1000 characters", "minLength": "Gaps must contain at least undefined characters", "type": "Gaps must be string " } } }, "additionalProperties": false, "required": [ "wasDesignatedAsSensitiveFunction" ], "errorMessage": { "required": { "wasDesignatedAsSensitiveFunction": "Designated as sensitive function required" } } }, "NewDriverUnemploymentCreateData": { "title": "NewDriverUnemploymentCreateData", "type": "object", "properties": { "startDate": { "type": "string", "format": "date", "errorMessage": { "type": "Start Date must be date ", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "errorMessage": { "type": "End Date must be date ", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "comments": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Comments must be one of these options: \nundefined", "maxLength": "Comments must not exceed 1000 characters", "minLength": "Comments must contain at least undefined characters", "type": "Comments must be string or null" } } }, "additionalProperties": false, "required": [ "startDate", "endDate" ] }, "NewDriverApplicationCreateData": { "title": "NewDriverApplicationCreateData", "type": "object", "properties": { "firstName": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 72 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "middleName": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Middle Name must be one of these options: \nundefined", "maxLength": "Middle Name must not exceed 72 characters", "minLength": "Middle Name must contain at least undefined characters", "type": "Middle Name must be string " } }, "secondName": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 72 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "suffix": { "type": "string", "maxLength": 24, "errorMessage": { "enum": "Suffix must be one of these options: \nundefined", "maxLength": "Suffix must not exceed 24 characters", "minLength": "Suffix must contain at least undefined characters", "type": "Suffix must be string " } }, "dateBirth": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date Birth must be date or null", "format": "DateBirth must be a valid date (YYYY-MM-DD)" } }, "ssn": { "type": "string", "maxLength": 24, "errorMessage": { "enum": "Ssn must be one of these options: \nundefined", "maxLength": "Ssn must not exceed 24 characters", "minLength": "Ssn must contain at least undefined characters", "type": "Ssn must be string " } }, "hasCurrentTWICCard": { "type": "boolean", "nullable": true }, "hasPassport": { "type": "boolean", "nullable": true }, "emergencyContactName": { "type": "string", "maxLength": 128, "errorMessage": { "enum": "Emergency Contact Name must be one of these options: \nundefined", "maxLength": "Emergency Contact Name must not exceed 128 characters", "minLength": "Emergency Contact Name must contain at least undefined characters", "type": "Emergency Contact Name must be string " } }, "emergencyContactPhone": { "type": "string", "maxLength": 20, "nullable": true, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Emergency Contact Phone must be one of these options: \nundefined", "maxLength": "Emergency Contact Phone must not exceed 20 characters", "minLength": "Emergency Contact Phone must contain at least undefined characters", "type": "Emergency Contact Phone must be string or null", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "driverResidences": { "type": "array", "items": { "$ref": "#/components/schemas/DriverResidenceCreateData" } }, "driverLicenses": { "type": "array", "items": { "$ref": "#/components/schemas/NewDriverLicenseCreateData" } }, "driverExperiences": { "type": "array", "items": { "$ref": "#/components/schemas/DriverExperienceCreateData" } }, "involvedInAccidentPast3Years": { "type": "boolean", "nullable": true }, "driverAccidents": { "type": "array", "items": { "$ref": "#/components/schemas/NewDriverAccidentCreateData" } }, "movingViolationsPast3Years": { "type": "boolean", "nullable": true }, "driverViolations": { "type": "array", "items": { "$ref": "#/components/schemas/NewDriverViolationCreateData" } }, "hasEverLicenseDenied": { "type": "boolean" }, "licenseEverRevoked": { "type": "boolean" }, "licenseDenialDescription": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "License Denial Description must be one of these options: \nundefined", "maxLength": "License Denial Description must not exceed 1000 characters", "minLength": "License Denial Description must contain at least undefined characters", "type": "License Denial Description must be string or null" } }, "testedPositiveOrRefusedToTest": { "type": "boolean" }, "canProvideDocumentation": { "type": "boolean", "nullable": true }, "driverEmployments": { "type": "array", "items": { "$ref": "#/components/schemas/NewDriverEmploymentCreateData" } }, "wasUnemployedPast3Years": { "type": "boolean", "nullable": true }, "driverUnemployments": { "type": "array", "items": { "$ref": "#/components/schemas/NewDriverUnemploymentCreateData" } }, "safetyPerformanceHistoryInformation": { "type": "boolean" }, "pspStatement": { "type": "boolean" }, "alcoholAndDrugTestPolicy": { "type": "boolean" }, "fairCreditReport": { "type": "boolean" }, "clearinghouseConsent": { "type": "boolean" }, "cdlDocumentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Cdl Document Id must be a valid UUID" } }, "signatureFileId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Signature File Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "firstName", "secondName", "email", "phone", "dateBirth", "ssn", "involvedInAccidentPast3Years", "movingViolationsPast3Years", "hasEverLicenseDenied", "licenseEverRevoked", "testedPositiveOrRefusedToTest", "canProvideDocumentation", "safetyPerformanceHistoryInformation", "pspStatement", "alcoholAndDrugTestPolicy", "fairCreditReport", "clearinghouseConsent", "signatureFileId" ], "errorMessage": { "required": { "firstName": "First name required", "secondName": "Second name required", "email": "Email required", "phone": "Phone required", "dateBirth": "Date birth required", "ssn": "SSN required", "involvedInAccidentPast3Years": "Accident involvement required", "movingViolationsPast3Years": "Violation involvement required", "hasEverLicenseDenied": "License, permit or privelege denial required", "licenseEverRevoked": "License, permit or privelege revoke required", "testedPositiveOrRefusedToTest": "DOT drug or alcohol test administration required", "canProvideDocumentation": "Documentation provide required", "safetyPerformanceHistoryInformation": "Safety Performance History Information required", "pspStatement": "PSP statement required", "alcoholAndDrugTestPolicy": "Alcohol and Drug Test Policy required", "fairCreditReport": "Fair Credit Report required", "clearinghouseConsent": "Clearing House Consent required", "signatureFileId": "Signature required" } } }, "DriverRoadTestEquipmentDto": { "title": "DriverRoadTestEquipmentDto", "type": "object", "properties": { "equipmentType": { "type": "string", "enum": [ "van", "tanker", "dump", "flatbed" ], "maxLength": 20, "errorMessage": { "enum": "Equipment Type must be one of these options: \nvan, tanker, dump, flatbed", "maxLength": "Equipment Type must not exceed 20 characters", "minLength": "Equipment Type must contain at least undefined characters", "type": "Equipment Type must be string " } }, "equipmentClass": { "type": "string", "enum": [ "straight-truck", "truck-tractor", "semi-trailer", "doubles-or-triples", "bus", "other" ], "maxLength": 25, "errorMessage": { "enum": "Equipment Class must be one of these options: \nstraight-truck, truck-tractor, semi-trailer, doubles-or-triples, bus, other", "maxLength": "Equipment Class must not exceed 25 characters", "minLength": "Equipment Class must contain at least undefined characters", "type": "Equipment Class must be string " } }, "hazmat": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "Hazmat must be one of these options: \nundefined", "maxLength": "Hazmat must not exceed 55 characters", "minLength": "Hazmat must contain at least undefined characters", "type": "Hazmat must be string " } }, "approxMiles": { "type": "number", "errorMessage": { "minimum": "Approx Miles cannot be lower than undefined", "maximum": "Approx Miles cannot be lower than undefined", "type": "Approx Miles must be number ", "exclusiveMinimum": "Approx Miles must be greater than undefined" } } }, "additionalProperties": false }, "DriverRoadTestDto": { "title": "DriverRoadTestDto", "type": "object", "properties": { "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "zipCode": { "type": "string", "maxLength": 32, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 32 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "examinerName": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Examiner Name must be one of these options: \nundefined", "maxLength": "Examiner Name must not exceed 120 characters", "minLength": "Examiner Name must contain at least undefined characters", "type": "Examiner Name must be string " } }, "name": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "preTripInspection": { "type": "boolean", "nullable": true }, "couplingUncoupling": { "type": "boolean", "nullable": true }, "familiarWithControls": { "type": "boolean", "nullable": true }, "placingVehicleInOperation": { "type": "boolean", "nullable": true }, "useOfControls": { "type": "boolean", "nullable": true }, "useOfEmergencyEquipment": { "type": "boolean", "nullable": true }, "operatingInTraffic": { "type": "boolean", "nullable": true }, "passingOtherVehicles": { "type": "boolean", "nullable": true }, "turningVehicle": { "type": "boolean", "nullable": true }, "brakingAndSlowing": { "type": "boolean", "nullable": true }, "backingVehicle": { "type": "boolean", "nullable": true }, "parkingVehicle": { "type": "boolean", "nullable": true }, "otherExplain": { "type": "string", "errorMessage": { "enum": "Other Explain must be one of these options: \nundefined", "maxLength": "Other Explain must not exceed undefined characters", "minLength": "Other Explain must contain at least undefined characters", "type": "Other Explain must be string " } }, "remark": { "type": "string", "errorMessage": { "enum": "Remark must be one of these options: \nundefined", "maxLength": "Remark must not exceed undefined characters", "minLength": "Remark must contain at least undefined characters", "type": "Remark must be string " } }, "roadTestDate": { "type": "string", "errorMessage": { "type": "Road Test Date must be date " } }, "driverRoadTestEquipments": { "type": "array", "items": { "$ref": "#/components/schemas/DriverRoadTestEquipmentDto" } } }, "additionalProperties": false, "required": [ "name", "address", "city", "state", "zipCode", "examinerName", "preTripInspection", "couplingUncoupling", "familiarWithControls", "placingVehicleInOperation", "useOfControls", "useOfEmergencyEquipment", "operatingInTraffic", "passingOtherVehicles", "turningVehicle", "brakingAndSlowing", "backingVehicle", "parkingVehicle" ], "errorMessage": { "required": { "address": "Address is required", "city": "City is required", "state": "State is required", "examinerName": "Examiner name is required", "preTripInspection": "Pre-trip inspection result is required", "couplingUncoupling": "Coupling/uncoupling result is required", "familiarWithControls": "Result for familiar with vehicle’s controls is required", "placingVehicleInOperation": "Result for placing the vehicle in operation is required", "useOfControls": "Result for use of vehicle’s controls is required", "useOfEmergencyEquipment": "Result for use of vehicle’s emergency equipment is required", "operatingInTraffic": "Result for operating the vehicle in traffic is required", "passingOtherVehicles": "Result for operating while passing other vehicles is required", "turningVehicle": "Result for turning the vehicle is required", "brakingAndSlowing": "Result for braking and slowing the vehicle is required", "backingVehicle": "Result for backing the vehicle is required", "parkingVehicle": "Result for parking the vehicle is required" } } }, "DriverRoadTestCertificateDto": { "title": "DriverRoadTestCertificateDto", "type": "object", "properties": { "driverName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Driver Name must be one of these options: \nundefined", "maxLength": "Driver Name must not exceed 255 characters", "minLength": "Driver Name must contain at least undefined characters", "type": "Driver Name must be string " } }, "passengerBusType": { "type": "string", "maxLength": 155, "errorMessage": { "enum": "Passenger Bus Type must be one of these options: \nundefined", "maxLength": "Passenger Bus Type must not exceed 155 characters", "minLength": "Passenger Bus Type must contain at least undefined characters", "type": "Passenger Bus Type must be string " } }, "ssn": { "type": "string", "maxLength": 24, "errorMessage": { "enum": "Ssn must be one of these options: \nundefined", "maxLength": "Ssn must not exceed 24 characters", "minLength": "Ssn must contain at least undefined characters", "type": "Ssn must be string " } }, "licenseState": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "License State must be one of these options: \nundefined", "maxLength": "License State must not exceed 55 characters", "minLength": "License State must contain at least undefined characters", "type": "License State must be string " } }, "licenseNumber": { "type": "string", "maxLength": 24, "errorMessage": { "enum": "License Number must be one of these options: \nundefined", "maxLength": "License Number must not exceed 24 characters", "minLength": "License Number must contain at least undefined characters", "type": "License Number must be string " } }, "trailerType": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "Trailer Type must be one of these options: \nundefined", "maxLength": "Trailer Type must not exceed 55 characters", "minLength": "Trailer Type must contain at least undefined characters", "type": "Trailer Type must be string " } }, "unitType": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "Unit Type must be one of these options: \nundefined", "maxLength": "Unit Type must not exceed 55 characters", "minLength": "Unit Type must contain at least undefined characters", "type": "Unit Type must be string " } }, "markAsCompleted": { "type": "boolean" }, "approxMiles": { "type": "number", "errorMessage": { "minimum": "Approx Miles cannot be lower than undefined", "maximum": "Approx Miles cannot be lower than undefined", "type": "Approx Miles must be number ", "exclusiveMinimum": "Approx Miles must be greater than undefined" } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "zipCode": { "type": "string", "maxLength": 32, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 32 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "roadTestId": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Road Test Id must be one of these options: \nundefined", "maxLength": "Road Test Id must not exceed 36 characters", "minLength": "Road Test Id must contain at least undefined characters", "type": "Road Test Id must be string " } }, "examinerOrganization": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Examiner Organization must be one of these options: \nundefined", "maxLength": "Examiner Organization must not exceed 120 characters", "minLength": "Examiner Organization must contain at least undefined characters", "type": "Examiner Organization must be string " } }, "roadTestSupervisionDate": { "type": "string", "errorMessage": { "type": "Road Test Supervision Date must be date " } }, "examinerTitle": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Examiner Title must be one of these options: \nundefined", "maxLength": "Examiner Title must not exceed 255 characters", "minLength": "Examiner Title must contain at least undefined characters", "type": "Examiner Title must be string " } } }, "additionalProperties": false }, "AcceptRandomProgram": {}, "DriverPspOrderDto": { "title": "DriverPspOrderDto", "type": "object", "properties": { "newDriverLicenseId": { "type": "string", "errorMessage": { "enum": "New Driver License Id must be one of these options: \nundefined", "maxLength": "New Driver License Id must not exceed undefined characters", "minLength": "New Driver License Id must contain at least undefined characters", "type": "New Driver License Id must be string " } }, "paymentMethodId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Payment Method Id must be one of these options: \nundefined", "maxLength": "Payment Method Id must not exceed undefined characters", "minLength": "Payment Method Id must contain at least undefined characters", "type": "Payment Method Id must be string or null" } } }, "additionalProperties": false, "required": [ "newDriverLicenseId" ] }, "DriverMvrNowOrderDto": { "title": "DriverMvrNowOrderDto", "type": "object", "properties": { "newDriverLicenseId": { "type": "string", "errorMessage": { "enum": "New Driver License Id must be one of these options: \nundefined", "maxLength": "New Driver License Id must not exceed undefined characters", "minLength": "New Driver License Id must contain at least undefined characters", "type": "New Driver License Id must be string " } }, "paymentMethodId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Payment Method Id must be one of these options: \nundefined", "maxLength": "Payment Method Id must not exceed undefined characters", "minLength": "Payment Method Id must contain at least undefined characters", "type": "Payment Method Id must be string or null" } } }, "additionalProperties": false, "required": [ "newDriverLicenseId" ] }, "DriverMedicalCardByTokenDto": { "title": "DriverMedicalCardByTokenDto", "type": "object", "properties": { "medicalExaminerName": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Medical Examiner Name must be one of these options: \nundefined", "maxLength": "Medical Examiner Name must not exceed 120 characters", "minLength": "Medical Examiner Name must contain at least undefined characters", "type": "Medical Examiner Name must be string or null" } }, "nationalRegistryNumber": { "type": "string", "maxLength": 20, "errorMessage": { "enum": "National Registry Number must be one of these options: \nundefined", "maxLength": "National Registry Number must not exceed 20 characters", "minLength": "National Registry Number must contain at least undefined characters", "type": "National Registry Number must be string " } }, "issueDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Issue Date must be date or null", "format": "IssueDate must be a valid date (YYYY-MM-DD)" } }, "expirationDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Expiration Date must be date or null", "format": "ExpirationDate must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false }, "DriverClearingHouseRequestDto": { "title": "DriverClearingHouseRequestDto", "type": "object", "properties": { "queryType": { "type": "string", "enum": [ "full_query", "limited_query" ], "maxLength": 55, "errorMessage": { "enum": "Query Type must be one of these options: \nfull_query, limited_query", "maxLength": "Query Type must not exceed 55 characters", "minLength": "Query Type must contain at least undefined characters", "type": "Query Type must be string " } }, "paymentMethodId": { "type": "string", "nullable": true, "errorMessage": { "enum": "Payment Method Id must be one of these options: \nundefined", "maxLength": "Payment Method Id must not exceed undefined characters", "minLength": "Payment Method Id must contain at least undefined characters", "type": "Payment Method Id must be string or null" } } }, "additionalProperties": false, "required": [ "queryType" ], "errorMessage": { "required": { "queryType": "Query type is required" } } }, "DriverClearingHouseExemptDto": { "title": "DriverClearingHouseExemptDto", "type": "object", "properties": { "reason": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Reason must be one of these options: \nundefined", "maxLength": "Reason must not exceed 1000 characters", "minLength": "Reason must contain at least undefined characters", "type": "Reason must be string " } } }, "additionalProperties": false, "required": [ "reason" ], "errorMessage": { "required": { "reason": "Reason is required" } } }, "AdminMakeAndModelDto": { "title": "AdminMakeAndModelDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "type": { "type": "string", "maxLength": 25, "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed 25 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "isActive": { "type": "boolean" }, "makeId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Make Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "name", "makeId" ], "errorMessage": { "required": { "name": "Name is required", "makeId": "Make is required" } } }, "AdminMakeDto": { "title": "AdminMakeDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "type": { "type": "string", "maxLength": 25, "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed 25 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "isActive": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "type" ], "errorMessage": { "required": { "name": "Name is required", "type": "Type is required" } } }, "NewVendor": { "title": "NewVendor", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewVendor', exclude: [ 'id' ] })", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "notes": { "type": "string" }, "zipCodes": { "type": "string" }, "placeId": { "type": "string" }, "companyId": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string" }, "qbEntityId": { "type": "string" }, "driverId": { "type": "string" }, "brokerCompanyId": { "type": "string" }, "dispatcherId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "VendorPartial": { "title": "VendorPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "notes": { "type": "string" }, "zipCodes": { "type": "string" }, "placeId": { "type": "string" }, "companyId": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string" }, "qbEntityId": { "type": "string" }, "driverId": { "type": "string" }, "brokerCompanyId": { "type": "string" }, "dispatcherId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Vendor": { "title": "Vendor", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "notes": { "type": "string" }, "zipCodes": { "type": "string" }, "placeId": { "type": "string" }, "companyId": { "type": "string" }, "email": { "type": "string" }, "type": { "type": "string" }, "qbEntityId": { "type": "string" }, "driverId": { "type": "string" }, "brokerCompanyId": { "type": "string" }, "dispatcherId": { "type": "string" } }, "additionalProperties": false }, "New Admin-user": { "title": "New Admin-user", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Admin-user', exclude: [ 'id' ] })", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "password": { "type": "string", "minLength": 6 }, "role": { "type": "string", "enum": [ "admin", "super-admin", "admin-support", "admin-sales" ] }, "username": { "type": "string" } }, "required": [ "email" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "AdminUser": { "title": "AdminUser", "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "password": { "type": "string", "minLength": 6 }, "role": { "type": "string", "enum": [ "admin", "super-admin", "admin-support", "admin-sales" ] }, "username": { "type": "string" } }, "required": [ "email" ], "additionalProperties": false }, "AdminSignInBodyDto": { "title": "AdminSignInBodyDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed undefined characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "password": { "type": "string", "minLength": 6, "maxLength": 255, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least 6 characters", "type": "Password must be string " } } }, "additionalProperties": false, "required": [ "email", "password" ], "errorMessage": { "required": { "email": "Email is required", "password": "Password is required" } } }, "AdminSignUpDto": { "title": "AdminSignUpDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed undefined characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "password": { "type": "string", "minLength": 6, "maxLength": 255, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least 6 characters", "type": "Password must be string " } }, "firstName": { "type": "string", "minLength": 4, "maxLength": 512, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 512 characters", "minLength": "First Name must contain at least 4 characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "minLength": 4, "maxLength": 512, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 512 characters", "minLength": "Second Name must contain at least 4 characters", "type": "Second Name must be string " } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "role": { "type": "string", "enum": [ "admin", "super-admin", "admin-support", "admin-sales" ], "errorMessage": { "enum": "Role must be one of these options: \nadmin, super-admin, admin-support, admin-sales", "maxLength": "Role must not exceed undefined characters", "minLength": "Role must contain at least undefined characters", "type": "Role must be string " } } }, "additionalProperties": false, "required": [ "email", "password", "firstName", "secondName", "phone" ], "errorMessage": { "required": { "email": "Email is required", "password": "Password is required", "firstName": "First name is required", "secondName": "Last name is required", "phone": "Phone is required" } } }, "New Unit": { "title": "New Unit", "type": "object", "description": "(tsType: Omit, 'id' | 'terminated' | 'locationUpdatedAt' | 'manualLocation' | 'driverType' | 'gpsData' | 'location' | 'createdAt' | 'updatedAt' | 'statusUpdated' | 'noteUpdatedDate' | 'fleetStatusCode' | 'statusCode' | 'importedId'>, schemaOptions: {\n title: 'New Unit',\n exclude: [\n 'id', 'terminated',\n 'locationUpdatedAt', 'manualLocation',\n 'driverType', 'gpsData',\n 'location', 'createdAt',\n 'updatedAt', 'statusUpdated',\n 'noteUpdatedDate', 'fleetStatusCode',\n 'statusCode', 'importedId'\n ],\n partial: true\n})", "properties": { "status": { "type": "string" }, "fleetStatus": { "type": "string" }, "equipmentStatus": { "type": "string" }, "origin": { "type": "string" }, "destination": { "type": "string" }, "deliveryAt": { "type": "string" }, "pickupAt": { "type": "string" }, "readyAt": { "type": "string" }, "driverReturnDate": { "type": "string", "format": "date-time" }, "eta": { "type": "string" }, "nextStop": { "type": "string" }, "isManualLocation": { "type": "boolean" }, "activated": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "truckNumber": { "type": "string" }, "year": { "type": "string" }, "licenseNumber": { "type": "string" }, "type": { "type": "string" }, "licenseIssuePlace": { "type": "string" }, "vin": { "type": "string" }, "fuelType": { "type": "string" }, "eldNumber": { "type": "string" }, "transparentRemoteId": { "type": "string" }, "creationSource": { "type": "string" }, "notes": { "type": "string" }, "equipmentNotes": { "type": "string" }, "odometer": { "type": "number" }, "odometerUpdatedAt": { "type": "string", "format": "date-time" }, "transparentLastSeenAt": { "type": "string", "format": "date-time" }, "temporaryTrailerDropDate": { "type": "string", "format": "date-time" }, "temporaryTrailerNumber": { "type": "string" }, "temporaryTrailerLocation": { "type": "string" }, "grossPercentage": { "type": "number" }, "netPayShare": { "type": "number" }, "companyId": { "type": "string" }, "driverId": { "type": "string" }, "coDriverId": { "type": "string" }, "vehicleId": { "type": "string" }, "modelId": { "type": "string" }, "makeId": { "type": "string" }, "trailerId": { "type": "string" }, "contractorId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'terminated' | 'locationUpdatedAt' | 'manualLocation' | 'driverType' | 'gpsData' | 'location' | 'createdAt' | 'updatedAt' | 'statusUpdated' | 'noteUpdatedDate' | 'fleetStatusCode' | 'statusCode' | 'importedId'>" }, "Update Unit": { "title": "Update Unit", "type": "object", "description": "(tsType: Omit, 'id' | 'driverType' | 'gpsData' | 'location' | 'createdAt' | 'updatedAt' | 'statusUpdated' | 'noteUpdatedDate'>, schemaOptions: { title: 'Update Unit', exclude: [ 'id', 'driverType', 'gpsData', 'location', 'createdAt', 'updatedAt', 'statusUpdated', 'noteUpdatedDate' ], partial: true })", "properties": { "importedId": { "type": "number" }, "statusCode": { "type": "number" }, "fleetStatusCode": { "type": "number" }, "status": { "type": "string" }, "fleetStatus": { "type": "string" }, "equipmentStatus": { "type": "string" }, "origin": { "type": "string" }, "destination": { "type": "string" }, "deliveryAt": { "type": "string" }, "pickupAt": { "type": "string" }, "readyAt": { "type": "string" }, "driverReturnDate": { "type": "string", "format": "date-time" }, "eta": { "type": "string" }, "nextStop": { "type": "string" }, "locationUpdatedAt": { "type": "string", "format": "date-time" }, "isManualLocation": { "type": "boolean" }, "manualLocation": { "type": "string" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "truckNumber": { "type": "string" }, "year": { "type": "string" }, "licenseNumber": { "type": "string" }, "type": { "type": "string" }, "licenseIssuePlace": { "type": "string" }, "vin": { "type": "string" }, "fuelType": { "type": "string" }, "eldNumber": { "type": "string" }, "transparentRemoteId": { "type": "string" }, "creationSource": { "type": "string" }, "notes": { "type": "string" }, "equipmentNotes": { "type": "string" }, "odometer": { "type": "number" }, "odometerUpdatedAt": { "type": "string", "format": "date-time" }, "transparentLastSeenAt": { "type": "string", "format": "date-time" }, "temporaryTrailerDropDate": { "type": "string", "format": "date-time" }, "temporaryTrailerNumber": { "type": "string" }, "temporaryTrailerLocation": { "type": "string" }, "grossPercentage": { "type": "number" }, "netPayShare": { "type": "number" }, "companyId": { "type": "string" }, "driverId": { "type": "string" }, "coDriverId": { "type": "string" }, "vehicleId": { "type": "string" }, "modelId": { "type": "string" }, "makeId": { "type": "string" }, "trailerId": { "type": "string" }, "contractorId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'driverType' | 'gpsData' | 'location' | 'createdAt' | 'updatedAt' | 'statusUpdated' | 'noteUpdatedDate'>" }, "Trailer": { "title": "Trailer", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "string" }, "trailerNumber": { "type": "string" }, "licenseNumber": { "type": "string" }, "type": { "type": "string" }, "licenseIssuePlace": { "type": "string" }, "vin": { "type": "string" }, "plateNumber": { "type": "string" }, "plateState": { "type": "string" }, "equipmentStatus": { "type": "string" }, "notes": { "type": "string" }, "equipmentNotes": { "type": "string" }, "isActive": { "type": "boolean" }, "hireDate": { "type": "string", "format": "date-time" }, "purchaseDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "belongToCompany": { "type": "boolean" }, "isPermanent": { "type": "boolean" }, "pickupDate": { "type": "string", "format": "date-time" }, "dropDate": { "type": "string", "format": "date-time" }, "pickupAddress": { "type": "string" }, "dropAddress": { "type": "string" }, "unitId": { "type": "string" }, "companyId": { "type": "string" } }, "additionalProperties": false }, "AdminTagCreateDto": { "title": "AdminTagCreateDto", "type": "object", "properties": { "text": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1000 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "companyId", "text" ], "errorMessage": { "required": { "companyId": "Company is required", "text": "Text is required" } } }, "AdminTagUpdateDto": { "title": "AdminTagUpdateDto", "type": "object", "properties": { "text": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Text must be one of these options: \nundefined", "maxLength": "Text must not exceed 1000 characters", "minLength": "Text must contain at least undefined characters", "type": "Text must be string " } } }, "additionalProperties": false, "required": [ "text" ], "errorMessage": { "required": { "text": "Text is required" } } }, "AdminSettlementCreateDto": { "title": "AdminSettlementCreateDto", "type": "object", "properties": { "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "amount": { "type": "number", "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "driverAmount": { "type": "number", "errorMessage": { "minimum": "Driver Amount cannot be lower than undefined", "maximum": "Driver Amount cannot be lower than undefined", "type": "Driver Amount must be number ", "exclusiveMinimum": "Driver Amount must be greater than undefined" } }, "paidBy": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Paid By must be one of these options: \nundefined", "maxLength": "Paid By must not exceed 72 characters", "minLength": "Paid By must contain at least undefined characters", "type": "Paid By must be string " } }, "stopId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Stop Id must be a valid UUID" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "billingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Ids items must be a valid UUID" } } }, "status": { "type": "number", "enum": [ 1, 2, 3 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "driverCode": { "type": "number", "errorMessage": { "minimum": "Driver Code cannot be lower than undefined", "maximum": "Driver Code cannot be lower than undefined", "type": "Driver Code must be number ", "exclusiveMinimum": "Driver Code must be greater than undefined" } }, "date": { "type": "string", "nullable": true, "errorMessage": { "type": "Date must be date or null" } }, "startDate": { "type": "string", "nullable": true, "errorMessage": { "type": "Start Date must be date or null" } }, "endDate": { "type": "string", "nullable": true, "errorMessage": { "type": "End Date must be date or null" } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "driverId", "dispatcherId" ], "errorMessage": { "required": { "driverId": "Driver is required" } } }, "AdminSettlementUpdateDto": { "title": "AdminSettlementUpdateDto", "type": "object", "properties": { "billingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Ids items must be a valid UUID" } } }, "status": { "type": "number", "enum": [ 1, 2, 3 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } }, "driverCode": { "type": "number", "errorMessage": { "minimum": "Driver Code cannot be lower than undefined", "maximum": "Driver Code cannot be lower than undefined", "type": "Driver Code must be number ", "exclusiveMinimum": "Driver Code must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "date": { "type": "string", "nullable": true, "errorMessage": { "type": "Date must be date or null" } }, "startDate": { "type": "string", "nullable": true, "errorMessage": { "type": "Start Date must be date or null" } }, "endDate": { "type": "string", "nullable": true, "errorMessage": { "type": "End Date must be date or null" } } }, "additionalProperties": false }, "AdminSettlementUpdateStatusDto": { "title": "AdminSettlementUpdateStatusDto", "type": "object", "properties": { "status": { "type": "number", "enum": [ 1, 2, 3 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } } }, "additionalProperties": false, "required": [ "status" ], "errorMessage": { "required": { "status": "Status is required" } } }, "AdminPaymentCreateDto": { "title": "AdminPaymentCreateDto", "type": "object", "properties": { "amount": { "type": "number", "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "settlementId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Settlement Id must be a valid UUID" } }, "date": { "type": "string", "format": "date-time", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date-time (ISO 8601)" } } }, "additionalProperties": false, "required": [ "amount", "settlementId" ], "errorMessage": { "required": { "amount": "Amount is required", "settlementId": "Settlement is required" } } }, "AdminBillingArchiveDto": { "title": "AdminBillingArchiveDto", "type": "object", "properties": { "isArchived": { "type": "boolean" } }, "additionalProperties": false, "required": [ "isArchived" ], "errorMessage": { "required": { "isArchived": "Is archived is required" } } }, "Settlement": { "title": "Settlement", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "total": { "type": "number" }, "due": { "type": "number" }, "balance": { "type": "number" }, "isActive": { "type": "boolean" }, "isSended": { "type": "boolean" }, "notes": { "type": "string" }, "driverName": { "type": "string" }, "status": { "type": "number" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "companyId": { "type": "string" }, "filePath": { "type": "string" }, "code": { "type": "number" }, "driverCode": { "type": "number" }, "isAddedToContractor": { "type": "boolean" }, "isArchivedToContractor": { "type": "boolean" }, "isPaidToContractor": { "type": "boolean" }, "settlementType": { "type": "string" }, "qbEntityId": { "type": "string" }, "driverId": { "type": "string" }, "contractorId": { "type": "string" }, "contractorSettlementId": { "type": "string" }, "payrollBatchId": { "type": "string" } }, "additionalProperties": false }, "New Settlement": { "title": "New Settlement", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Settlement', exclude: [ 'id' ] })", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "total": { "type": "number" }, "due": { "type": "number" }, "balance": { "type": "number" }, "isActive": { "type": "boolean" }, "isSended": { "type": "boolean" }, "notes": { "type": "string" }, "driverName": { "type": "string" }, "status": { "type": "number" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "companyId": { "type": "string" }, "filePath": { "type": "string" }, "code": { "type": "number" }, "driverCode": { "type": "number" }, "isAddedToContractor": { "type": "boolean" }, "isArchivedToContractor": { "type": "boolean" }, "isPaidToContractor": { "type": "boolean" }, "settlementType": { "type": "string" }, "qbEntityId": { "type": "string" }, "driverId": { "type": "string" }, "contractorId": { "type": "string" }, "contractorSettlementId": { "type": "string" }, "payrollBatchId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Update Settlement": { "title": "Update Settlement", "type": "object", "description": "(tsType: Omit, 'id'>, schemaOptions: { title: 'Update Settlement', exclude: [ 'id' ], partial: true })", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "total": { "type": "number" }, "due": { "type": "number" }, "balance": { "type": "number" }, "isActive": { "type": "boolean" }, "isSended": { "type": "boolean" }, "notes": { "type": "string" }, "driverName": { "type": "string" }, "status": { "type": "number" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "companyId": { "type": "string" }, "filePath": { "type": "string" }, "code": { "type": "number" }, "driverCode": { "type": "number" }, "isAddedToContractor": { "type": "boolean" }, "isArchivedToContractor": { "type": "boolean" }, "isPaidToContractor": { "type": "boolean" }, "settlementType": { "type": "string" }, "qbEntityId": { "type": "string" }, "driverId": { "type": "string" }, "contractorId": { "type": "string" }, "contractorSettlementId": { "type": "string" }, "payrollBatchId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id'>" }, "AdminServiceTaskDto": { "title": "AdminServiceTaskDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "systemTemplate": { "type": "boolean" }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false }, "AdminServiceTaskEditDto": { "title": "AdminServiceTaskEditDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "description": { "type": "string", "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed undefined characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "systemTemplate": { "type": "boolean" }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false }, "AdminServiceProgramDto": { "title": "AdminServiceProgramDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "serviceSchedules": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceScheduleDto" } }, "unitIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Ids items must be a valid UUID" } } }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "name" ], "errorMessage": { "required": { "name": "Name is required" } } }, "AdminServiceProgramEditDto": { "title": "AdminServiceProgramEditDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "unitIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Ids items must be a valid UUID" } } }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false }, "AdminUnitsForServiceProgramDto": { "title": "AdminUnitsForServiceProgramDto", "type": "object", "properties": { "unitIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Ids items must be a valid UUID" } } } }, "additionalProperties": false }, "RtsRequestCredentialsData": { "title": "RtsRequestCredentialsData", "type": "object", "properties": { "token": { "type": "string", "errorMessage": { "enum": "Token must be one of these options: \nundefined", "maxLength": "Token must not exceed undefined characters", "minLength": "Token must contain at least undefined characters", "type": "Token must be string " } }, "refreshToken": { "type": "string", "errorMessage": { "enum": "Refresh Token must be one of these options: \nundefined", "maxLength": "Refresh Token must not exceed undefined characters", "minLength": "Refresh Token must contain at least undefined characters", "type": "Refresh Token must be string " } }, "cookie": { "type": "string", "maxLength": 256, "errorMessage": { "enum": "Cookie must be one of these options: \nundefined", "maxLength": "Cookie must not exceed 256 characters", "minLength": "Cookie must contain at least undefined characters", "type": "Cookie must be string " } } }, "additionalProperties": false, "required": [ "token", "cookie" ], "errorMessage": { "required": { "token": "Token is required", "cookie": "Cookie is required" } } }, "AdminQuestDiagnosticsUnitCodesCreateData": { "title": "AdminQuestDiagnosticsUnitCodesCreateData", "type": "object", "properties": { "code": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Code must be one of these options: \nundefined", "maxLength": "Code must not exceed 255 characters", "minLength": "Code must contain at least undefined characters", "type": "Code must be string " } }, "typeOfTest": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Type Of Test must be one of these options: \nundefined", "maxLength": "Type Of Test must not exceed 255 characters", "minLength": "Type Of Test must contain at least undefined characters", "type": "Type Of Test must be string " } }, "testType": { "type": "string", "enum": [ "drug", "alcohol" ], "maxLength": 25, "errorMessage": { "enum": "Test Type must be one of these options: \ndrug, alcohol", "maxLength": "Test Type must not exceed 25 characters", "minLength": "Test Type must contain at least undefined characters", "type": "Test Type must be string " } }, "notes": { "type": "string", "maxLength": 500, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 500 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "code", "typeOfTest", "testType" ] }, "AdminQuestDiagnosticsUnitCodesUpdateData": { "title": "AdminQuestDiagnosticsUnitCodesUpdateData", "type": "object", "properties": { "code": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Code must be one of these options: \nundefined", "maxLength": "Code must not exceed 255 characters", "minLength": "Code must contain at least undefined characters", "type": "Code must be string " } }, "typeOfTest": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Type Of Test must be one of these options: \nundefined", "maxLength": "Type Of Test must not exceed 255 characters", "minLength": "Type Of Test must contain at least undefined characters", "type": "Type Of Test must be string " } }, "testType": { "type": "string", "enum": [ "drug", "alcohol" ], "maxLength": 25, "errorMessage": { "enum": "Test Type must be one of these options: \ndrug, alcohol", "maxLength": "Test Type must not exceed 25 characters", "minLength": "Test Type must contain at least undefined characters", "type": "Test Type must be string " } }, "notes": { "type": "string", "maxLength": 500, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 500 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false }, "AdminProviderDto": { "title": "AdminProviderDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "description": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 255 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string " } }, "key": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Key must be one of these options: \nundefined", "maxLength": "Key must not exceed 120 characters", "minLength": "Key must contain at least undefined characters", "type": "Key must be string " } }, "category": { "type": "string", "enum": [ "eld", "factoring", "fuel", "other" ] }, "connectionType": { "type": "string", "enum": [ "self_serve", "request", "webhook" ] }, "isEnabled": { "type": "boolean" }, "logo": { "type": "string", "maxLength": 500, "errorMessage": { "enum": "Logo must be one of these options: \nundefined", "maxLength": "Logo must not exceed 500 characters", "minLength": "Logo must contain at least undefined characters", "type": "Logo must be string " } }, "sortOrder": { "type": "number" } }, "additionalProperties": false, "required": [ "name", "key", "category", "connectionType" ], "errorMessage": { "required": { "name": "Name is required", "key": "Key is required", "category": "Category is required", "connectionType": "Connection type is required" } } }, "AdminProviderEditDto": {}, "Places": { "title": "Places", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "phoneNumber": { "type": "string" }, "address": { "type": "string" }, "highwayRoute": { "type": "string" }, "municipal": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" }, "milePost": { "type": "number" }, "stateNumber": { "type": "number" }, "lat": { "type": "number" }, "lng": { "type": "number" } }, "additionalProperties": false }, "AdminScheduleDriverPaymentDto": { "title": "AdminScheduleDriverPaymentDto", "type": "object", "properties": { "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "everyDay": { "type": "boolean", "nullable": true }, "everyWeek": { "type": "boolean", "nullable": true }, "everyOtherWeek": { "type": "boolean", "nullable": true }, "everyMonth": { "type": "boolean", "nullable": true }, "annually": { "type": "boolean", "nullable": true }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "startDate": { "type": "string", "format": "date", "errorMessage": { "type": "Start Date must be date ", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "errorMessage": { "type": "End Date must be date ", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "scheduleName": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Schedule Name must be one of these options: \nundefined", "maxLength": "Schedule Name must not exceed 72 characters", "minLength": "Schedule Name must contain at least undefined characters", "type": "Schedule Name must be string or null" } }, "addition": { "type": "boolean", "nullable": true }, "deduction": { "type": "boolean", "nullable": true }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "startDate", "endDate", "categoryId", "amount", "driverId" ], "errorMessage": { "required": { "startDate": "Start date is required", "endDate": "End date is required", "categoryId": "Category is required", "amount": "Amount is required", "driverId": "Driver is required" } } }, "AdminScheduleDriverPaymentEditDto": { "title": "AdminScheduleDriverPaymentEditDto", "type": "object", "properties": { "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "everyDay": { "type": "boolean", "nullable": true }, "everyWeek": { "type": "boolean", "nullable": true }, "everyOtherWeek": { "type": "boolean", "nullable": true }, "everyMonth": { "type": "boolean", "nullable": true }, "annually": { "type": "boolean", "nullable": true }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "startDate": { "type": "string", "format": "date", "errorMessage": { "type": "Start Date must be date ", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "errorMessage": { "type": "End Date must be date ", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "scheduleName": { "type": "string", "maxLength": 72, "nullable": true, "errorMessage": { "enum": "Schedule Name must be one of these options: \nundefined", "maxLength": "Schedule Name must not exceed 72 characters", "minLength": "Schedule Name must contain at least undefined characters", "type": "Schedule Name must be string or null" } }, "addition": { "type": "boolean", "nullable": true }, "deduction": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "required": [ "startDate", "endDate", "categoryId", "amount" ], "errorMessage": { "required": { "startDate": "Start date is required", "endDate": "End date is required", "categoryId": "Category is required", "amount": "Amount is required" } } }, "New Billing": { "title": "New Billing", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Billing', exclude: [ 'id' ] })", "properties": { "amount": { "type": "number" }, "weeklyAmount": { "type": "number" }, "workingDay": { "type": "number" }, "isActive": { "type": "boolean" }, "isUsed": { "type": "boolean" }, "isFreightDeduction": { "type": "boolean" }, "isLoad": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isAdvancePayment": { "type": "boolean" }, "isPaid": { "type": "boolean" }, "isPayment": { "type": "boolean" }, "type": { "type": "string" }, "notes": { "type": "string" }, "description": { "type": "string" }, "loadBillingStatus": { "type": "string" }, "loadStatus": { "type": "string" }, "loadNumber": { "type": "string" }, "from": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "date": { "type": "string", "format": "date-time" }, "loadDeliveryDate": { "type": "string", "format": "date-time" }, "isAddedToContractor": { "type": "boolean" }, "isArchivedToContractor": { "type": "boolean" }, "isPaidToContractor": { "type": "boolean" }, "contractorSettlementId": { "type": "string" }, "stopId": { "type": "string" }, "load_service_id": { "type": "string" }, "brokerId": { "type": "string" }, "companyId": { "type": "string" }, "options": { "type": "object" }, "loadId": { "type": "string" }, "settlementId": { "type": "string" }, "billingPaymentId": { "type": "string" }, "expenseId": { "type": "string" }, "chargeId": { "type": "string" }, "unitId": { "type": "string" }, "driverId": { "type": "string" }, "contractorId": { "type": "string" }, "scheduleId": { "type": "string" }, "scheduledPaymentId": { "type": "string" }, "categoryId": { "type": "string" }, "fuelTransactionId": { "type": "string" }, "tollTransactionId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BillingPayment": { "title": "BillingPayment", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "isUsed": { "type": "boolean" }, "billingPaymentType": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "from": { "type": "string" }, "amount": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "companyId": { "type": "string" }, "expenseId": { "type": "string" }, "dispatcherId": { "type": "string" }, "categoryId": { "type": "string" }, "vendorId": { "type": "string" }, "driverId": { "type": "string" }, "contractorId": { "type": "string" }, "settlementId": { "type": "string" }, "contractorSettlementId": { "type": "string" }, "createdBy": { "type": "string" }, "status": { "type": "string" }, "dwollaTransferId": { "type": "string" }, "dwollaTransferStatus": { "type": "string" }, "dwollaTransferNotes": { "type": "string" }, "qbEntityId": { "type": "string" } }, "additionalProperties": false }, "Load": { "title": "Load", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "origin": { "type": "string" }, "deliveryAddress": { "type": "string" }, "notes": { "type": "string" }, "applied": { "type": "string" }, "orderNumber": { "type": "string" }, "purchaseOrderNumber": { "type": "string" }, "price": { "type": "number" }, "cancelPrice": { "type": "number" }, "mile": { "type": "number" }, "emptyMile": { "type": "number" }, "stopStatus": { "type": "string" }, "currentStop": { "type": "number" }, "stopCount": { "type": "number" }, "statusCode": { "type": "number" }, "isActive": { "type": "boolean" }, "puDateTo": { "type": "string", "format": "date-time" }, "puDateFrom": { "type": "string", "format": "date-time" }, "delDateTo": { "type": "string", "format": "date-time" }, "delDateFrom": { "type": "string", "format": "date-time" }, "lastStopCheckOutDate": { "type": "string", "format": "date-time" }, "driverPayOverriddenType": { "type": "string" }, "priceOverridden": { "type": "number" }, "percentageOverridden": { "type": "number" }, "perMileOverridden": { "type": "number" }, "perEmptyMileOverridden": { "type": "number" }, "mileOverridden": { "type": "number" }, "emptyMileOverridden": { "type": "number" }, "adjustmentPrice": { "type": "number" }, "completed": { "type": "string", "format": "date-time" }, "cancelled": { "type": "string", "format": "date-time" }, "assignedAt": { "type": "string", "format": "date-time" }, "dispatchedAt": { "type": "string", "format": "date-time" }, "driverLoadStarted": { "type": "boolean" }, "driverLoadRejected": { "type": "boolean" }, "driverLoadCompleted": { "type": "boolean" }, "reason": { "type": "string" }, "code": { "type": "number" }, "uniqueCode": { "type": "string" }, "roundTrip": { "type": "boolean" }, "isOverridden": { "type": "boolean" }, "isCompensation": { "type": "boolean" }, "isPickUpTime": { "type": "boolean" }, "isDelTime": { "type": "boolean" }, "isAdjustment": { "type": "boolean" }, "hasInvoice": { "type": "boolean" }, "calculatedPrice": { "type": "number" }, "isDispatched": { "type": "boolean" }, "billingStatus": { "type": "string" }, "totalTrip": { "type": "number" }, "status": { "type": "string" }, "calculatedData": { "type": "object" }, "brokerEmails": { "type": "array", "items": { "type": "string" } }, "trackingNumber": { "type": "string" }, "driverName": { "type": "string" }, "importSource": { "type": "string" }, "stopCheckIn": { "type": "number" }, "stopCheckOut": { "type": "number" }, "tollTagPrice": { "type": "number" }, "duration": { "type": "object" }, "rate": { "type": "number" }, "driverPay": { "type": "number" }, "coDriverPay": { "type": "number" }, "tollParam": { "type": "object" }, "amazonLoadId": { "type": "string" }, "hasBillingIssues": { "type": "boolean" }, "receivableId": { "type": "string" }, "companyId": { "type": "string" }, "brokerCompanyId": { "type": "string" }, "driverId": { "type": "string" }, "coDriverId": { "type": "string" }, "dispatcherId": { "type": "string" }, "unitId": { "type": "string" } }, "additionalProperties": false }, "AdminCreateGlobalBannerDto": { "title": "AdminCreateGlobalBannerDto", "type": "object", "properties": { "title": { "type": "string", "maxLength": 512, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 512 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string " } }, "message": { "type": "string", "errorMessage": { "enum": "Message must be one of these options: \nundefined", "maxLength": "Message must not exceed undefined characters", "minLength": "Message must contain at least undefined characters", "type": "Message must be string " } }, "type": { "type": "string", "enum": [ "info", "warning", "critical" ], "maxLength": 20, "errorMessage": { "enum": "Type must be one of these options: \ninfo, warning, critical", "maxLength": "Type must not exceed 20 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } } }, "additionalProperties": false, "required": [ "title", "message", "type" ] }, "AdminUpdateGlobalBannerDtoPartial": { "title": "AdminUpdateGlobalBannerDtoPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "title": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 512 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string or null" } }, "message": { "type": "string", "nullable": true, "errorMessage": { "enum": "Message must be one of these options: \nundefined", "maxLength": "Message must not exceed undefined characters", "minLength": "Message must contain at least undefined characters", "type": "Message must be string or null" } }, "type": { "type": "string", "enum": [ "info", "warning", "critical" ], "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \ninfo, warning, critical", "maxLength": "Type must not exceed 20 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AdminUpdateGlobalBannerDto": { "title": "AdminUpdateGlobalBannerDto", "type": "object", "properties": { "title": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Title must be one of these options: \nundefined", "maxLength": "Title must not exceed 512 characters", "minLength": "Title must contain at least undefined characters", "type": "Title must be string or null" } }, "message": { "type": "string", "nullable": true, "errorMessage": { "enum": "Message must be one of these options: \nundefined", "maxLength": "Message must not exceed undefined characters", "minLength": "Message must contain at least undefined characters", "type": "Message must be string or null" } }, "type": { "type": "string", "enum": [ "info", "warning", "critical" ], "maxLength": 20, "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \ninfo, warning, critical", "maxLength": "Type must not exceed 20 characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "AdminScheduleExpenseDto": { "title": "AdminScheduleExpenseDto", "type": "object", "properties": { "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "everyDay": { "type": "boolean", "nullable": true }, "everyWeek": { "type": "boolean", "nullable": true }, "everyOtherWeek": { "type": "boolean", "nullable": true }, "everyMonth": { "type": "boolean", "nullable": true }, "annually": { "type": "boolean", "nullable": true }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "startDate": { "type": "string", "format": "date", "errorMessage": { "type": "Start Date must be date ", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "repeat": { "type": "string", "enum": [ "always", "number_of_times", "until_the_date" ], "maxLength": 20, "errorMessage": { "enum": "Repeat must be one of these options: \nalways, number_of_times, until_the_date", "maxLength": "Repeat must not exceed 20 characters", "minLength": "Repeat must contain at least undefined characters", "type": "Repeat must be string " } }, "numberOfTimes": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Number Of Times cannot be lower than undefined", "maximum": "Number Of Times cannot be lower than undefined", "type": "Number Of Times must be number or null", "exclusiveMinimum": "Number Of Times must be greater than undefined" } }, "endDate": { "type": "string", "format": "date", "errorMessage": { "type": "End Date must be date ", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "startDate", "endDate", "categoryId", "amount" ], "errorMessage": { "required": { "startDate": "Start date is required", "endDate": "End date is required", "categoryId": "Category is required", "amount": "Amount is required" } } }, "AdminScheduleExpenseEditDto": { "title": "AdminScheduleExpenseEditDto", "type": "object", "properties": { "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "everyDay": { "type": "boolean", "nullable": true }, "everyWeek": { "type": "boolean", "nullable": true }, "everyOtherWeek": { "type": "boolean", "nullable": true }, "everyMonth": { "type": "boolean", "nullable": true }, "annually": { "type": "boolean", "nullable": true }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "startDate": { "type": "string", "format": "date", "errorMessage": { "type": "Start Date must be date ", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "repeat": { "type": "string", "enum": [ "always", "number_of_times", "until_the_date" ], "maxLength": 20, "errorMessage": { "enum": "Repeat must be one of these options: \nalways, number_of_times, until_the_date", "maxLength": "Repeat must not exceed 20 characters", "minLength": "Repeat must contain at least undefined characters", "type": "Repeat must be string " } }, "numberOfTimes": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Number Of Times cannot be lower than undefined", "maximum": "Number Of Times cannot be lower than undefined", "type": "Number Of Times must be number or null", "exclusiveMinimum": "Number Of Times must be greater than undefined" } }, "endDate": { "type": "string", "format": "date", "errorMessage": { "type": "End Date must be date ", "format": "EndDate must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false, "required": [ "startDate", "endDate", "categoryId", "amount" ], "errorMessage": { "required": { "startDate": "Start date is required", "endDate": "End date is required", "categoryId": "Category is required", "amount": "Amount is required" } } }, "New Expense": { "title": "New Expense", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Expense', exclude: [ 'id' ] })", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "isRecurring": { "type": "boolean" }, "balanceDue": { "type": "number" }, "amount": { "type": "number" }, "from": { "type": "string" }, "sourceId": { "type": "string" }, "metadata": { "type": "object" }, "vendorId": { "type": "string" }, "categoryId": { "type": "string" }, "createdById": { "type": "string" }, "qbEntityId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Update Expense": { "title": "Update Expense", "type": "object", "description": "(tsType: Omit, 'id' | 'companyId' | 'updatedAt'>, schemaOptions: { title: 'Update Expense', exclude: [ 'id', 'companyId', 'updatedAt' ], partial: true })", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "isRecurring": { "type": "boolean" }, "balanceDue": { "type": "number" }, "amount": { "type": "number" }, "from": { "type": "string" }, "sourceId": { "type": "string" }, "metadata": { "type": "object" }, "vendorId": { "type": "string" }, "categoryId": { "type": "string" }, "createdById": { "type": "string" }, "qbEntityId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'companyId' | 'updatedAt'>" }, "Expense": { "title": "Expense", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string" }, "notes": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "isRecurring": { "type": "boolean" }, "balanceDue": { "type": "number" }, "amount": { "type": "number" }, "from": { "type": "string" }, "sourceId": { "type": "string" }, "metadata": { "type": "object" }, "vendorId": { "type": "string" }, "categoryId": { "type": "string" }, "createdById": { "type": "string" }, "qbEntityId": { "type": "string" } }, "additionalProperties": false }, "AdminMarkAsPaidDto": { "title": "AdminMarkAsPaidDto", "type": "object", "properties": { "date": { "type": "string", "default": "2026-07-29T08:52:51.565Z", "errorMessage": { "type": "Date must be date " } }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "amount", "date" ], "errorMessage": { "required": { "amount": "Amount is required", "date": "Date is required" } } }, "AdminExpenseChargeDto": { "title": "AdminExpenseChargeDto", "type": "object", "properties": { "date": { "type": "string", "default": "2026-07-29T08:52:51.565Z", "errorMessage": { "type": "Date must be date " } }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "amount", "date" ], "errorMessage": { "required": { "amount": "Amount is required", "date": "Date is required" } } }, "CompanyDwollaSettingsData": { "title": "CompanyDwollaSettingsData", "type": "object", "properties": { "isRestrictedFromTransfers": { "type": "boolean" } }, "additionalProperties": false, "required": [ "isRestrictedFromTransfers" ], "errorMessage": { "required": { "isRestrictedFromTransfers": "Transfers restriction required" } } }, "TransferFromBalanceData": { "title": "TransferFromBalanceData", "type": "object", "properties": { "destinationFundingSourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Destination Funding Source Id must be a valid UUID" } }, "amount": { "$ref": "#/components/schemas/AmountData" } }, "additionalProperties": false, "required": [ "destinationFundingSourceId" ] }, "WebhookSubscriptionData": { "title": "WebhookSubscriptionData", "type": "object", "properties": { "url": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Url must be one of these options: \nundefined", "maxLength": "Url must not exceed 255 characters", "minLength": "Url must contain at least undefined characters", "type": "Url must be string " } }, "secret": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Secret must be one of these options: \nundefined", "maxLength": "Secret must not exceed 255 characters", "minLength": "Secret must contain at least undefined characters", "type": "Secret must be string " } } }, "additionalProperties": false, "required": [ "url", "secret" ], "errorMessage": { "required": { "url": "URL required", "secret": "Secret required" } } }, "SandboxSimulationsData": { "title": "SandboxSimulationsData", "type": "object", "properties": { "type": { "type": "string", "errorMessage": { "enum": "Type must be one of these options: \nundefined", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "_links": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "href": { "type": "string" } } } } }, "errorCode": { "type": "string", "errorMessage": { "enum": "Error Code must be one of these options: \nundefined", "maxLength": "Error Code must not exceed undefined characters", "minLength": "Error Code must contain at least undefined characters", "type": "Error Code must be string " } } }, "additionalProperties": false }, "AdminDriverReInviteDto": { "title": "AdminDriverReInviteDto", "type": "object", "properties": { "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "dispatcherId", "driverId" ], "errorMessage": { "required": { "dispatcherId": "Dispatcher is required", "driverId": "Driver is required" } } }, "AdminDriverDto": { "title": "AdminDriverDto", "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 120, "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed 120 characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string ", "format": "Email must be a valid email address" } }, "firstName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "First Name must be one of these options: \nundefined", "maxLength": "First Name must not exceed 255 characters", "minLength": "First Name must contain at least undefined characters", "type": "First Name must be string " } }, "secondName": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Second Name must be one of these options: \nundefined", "maxLength": "Second Name must not exceed 255 characters", "minLength": "Second Name must contain at least undefined characters", "type": "Second Name must be string " } }, "driverType": { "type": "string", "enum": [ "owner", "company" ], "maxLength": 72, "errorMessage": { "enum": "Driver Type must be one of these options: \nowner, company", "maxLength": "Driver Type must not exceed 72 characters", "minLength": "Driver Type must contain at least undefined characters", "type": "Driver Type must be string " } }, "phone": { "type": "string", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed undefined characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string " } }, "address": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string or null" } }, "address1": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address1 must be one of these options: \nundefined", "maxLength": "Address1 must not exceed 255 characters", "minLength": "Address1 must contain at least undefined characters", "type": "Address1 must be string or null" } }, "address2": { "type": "string", "maxLength": 255, "nullable": true, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string or null" } }, "zipCode": { "type": "string", "maxLength": 32, "nullable": true, "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed 32 characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string or null" } }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "city": { "type": "string", "maxLength": 150, "nullable": true, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string or null" } }, "state": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string or null" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "payment": { "$ref": "#/components/schemas/DriverPaymentObj" }, "payPeriod": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "maxLength": 55, "errorMessage": { "enum": "Pay Period must be one of these options: \ndaily, weekly, monthly", "maxLength": "Pay Period must not exceed 55 characters", "minLength": "Pay Period must contain at least undefined characters", "type": "Pay Period must be string " } }, "TWICCard": { "type": "boolean" }, "tankerEndorsed": { "type": "boolean" }, "HazMatCertified": { "type": "boolean" }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } }, "isActive": { "type": "boolean" } }, "additionalProperties": false, "required": [ "firstName", "secondName", "email", "phone", "companyId" ], "errorMessage": { "required": { "firstName": "First name is required", "secondName": "Last name is required", "email": "Email is required", "phone": "Phone is required", "companyId": "Company is required" } } }, "Update Driver": { "title": "Update Driver", "type": "object", "description": "(tsType: Omit, 'id'>, schemaOptions: { title: 'Update Driver', exclude: [ 'id' ], partial: true })", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "truckNumber": { "type": "string" }, "middleName": { "type": "string" }, "importId": { "type": "number" }, "driverType": { "type": "string" }, "payment": { "type": "object", "properties": { "perMile": { "type": "number" }, "perEmptyMile": { "type": "number" }, "perHour": { "type": "number" }, "percentage": { "type": "number" }, "perExtraStop": { "type": "number" }, "flatPay": { "type": "number" }, "type": { "type": "number" } } }, "driverOwnCompany": { "type": "object" }, "coDriverId": { "type": "string" }, "companyId": { "type": "string" }, "userId": { "type": "string" }, "payPeriod": { "type": "string" }, "payPeriodDate": { "type": "string", "format": "date-time" }, "TWICCard": { "type": "boolean" }, "tankerEndorsed": { "type": "boolean" }, "HazMatCertified": { "type": "boolean" }, "activityStatus": { "type": "string" }, "dwollaCustomerId": { "type": "string" }, "eldId": { "type": "string" }, "transparentRemoteId": { "type": "string" }, "source": { "type": "string" }, "emergencyName": { "type": "string" }, "emergencyContact": { "type": "string" }, "licenseNumber": { "type": "string" }, "licenseNumberLast4": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isRejected": { "type": "boolean" }, "isHiredViaRecruitment": { "type": "boolean" }, "showNetPay": { "type": "boolean" }, "qbEntityId": { "type": "string" }, "location": { "type": "object" }, "newRecruitmentId": { "type": "string" }, "unitId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id'>" }, "Driver": { "title": "Driver", "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "truckNumber": { "type": "string" }, "middleName": { "type": "string" }, "importId": { "type": "number" }, "driverType": { "type": "string" }, "payment": { "type": "object", "properties": { "perMile": { "type": "number" }, "perEmptyMile": { "type": "number" }, "perHour": { "type": "number" }, "percentage": { "type": "number" }, "perExtraStop": { "type": "number" }, "flatPay": { "type": "number" }, "type": { "type": "number" } } }, "driverOwnCompany": { "type": "object" }, "coDriverId": { "type": "string" }, "companyId": { "type": "string" }, "userId": { "type": "string" }, "payPeriod": { "type": "string" }, "payPeriodDate": { "type": "string", "format": "date-time" }, "TWICCard": { "type": "boolean" }, "tankerEndorsed": { "type": "boolean" }, "HazMatCertified": { "type": "boolean" }, "activityStatus": { "type": "string" }, "dwollaCustomerId": { "type": "string" }, "eldId": { "type": "string" }, "transparentRemoteId": { "type": "string" }, "source": { "type": "string" }, "emergencyName": { "type": "string" }, "emergencyContact": { "type": "string" }, "licenseNumber": { "type": "string" }, "licenseNumberLast4": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isRejected": { "type": "boolean" }, "isHiredViaRecruitment": { "type": "boolean" }, "showNetPay": { "type": "boolean" }, "qbEntityId": { "type": "string" }, "location": { "type": "object" }, "newRecruitmentId": { "type": "string" }, "unitId": { "type": "string" } }, "additionalProperties": false }, "NewUser": { "title": "NewUser", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewUser', exclude: [ 'id' ] })", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "password": { "type": "string" }, "hometown": { "type": "string" }, "signUpType": { "type": "string" }, "dwollaCustomerId": { "type": "string" }, "middleName": { "type": "string" }, "config": { "type": "object" }, "settings": { "type": "object" } }, "required": [ "email" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "UserPartial": { "title": "UserPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "password": { "type": "string" }, "hometown": { "type": "string" }, "signUpType": { "type": "string" }, "dwollaCustomerId": { "type": "string" }, "middleName": { "type": "string" }, "config": { "type": "object" }, "settings": { "type": "object" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "User": { "title": "User", "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "password": { "type": "string" }, "hometown": { "type": "string" }, "signUpType": { "type": "string" }, "dwollaCustomerId": { "type": "string" }, "middleName": { "type": "string" }, "config": { "type": "object" }, "settings": { "type": "object" } }, "required": [ "email" ], "additionalProperties": false }, "AdminAddToDisPermissionIds": { "title": "AdminAddToDisPermissionIds", "type": "object", "properties": { "permissionIds": { "type": "array", "items": { "type": "number", "errorMessage": { "type": "Permission Ids must be array " } } }, "roleId": { "type": "number", "errorMessage": { "minimum": "Role Id cannot be lower than undefined", "maximum": "Role Id cannot be lower than undefined", "type": "Role Id must be number ", "exclusiveMinimum": "Role Id must be greater than undefined" } } }, "additionalProperties": false, "required": [ "permissionIds" ], "errorMessage": { "required": { "permissionIds": "Permissions is required" } } }, "New Dispatcher": { "title": "New Dispatcher", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Dispatcher', exclude: [ 'id', 'verificationToken', 'profilePhoto', 'activated', 'terminated', 'createdAt', 'updatedAt', 'config', 'password' ] })", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "twoStepEnabled": { "type": "boolean" }, "isSupport": { "type": "boolean" }, "referralCode": { "type": "string" }, "referralPoints": { "type": "number" }, "lastActiveAt": { "type": "string", "format": "date-time" } }, "required": [ "email" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "Update Dispatcher": { "title": "Update Dispatcher", "type": "object", "description": "(tsType: Omit, 'id' | 'verificationToken' | 'config' | 'profilePhoto'>, schemaOptions: { title: 'Update Dispatcher', exclude: [ 'id', 'verificationToken', 'config', 'profilePhoto' ], partial: true })", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "password": { "type": "string" }, "twoStepEnabled": { "type": "boolean" }, "isSupport": { "type": "boolean" }, "referralCode": { "type": "string" }, "referralPoints": { "type": "number" }, "lastActiveAt": { "type": "string", "format": "date-time" }, "isDefault": { "type": "boolean" }, "companyId": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Company Id must be one of these options: \nundefined", "maxLength": "Company Id must not exceed 36 characters", "minLength": "Company Id must contain at least undefined characters", "type": "Company Id must be string " } }, "confirmPassword": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least undefined characters", "type": "Confirm Password must be string " } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'verificationToken' | 'config' | 'profilePhoto'>" }, "AdminDispatcherUpdateDto": { "title": "AdminDispatcherUpdateDto", "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "secondName": { "type": "string" }, "phone": { "type": "string" }, "notes": { "type": "string" }, "verificationToken": { "type": "string" }, "address": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "dateBirth": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "profilePhoto": { "type": "string" }, "isActive": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "terminated": { "type": "string", "format": "date-time" }, "activated": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "password": { "type": "string" }, "config": { "type": "object" }, "twoStepEnabled": { "type": "boolean" }, "isSupport": { "type": "boolean" }, "referralCode": { "type": "string" }, "referralPoints": { "type": "number" }, "lastActiveAt": { "type": "string", "format": "date-time" }, "isDefault": { "type": "boolean" }, "companyId": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Company Id must be one of these options: \nundefined", "maxLength": "Company Id must not exceed 36 characters", "minLength": "Company Id must contain at least undefined characters", "type": "Company Id must be string " } }, "confirmPassword": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least undefined characters", "type": "Confirm Password must be string " } } }, "required": [ "email" ], "additionalProperties": false }, "AdminDispatcherEditPasswordDto": { "title": "AdminDispatcherEditPasswordDto", "type": "object", "properties": { "password": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Password must be one of these options: \nundefined", "maxLength": "Password must not exceed 255 characters", "minLength": "Password must contain at least undefined characters", "type": "Password must be string " } }, "confirmPassword": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Confirm Password must be one of these options: \nundefined", "maxLength": "Confirm Password must not exceed 255 characters", "minLength": "Confirm Password must contain at least undefined characters", "type": "Confirm Password must be string " } } }, "additionalProperties": false, "required": [ "password", "confirmPassword" ], "errorMessage": { "required": { "password": "Password is required", "confirmPassword": "Password confirmation is required" } } }, "AdminDeviceCreateDto": { "title": "AdminDeviceCreateDto", "type": "object", "properties": { "model": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "Model must be one of these options: \nundefined", "maxLength": "Model must not exceed 55 characters", "minLength": "Model must contain at least undefined characters", "type": "Model must be string " } }, "androidVersion": { "type": "string", "maxLength": 20, "errorMessage": { "enum": "Android Version must be one of these options: \nundefined", "maxLength": "Android Version must not exceed 20 characters", "minLength": "Android Version must contain at least undefined characters", "type": "Android Version must be string " } }, "iosVersion": { "type": "string", "maxLength": 20, "errorMessage": { "enum": "Ios Version must be one of these options: \nundefined", "maxLength": "Ios Version must not exceed 20 characters", "minLength": "Ios Version must contain at least undefined characters", "type": "Ios Version must be string " } }, "oneSignalUserId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "One Signal User Id must be a valid UUID" } }, "appVersion": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "App Version must be one of these options: \nundefined", "maxLength": "App Version must not exceed 50 characters", "minLength": "App Version must contain at least undefined characters", "type": "App Version must be string " } }, "versionCode": { "type": "string", "maxLength": 36, "errorMessage": { "enum": "Version Code must be one of these options: \nundefined", "maxLength": "Version Code must not exceed 36 characters", "minLength": "Version Code must contain at least undefined characters", "type": "Version Code must be string " } }, "tagId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Tag Id must be a valid UUID" } }, "userId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "User Id must be a valid UUID" } }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [] }, "Device": { "title": "Device", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "appVersion": { "type": "string" }, "deviceId": { "type": "string" }, "fcmToken": { "type": "string" }, "model": { "type": "string" }, "osVersion": { "type": "string" }, "type": { "type": "string" }, "versionCode": { "type": "string" }, "isActive": { "type": "boolean" }, "notification": { "type": "boolean" }, "dispatcherId": { "type": "string" }, "userId": { "type": "string" } }, "additionalProperties": false }, "AdminCustomerCreateDto": { "title": "AdminCustomerCreateDto", "type": "object", "properties": { "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "isActive": { "type": "boolean", "nullable": true }, "lat": { "type": "number", "format": "float", "errorMessage": { "type": "Lat must be number ", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "format": "float", "errorMessage": { "type": "Lng must be number ", "exclusiveMinimum": "Lng must be greater than undefined" } }, "zipCodes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed undefined characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string " } }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "companyId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Company Id must be one of these options: \nundefined", "maxLength": "Company Id must not exceed undefined characters", "minLength": "Company Id must contain at least undefined characters", "type": "Company Id must be string " } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } } }, "additionalProperties": false, "required": [] }, "AdminCustomerUpdateDto": { "title": "AdminCustomerUpdateDto", "type": "object", "properties": { "address": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed 255 characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "address2": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Address2 must be one of these options: \nundefined", "maxLength": "Address2 must not exceed 255 characters", "minLength": "Address2 must contain at least undefined characters", "type": "Address2 must be string " } }, "name": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 255 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "isActive": { "type": "boolean", "nullable": true }, "lat": { "type": "number", "format": "float", "errorMessage": { "type": "Lat must be number ", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "format": "float", "errorMessage": { "type": "Lng must be number ", "exclusiveMinimum": "Lng must be greater than undefined" } }, "zipCodes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Zip Codes must be one of these options: \nundefined", "maxLength": "Zip Codes must not exceed undefined characters", "minLength": "Zip Codes must contain at least undefined characters", "type": "Zip Codes must be string " } }, "notes": { "type": "string", "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed undefined characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "companyId": { "type": "string", "maxLength": 36, "nullable": true, "errorMessage": { "enum": "Company Id must be one of these options: \nundefined", "maxLength": "Company Id must not exceed undefined characters", "minLength": "Company Id must contain at least undefined characters", "type": "Company Id must be string " } }, "phone": { "type": "string", "maxLength": 20, "pattern": "^\\([0-9]{3}\\) [0-9]{3}-[0-9]{4}$", "errorMessage": { "enum": "Phone must be one of these options: \nundefined", "maxLength": "Phone must not exceed 20 characters", "minLength": "Phone must contain at least undefined characters", "type": "Phone must be string ", "pattern": "Phone must follow the '(###) ###-####' pattern" } }, "placeId": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Place Id must be one of these options: \nundefined", "maxLength": "Place Id must not exceed 512 characters", "minLength": "Place Id must contain at least undefined characters", "type": "Place Id must be string or null" } }, "zipCodeId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": false, "errorMessage": { "pattern": "Zip Code Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "name", "address", "city", "state" ] }, "New Customer": { "title": "New Customer", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Customer', exclude: [ 'id' ] })", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "notes": { "type": "string" }, "zipCodes": { "type": "string" }, "placeId": { "type": "string" }, "companyId": { "type": "string" }, "lat": { "type": "number" }, "lng": { "type": "number" }, "coordinates": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Contact": { "title": "Contact", "type": "object", "properties": { "id": { "type": "string" }, "fullName": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "email": { "type": "string" }, "notes": { "type": "string" }, "role": { "type": "string" }, "companyId": { "type": "string" }, "brokerCompanyId": { "type": "string" }, "customerId": { "type": "string" }, "vendorId": { "type": "string" } }, "additionalProperties": false }, "New Contact": { "title": "New Contact", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Contact', exclude: [ 'id' ] })", "properties": { "fullName": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "email": { "type": "string" }, "notes": { "type": "string" }, "role": { "type": "string" }, "companyId": { "type": "string" }, "brokerCompanyId": { "type": "string" }, "customerId": { "type": "string" }, "vendorId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Update Customer": { "title": "Update Customer", "type": "object", "description": "(tsType: Omit, 'id'>, schemaOptions: { title: 'Update Customer', exclude: [ 'id' ], partial: true })", "properties": { "fullName": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "email": { "type": "string" }, "notes": { "type": "string" }, "role": { "type": "string" }, "companyId": { "type": "string" }, "brokerCompanyId": { "type": "string" }, "customerId": { "type": "string" }, "vendorId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id'>" }, "Create Company": { "title": "Create Company", "type": "object", "description": "(tsType: Omit, 'id' | 'updatedAt' | 'createdAt' | 'updatedAt' | 'originalLogo' | 'terminalAddress' | 'settings' | 'payForDispatcher' | 'isActive' | 'subscriptionCount' | 'stripeCustomerId' | 'stripeSubscriptionId' | 'stripeBillingConfigurationId' | 'stripe' | 'contacts' | 'joinedByReferralCode' | 'referralCreditBalance' | 'referredByDispatcherId' | 'referralCodeUsed'>, schemaOptions: { title: 'Create Company', exclude: [ 'id', 'updatedAt', 'createdAt', 'updatedAt', 'originalLogo', 'terminalAddress', 'settings', 'payForDispatcher', 'isActive', 'subscriptionCount', 'stripeCustomerId', 'stripeSubscriptionId', 'stripeBillingConfigurationId', 'stripe', 'contacts', 'joinedByReferralCode', 'referralCreditBalance', 'referredByDispatcherId', 'referralCodeUsed' ], partial: true })", "properties": { "name": { "type": "string" }, "usernamePrefix": { "type": "string" }, "email": { "type": "string" }, "tz": { "type": "object" }, "phone": { "type": "string" }, "address": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "chatId": { "type": "string" }, "postCode": { "type": "string" }, "fax": { "type": "string" }, "mc": { "type": "string" }, "taxId": { "type": "string" }, "fid": { "type": "string" }, "factoringCompany": { "type": "string" }, "typeOfTaxForDriver": { "type": "string" }, "logo": { "type": "string" }, "safetyEmail": { "type": "string" }, "startOfWeek": { "type": "string" }, "usdot": { "type": "string" }, "fmcsaStatus": { "type": "string" }, "fmcsaVerified": { "type": "boolean" }, "fmcsaSnapshot": { "type": "object" }, "fmcsaLastRefreshedAt": { "type": "string", "format": "date-time" }, "fmcsaNextRefreshAt": { "type": "string", "format": "date-time" }, "fmcsaRefreshLeaseUntil": { "type": "string", "format": "date-time" }, "fmcsaLastRefreshAttemptAt": { "type": "string", "format": "date-time" }, "fmcsaLastRefreshFailedAt": { "type": "string", "format": "date-time" }, "fmcsaLastRefreshError": { "type": "string" }, "fmcsaVerifiedAt": { "type": "string", "format": "date-time" }, "fmcsaConsecutiveRefreshFailures": { "type": "number" }, "clearinghouseIsRegistered": { "type": "boolean" }, "clearinghouseQueryBalance": { "type": "number" }, "clearinghouseBalanceLastRefreshedAt": { "type": "string", "format": "date-time" }, "onboardingCompleted": { "type": "boolean" }, "dwollaCustomerId": { "type": "string" }, "dwollaEmail": { "type": "string" }, "dwollaTransferLimit": { "type": "string" }, "isRestrictedFromTransfers": { "type": "boolean" }, "questLabAccount": { "type": "number" }, "rtsCredentials": { "type": "object" }, "triumphCredentials": { "type": "object" }, "accountingEmail": { "type": "string" }, "mainContactPerson": { "type": "string" }, "contactTitle": { "type": "string" }, "dispatchEmail": { "type": "string" }, "supportEmail": { "type": "string" }, "website": { "type": "string" }, "minimumDrivingExperienceMonths": { "type": "number" }, "minimumDriverAge": { "type": "number" }, "ownerId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'updatedAt' | 'createdAt' | 'updatedAt' | 'originalLogo' | 'terminalAddress' | 'settings' | 'payForDispatcher' | 'isActive' | 'subscriptionCount' | 'stripeCustomerId' | 'stripeSubscriptionId' | 'stripeBillingConfigurationId' | 'stripe' | 'contacts' | 'joinedByReferralCode' | 'referralCreditBalance' | 'referredByDispatcherId' | 'referralCodeUsed'>" }, "AdminCompanyInviteTDispatcher": { "title": "AdminCompanyInviteTDispatcher", "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 120, "format": "email" }, "role": { "type": "string", "enum": [ "owner", "company_manager", "operation_manager", "dispatcher", "accounting", "safety", "maintenance", "recruitment", "read_only" ], "maxLength": 36 }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "email", "role" ] }, "Edit Company": { "title": "Edit Company", "type": "object", "description": "(tsType: Omit, 'id' | 'updatedAt' | 'createdAt' | 'joinedByReferralCode' | 'referralCreditBalance' | 'referredByDispatcherId' | 'referralCodeUsed'>, schemaOptions: { title: 'Edit Company', exclude: [ 'id', 'updatedAt', 'createdAt', 'joinedByReferralCode', 'referralCreditBalance', 'referredByDispatcherId', 'referralCodeUsed' ], partial: true })", "properties": { "name": { "type": "string" }, "usernamePrefix": { "type": "string" }, "email": { "type": "string" }, "tz": { "type": "object" }, "phone": { "type": "string" }, "address": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "zipCode": { "type": "string" }, "chatId": { "type": "string" }, "postCode": { "type": "string" }, "fax": { "type": "string" }, "mc": { "type": "string" }, "taxId": { "type": "string" }, "fid": { "type": "string" }, "factoringCompany": { "type": "string" }, "typeOfTaxForDriver": { "type": "string" }, "logo": { "type": "string" }, "originalLogo": { "type": "string" }, "safetyEmail": { "type": "string" }, "startOfWeek": { "type": "string" }, "terminalAddress": { "type": "string" }, "usdot": { "type": "string" }, "fmcsaStatus": { "type": "string" }, "fmcsaVerified": { "type": "boolean" }, "fmcsaSnapshot": { "type": "object" }, "fmcsaLastRefreshedAt": { "type": "string", "format": "date-time" }, "fmcsaNextRefreshAt": { "type": "string", "format": "date-time" }, "fmcsaRefreshLeaseUntil": { "type": "string", "format": "date-time" }, "fmcsaLastRefreshAttemptAt": { "type": "string", "format": "date-time" }, "fmcsaLastRefreshFailedAt": { "type": "string", "format": "date-time" }, "fmcsaLastRefreshError": { "type": "string" }, "fmcsaVerifiedAt": { "type": "string", "format": "date-time" }, "fmcsaConsecutiveRefreshFailures": { "type": "number" }, "clearinghouseIsRegistered": { "type": "boolean" }, "clearinghouseQueryBalance": { "type": "number" }, "clearinghouseBalanceLastRefreshedAt": { "type": "string", "format": "date-time" }, "settings": { "type": "object" }, "payForDispatcher": { "type": "boolean" }, "isActive": { "type": "boolean" }, "onboardingCompleted": { "type": "boolean" }, "subscriptionCount": { "type": "number" }, "stripeCustomerId": { "type": "string" }, "stripeSubscriptionId": { "type": "string" }, "stripeBillingConfigurationId": { "type": "string" }, "stripe": { "type": "object" }, "dwollaCustomerId": { "type": "string" }, "dwollaEmail": { "type": "string" }, "dwollaTransferLimit": { "type": "string" }, "isRestrictedFromTransfers": { "type": "boolean" }, "contacts": { "type": "object" }, "questLabAccount": { "type": "number" }, "rtsCredentials": { "type": "object" }, "triumphCredentials": { "type": "object" }, "accountingEmail": { "type": "string" }, "mainContactPerson": { "type": "string" }, "contactTitle": { "type": "string" }, "dispatchEmail": { "type": "string" }, "supportEmail": { "type": "string" }, "website": { "type": "string" }, "minimumDrivingExperienceMonths": { "type": "number" }, "minimumDriverAge": { "type": "number" }, "ownerId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'updatedAt' | 'createdAt' | 'joinedByReferralCode' | 'referralCreditBalance' | 'referredByDispatcherId' | 'referralCodeUsed'>" }, "AdminClearingHouseQueryRequestUpdateDto": { "title": "AdminClearingHouseQueryRequestUpdateDto", "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "processing", "completed", "cancelled" ], "maxLength": 24, "errorMessage": { "enum": "Status must be one of these options: \npending, processing, completed, cancelled", "maxLength": "Status must not exceed 24 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "queryType": { "type": "string", "enum": [ "full_query", "limited_query" ], "maxLength": 55, "nullable": true, "errorMessage": { "enum": "Query Type must be one of these options: \nfull_query, limited_query", "maxLength": "Query Type must not exceed 55 characters", "minLength": "Query Type must contain at least undefined characters", "type": "Query Type must be string or null" } }, "queryId": { "type": "string", "maxLength": 55, "nullable": true, "errorMessage": { "enum": "Query Id must be one of these options: \nundefined", "maxLength": "Query Id must not exceed 55 characters", "minLength": "Query Id must contain at least undefined characters", "type": "Query Id must be string or null" } }, "dateCompleted": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Date Completed must be date or null", "format": "DateCompleted must be a valid date (YYYY-MM-DD)" } }, "isDriverProhibited": { "type": "boolean", "nullable": true }, "queryPlanBalance": { "type": "number", "nullable": true, "errorMessage": { "minimum": "Query Plan Balance cannot be lower than undefined", "maximum": "Query Plan Balance cannot be lower than undefined", "type": "Query Plan Balance must be number or null", "exclusiveMinimum": "Query Plan Balance must be greater than undefined" } }, "nationalRegistryNumber": { "type": "number", "nullable": true, "errorMessage": { "minimum": "National Registry Number cannot be lower than undefined", "maximum": "National Registry Number cannot be lower than undefined", "type": "National Registry Number must be number or null", "exclusiveMinimum": "National Registry Number must be greater than undefined" } }, "adminNote": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Admin Note must be one of these options: \nundefined", "maxLength": "Admin Note must not exceed 1000 characters", "minLength": "Admin Note must contain at least undefined characters", "type": "Admin Note must be string or null" } } }, "additionalProperties": false, "required": [ "status" ], "errorMessage": { "required": { "status": "Status is required" } } }, "AdminClaimDto": { "title": "AdminClaimDto", "type": "object", "properties": { "faultParty": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Fault Party must be one of these options: \nundefined", "maxLength": "Fault Party must not exceed 255 characters", "minLength": "Fault Party must contain at least undefined characters", "type": "Fault Party must be string " } }, "policyNumber": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Policy Number must be one of these options: \nundefined", "maxLength": "Policy Number must not exceed 50 characters", "minLength": "Policy Number must contain at least undefined characters", "type": "Policy Number must be string " } }, "status": { "type": "string", "enum": [ "open", "submitted", "in-progress", "paid", "cancelled", "closed" ], "maxLength": 50, "errorMessage": { "enum": "Status must be one of these options: \nopen, submitted, in-progress, paid, cancelled, closed", "maxLength": "Status must not exceed 50 characters", "minLength": "Status must contain at least undefined characters", "type": "Status must be string " } }, "lossStatus": { "type": "string", "enum": [ "paid", "not_paid" ], "maxLength": 50, "errorMessage": { "enum": "Loss Status must be one of these options: \npaid, not_paid", "maxLength": "Loss Status must not exceed 50 characters", "minLength": "Loss Status must contain at least undefined characters", "type": "Loss Status must be string " } }, "insuranceCompany": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Insurance Company must be one of these options: \nundefined", "maxLength": "Insurance Company must not exceed 50 characters", "minLength": "Insurance Company must contain at least undefined characters", "type": "Insurance Company must be string " } }, "coi": { "type": "string", "maxLength": 50, "errorMessage": { "enum": "Coi must be one of these options: \nundefined", "maxLength": "Coi must not exceed 50 characters", "minLength": "Coi must contain at least undefined characters", "type": "Coi must be string " } }, "accidentId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Accident Id must be a valid UUID" } }, "adjuster": { "$ref": "#/components/schemas/ClaimAdjuster" }, "loss": { "$ref": "#/components/schemas/ClaimBillingDto" }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false }, "AdminCityCreateDto": { "title": "AdminCityCreateDto", "type": "object", "properties": { "city": { "type": "string", "maxLength": 150, "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed 150 characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed 55 characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "lat": { "type": "number", "format": "float", "errorMessage": { "type": "Lat must be number ", "exclusiveMinimum": "Lat must be greater than undefined" } }, "lng": { "type": "number", "format": "float", "errorMessage": { "type": "Lng must be number ", "exclusiveMinimum": "Lng must be greater than undefined" } }, "zips": { "type": "string", "errorMessage": { "enum": "Zips must be one of these options: \nundefined", "maxLength": "Zips must not exceed undefined characters", "minLength": "Zips must contain at least undefined characters", "type": "Zips must be string " } }, "timezone": { "type": "string", "maxLength": 55, "errorMessage": { "enum": "Timezone must be one of these options: \nundefined", "maxLength": "Timezone must not exceed 55 characters", "minLength": "Timezone must contain at least undefined characters", "type": "Timezone must be string " } } }, "additionalProperties": false, "required": [ "lat", "lng" ] }, "City": { "title": "City", "type": "object", "properties": { "id": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "lat": { "type": "number" }, "lng": { "type": "number" }, "zips": { "type": "string" }, "timezone": { "type": "string" }, "fullAddress": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "New Broker": { "title": "New Broker", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'New Broker', exclude: [ 'id' ] })", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "notes": { "type": "string" }, "zipCodes": { "type": "string" }, "placeId": { "type": "string" }, "companyId": { "type": "string" }, "email": { "type": "string" }, "website": { "type": "string" }, "mai_str": { "type": "string" }, "mai_zip": { "type": "string" }, "mc": { "type": "string" }, "nameDBA": { "type": "string" }, "dot": { "type": "string" }, "brokerClass": { "type": "string" }, "isCustom": { "type": "boolean" }, "qbEntityId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerCompany": { "title": "BrokerCompany", "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "isActive": { "type": "boolean" }, "phone": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "notes": { "type": "string" }, "zipCodes": { "type": "string" }, "placeId": { "type": "string" }, "companyId": { "type": "string" }, "email": { "type": "string" }, "website": { "type": "string" }, "mai_str": { "type": "string" }, "mai_zip": { "type": "string" }, "mc": { "type": "string" }, "nameDBA": { "type": "string" }, "dot": { "type": "string" }, "brokerClass": { "type": "string" }, "isCustom": { "type": "boolean" }, "qbEntityId": { "type": "string" } }, "additionalProperties": false }, "AdminBillingCreateDto": { "title": "AdminBillingCreateDto", "type": "object", "properties": { "amount": { "type": "number", "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "loadId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Load Id must be a valid UUID" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "date": { "type": "string", "nullable": false, "errorMessage": { "type": "Date must be date " } } }, "additionalProperties": false, "required": [ "driverId", "categoryId", "amount" ], "errorMessage": { "required": { "driverId": "Driver is required", "categoryId": "Category is required", "amount": "Amount is required" } } }, "Billing": { "title": "Billing", "type": "object", "properties": { "id": { "type": "string" }, "amount": { "type": "number" }, "weeklyAmount": { "type": "number" }, "workingDay": { "type": "number" }, "isActive": { "type": "boolean" }, "isUsed": { "type": "boolean" }, "isFreightDeduction": { "type": "boolean" }, "isLoad": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "isAdvancePayment": { "type": "boolean" }, "isPaid": { "type": "boolean" }, "isPayment": { "type": "boolean" }, "type": { "type": "string" }, "notes": { "type": "string" }, "description": { "type": "string" }, "loadBillingStatus": { "type": "string" }, "loadStatus": { "type": "string" }, "loadNumber": { "type": "string" }, "from": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "date": { "type": "string", "format": "date-time" }, "loadDeliveryDate": { "type": "string", "format": "date-time" }, "isAddedToContractor": { "type": "boolean" }, "isArchivedToContractor": { "type": "boolean" }, "isPaidToContractor": { "type": "boolean" }, "contractorSettlementId": { "type": "string" }, "stopId": { "type": "string" }, "load_service_id": { "type": "string" }, "brokerId": { "type": "string" }, "companyId": { "type": "string" }, "options": { "type": "object" }, "loadId": { "type": "string" }, "settlementId": { "type": "string" }, "billingPaymentId": { "type": "string" }, "expenseId": { "type": "string" }, "chargeId": { "type": "string" }, "unitId": { "type": "string" }, "driverId": { "type": "string" }, "contractorId": { "type": "string" }, "scheduleId": { "type": "string" }, "scheduledPaymentId": { "type": "string" }, "categoryId": { "type": "string" }, "fuelTransactionId": { "type": "string" }, "tollTransactionId": { "type": "string" } }, "additionalProperties": false }, "AdminAccidentDto": { "title": "AdminAccidentDto", "type": "object", "properties": { "accidentDate": { "type": "string", "format": "date-time", "errorMessage": { "type": "Accident Date must be date ", "format": "AccidentDate must be a valid date-time (ISO 8601)" } }, "date": { "type": "string", "format": "date-time", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date-time (ISO 8601)" } }, "withHazmat": { "type": "boolean" }, "policeInvolved": { "type": "boolean" }, "towingInvolved": { "type": "boolean" }, "emergencyInvolved": { "type": "boolean" }, "fatalInjuries": { "type": "number", "errorMessage": { "minimum": "Fatal Injuries cannot be lower than undefined", "maximum": "Fatal Injuries cannot be lower than undefined", "type": "Fatal Injuries must be number ", "exclusiveMinimum": "Fatal Injuries must be greater than undefined" } }, "nonFatalInjuries": { "type": "number", "errorMessage": { "minimum": "Non Fatal Injuries cannot be lower than undefined", "maximum": "Non Fatal Injuries cannot be lower than undefined", "type": "Non Fatal Injuries must be number ", "exclusiveMinimum": "Non Fatal Injuries must be greater than undefined" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "address": { "type": "string", "errorMessage": { "enum": "Address must be one of these options: \nundefined", "maxLength": "Address must not exceed undefined characters", "minLength": "Address must contain at least undefined characters", "type": "Address must be string " } }, "city": { "type": "string", "errorMessage": { "enum": "City must be one of these options: \nundefined", "maxLength": "City must not exceed undefined characters", "minLength": "City must contain at least undefined characters", "type": "City must be string " } }, "state": { "type": "string", "errorMessage": { "enum": "State must be one of these options: \nundefined", "maxLength": "State must not exceed undefined characters", "minLength": "State must contain at least undefined characters", "type": "State must be string " } }, "zipCode": { "type": "string", "errorMessage": { "enum": "Zip Code must be one of these options: \nundefined", "maxLength": "Zip Code must not exceed undefined characters", "minLength": "Zip Code must contain at least undefined characters", "type": "Zip Code must be string " } }, "note": { "type": "string", "errorMessage": { "enum": "Note must be one of these options: \nundefined", "maxLength": "Note must not exceed undefined characters", "minLength": "Note must contain at least undefined characters", "type": "Note must be string " } }, "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } } }, "additionalProperties": false }, "AdminRoleCrudDto": { "title": "AdminRoleCrudDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 175, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 175 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "label": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Label must be one of these options: \nundefined", "maxLength": "Label must not exceed 255 characters", "minLength": "Label must contain at least undefined characters", "type": "Label must be string " } }, "description": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 512 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } } }, "additionalProperties": false, "required": [ "name", "label" ] }, "AdminRoleCrudDtoPartial": { "title": "AdminRoleCrudDtoPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "name": { "type": "string", "maxLength": 175, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 175 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "label": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Label must be one of these options: \nundefined", "maxLength": "Label must not exceed 255 characters", "minLength": "Label must contain at least undefined characters", "type": "Label must be string " } }, "description": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 512 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } } }, "additionalProperties": false, "required": [ "name", "label" ], "x-typescript-type": "Partial" }, "AdminPermissionCrudDto": { "title": "AdminPermissionCrudDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 175, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 175 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "label": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Label must be one of these options: \nundefined", "maxLength": "Label must not exceed 255 characters", "minLength": "Label must contain at least undefined characters", "type": "Label must be string " } }, "module": { "type": "number", "errorMessage": { "minimum": "Module cannot be lower than undefined", "maximum": "Module cannot be lower than undefined", "type": "Module must be number ", "exclusiveMinimum": "Module must be greater than undefined" } }, "section": { "type": "string", "maxLength": 65, "nullable": true, "errorMessage": { "enum": "Section must be one of these options: \nundefined", "maxLength": "Section must not exceed 65 characters", "minLength": "Section must contain at least undefined characters", "type": "Section must be string or null" } } }, "additionalProperties": false, "required": [ "name", "label", "module" ], "errorMessage": { "required": { "name": "Permission name is required", "label": "Permission label is required", "module": "Permission module is required" } } }, "AdminPermissionCrudDtoPartial": { "title": "AdminPermissionCrudDtoPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "name": { "type": "string", "maxLength": 175, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 175 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "label": { "type": "string", "maxLength": 255, "errorMessage": { "enum": "Label must be one of these options: \nundefined", "maxLength": "Label must not exceed 255 characters", "minLength": "Label must contain at least undefined characters", "type": "Label must be string " } }, "module": { "type": "number", "errorMessage": { "minimum": "Module cannot be lower than undefined", "maximum": "Module cannot be lower than undefined", "type": "Module must be number ", "exclusiveMinimum": "Module must be greater than undefined" } }, "section": { "type": "string", "maxLength": 65, "nullable": true, "errorMessage": { "enum": "Section must be one of these options: \nundefined", "maxLength": "Section must not exceed 65 characters", "minLength": "Section must contain at least undefined characters", "type": "Section must be string or null" } } }, "additionalProperties": false, "required": [ "name", "label", "module" ], "errorMessage": { "required": { "name": "Permission name is required", "label": "Permission label is required", "module": "Permission module is required" } }, "x-typescript-type": "Partial" }, "AdminRolePermissionCrudDto": { "title": "AdminRolePermissionCrudDto", "type": "object", "properties": { "rolesId": { "type": "number", "errorMessage": { "minimum": "Roles Id cannot be lower than undefined", "maximum": "Roles Id cannot be lower than undefined", "type": "Roles Id must be number ", "exclusiveMinimum": "Roles Id must be greater than undefined" } }, "permissionsId": { "type": "number", "errorMessage": { "minimum": "Permissions Id cannot be lower than undefined", "maximum": "Permissions Id cannot be lower than undefined", "type": "Permissions Id must be number ", "exclusiveMinimum": "Permissions Id must be greater than undefined" } } }, "additionalProperties": false, "required": [ "rolesId", "permissionsId" ], "errorMessage": { "required": { "rolesId": "Role is required", "permissionsId": "Permission is required" } } }, "AdminDispatcherPermissionCrudDto": { "title": "AdminDispatcherPermissionCrudDto", "type": "object", "properties": { "companyId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Company Id must be a valid UUID" } }, "dispatcherId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Dispatcher Id must be a valid UUID" } }, "permissionId": { "type": "number", "errorMessage": { "minimum": "Permission Id cannot be lower than undefined", "maximum": "Permission Id cannot be lower than undefined", "type": "Permission Id must be number ", "exclusiveMinimum": "Permission Id must be greater than undefined" } } }, "additionalProperties": false, "required": [ "companyId", "dispatcherId", "permissionId" ], "errorMessage": { "required": { "companyId": "Company is required", "dispatcherId": "Dispatcher is required", "permissionId": "Permission is required" } } }, "SettlementBulkCreateDto": { "title": "SettlementBulkCreateDto", "type": "object", "properties": { "driverIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Ids items must be a valid UUID" } } }, "startDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Start Date must be date or null", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false, "required": [ "driverIds" ], "errorMessage": { "required": { "driverIds": "Driver's required" } } }, "SettlementPaymentCreateV3Dto": { "title": "SettlementPaymentCreateV3Dto", "type": "object", "properties": { "amount": { "type": "number", "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "settlementId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Settlement Id must be a valid UUID" } }, "date": { "type": "string", "format": "date-time", "errorMessage": { "type": "Date must be date ", "format": "Date must be a valid date-time (ISO 8601)" } } }, "additionalProperties": false, "required": [ "amount", "settlementId" ], "errorMessage": { "required": { "amount": "Amount is required", "settlementId": "Settlement is required" } } }, "SettlementBillingArchiveV3Dto": { "title": "SettlementBillingArchiveV3Dto", "type": "object", "properties": { "billingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Ids items must be a valid UUID" } } }, "isArchived": { "type": "boolean" } }, "additionalProperties": false, "required": [ "billingIds", "isArchived" ], "errorMessage": { "required": { "billingIds": "Billings is required" } } }, "SettlementWeeklyDeductionCalculateV3Dto": { "title": "SettlementWeeklyDeductionCalculateV3Dto", "type": "object", "properties": { "billingId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Id must be a valid UUID" } }, "workingDay": { "type": "number", "errorMessage": { "minimum": "Working Day cannot be lower than undefined", "maximum": "Working Day cannot be lower than undefined", "type": "Working Day must be number ", "exclusiveMinimum": "Working Day must be greater than undefined" } } }, "additionalProperties": false, "required": [ "billingId", "workingDay" ], "errorMessage": { "required": { "billingId": "Billing is required", "workingDay": "Working Day is required" } } }, "SettlementCreateV3Dto": { "title": "SettlementCreateV3Dto", "type": "object", "properties": { "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "billingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Ids items must be a valid UUID" } } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "driverCode": { "type": "number", "errorMessage": { "minimum": "Driver Code cannot be lower than undefined", "maximum": "Driver Code cannot be lower than undefined", "type": "Driver Code must be number ", "exclusiveMinimum": "Driver Code must be greater than undefined" } }, "startDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Start Date must be date or null", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "balanceAmount": { "type": "number", "errorMessage": { "minimum": "Balance Amount cannot be lower than undefined", "maximum": "Balance Amount cannot be lower than undefined", "type": "Balance Amount must be number ", "exclusiveMinimum": "Balance Amount must be greater than undefined" } }, "weeklyBillings": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementWeeklyDeductionCalculateV3Dto" } } }, "additionalProperties": false, "required": [ "driverId" ], "errorMessage": { "required": { "driverId": "Driver is required" } } }, "SettlementUpdateV3Dto": { "title": "SettlementUpdateV3Dto", "type": "object", "properties": { "billingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Ids items must be a valid UUID" } } }, "archivedBillingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Archived Billing Ids items must be a valid UUID" } } }, "driverCode": { "type": "number", "errorMessage": { "minimum": "Driver Code cannot be lower than undefined", "maximum": "Driver Code cannot be lower than undefined", "type": "Driver Code must be number ", "exclusiveMinimum": "Driver Code must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "startDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Start Date must be date or null", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "balanceAmount": { "type": "number", "errorMessage": { "minimum": "Balance Amount cannot be lower than undefined", "maximum": "Balance Amount cannot be lower than undefined", "type": "Balance Amount must be number ", "exclusiveMinimum": "Balance Amount must be greater than undefined" } }, "status": { "type": "number", "enum": [ 10, 20, 40, 70, 80, 90 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } }, "weeklyBillings": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementWeeklyDeductionCalculateV3Dto" } } }, "additionalProperties": false }, "SettlementUpdateStatusV3Dto": { "title": "SettlementUpdateStatusV3Dto", "type": "object", "properties": { "status": { "type": "number", "enum": [ 10, 20, 40, 70, 80, 90 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } } }, "additionalProperties": false, "required": [ "status" ], "errorMessage": { "required": { "status": "Status is required" } } }, "ContractorSettlementBillingArchiveV3Dto": { "title": "ContractorSettlementBillingArchiveV3Dto", "type": "object", "properties": { "billingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Ids items must be a valid UUID" } } }, "isArchivedToContractor": { "type": "boolean" } }, "additionalProperties": false, "required": [ "billingIds", "isArchivedToContractor" ], "errorMessage": { "required": { "billingIds": "Billings is required" } } }, "ContractorSettlementCreateV3Dto": { "title": "ContractorSettlementCreateV3Dto", "type": "object", "properties": { "contractorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Contractor Id must be a valid UUID" } }, "billingIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Ids items must be a valid UUID" } } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "driverCode": { "type": "number", "errorMessage": { "minimum": "Driver Code cannot be lower than undefined", "maximum": "Driver Code cannot be lower than undefined", "type": "Driver Code must be number ", "exclusiveMinimum": "Driver Code must be greater than undefined" } }, "startDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Start Date must be date or null", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "balanceAmount": { "type": "number", "errorMessage": { "minimum": "Balance Amount cannot be lower than undefined", "maximum": "Balance Amount cannot be lower than undefined", "type": "Balance Amount must be number ", "exclusiveMinimum": "Balance Amount must be greater than undefined" } }, "weeklyBillings": { "type": "array", "items": { "$ref": "#/components/schemas/SettlementWeeklyDeductionCalculateV3Dto" } } }, "additionalProperties": false, "required": [ "contractorId" ], "errorMessage": { "required": { "driverId": "Contractor is required" } } }, "SettlementContractorDriverBulkCreateDto": { "title": "SettlementContractorDriverBulkCreateDto", "type": "object", "properties": { "entryIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Entry Ids items must be a valid UUID" } } }, "type": { "type": "string", "enum": [ "driver", "contractor" ], "errorMessage": { "enum": "Type must be one of these options: \ndriver, contractor", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "startDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Start Date must be date or null", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } } }, "additionalProperties": false }, "ScheduledPaymentCreateDto": { "title": "ScheduledPaymentCreateDto", "type": "object", "properties": { "ruleName": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Rule Name must be one of these options: \nundefined", "maxLength": "Rule Name must not exceed 120 characters", "minLength": "Rule Name must contain at least undefined characters", "type": "Rule Name must be string " } }, "type": { "type": "string", "enum": [ "addition", "deduction" ], "errorMessage": { "enum": "Type must be one of these options: \naddition, deduction", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } }, "frequency": { "type": "string", "enum": [ "weekly", "biweekly", "monthly" ], "errorMessage": { "enum": "Frequency must be one of these options: \nweekly, biweekly, monthly", "maxLength": "Frequency must not exceed undefined characters", "minLength": "Frequency must contain at least undefined characters", "type": "Frequency must be string " } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "entityType": { "type": "string", "enum": [ "driver", "contractor" ], "errorMessage": { "enum": "Entity Type must be one of these options: \ndriver, contractor", "maxLength": "Entity Type must not exceed undefined characters", "minLength": "Entity Type must contain at least undefined characters", "type": "Entity Type must be string " } }, "entityId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Entity Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "amount": { "type": "number", "exclusiveMinimum": 0, "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than 0" } }, "startDate": { "type": "string", "format": "date", "errorMessage": { "type": "Start Date must be date ", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false, "required": [ "ruleName", "type", "frequency", "categoryId", "entityType", "entityId", "amount", "startDate" ], "errorMessage": { "required": { "ruleName": "Rule name is required", "type": "Type is required", "frequency": "Frequency is required", "categoryId": "Category is required", "entityType": "Entity type is required", "entityId": "Entity is required", "amount": "Amount is required", "startDate": "Start date is required" } } }, "ScheduledPaymentUpdateDto": { "title": "ScheduledPaymentUpdateDto", "type": "object", "properties": { "ruleName": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Rule Name must be one of these options: \nundefined", "maxLength": "Rule Name must not exceed 120 characters", "minLength": "Rule Name must contain at least undefined characters", "type": "Rule Name must be string or null" } }, "type": { "type": "string", "enum": [ "addition", "deduction" ], "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \naddition, deduction", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "frequency": { "type": "string", "enum": [ "weekly", "biweekly", "monthly" ], "nullable": true, "errorMessage": { "enum": "Frequency must be one of these options: \nweekly, biweekly, monthly", "maxLength": "Frequency must not exceed undefined characters", "minLength": "Frequency must contain at least undefined characters", "type": "Frequency must be string or null" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "entityType": { "type": "string", "enum": [ "driver", "contractor" ], "nullable": true, "errorMessage": { "enum": "Entity Type must be one of these options: \ndriver, contractor", "maxLength": "Entity Type must not exceed undefined characters", "minLength": "Entity Type must contain at least undefined characters", "type": "Entity Type must be string or null" } }, "entityId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Entity Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "amount": { "type": "number", "exclusiveMinimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Amount must be number or null", "exclusiveMinimum": "Amount must be greater than 0" } }, "startDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "Start Date must be date or null", "format": "StartDate must be a valid date (YYYY-MM-DD)" } }, "endDate": { "type": "string", "format": "date", "nullable": true, "errorMessage": { "type": "End Date must be date or null", "format": "EndDate must be a valid date (YYYY-MM-DD)" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } } }, "additionalProperties": false }, "ScheduledPaymentStatusDto": { "title": "ScheduledPaymentStatusDto", "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false, "required": [ "isActive" ], "errorMessage": { "required": { "isActive": "Status is required" } } }, "ReceivableItemsDto": { "title": "ReceivableItemsDto", "type": "object", "properties": { "description": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Description must be one of these options: \nundefined", "maxLength": "Description must not exceed 1000 characters", "minLength": "Description must contain at least undefined characters", "type": "Description must be string or null" } }, "rate": { "type": "number", "exclusiveMinimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Rate must be number or null", "exclusiveMinimum": "Rate must be greater than 0" } }, "qty": { "type": "number", "exclusiveMinimum": 0, "nullable": true, "format": "float", "errorMessage": { "type": "Qty must be number or null", "exclusiveMinimum": "Qty must be greater than 0" } }, "amount": { "type": "number", "exclusiveMinimum": 0, "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than 0" } } }, "additionalProperties": false, "required": [ "amount", "qty" ], "errorMessage": { "required": { "amount": "Amount is required", "qty": "Quantity is required" } } }, "ReceivablesDto": { "title": "ReceivablesDto", "type": "object", "properties": { "status": { "type": "number", "enum": [ 10, 20, 30, 50 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } }, "notes": { "type": "string", "maxLength": 1000, "nullable": true, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string or null" } }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } }, "invoiceDate": { "type": "string", "format": "date", "default": "2026-07-29T08:52:51.641Z", "nullable": true, "errorMessage": { "type": "Invoice Date must be date or null", "format": "InvoiceDate must be a valid date (YYYY-MM-DD)" } }, "dueDate": { "type": "string", "format": "date", "default": "2026-07-29T08:52:51.641Z", "nullable": true, "errorMessage": { "type": "Due Date must be date or null", "format": "DueDate must be a valid date (YYYY-MM-DD)" } }, "tax": { "type": "number", "nullable": true, "format": "float", "errorMessage": { "type": "Tax must be number or null", "exclusiveMinimum": "Tax must be greater than undefined" } }, "total": { "type": "number", "exclusiveMinimum": 0, "format": "float", "errorMessage": { "type": "Total must be number ", "exclusiveMinimum": "Total must be greater than 0" } }, "receivableItemsDto": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableItemsDto" } } }, "additionalProperties": false, "required": [ "total", "status", "invoiceDate", "dueDate", "vendorId" ], "errorMessage": { "required": { "invoiceDate": "Invoice date is required", "dueDate": "Due date is required", "total": "Amount is required", "vendorId": "Vendor is required", "status": "Status is required" } } }, "ReceivableWithReasonDto": { "title": "ReceivableWithReasonDto", "type": "object", "properties": { "reason": { "type": "string", "maxLength": 512, "nullable": true, "errorMessage": { "enum": "Reason must be one of these options: \nundefined", "maxLength": "Reason must not exceed 512 characters", "minLength": "Reason must contain at least undefined characters", "type": "Reason must be string or null" } }, "status": { "type": "number", "enum": [ 40, 60 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } } }, "additionalProperties": false, "required": [ "status" ] }, "MassUpdateStatusReceivablesDto": { "title": "MassUpdateStatusReceivablesDto", "type": "object", "properties": { "receivableIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Receivable Ids items must be a valid UUID" } } }, "status": { "type": "number", "enum": [ 60, 40 ], "errorMessage": { "minimum": "Status cannot be lower than undefined", "maximum": "Status cannot be lower than undefined", "type": "Status must be number ", "exclusiveMinimum": "Status must be greater than undefined" } } }, "additionalProperties": false, "required": [ "receivableIds", "status" ] }, "SendToRtsByReceivablesDto": { "title": "SendToRtsByReceivablesDto", "type": "object", "properties": { "receivableIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Receivable Ids items must be a valid UUID" } } } }, "additionalProperties": false, "required": [ "receivableIds" ] }, "ReceivableDirectBill": { "title": "ReceivableDirectBill", "type": "object", "properties": { "receivableId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Receivable Id must be a valid UUID" } }, "email": { "type": "string", "errorMessage": { "enum": "Email must be one of these options: \nundefined", "maxLength": "Email must not exceed undefined characters", "minLength": "Email must contain at least undefined characters", "type": "Email must be string " } } }, "additionalProperties": false, "required": [ "receivableId", "email" ] }, "SendToDirectByReceivablesDto": { "title": "SendToDirectByReceivablesDto", "type": "object", "properties": { "receivableBills": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableDirectBill" } } }, "additionalProperties": false, "required": [ "receivableBills" ] }, "ReceivableBatchBillingStatusUpdateDto": { "title": "ReceivableBatchBillingStatusUpdateDto", "type": "object", "properties": { "receivableIds": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Receivable Ids items must be a valid UUID" } } } }, "additionalProperties": false, "required": [ "receivableIds" ] }, "ExpenseUpdatePartialDto": { "title": "ExpenseUpdatePartialDto", "type": "object", "properties": { "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "date": { "type": "string", "default": "2026-07-29T08:52:51.639Z", "errorMessage": { "type": "Date must be date " } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false }, "ExpenseDto": { "title": "ExpenseDto", "type": "object", "properties": { "date": { "type": "string", "default": "2026-07-29T08:52:51.639Z", "errorMessage": { "type": "Date must be date " } }, "amount": { "type": "number", "exclusiveMinimum": 0, "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than 0" } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "default": null, "errorMessage": { "pattern": "Created By Id must be a valid UUID" } } }, "additionalProperties": false, "required": [ "amount", "date", "categoryId", "vendorId" ] }, "MarkAsPaidDto": { "title": "MarkAsPaidDto", "type": "object", "properties": { "date": { "type": "string", "default": "2026-07-29T08:52:51.639Z", "errorMessage": { "type": "Date must be date " } }, "amount": { "type": "number", "exclusiveMinimum": 0, "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than 0" } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "amount", "date" ] }, "ExpenseChargeV2Dto": { "title": "ExpenseChargeV2Dto", "type": "object", "properties": { "date": { "type": "string", "default": "2026-07-29T08:52:51.639Z", "errorMessage": { "type": "Date must be date " } }, "amount": { "type": "number", "exclusiveMinimum": 0, "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than 0" } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "chargeSplit": { "type": "number", "exclusiveMinimum": 0, "errorMessage": { "minimum": "Charge Split cannot be lower than undefined", "maximum": "Charge Split cannot be lower than undefined", "type": "Charge Split must be number ", "exclusiveMinimum": "Charge Split must be greater than 0" } } }, "additionalProperties": false, "required": [ "amount", "date", "chargeSplit" ] }, "ExpenseChargeSplitV2Dto": { "title": "ExpenseChargeSplitV2Dto", "type": "object", "properties": { "chargeSplit": { "type": "number", "exclusiveMinimum": 0, "errorMessage": { "minimum": "Charge Split cannot be lower than undefined", "maximum": "Charge Split cannot be lower than undefined", "type": "Charge Split must be number ", "exclusiveMinimum": "Charge Split must be greater than 0" } }, "chargeAmount": { "type": "number", "exclusiveMinimum": 0, "errorMessage": { "minimum": "Charge Amount cannot be lower than undefined", "maximum": "Charge Amount cannot be lower than undefined", "type": "Charge Amount must be number ", "exclusiveMinimum": "Charge Amount must be greater than 0" } }, "notes": { "type": "string", "maxLength": 1200, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1200 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "chargeAmount", "chargeSplit" ] }, "CategoryAddDeductCreateDto": { "title": "CategoryAddDeductCreateDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 120, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "direction": { "type": "string", "enum": [ "addition", "deduction" ], "errorMessage": { "enum": "Direction must be one of these options: \naddition, deduction", "maxLength": "Direction must not exceed undefined characters", "minLength": "Direction must contain at least undefined characters", "type": "Direction must be string " } }, "type": { "type": "string", "enum": [ "settlement_adjustment", "reimbursement", "advance", "fee", "other" ], "errorMessage": { "enum": "Type must be one of these options: \nsettlement_adjustment, reimbursement, advance, fee, other", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string " } } }, "additionalProperties": false, "required": [ "name", "direction", "type" ], "errorMessage": { "required": { "name": "Name is required", "direction": "Direction is required", "type": "Type is required" } } }, "CategoryAddDeductUpdateDto": { "title": "CategoryAddDeductUpdateDto", "type": "object", "properties": { "name": { "type": "string", "maxLength": 120, "nullable": true, "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed 120 characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string or null" } }, "direction": { "type": "string", "enum": [ "addition", "deduction" ], "nullable": true, "errorMessage": { "enum": "Direction must be one of these options: \naddition, deduction", "maxLength": "Direction must not exceed undefined characters", "minLength": "Direction must contain at least undefined characters", "type": "Direction must be string or null" } }, "type": { "type": "string", "enum": [ "settlement_adjustment", "reimbursement", "advance", "fee", "other" ], "nullable": true, "errorMessage": { "enum": "Type must be one of these options: \nsettlement_adjustment, reimbursement, advance, fee, other", "maxLength": "Type must not exceed undefined characters", "minLength": "Type must contain at least undefined characters", "type": "Type must be string or null" } }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "LoadServiceDto": { "title": "LoadServiceDto", "type": "object", "properties": { "name": { "type": "string", "errorMessage": { "enum": "Name must be one of these options: \nundefined", "maxLength": "Name must not exceed undefined characters", "minLength": "Name must contain at least undefined characters", "type": "Name must be string " } }, "amount": { "type": "number", "exclusiveMinimum": 0, "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than 0" } }, "driverAmount": { "type": "number", "errorMessage": { "minimum": "Driver Amount cannot be lower than undefined", "maximum": "Driver Amount cannot be lower than undefined", "type": "Driver Amount must be number ", "exclusiveMinimum": "Driver Amount must be greater than undefined" } }, "paidBy": { "type": "string", "maxLength": 72, "errorMessage": { "enum": "Paid By must be one of these options: \nundefined", "maxLength": "Paid By must not exceed 72 characters", "minLength": "Paid By must contain at least undefined characters", "type": "Paid By must be string " } }, "stopId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Stop Id must be a valid UUID" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } } }, "additionalProperties": false, "required": [ "name", "amount" ], "errorMessage": { "required": { "amount": "Amount is required", "name": "Name is required" } } }, "BillingCreateDto": { "title": "BillingCreateDto", "type": "object", "properties": { "amount": { "type": "number", "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "driverId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Driver Id must be a valid UUID" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "loadId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Load Id must be a valid UUID" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "date": { "type": "string", "nullable": false, "errorMessage": { "type": "Date must be date " } } }, "additionalProperties": false, "required": [ "driverId", "categoryId", "amount" ], "errorMessage": { "required": { "driverId": "Driver is required", "categoryId": "Category is required", "amount": "Amount is required" } } }, "ContractorBillingCreateDto": {}, "BillingCreateToContractorSettlementDto": { "title": "BillingCreateToContractorSettlementDto", "type": "object", "properties": { "amount": { "type": "number", "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "unitId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Unit Id must be a valid UUID" } }, "contractorSettlementId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Contractor Settlement Id must be a valid UUID" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "date": { "type": "string", "default": "2026-07-29T08:52:54.971Z", "errorMessage": { "type": "Date must be date " } } }, "additionalProperties": false, "required": [ "categoryId", "unitId", "amount", "contractorSettlementId", "date" ], "errorMessage": { "required": { "categoryId": "Category is required", "amount": "Amount is required", "contractorSettlementId": "Settlement is required", "date": "Date is required", "unitId": "Truck is required" } } }, "BillingCreateToSettlementDto": { "title": "BillingCreateToSettlementDto", "type": "object", "properties": { "amount": { "type": "number", "errorMessage": { "minimum": "Amount cannot be lower than undefined", "maximum": "Amount cannot be lower than undefined", "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "categoryId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Category Id must be a valid UUID" } }, "settlementId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Settlement Id must be a valid UUID" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "date": { "type": "string", "default": "2026-07-29T08:52:51.400Z", "errorMessage": { "type": "Date must be date " } } }, "additionalProperties": false, "required": [ "categoryId", "amount", "settlementId", "date" ], "errorMessage": { "required": { "categoryId": "Category is required", "amount": "Amount is required", "settlementId": "Settlement is required", "date": "Date is required" } } }, "WeeklyDeductionCalculateDto": { "title": "WeeklyDeductionCalculateDto", "type": "object", "properties": { "billingId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "nullable": true, "errorMessage": { "pattern": "Billing Id must be a valid UUID" } }, "workingDay": { "type": "number", "errorMessage": { "minimum": "Working Day cannot be lower than undefined", "maximum": "Working Day cannot be lower than undefined", "type": "Working Day must be number ", "exclusiveMinimum": "Working Day must be greater than undefined" } } }, "additionalProperties": false, "required": [ "billingId", "workingDay" ], "errorMessage": { "required": { "billingId": "Billing is required", "workingDay": "Working Day is required" } } }, "BillingWeeklyDeductionDto": { "title": "BillingWeeklyDeductionDto", "type": "object", "properties": { "weeklyBillings": { "type": "array", "items": { "$ref": "#/components/schemas/WeeklyDeductionCalculateDto" } } }, "additionalProperties": false, "required": [ "weeklyBillings" ], "errorMessage": { "required": { "weeklyBillings": "Weekly Billings is required" } } }, "BillingPaymentCreateDtoV2": { "title": "BillingPaymentCreateDtoV2", "type": "object", "properties": { "vendorId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "errorMessage": { "pattern": "Vendor Id must be a valid UUID" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "date": { "type": "string", "format": "date-time", "errorMessage": { "enum": "Date must be one of these options: \nundefined", "maxLength": "Date must not exceed undefined characters", "minLength": "Date must contain at least undefined characters", "type": "Date must be string ", "format": "Date must be a valid date-time (ISO 8601)" } }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "categoryId": { "type": "string", "errorMessage": { "enum": "Category Id must be one of these options: \nundefined", "maxLength": "Category Id must not exceed undefined characters", "minLength": "Category Id must contain at least undefined characters", "type": "Category Id must be string " } } }, "additionalProperties": false, "required": [ "vendorId", "date", "categoryId" ], "errorMessage": { "required": { "vendorId": "Vendor is required", "categoryId": "Category is required", "date": "Date is required" } } }, "BillingPaymentUpdateDtoV2": { "title": "BillingPaymentUpdateDtoV2", "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "errorMessage": { "enum": "Date must be one of these options: \nundefined", "maxLength": "Date must not exceed undefined characters", "minLength": "Date must contain at least undefined characters", "type": "Date must be string ", "format": "Date must be a valid date-time (ISO 8601)" } }, "notes": { "type": "string", "maxLength": 1000, "errorMessage": { "enum": "Notes must be one of these options: \nundefined", "maxLength": "Notes must not exceed 1000 characters", "minLength": "Notes must contain at least undefined characters", "type": "Notes must be string " } }, "amount": { "type": "number", "format": "float", "errorMessage": { "type": "Amount must be number ", "exclusiveMinimum": "Amount must be greater than undefined" } }, "categoryId": { "type": "string", "errorMessage": { "enum": "Category Id must be one of these options: \nundefined", "maxLength": "Category Id must not exceed undefined characters", "minLength": "Category Id must contain at least undefined characters", "type": "Category Id must be string " } } }, "additionalProperties": false, "required": [ "date" ], "errorMessage": { "required": { "date": "Date is required" } } }, "Places.Filter": { "type": "object", "title": "Places.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "phoneNumber": { "type": "boolean" }, "address": { "type": "boolean" }, "highwayRoute": { "type": "boolean" }, "municipal": { "type": "boolean" }, "county": { "type": "boolean" }, "state": { "type": "boolean" }, "milePost": { "type": "boolean" }, "stateNumber": { "type": "boolean" }, "lat": { "type": "boolean" }, "lng": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "updatedAt", "createdAt", "phoneNumber", "address", "highwayRoute", "municipal", "county", "state", "milePost", "stateNumber", "lat", "lng" ], "example": "id" }, "uniqueItems": true } ], "title": "Places.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Places.Filter1": { "type": "object", "title": "Places.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Places.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "phoneNumber": { "type": "boolean" }, "address": { "type": "boolean" }, "highwayRoute": { "type": "boolean" }, "municipal": { "type": "boolean" }, "county": { "type": "boolean" }, "state": { "type": "boolean" }, "milePost": { "type": "boolean" }, "stateNumber": { "type": "boolean" }, "lat": { "type": "boolean" }, "lng": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "updatedAt", "createdAt", "phoneNumber", "address", "highwayRoute", "municipal", "county", "state", "milePost", "stateNumber", "lat", "lng" ], "example": "id" }, "uniqueItems": true } ], "title": "Places.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" } } }, "security": [ { "jwt": [], "companyId": [] } ], "servers": [ { "url": "/" } ] }