{ "openapi": "3.0.0", "info": { "title": "kango-backend", "version": "0.0.1", "description": "backend for Kango frontend", "contact": { "name": "eucastillo", "email": "64089757+eucastillo@users.noreply.github.com>" } }, "paths": { "/carriage-detail/{id}": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "getCarriageDetail", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InfoCarriageController.getCarriageDetail" } }, "/carriages": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "find", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoCarriage.Filter" } } } } ], "operationId": "InfoCarriageController.find" } }, "/cat-carriage-types": { "get": { "x-controller-name": "CatCarriageTypeController", "x-operation-name": "find", "tags": [ "CatCarriageTypeController" ], "responses": { "200": { "description": "Array of CatCarriageType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatCarriageType" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatCarriageType.Filter" } } } } ], "operationId": "CatCarriageTypeController.find" } }, "/cat-cities": { "get": { "x-controller-name": "CatCityController", "x-operation-name": "find", "tags": [ "CatCityController" ], "responses": { "200": { "description": "Array of CatCity model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatCityWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatCity.Filter" } } } } ], "operationId": "CatCityController.find" } }, "/cat-notifications-types": { "get": { "x-controller-name": "CatNotificationsTypeController", "x-operation-name": "find", "tags": [ "CatNotificationsTypeController" ], "responses": { "200": { "description": "Array of CatNotificationsType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatNotificationsTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatNotificationsType.Filter" } } } } ], "operationId": "CatNotificationsTypeController.find" } }, "/cat-ranges": { "get": { "x-controller-name": "CatRangeController", "x-operation-name": "find", "tags": [ "CatRangeController" ], "responses": { "200": { "description": "Array of CatRange model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatRangeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatRange.Filter" } } } } ], "operationId": "CatRangeController.find" } }, "/cat-unit-types": { "get": { "x-controller-name": "CatUnitTypeController", "x-operation-name": "find", "tags": [ "CatUnitTypeController" ], "responses": { "200": { "description": "Array of CatUnitType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CatUnitTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatUnitType.Filter" } } } } ], "operationId": "CatUnitTypeController.find" } }, "/client-products/{clientId}": { "get": { "x-controller-name": "CcpController", "x-operation-name": "getClientProducts", "tags": [ "CcpController" ], "responses": { "200": { "description": "Array of client products ", "content": { "application/json": { "schema": { "type": "array", "properties": { "Name": { "type": "string" }, "IdClientCompany": { "type": "number" }, "IdRoute": { "type": "number" } } } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CcpController.getClientProducts" } }, "/client-routes": { "get": { "x-controller-name": "CcpController", "x-operation-name": "getClientRoutes", "tags": [ "CcpController" ], "responses": { "200": { "description": "Array of client routes ", "content": { "application/json": { "schema": { "type": "array", "properties": { "Name": { "type": "string" }, "IdClientCompany": { "type": "number" }, "IdRoute": { "type": "number" } } } } } } }, "operationId": "CcpController.getClientRoutes" } }, "/complete-carriages": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "findCompleted", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageWithRelations" } } } } } }, "operationId": "InfoCarriageController.findCompleted" } }, "/draft-carriages": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "findDrafts", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageWithRelations" } } } } } }, "operationId": "InfoCarriageController.findDrafts" } }, "/get-accepted-trips": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "findAcceptedCarriages", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "null" } } } } }, "operationId": "InfoCarriageController.findAcceptedCarriages" } }, "/get-general-trips": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "findGeneralTrips", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "null" } } } } }, "operationId": "InfoCarriageController.findGeneralTrips" } }, "/info-carriers": { "post": { "x-controller-name": "InfoCarrierController", "x-operation-name": "modifyCarrier", "tags": [ "InfoCarrierController" ], "responses": { "200": { "description": "InfoCarrier model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoCarrier" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "description": "fields for infoCarrier", "properties": { "IdCarrier": { "type": "number" }, "Name": { "type": "string" }, "Phone": { "type": "string" }, "Email": { "type": "string" }, "Main": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string" }, "UpdatedAt": { "type": "string" }, "IdCarriage": { "type": "number" } } } } } }, "operationId": "InfoCarrierController.modifyCarrier" } }, "/info-user-preference": { "post": { "x-controller-name": "InfoUsersController", "x-operation-name": "createModifyPreference", "tags": [ "InfoUsersController" ], "responses": { "200": { "description": "Info User Preference update or create", "content": { "application/json": { "schema": { "type": "object", "properties": { "IdPreference": { "type": "number" }, "Cities": { "type": "array", "items": { "type": "number" } }, "Range": { "type": "number" }, "UnitTypes": { "type": "array", "items": { "type": "number" } }, "Notifications": { "type": "array", "items": { "type": "number" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "IdPreference", "Cities", "Range", "UnitTypes" ], "properties": { "IdPreference": { "type": "number" }, "Cities": { "type": "array", "items": { "type": "number" } }, "Range": { "type": "number" }, "UnitTypes": { "type": "array", "items": { "type": "number" } }, "Notifications": { "type": "array", "items": { "type": "number" } } } } } }, "description": "Required input for user preference", "required": true }, "operationId": "InfoUsersController.createModifyPreference" }, "get": { "x-controller-name": "InfoUsersController", "x-operation-name": "find", "tags": [ "InfoUsersController" ], "responses": { "200": { "description": "Array of InfoUserPreference model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfoUserPreferencesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoUserPreferences.Filter" } } } } ], "operationId": "InfoUsersController.find" } }, "/info-users": { "post": { "x-controller-name": "InfoUsersController", "x-operation-name": "create", "tags": [ "InfoUsersController" ], "responses": { "200": { "description": "InfoUsers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoUsers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Esta se utilizara para obtener la respuesta del transportista\n sobre algún viaje ofrecido.", "properties": { "whatsapp": { "type": "string" }, "email": { "type": "string" } } } } } }, "operationId": "InfoUsersController.create" } }, "/pending-carriages": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "findPendings", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageWithRelations" } } } } } }, "operationId": "InfoCarriageController.findPendings" } }, "/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/rejected-carriages": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "findRejected", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageWithRelations" } } } } } }, "operationId": "InfoCarriageController.findRejected" } }, "/request-carrier": { "post": { "x-controller-name": "InfoCarrierController", "x-operation-name": "requestCarrier", "tags": [ "InfoCarrierController" ], "responses": { "200": { "description": "Fields to start flow 1 in chatbot ", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Fields to start flow 1 in chatbot", "properties": { "CityDestiny": { "type": "number" }, "CityOrigin": { "type": "number" }, "CarriageType": { "type": "number" }, "SpecialComments": { "type": "string" }, "Rate": { "type": "number" }, "Weight": { "type": "number" }, "IdCarriage": { "type": "number" } } } } }, "description": "Fields to start flow 1 in chatbot ", "required": true }, "operationId": "InfoCarrierController.requestCarrier" } }, "/save-carriage-draft": { "post": { "x-controller-name": "CarriageRequestController", "x-operation-name": "saveDraft", "tags": [ "CarriageRequestController" ], "responses": { "200": { "description": "Save carriage with status as draft", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Optional fields to save a draft", "properties": { "IdCarriage": { "type": "number" }, "IdOTM": { "type": "string" }, "CityOrigin": { "type": "number" }, "AddressOrigin": { "type": "string" }, "Rate": { "type": "number" }, "CityDestiny": { "type": "number" }, "AddressDestiny": { "type": "string" }, "CarriageType": { "type": "number" }, "Eta": { "type": "string", "format": "date" }, "Weight": { "type": "number" }, "LastCarrierResponse": { "type": "string", "format": "date" }, "SpecialComments": { "type": "string" }, "IdCarrier": { "type": "number" }, "IdRoute": { "type": "number" }, "CcpInfo": { "type": "array", "items": { "type": "object", "properties": { "IdProduct": { "type": "number" }, "ProductName": { "type": "string" }, "Mount": { "type": "number" }, "UnitValue": { "type": "number" }, "Weight": { "type": "number" } } } } } } } }, "description": "Required input for save draft", "required": true }, "operationId": "CarriageRequestController.saveDraft" } }, "/save-complete-carriage": { "post": { "x-controller-name": "CarriageRequestController", "x-operation-name": "saveCompleted", "tags": [ "CarriageRequestController" ], "responses": { "200": { "description": "Save carriage with status as completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "fields to save completed carriage", "properties": { "IdCarriage": { "type": "number" }, "IdOTM": { "type": "string" }, "CityOrigin": { "type": "number" }, "AddressOrigin": { "type": "string" }, "Rate": { "type": "number" }, "CityDestiny": { "type": "number" }, "AddressDestiny": { "type": "string" }, "CarriageType": { "type": "number" }, "Eta": { "type": "string", "format": "date" }, "Weight": { "type": "number" }, "LastCarrierResponse": { "type": "string", "format": "date" }, "SpecialComments": { "type": "string" }, "IdCarrier": { "type": "number" }, "IdRoute": { "type": "number" }, "CcpInfo": { "type": "array", "items": { "type": "object", "properties": { "IdProduct": { "type": "number" }, "ProductName": { "type": "string" }, "Mount": { "type": "number" }, "UnitValue": { "type": "number" }, "Weight": { "type": "number" } } } } } } } }, "description": "Required input for save completed carriage", "required": true }, "operationId": "CarriageRequestController.saveCompleted" } }, "/save-pending-carriage": { "post": { "x-controller-name": "CarriageRequestController", "x-operation-name": "savePending", "tags": [ "CarriageRequestController" ], "responses": { "200": { "description": "Save carriage with status as pending", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Optional fields to save a draft", "properties": { "IdCarriage": { "type": "number" }, "IdOTM": { "type": "string" }, "CityOrigin": { "type": "number" }, "AddressOrigin": { "type": "string" }, "Rate": { "type": "number" }, "CityDestiny": { "type": "number" }, "AddressDestiny": { "type": "string" }, "CarriageType": { "type": "number" }, "Eta": { "type": "string", "format": "date" }, "Weight": { "type": "number" }, "LastCarrierResponse": { "type": "string", "format": "date" }, "SpecialComments": { "type": "string" }, "IdCarrier": { "type": "number" }, "IdRoute": { "type": "number" }, "CcpInfo": { "type": "array", "items": { "type": "object", "properties": { "IdProduct": { "type": "number" }, "ProductName": { "type": "string" }, "Mount": { "type": "number" }, "UnitValue": { "type": "number" }, "Weight": { "type": "number" } } } } } } } }, "description": "Required input for save pending carriage", "required": true }, "operationId": "CarriageRequestController.savePending" } }, "/suggested-carriages": { "get": { "x-controller-name": "InfoCarriageController", "x-operation-name": "findsuggested", "tags": [ "InfoCarriageController" ], "responses": { "200": { "description": "Array of InfoCarriage model instances", "content": { "application/json": { "schema": { "type": "array", "description": "Se utilizara para obtejer los viajes sugeridos a los usuarios.", "properties": { "route": { "type": "string" }, "carriages": { "type": "array" } } } } } } }, "operationId": "InfoCarriageController.findsuggested" } }, "/users/login": { "post": { "x-controller-name": "AuthUserController", "x-operation-name": "login", "tags": [ "AuthUserController" ], "responses": { "200": { "description": "Token", "content": { "application/json": { "schema": { "type": "object", "properties": { "Username": { "type": "string" }, "Token": { "type": "string" }, "IsNew": { "type": "string" } } } } } }, "401": { "description": "Invalid user or password", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "Username", "password" ], "properties": { "Username": { "type": "string" }, "Password": { "type": "string" } } } } }, "description": "Required input for login", "required": true }, "operationId": "AuthUserController.login" } }, "/validate-voucher/{OtmId}": { "get": { "x-controller-name": "CcpController", "x-operation-name": "getVoucherValidation", "tags": [ "CcpController" ], "responses": { "200": { "description": "Array of client products ", "content": { "application/json": { "schema": { "type": "array", "properties": { "Name": { "type": "string" }, "IdClientCompany": { "type": "number" }, "IdRoute": { "type": "number" } } } } } } }, "parameters": [ { "name": "OtmId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CcpController.getVoucherValidation" } } }, "servers": [ { "url": "https://qa.api.kango.dlabs.com.mx" } ], "components": { "schemas": { "CatCarriageType": { "title": "CatCarriageType", "type": "object", "properties": { "IdCarriageType": { "type": "number" }, "Description": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Description" ], "additionalProperties": false }, "CatCityWithRelations": { "title": "CatCityWithRelations", "type": "object", "description": "(tsType: CatCityWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCity": { "type": "number" }, "Name": { "type": "string" }, "State": { "type": "string" }, "Country": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Name", "State", "Country" ], "additionalProperties": false, "x-typescript-type": "CatCityWithRelations" }, "CatNotificationsTypeWithRelations": { "title": "CatNotificationsTypeWithRelations", "type": "object", "description": "(tsType: CatNotificationsTypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdNotificationType": { "type": "number" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Name", "Description" ], "additionalProperties": false, "x-typescript-type": "CatNotificationsTypeWithRelations" }, "CatRangeWithRelations": { "title": "CatRangeWithRelations", "type": "object", "description": "(tsType: CatRangeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdRange": { "type": "number" }, "Description": { "type": "string" }, "disabled": { "type": "boolean" }, "createdat": { "type": "string", "format": "date-time" }, "updatedat": { "type": "string", "format": "date-time" } }, "required": [ "Description" ], "additionalProperties": false, "x-typescript-type": "CatRangeWithRelations" }, "CatUnitTypeWithRelations": { "title": "CatUnitTypeWithRelations", "type": "object", "description": "(tsType: CatUnitTypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdUnitType": { "type": "number" }, "Description": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Description" ], "additionalProperties": false, "x-typescript-type": "CatUnitTypeWithRelations" }, "AuthCompanyWithRelations": { "title": "AuthCompanyWithRelations", "type": "object", "description": "(tsType: AuthCompanyWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCompany": { "type": "number" }, "CompanyName": { "type": "string" }, "Apikey": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "Carriages": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageWithRelations" } } }, "required": [ "CompanyName", "Apikey" ], "additionalProperties": false, "x-typescript-type": "AuthCompanyWithRelations" }, "InfoCarrierWithRelations": { "title": "InfoCarrierWithRelations", "type": "object", "description": "(tsType: InfoCarrierWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarrierInfo": { "type": "number" }, "IdCarrier": { "type": "number" }, "Name": { "type": "string" }, "Phone": { "type": "string" }, "Email": { "type": "string" }, "Main": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "IdCarrier", "Name", "Phone", "Email", "Main" ], "additionalProperties": false, "x-typescript-type": "InfoCarrierWithRelations" }, "CatCarrierWithRelations": { "title": "CatCarrierWithRelations", "type": "object", "description": "(tsType: CatCarrierWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarrier": { "type": "number" }, "Cup": { "type": "string" }, "Name": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "infoCarriers": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarrierWithRelations" } } }, "required": [ "Cup", "Name" ], "additionalProperties": false, "x-typescript-type": "CatCarrierWithRelations" }, "CatZoneWithRelations": { "title": "CatZoneWithRelations", "type": "object", "description": "(tsType: CatZoneWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdZone": { "type": "number" }, "Description": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Description" ], "additionalProperties": false, "x-typescript-type": "CatZoneWithRelations" }, "InfoCarriageZoneWithRelations": { "title": "InfoCarriageZoneWithRelations", "type": "object", "description": "(tsType: InfoCarriageZoneWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarriageZone": { "type": "number" }, "IdCarriage": { "type": "number" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "IdZone": { "type": "number" }, "catZone": { "$ref": "#/components/schemas/CatZoneWithRelations" } }, "required": [ "IdCarriage" ], "additionalProperties": false, "x-typescript-type": "InfoCarriageZoneWithRelations" }, "CatRoutesWithRelations": { "title": "CatRoutesWithRelations", "type": "object", "description": "(tsType: CatRoutesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdRoute": { "type": "number" }, "IdCompany": { "type": "number" }, "IdUnitType": { "type": "number" }, "IdCityOrigin": { "type": "number" }, "IdCityDestiny": { "type": "number" }, "Active": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "CityOrigin": { "$ref": "#/components/schemas/CatCityWithRelations" }, "CityDestiny": { "$ref": "#/components/schemas/CatCityWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CatRoutesWithRelations" }, "InfoCarriageMatchesWithRelations": { "title": "InfoCarriageMatchesWithRelations", "type": "object", "description": "(tsType: InfoCarriageMatchesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarriageMatches": { "type": "number" }, "IdRoute": { "type": "number" }, "IdCarriage": { "type": "number" }, "CreatedAt": { "type": "string", "format": "date-time" }, "route": { "$ref": "#/components/schemas/CatRoutesWithRelations" } }, "required": [ "IdCarriage" ], "additionalProperties": false, "x-typescript-type": "InfoCarriageMatchesWithRelations" }, "InfoCarriageCcpWithRelations": { "title": "InfoCarriageCcpWithRelations", "type": "object", "description": "(tsType: InfoCarriageCcpWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarriageCcp": { "type": "number" }, "IdRequest": { "type": "number" }, "IdProduct": { "type": "number" }, "ProductName": { "type": "string" }, "Mount": { "type": "number" }, "UnitValue": { "type": "number" }, "Weight": { "type": "number" }, "CreatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "InfoCarriageCcpWithRelations" }, "CatCarriageTypeWithRelations": { "title": "CatCarriageTypeWithRelations", "type": "object", "description": "(tsType: CatCarriageTypeWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarriageType": { "type": "number" }, "Description": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Description" ], "additionalProperties": false, "x-typescript-type": "CatCarriageTypeWithRelations" }, "InfoCarrierResponseWithRelations": { "title": "InfoCarrierResponseWithRelations", "type": "object", "description": "(tsType: InfoCarrierResponseWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarrierResponse": { "type": "number" }, "IdResponse": { "type": "number" }, "IdRequest": { "type": "number" }, "Message": { "type": "string" }, "Schedule": { "type": "string" }, "LicensePlate": { "type": "string" }, "OperatorName": { "type": "boolean" }, "FumigationCert": { "type": "boolean" }, "ImssAffiliate": { "type": "boolean" }, "SpecialConditions": { "type": "string" }, "AnythingElse": { "type": "string" }, "Score": { "type": "number" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "idrequest": { "type": "number" } }, "required": [ "IdResponse", "IdRequest", "Score" ], "additionalProperties": false, "x-typescript-type": "InfoCarrierResponseWithRelations" }, "InfoCarriageRequestWithRelations": { "title": "InfoCarriageRequestWithRelations", "type": "object", "description": "(tsType: InfoCarriageRequestWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdRequest": { "type": "number" }, "IdCarriage": { "type": "number" }, "IdCarrier": { "type": "number" }, "IdUser": { "type": "number" }, "IdLot": { "type": "number" }, "Weight": { "type": "number" }, "Rate": { "type": "number" }, "SpecialComments": { "type": "string" }, "IdOTM": { "type": "string" }, "CityOrigin": { "type": "number" }, "AddressOrigin": { "type": "string" }, "CityDestiny": { "type": "number" }, "AddressDestiny": { "type": "string" }, "IdRoute": { "type": "number" }, "IdCsc": { "type": "number" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "idCarriage": { "type": "number" }, "IdCarriageType": { "type": "number" }, "cityOriginRelation": { "$ref": "#/components/schemas/CatCityWithRelations" }, "cityDestinyRelation": { "$ref": "#/components/schemas/CatCityWithRelations" }, "cartaPorte": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageCcpWithRelations" } }, "carriageTypeRelation": { "$ref": "#/components/schemas/CatCarriageTypeWithRelations" }, "carriageResponseRelation": { "$ref": "#/components/schemas/InfoCarrierResponseWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InfoCarriageRequestWithRelations" }, "CatLocationWithRelations": { "title": "CatLocationWithRelations", "type": "object", "description": "(tsType: CatLocationWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdLocation": { "type": "number" }, "Description": { "type": "string" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Description" ], "additionalProperties": false, "x-typescript-type": "CatLocationWithRelations" }, "CatCarriageStatusWithRelations": { "title": "CatCarriageStatusWithRelations", "type": "object", "description": "(tsType: CatCarriageStatusWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdStatus": { "type": "number" }, "Description": { "type": "string" }, "disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Description" ], "additionalProperties": false, "x-typescript-type": "CatCarriageStatusWithRelations" }, "InfoCarriageStatusWithRelations": { "title": "InfoCarriageStatusWithRelations", "type": "object", "description": "(tsType: InfoCarriageStatusWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarriageStatus": { "type": "number" }, "IdCarriage": { "type": "number" }, "IdUser": { "type": "number" }, "CreatedAt": { "type": "string", "format": "date-time" }, "IdStatus": { "type": "number" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "CatStatus": { "$ref": "#/components/schemas/CatCarriageStatusWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InfoCarriageStatusWithRelations" }, "CatUnitTypeDalWithRelations": { "title": "CatUnitTypeDalWithRelations", "type": "object", "description": "(tsType: CatUnitTypeDalWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdUnitType": { "type": "number" }, "Name": { "type": "string" }, "CreatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Name" ], "additionalProperties": false, "x-typescript-type": "CatUnitTypeDalWithRelations" }, "InfoUnitTypeRelWithRelations": { "title": "InfoUnitTypeRelWithRelations", "type": "object", "description": "(tsType: InfoUnitTypeRelWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdUnitTypeRel": { "type": "number" }, "IdUnitType": { "type": "number" }, "IdUnitTypeDAL": { "type": "number" }, "catUnitTypeDal": { "$ref": "#/components/schemas/CatUnitTypeDalWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InfoUnitTypeRelWithRelations" }, "InfoCarriageWithRelations": { "title": "InfoCarriageWithRelations", "type": "object", "description": "(tsType: InfoCarriageWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdCarriage": { "type": "number" }, "IdCompany": { "type": "number" }, "IdTrip": { "type": "number" }, "IdLocation": { "type": "number" }, "IdCityOrigin": { "type": "number" }, "Cup": { "type": "string" }, "Rate": { "type": "number" }, "Weight": { "type": "number" }, "Eta": { "type": "string", "format": "date-time" }, "MultipleLocation": { "type": "boolean" }, "CloseCircuit": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "LastResponse": { "type": "string", "format": "date-time" }, "IdCityDestiny": { "type": "number" }, "IdUnitType": { "type": "number" }, "cup": { "type": "string" }, "idCarriage": { "type": "number" }, "Schedule": { "type": "string" }, "LicensePlate": { "type": "string" }, "carriageBelongsToCompany": { "$ref": "#/components/schemas/AuthCompanyWithRelations" }, "CityOrigin": { "$ref": "#/components/schemas/CatCityWithRelations" }, "CityDestiny": { "$ref": "#/components/schemas/CatCityWithRelations" }, "UnitType": { "$ref": "#/components/schemas/CatUnitTypeWithRelations" }, "CupCarrier": { "$ref": "#/components/schemas/CatCarrierWithRelations" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageZoneWithRelations" } }, "match": { "type": "array", "items": { "$ref": "#/components/schemas/InfoCarriageMatchesWithRelations" } }, "carriageRequest": { "$ref": "#/components/schemas/InfoCarriageRequestWithRelations" }, "locationRelation": { "$ref": "#/components/schemas/CatLocationWithRelations" }, "carriageStatusRelation": { "$ref": "#/components/schemas/InfoCarriageStatusWithRelations" }, "infoUnitTypeRel": { "$ref": "#/components/schemas/InfoUnitTypeRelWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InfoCarriageWithRelations" }, "InfoCarrier": { "title": "InfoCarrier", "type": "object", "properties": { "IdCarrierInfo": { "type": "number" }, "IdCarrier": { "type": "number" }, "Name": { "type": "string" }, "Phone": { "type": "string" }, "Email": { "type": "string" }, "Main": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "IdCarrier", "Name", "Phone", "Email", "Main" ], "additionalProperties": false }, "InfoUsers": { "title": "InfoUsers", "type": "object", "properties": { "IdInfoUser": { "type": "number" }, "IdNotificationType": { "type": "number" }, "IdUser": { "type": "number" }, "Data": { "type": "string" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" } }, "required": [ "Data" ], "additionalProperties": false }, "InfoUserPreferencesWithRelations": { "title": "InfoUserPreferencesWithRelations", "type": "object", "description": "(tsType: InfoUserPreferencesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "IdUserPreference": { "type": "number" }, "IdUser": { "type": "number" }, "IdRange": { "type": "number" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "string", "format": "date-time" }, "UpdatedAt": { "type": "string", "format": "date-time" }, "Range": { "$ref": "#/components/schemas/CatRangeWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InfoUserPreferencesWithRelations" }, "InfoCarriage.ScopeFilter": { "type": "object", "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": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "InfoCarriage.ScopeFilter" }, "InfoCarriage.IncludeFilter.Items": { "title": "InfoCarriage.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string" }, "scope": { "$ref": "#/components/schemas/InfoCarriage.ScopeFilter" } } }, "InfoCarriage.Filter": { "type": "object", "title": "InfoCarriage.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": "InfoCarriage.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "IdCarriage": { "type": "boolean" }, "IdCompany": { "type": "boolean" }, "IdTrip": { "type": "boolean" }, "IdLocation": { "type": "boolean" }, "IdCityOrigin": { "type": "boolean" }, "Cup": { "type": "boolean" }, "Rate": { "type": "boolean" }, "Weight": { "type": "boolean" }, "Eta": { "type": "boolean" }, "MultipleLocation": { "type": "boolean" }, "CloseCircuit": { "type": "boolean" }, "CreatedAt": { "type": "boolean" }, "UpdatedAt": { "type": "boolean" }, "LastResponse": { "type": "boolean" }, "IdCityDestiny": { "type": "boolean" }, "IdUnitType": { "type": "boolean" }, "cup": { "type": "boolean" }, "idCarriage": { "type": "boolean" }, "Schedule": { "type": "boolean" }, "LicensePlate": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "IdCarriage", "IdCompany", "IdTrip", "IdLocation", "IdCityOrigin", "Cup", "Rate", "Weight", "Eta", "MultipleLocation", "CloseCircuit", "CreatedAt", "UpdatedAt", "LastResponse", "IdCityDestiny", "IdUnitType", "cup", "idCarriage", "Schedule", "LicensePlate" ], "example": "IdCarriage" }, "uniqueItems": true } ], "title": "InfoCarriage.Fields" }, "include": { "title": "InfoCarriage.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/InfoCarriage.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CatCarriageType.Filter": { "type": "object", "title": "CatCarriageType.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": "CatCarriageType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "IdCarriageType": { "type": "boolean" }, "Description": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "boolean" }, "UpdatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "IdCarriageType", "Description", "Disabled", "CreatedAt", "UpdatedAt" ], "example": "IdCarriageType" }, "uniqueItems": true } ], "title": "CatCarriageType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CatCity.Filter": { "type": "object", "title": "CatCity.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": "CatCity.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "IdCity": { "type": "boolean" }, "Name": { "type": "boolean" }, "State": { "type": "boolean" }, "Country": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "boolean" }, "UpdatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "IdCity", "Name", "State", "Country", "Disabled", "CreatedAt", "UpdatedAt" ], "example": "IdCity" }, "uniqueItems": true } ], "title": "CatCity.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CatNotificationsType.Filter": { "type": "object", "title": "CatNotificationsType.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": "CatNotificationsType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "IdNotificationType": { "type": "boolean" }, "Name": { "type": "boolean" }, "Description": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "boolean" }, "UpdatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "IdNotificationType", "Name", "Description", "Disabled", "CreatedAt", "UpdatedAt" ], "example": "IdNotificationType" }, "uniqueItems": true } ], "title": "CatNotificationsType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CatRange.Filter": { "type": "object", "title": "CatRange.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": "CatRange.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "IdRange": { "type": "boolean" }, "Description": { "type": "boolean" }, "disabled": { "type": "boolean" }, "createdat": { "type": "boolean" }, "updatedat": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "IdRange", "Description", "disabled", "createdat", "updatedat" ], "example": "IdRange" }, "uniqueItems": true } ], "title": "CatRange.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CatUnitType.Filter": { "type": "object", "title": "CatUnitType.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": "CatUnitType.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "IdUnitType": { "type": "boolean" }, "Description": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "boolean" }, "UpdatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "IdUnitType", "Description", "Disabled", "CreatedAt", "UpdatedAt" ], "example": "IdUnitType" }, "uniqueItems": true } ], "title": "CatUnitType.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "InfoUserPreferences.ScopeFilter": { "type": "object", "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": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "InfoUserPreferences.ScopeFilter" }, "InfoUserPreferences.IncludeFilter.Items": { "title": "InfoUserPreferences.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string" }, "scope": { "$ref": "#/components/schemas/InfoUserPreferences.ScopeFilter" } } }, "InfoUserPreferences.Filter": { "type": "object", "title": "InfoUserPreferences.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": "InfoUserPreferences.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "IdUserPreference": { "type": "boolean" }, "IdUser": { "type": "boolean" }, "IdRange": { "type": "boolean" }, "Disabled": { "type": "boolean" }, "CreatedAt": { "type": "boolean" }, "UpdatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "IdUserPreference", "IdUser", "IdRange", "Disabled", "CreatedAt", "UpdatedAt" ], "example": "IdUserPreference" }, "uniqueItems": true } ], "title": "InfoUserPreferences.Fields" }, "include": { "title": "InfoUserPreferences.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/InfoUserPreferences.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PingResponse": { "type": "object", "title": "PingResponse", "properties": { "greeting": { "type": "string" }, "date": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } }, "additionalProperties": true } } } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "jwt": [] } ] }