{ "openapi": "3.0.0", "info": { "title": "ubf", "version": "1.0.0", "description": "ubf forms", "contact": { "name": "Dragonfly Lab", "email": "hello@dragonflylabs.com" } }, "paths": { "/bookings/export/excel": { "get": { "x-controller-name": "BookingController", "x-operation-name": "exportBooking", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BookingController.exportBooking" } }, "/bookings/{id}/change-status": { "patch": { "x-controller-name": "BookingController", "x-operation-name": "markAsCompleted", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.markAsCompleted" } }, "/bookings/{id}/export/pdf": { "get": { "x-controller-name": "BookingController", "x-operation-name": "exportPdfById", "tags": [ "BookingController" ], "responses": { "200": { "description": "The file content", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.exportPdfById" } }, "/bookings/{id}/generate-customs-declarations": { "get": { "x-controller-name": "BookingController", "x-operation-name": "generateCustomsDeclarations", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BookingController.generateCustomsDeclarations" } }, "/bookings/{id}/generate-label": { "get": { "x-controller-name": "BookingController", "x-operation-name": "generateLabel", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BookingController.generateLabel" } }, "/bookings/{id}/generate-payment-link": { "post": { "x-controller-name": "BookingController", "x-operation-name": "generatePaymentLink", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount" ], "properties": { "amount": { "type": "number" } } } } }, "description": "Generate payment link request body", "required": true, "x-parameter-index": 1 }, "operationId": "BookingController.generatePaymentLink" } }, "/bookings/{id}/send-payment-email": { "patch": { "x-controller-name": "BookingController", "x-operation-name": "sendPaymentEmail", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount" ], "properties": { "attachment": { "type": "string", "description": "Attachment" }, "emailRecipients": { "type": "string", "description": "email reciepents" }, "emailSubject": { "type": "string", "description": "email subject" }, "emailBody": { "type": "string", "description": "email body" } } } } }, "description": "Send payment email request body", "required": true, "x-parameter-index": 1 }, "operationId": "BookingController.sendPaymentEmail" } }, "/bookings/{id}": { "patch": { "x-controller-name": "BookingController", "x-operation-name": "updateById", "tags": [ "BookingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Booking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "branchId": { "type": "number", "description": "Branch Id" }, "formNo": { "type": "number", "description": "Form no" }, "freightType": { "type": "number", "description": "Freight type. 1=Air Freight,2=Sea Freight" }, "typeOfService": { "type": "number", "description": "Type of service. possible values are 1=Port to port, 2=Door to port" }, "pol": { "type": "string", "description": "Port of loading" }, "pod": { "type": "string", "description": "Port of destination" }, "insurance": { "type": "number", "description": "Insurance. possible values are 1=Yes, 0=No" }, "insuranceCoveredAmount": { "type": "number", "description": "Insurance covered amount" }, "personalProperty": { "type": "number", "description": "Personal property? possible values are 1=Yes, 0=No" }, "purposeOfExport": { "type": "number", "description": "Perpose of export. possible values are 2=Sold, 1=Repair & Return, 3=Other" }, "incoterm": { "type": "string", "description": "Incoterm" }, "shipmentType": { "type": "number", "description": "Shipment type. possible values are 1=LCL, 2=FCL" }, "paymentDetail": { "type": "number", "description": "Payment detail. possible values are 1=Prepaid, 2=Collect" }, "customsValue": { "type": "number", "description": "Value of customs" }, "drawback": { "type": "number", "description": "Drawback required?" }, "pickupDate": { "type": "string", "description": "Pickup date" }, "deliveryDate": { "type": "string", "description": "Pickup date" }, "countryOrigin": { "type": "string", "description": "Country of Origin" }, "dangerousGoods": { "type": "number", "description": "Does this shipment contain dangerous goods?" }, "documentOptions": { "type": "array", "items": { "type": "number" }, "description": "Document options" }, "documents": { "type": "array", "items": { "type": "string" }, "description": "Documents" }, "specialInstruction": { "type": "string", "description": "Special Instructions" }, "shipperSignature": { "type": "string", "description": "Shipper signature" }, "descriptionAndMarks": { "type": "string", "description": "Description & marks" }, "shipmentBattery": { "type": "number", "description": "Does this shipment contain any battery?" }, "signName": { "type": "string", "description": "" }, "signDate": { "type": "string", "description": "" }, "checklistOptions": { "type": "array", "items": { "type": "number" }, "description": "Check list options" }, "bagPacked": { "type": "number", "description": "" }, "billNo": { "type": "string", "description": "" }, "shipper": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "shipper id" }, "companyName": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "email": { "type": "string", "format": "email", "description": "" }, "contactPerson": { "type": "string", "description": "" }, "tin": { "type": "string", "description": "" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "consignee": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "consignee id" }, "companyName": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "email": { "type": "string", "format": "email", "description": "" }, "contactPerson": { "type": "string", "description": "" }, "tin": { "type": "string", "description": "" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "cargoDetails": { "type": "array", "description": "", "items": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "Cargo id" }, "cargoDescription": { "type": "string", "description": "Cargo description" }, "packageType": { "type": "string", "description": "Package type" }, "weight": { "type": "number", "description": "Weight" }, "chargeableWeight": { "type": "number", "description": "Chargeable Weight" }, "quantity": { "type": "number", "description": "Quanitity" }, "perPackageWeight": { "type": "number", "description": "Per package weight" }, "totalWeight": { "type": "number", "description": "Total weight" }, "length": { "type": "number", "description": "Length" }, "height": { "type": "number", "description": "Height" }, "width": { "type": "number", "description": "Width" }, "cbm": { "type": "number", "description": "cbm" }, "totalCbm": { "type": "number", "description": "total cbm" } } } }, "country": { "type": "string", "description": "" }, "sendEmail": { "type": "number", "description": "" }, "pickup": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "Address id" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "delivery": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "Address id" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "isPickupSameAsSender": { "type": "number", "description": "" }, "isDeliverySameAsConsignee": { "type": "number", "description": "" }, "isShipmentQuoted": { "type": "number", "description": "" }, "cargoType": { "type": "number", "description": "" }, "isPickupServiceRequired": { "type": "number", "description": "" }, "isTailLiftRequired": { "type": "number", "description": "" }, "isHandLoadRequired": { "type": "number", "description": "" }, "bookingPdf": { "type": "string", "description": "" } } } } }, "description": "Request body for booking save", "required": true, "x-parameter-index": 1 }, "operationId": "BookingController.updateById" }, "get": { "x-controller-name": "BookingController", "x-operation-name": "findById", "tags": [ "BookingController" ], "responses": { "200": { "description": "BookingFormOneResponse", "content": { "application/json": { "schema": { "anyOf": [ { "type": "array", "title": "BookingFormOneResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "uniqueId": { "type": "string" }, "formNo": { "type": "number" }, "freightType": { "type": "number" }, "typeOfService": { "type": "number" }, "pol": { "type": "string" }, "pod": { "type": "string" }, "personalProperty": { "type": "number" }, "specialInstruction": { "type": "string" }, "shipperSignature": { "type": "string" }, "shipperSignatureSource": { "type": "string" }, "descriptionAndMarks": { "type": "string" }, "cargoDetails": { "description": "CargoDetailsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "CargoDetailsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "packageType": { "type": "string" }, "cargoDescription": { "type": "string" }, "weight": { "type": "number" }, "quantity": { "type": "number" }, "perPackageWeight": { "type": "number" }, "totalWeight": { "type": "number" }, "length": { "type": "number" }, "height": { "type": "number" }, "width": { "type": "number" }, "cbm": { "type": "number" }, "totalCbm": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } }, "shipper": { "description": "ShipperResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperResponse" } } } }, "consignee": { "description": "ConsigneeResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsigneeResponse" } } } }, "created": { "type": "number" }, "updated": { "type": "number" }, "status": { "type": "number" } } } }, { "type": "array", "title": "BookingResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "uniqueId": { "type": "string" }, "formNo": { "type": "number" }, "freightType": { "type": "number" }, "typeOfService": { "type": "number" }, "pol": { "type": "string" }, "pod": { "type": "string" }, "insurance": { "type": "number" }, "insuranceCoveredAmount": { "type": "number" }, "personalProperty": { "type": "number" }, "purposeOfExport": { "type": "number" }, "incoterm": { "type": "string" }, "shipmentType": { "type": "number" }, "paymentDetail": { "type": "number" }, "customsValue": { "type": "number" }, "drawback": { "type": "number" }, "pickupDate": { "type": "string" }, "deliveryDate": { "type": "string" }, "countryOrigin": { "type": "string" }, "dangerousGoods": { "type": "number" }, "documentOptions": { "type": "array", "items": [] }, "documents": { "type": "array", "items": [] }, "documentsSources": { "type": "array", "items": [] }, "specialInstruction": { "type": "string" }, "shipperSignature": { "type": "string" }, "shipperSignatureSource": { "type": "string" }, "descriptionAndMarks": { "type": "string" }, "shipmentBattery": { "type": "number" }, "cargoDetails": { "description": "CargoDetailsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "CargoDetailsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "packageType": { "type": "string" }, "cargoDescription": { "type": "string" }, "weight": { "type": "number" }, "quantity": { "type": "number" }, "perPackageWeight": { "type": "number" }, "totalWeight": { "type": "number" }, "length": { "type": "number" }, "height": { "type": "number" }, "width": { "type": "number" }, "cbm": { "type": "number" }, "totalCbm": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } }, "shipper": { "description": "ShipperResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperResponse" } } } }, "consignee": { "description": "ConsigneeResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsigneeResponse" } } } }, "created": { "type": "number" }, "updated": { "type": "number" }, "status": { "type": "number" } } } } ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BookingController.findById" } }, "/bookings": { "post": { "x-controller-name": "BookingController", "x-operation-name": "create", "tags": [ "BookingController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [], "properties": { "branchId": { "type": "number", "description": "Branch Id" }, "formNo": { "type": "number", "description": "Form no" }, "freightType": { "type": "number", "description": "Freight type. 1=Air Freight,2=Sea Freight" }, "typeOfService": { "type": "number", "description": "Type of service. possible values are 1=Port to port, 2=Door to port" }, "pol": { "type": "string", "description": "Port of loading" }, "pod": { "type": "string", "description": "Port of destination" }, "insurance": { "type": "number", "description": "Insurance. possible values are 1=Yes, 0=No" }, "insuranceCoveredAmount": { "type": "number", "description": "Insurance covered amount" }, "personalProperty": { "type": "number", "description": "Personal property? possible values are 1=Yes, 0=No" }, "purposeOfExport": { "type": "number", "description": "Perpose of export. possible values are 2=Sold, 1=Repair & Return, 3=Other" }, "incoterm": { "type": "string", "description": "Incoterm" }, "shipmentType": { "type": "number", "description": "Shipment type. possible values are 1=LCL, 2=FCL" }, "paymentDetail": { "type": "number", "description": "Payment detail. possible values are 1=Prepaid, 2=Collect" }, "customsValue": { "type": "number", "description": "Value of customs" }, "drawback": { "type": "number", "description": "Drawback required?" }, "pickupDate": { "type": "string", "description": "Pickup date" }, "deliveryDate": { "type": "string", "description": "Pickup date" }, "countryOrigin": { "type": "string", "description": "Country of Origin" }, "dangerousGoods": { "type": "number", "description": "Does this shipment contain dangerous goods?" }, "documentOptions": { "type": "array", "items": { "type": "number" }, "description": "Document options" }, "documents": { "type": "array", "items": { "type": "string" }, "description": "Documents" }, "specialInstruction": { "type": "string", "description": "Special Instructions" }, "shipperSignature": { "type": "string", "description": "Shipper signature" }, "descriptionAndMarks": { "type": "string", "description": "Description & marks" }, "shipmentBattery": { "type": "number", "description": "Does this shipment contain any battery?" }, "signName": { "type": "string", "description": "" }, "signDate": { "type": "string", "description": "" }, "checklistOptions": { "type": "array", "items": { "type": "number" }, "description": "Check list options" }, "bagPacked": { "type": "number", "description": "" }, "billNo": { "type": "string", "description": "" }, "shipper": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "shipper id" }, "companyName": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "email": { "type": "string", "format": "email", "description": "" }, "contactPerson": { "type": "string", "description": "" }, "tin": { "type": "string", "description": "" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "consignee": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "consignee id" }, "companyName": { "type": "string", "description": "" }, "phoneNumber": { "type": "string", "description": "" }, "email": { "type": "string", "format": "email", "description": "" }, "contactPerson": { "type": "string", "description": "" }, "tin": { "type": "string", "description": "" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "cargoDetails": { "type": "array", "description": "", "items": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "Cargo id" }, "cargoDescription": { "type": "string", "description": "Cargo description" }, "packageType": { "type": "string", "description": "Package type" }, "weight": { "type": "number", "description": "Weight" }, "chargeableWeight": { "type": "number", "description": "Chargeable Weight" }, "quantity": { "type": "number", "description": "Quanitity" }, "perPackageWeight": { "type": "number", "description": "Per package weight" }, "totalWeight": { "type": "number", "description": "Total weight" }, "length": { "type": "number", "description": "Length" }, "height": { "type": "number", "description": "Height" }, "width": { "type": "number", "description": "Width" }, "cbm": { "type": "number", "description": "cbm" }, "totalCbm": { "type": "number", "description": "total cbm" } } } }, "country": { "type": "string", "description": "" }, "sendEmail": { "type": "number", "description": "" }, "pickup": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "Address id" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "delivery": { "type": "object", "required": [], "properties": { "id": { "type": "number", "description": "Address id" }, "address": { "type": "string", "description": "" }, "city": { "type": "string", "description": "" }, "state": { "type": "string", "description": "" }, "pincode": { "type": "number", "description": "" } } }, "isPickupSameAsSender": { "type": "number", "description": "" }, "isDeliverySameAsConsignee": { "type": "number", "description": "" }, "isShipmentQuoted": { "type": "number", "description": "" }, "cargoType": { "type": "number", "description": "" }, "isPickupServiceRequired": { "type": "number", "description": "" }, "isTailLiftRequired": { "type": "number", "description": "" }, "isHandLoadRequired": { "type": "number", "description": "" }, "bookingPdf": { "type": "string", "description": "" } } } } }, "description": "Request body for booking save", "required": true }, "operationId": "BookingController.create" }, "get": { "x-controller-name": "BookingController", "x-operation-name": "find", "tags": [ "BookingController" ], "responses": { "200": { "description": "BookingsResponse", "content": { "application/json": { "schema": { "type": "array", "title": "BookingsResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "uniqueId": { "type": "string" }, "formNo": { "type": "number" }, "shipper": { "type": "string" }, "consignee": { "type": "string" }, "pol": { "type": "string" }, "pod": { "type": "string" }, "created": { "type": "number" }, "updated": { "type": "number" }, "status": { "type": "number" } } } } } } } }, "parameters": [ { "name": "searchStr", "in": "query", "schema": { "type": "string" } }, { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BookingController.find" } }, "/countries": { "get": { "x-controller-name": "CountryController", "x-operation-name": "find", "tags": [ "CountryController" ], "responses": { "200": { "description": "Array of Country model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryWithRelations" } } } } } }, "operationId": "CountryController.find" } }, "/documenttypes": { "get": { "x-controller-name": "DocumenttypeController", "x-operation-name": "find", "tags": [ "DocumenttypeController" ], "responses": { "200": { "description": "DocumenttypesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "DocumenttypesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" } } } } } } } }, "operationId": "DocumenttypeController.find" } }, "/files/{purpose}": { "post": { "x-controller-name": "FileUploadController", "x-operation-name": "fileUpload", "tags": [ "FileUploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "parameters": [ { "name": "purpose", "in": "path", "schema": { "type": "number" }, "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": "FileUploadController.fileUpload" } }, "/generate-stripe-link": { "get": { "x-controller-name": "BookingController", "x-operation-name": "generateStripeLink", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Export booking" } } } } }, "operationId": "BookingController.generateStripeLink" } }, "/migrate/consignee": { "get": { "x-controller-name": "BookingController", "x-operation-name": "migrateConsignee", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "" } } } } }, "parameters": [ { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } } ], "operationId": "BookingController.migrateConsignee" } }, "/migrate/shipper": { "get": { "x-controller-name": "BookingController", "x-operation-name": "migrateShipper", "tags": [ "BookingController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "" } } } } }, "parameters": [ { "name": "start", "in": "query", "schema": { "type": "number" } }, { "name": "length", "in": "query", "schema": { "type": "number" } } ], "operationId": "BookingController.migrateShipper" } }, "/paymark/getresponse": { "post": { "x-controller-name": "PaymarkController", "x-operation-name": "getResponse", "tags": [ "PaymarkController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Paymark webhook response" } } } } }, "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": {} } } }, "description": "Webhook request", "required": true }, "operationId": "PaymarkController.getResponse" } }, "/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" } }, "/roles": { "get": { "x-controller-name": "RoleController", "x-operation-name": "find", "tags": [ "RoleController" ], "responses": { "200": { "description": "RolesResponse", "content": { "application/json": { "schema": { "type": "array", "title": "RolesResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } } } } } } }, "operationId": "RoleController.find" } }, "/stripe/getresponse": { "post": { "x-controller-name": "StripeController", "x-operation-name": "getResponse", "tags": [ "StripeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Stripe webhook response" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } }, "description": "Webhook request", "required": true }, "operationId": "StripeController.getResponse" } }, "/stripe/payment-confirmation/{bookingId}": { "get": { "x-controller-name": "StripeController", "x-operation-name": "paymentConfirmation", "tags": [ "StripeController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Payment confirmation" } } } } }, "parameters": [ { "name": "bookingId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StripeController.paymentConfirmation" } }, "/users/add": { "post": { "x-controller-name": "UserController", "x-operation-name": "registration", "tags": [ "UserController" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "title": "", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName", "lastName", "email", "password", "confirmPassword", "roleId" ], "properties": { "firstName": { "type": "string", "description": "User first name." }, "lastName": { "type": "string", "description": "User last name." }, "email": { "type": "string", "description": "Email address for a user.", "jsonSchema": { "format": "email", "transform": [ "toLowerCase" ], "errorMessage": "Email should be valid." } }, "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" } } } } }, "description": "Add user request body", "required": true }, "operationId": "UserController.registration" } }, "/users/change-password": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changePassword", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "password", "confirmPassword" ], "properties": { "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } } } } } }, "description": "Change password request body", "required": true }, "operationId": "UserController.changePassword" } }, "/users/change-role": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeRole", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change role success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "roleId" ], "properties": { "id": { "type": "number" }, "roleId": { "type": "number", "description": "Role of the user. Possible values are 2 = Sales Manager,3 = Sales Support Executive,4 = Ops Staff" } } } } }, "description": "Change role request body", "required": true }, "operationId": "UserController.changeRole" } }, "/users/change-status": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeStatus", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "number" }, "status": { "type": "number", "description": " Possible values are 0 = Deactive, 1 = Active,2 = Delete" } } } } }, "description": "Change status request body", "required": true }, "operationId": "UserController.changeStatus" } }, "/users/login": { "post": { "x-controller-name": "UserController", "x-operation-name": "login", "tags": [ "UserController" ], "responses": { "200": { "description": "LoginResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 } } } } }, "description": "The input of login function", "required": true }, "operationId": "UserController.login" } }, "/users/me": { "get": { "x-controller-name": "UserController", "x-operation-name": "me", "tags": [ "UserController" ], "responses": { "200": { "description": "UserResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "operationId": "UserController.me" } }, "/users/roles/{roleId}": { "get": { "x-controller-name": "UserController", "x-operation-name": "findRoleWiseUsers", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "roleId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserController.findRoleWiseUsers" } }, "/users/roles": { "get": { "x-controller-name": "UserController", "x-operation-name": "findRolesUsers", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "roleId", "in": "query", "schema": { "type": "string" } } ], "operationId": "UserController.findRolesUsers" } }, "/users/{id}/change-password": { "patch": { "x-controller-name": "UserController", "x-operation-name": "changeUserPassword", "tags": [ "UserController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Change status success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "password", "confirmPassword" ], "properties": { "password": { "type": "string", "description": "Password for authentication. Must be atleast 8 character and maximum 16 character.", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Password must be atleast 8 character and maximum 16 character." } }, "confirmPassword": { "type": "string", "description": "Re enter password", "jsonSchema": { "minLength": 8, "maxLength": 16, "errorMessage": "Please re enter password." } } } } } }, "description": "Change password request body", "required": true, "x-parameter-index": 1 }, "operationId": "UserController.changeUserPassword" } }, "/users/{id}": { "get": { "x-controller-name": "UserController", "x-operation-name": "findById", "tags": [ "UserController" ], "responses": { "200": { "description": "UserResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserController.findById" } }, "/users": { "get": { "x-controller-name": "UserController", "x-operation-name": "find", "tags": [ "UserController" ], "responses": { "200": { "description": "UsersResponse", "content": { "application/json": { "schema": { "type": "array", "title": "UsersResponse", "items": { "type": "object", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } } } }, "operationId": "UserController.find" } } }, "servers": [ { "url": "http://ubforms.techkopra.com" } ], "components": { "schemas": { "CountryWithRelations": { "title": "CountryWithRelations", "type": "object", "description": "(tsType: CountryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "CountryWithRelations" }, "ShipperResponse": { "type": "object", "title": "ShipperResponse", "properties": { "id": { "type": "number" }, "companyName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "contactPerson": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "pincode": { "type": "number" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "ConsigneeResponse": { "type": "object", "title": "ConsigneeResponse", "properties": { "id": { "type": "number" }, "companyName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "contactPerson": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "pincode": { "type": "number" }, "status": { "type": "number" }, "created": { "type": "number" }, "updated": { "type": "number" } } }, "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 } } }, "LoginResponse": { "type": "object", "title": "LoginResponse", "properties": { "token": { "type": "string" } } }, "UserResponse": { "type": "object", "title": "UserResponse", "properties": { "id": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "roleId": { "type": "number" }, "branchId": { "type": "number" }, "status": { "type": "number" }, "role": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } }, "branch": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [] }