{ "openapi": "3.0.0", "info": { "title": "Harba API Documentation", "version": "0.0.0" }, "servers": [ { "url": "https://api.harba.co", "description": "Production server" } ], "paths": { "/doc/": { "get": { "responses": { "default": { "description": "" } } } }, "/harbor-employee/{harbor}/list": { "get": { "tags": [ "Harbor employee" ], "operationId": "get_harbor_employee_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of harbor employees.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HarborEmployee" } } } } } } } }, "/harbor-employee/{harbor}/{employee}/remove": { "delete": { "tags": [ "Harbor employee" ], "operationId": "delete_harbor_employee_remove", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Harbor employee deleted successfully.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/harbor-employee/{harbor}/{user}/exists": { "get": { "tags": [ "Harbor employee" ], "operationId": "get_harbor_employee_exists", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Checks if selected user already is already part of harbor team.", "content": { "application/json": { "schema": { "properties": { "exists": { "type": "boolean" } }, "type": "object" } } } } } } }, "/harbor-employee/{harbor}/add": { "post": { "tags": [ "Harbor employee" ], "operationId": "post_harbor_employee_add", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborEmployeeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborEmployeeForm" } } } }, "responses": { "200": { "description": "Returns harbor employee.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborEmployee2" } } } } } } }, "/harbor-employee/{harbor}/{employee}/edit": { "put": { "tags": [ "Harbor employee" ], "operationId": "put_harbor_employee_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "employee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborEmployeeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborEmployeeForm" } } } }, "responses": { "200": { "description": "Returns harbor employee.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborEmployee2" } } } } } } }, "/": { "get": { "responses": { "default": { "description": "" } } }, "put": { "responses": { "default": { "description": "" } } }, "post": { "responses": { "default": { "description": "" } } }, "delete": { "responses": { "default": { "description": "" } } }, "options": { "responses": { "default": { "description": "" } } }, "head": { "responses": { "default": { "description": "" } } }, "patch": { "responses": { "default": { "description": "" } } }, "trace": { "responses": { "default": { "description": "" } } } }, "/marketing-material/{module}": { "get": { "tags": [ "Marketing material" ], "operationId": "get_marketing_material_view", "parameters": [ { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns marketing material for different locales.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingMaterialDTO" } } } } } }, "put": { "tags": [ "Marketing material" ], "operationId": "put_marketing_material_edit", "parameters": [ { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "MarketingMaterialController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingMaterialBulkForm" } } } }, "responses": { "200": { "description": "Returns marketing material for different locales.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketingMaterialDTO" } } } } } } }, "/marketing-material/{module}/{harbor}/interact": { "get": { "tags": [ "Marketing material" ], "operationId": "get_marketing_material_interact", "parameters": [ { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully interacted." } } } }, "/marketing-material/{module}/get-call": { "post": { "tags": [ "Marketing material" ], "operationId": "post_marketing_material_get_call", "parameters": [ { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "MarketingMaterialController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSalesCallForm" } } } }, "responses": { "200": { "description": "Call successfully booked.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/admin/alert/view": { "get": { "tags": [ "Admin alert" ], "operationId": "get_notification_adminalert_view", "responses": { "default": { "description": "" } } } }, "/admin/alert/edit": { "post": { "tags": [ "Admin alert" ], "operationId": "post_notification_adminalert_edit", "responses": { "default": { "description": "" } } } }, "/sailor/trip-report/add": { "post": { "tags": [ "Sailor Trip Report" ], "operationId": "post_sailor_trip_report_add", "requestBody": { "request": "SailorTripReportController", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorTripReportForm" } } } }, "responses": { "200": { "description": "Trip report added.", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" } }, "type": "object" } } } } } } }, "/sailor/trip-report/active-list/{harbor}": { "get": { "tags": [ "Sailor Trip Report" ], "operationId": "get_sailor_trip_report_active_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Active trip report list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripReportDTO" } } } } } } }, "/trip-report/list": { "get": { "tags": [ "Trip reports" ], "operationId": "get_trip_report_list", "parameters": [ { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "q", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "userHarbors", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripReport" } } } } } } }, "/trip-report/{tripReport}": { "get": { "tags": [ "Trip reports" ], "operationId": "get_trip_report_view", "parameters": [ { "name": "tripReport", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripReport" } } } } } }, "put": { "tags": [ "Trip reports" ], "operationId": "put_trip_report_edit", "parameters": [ { "name": "tripReport", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "TripReportController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripReport2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripReport" } } } } } }, "delete": { "tags": [ "Trip reports" ], "operationId": "delete_trip_report_delete", "parameters": [ { "name": "tripReport", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/trip-report/{harbor}": { "post": { "tags": [ "Trip reports" ], "operationId": "post_trip_report_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "TripReportController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripReport2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripReport" } } } } } } }, "/discounts": { "get": { "tags": [ "Discount" ], "operationId": "get_discounts_list", "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Discount" ], "operationId": "post_discounts_create", "responses": { "201": { "description": "Success" } } } }, "/discounts/{discountCode}": { "get": { "tags": [ "Discount" ], "operationId": "get_discounts_view", "parameters": [ { "name": "discountCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Discount" ], "operationId": "put_discounts_update", "parameters": [ { "name": "discountCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Discount" ], "operationId": "delete_discounts_delete", "parameters": [ { "name": "discountCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/discounts/discount/check": { "get": { "tags": [ "Discount" ], "operationId": "get_discounts_check", "parameters": [ { "name": "code", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "currency", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/lots/{harbor}": { "get": { "tags": [ "Camper lots" ], "operationId": "get_camper_lot_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/lots/{harbor}/view/{lot}": { "get": { "tags": [ "Camper lots" ], "operationId": "get_camper_lot_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "lot", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/lots/{harbor}/create": { "post": { "tags": [ "Camper lots" ], "operationId": "post_camper_lot_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/lots/{harbor}/edit/{camperLot}": { "put": { "tags": [ "Camper lots" ], "operationId": "put_camper_lot_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "camperLot", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/lots/{harbor}/delete/{camperLot}": { "delete": { "tags": [ "Camper lots" ], "operationId": "delete_camper_lot_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "camperLot", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/camper/reservations/active-list": { "get": { "tags": [ "Camper reservations" ], "operationId": "get_camper_reservations_active_list", "responses": { "200": { "description": "Get a paginated list of current autocamper visitors of assigned harbor", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total count", "type": "integer" }, "data": { "description": "Current page data", "type": "array", "items": { "$ref": "#/components/schemas/CamperReservationListDTO" } } }, "type": "object" } } } } } } }, "/camper/reservations/list": { "get": { "tags": [ "Camper reservations" ], "operationId": "get_camper_reservations_list", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/reservations/summary": { "get": { "tags": [ "Camper reservations" ], "operationId": "get_camper_reservations_summary", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "q", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/reservations/boat_stats": { "get": { "tags": [ "Camper reservations" ], "operationId": "get_camper_reservations_boat_stats", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/reservations/view/{camperReservation}": { "get": { "tags": [ "Camper reservations" ], "operationId": "get_camper_reservations_camper_camperreservation_view", "parameters": [ { "name": "camperReservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/camper/settings/{harbor}": { "get": { "tags": [ "Camper settings" ], "operationId": "get_camper_setting_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Camper settings" ], "operationId": "put_camper_setting_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Camper settings" ], "operationId": "post_camper_setting_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor/camper-reservation/current-list": { "get": { "tags": [ "Sailor Campers" ], "operationId": "get_sailor_camper_current_list", "responses": { "200": { "description": "Returns an array of current user camper reservations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCamperCurrentListProvider" } } } } } } }, "/sailor/camper-reservation/past-list": { "get": { "tags": [ "Sailor Campers" ], "operationId": "get_sailor_camper_past_list", "responses": { "200": { "description": "Returns an array of current user camper reservations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCamperPastListProvider" } } } } } } }, "/sailor/camper-reservation/view/{camper}": { "get": { "tags": [ "Sailor Campers" ], "operationId": "get_sailor_camper_view", "parameters": [ { "name": "camper", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns camper reservation data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamperReservation" } } } } } } }, "/sailor-public/camper/lot/{harbor}": { "get": { "tags": [ "Sailor Public Campers" ], "operationId": "get_sailor_public_camper_lot_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of available camper lots", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorPublicCamperLotDTO" } } } } } } } }, "/sailor-public/camper/settings/{harbor}": { "get": { "tags": [ "Sailor Public Campers" ], "operationId": "get_sailor_public_camper_settings_view_settings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicCamperSettingDTO" } } } } } } }, "/sailor-public/slipway/settings/{harbor}": { "get": { "tags": [ "Public slipway" ], "operationId": "get_sailor_public_slipway_view_settings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/slipway/reservations/active-list": { "get": { "tags": [ "Slipway reservations" ], "operationId": "get_slipway_reservations_active_list", "responses": { "200": { "description": "Get a paginated list of current slipway visitors of assigned harbor", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total count", "type": "integer" }, "data": { "description": "Current page data", "type": "array", "items": { "$ref": "#/components/schemas/SlipwayReservationListDTO" } } }, "type": "object" } } } } } } }, "/slipway/reservations/list": { "get": { "tags": [ "Slipway reservations" ], "operationId": "get_slipway_reservations_list", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/slipway/reservations/summary": { "get": { "tags": [ "Slipway reservations" ], "operationId": "get_slipway_reservations_summary", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "q", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/slipway/reservations/boat_stats": { "get": { "tags": [ "Slipway reservations" ], "operationId": "get_slipway_reservations_boat_stats", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/slipway/reservations/view/{slipwayReservation}": { "get": { "tags": [ "Slipway reservations" ], "operationId": "get_slipway_reservations_slipway_slipwayreservation_view", "parameters": [ { "name": "slipwayReservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/slipway/settings/{harbor}": { "get": { "tags": [ "Slipway settings" ], "operationId": "get_slipway_setting_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Slipway settings" ], "operationId": "put_slipway_setting_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Slipway settings" ], "operationId": "post_slipway_setting_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/credits/{harbor}": { "get": { "tags": [ "Credits" ], "operationId": "get_credit_credit_credit_getcardholdercredits", "parameters": [ { "name": "email", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "phone", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/credits/{credit}/balance": { "put": { "tags": [ "Credits" ], "operationId": "put_credit_credit_credit_changecardholdercredits", "parameters": [ { "name": "credit", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/credit-logs/{credit}": { "get": { "tags": [ "Credit logs" ], "operationId": "get_credit_logs_list", "parameters": [ { "name": "credit", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/credit/settings/{harbor}": { "get": { "tags": [ "Credit settings" ], "operationId": "get_credit_creditsettings_getsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditSettings" } } } } } }, "put": { "tags": [ "Credit settings" ], "operationId": "put_credit_creditsettings_postsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CreditSettingsController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditSettingsForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditSettings" } } } } } }, "post": { "tags": [ "Credit settings" ], "operationId": "post_credit_creditsettings_postsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CreditSettingsController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditSettingsForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditSettings" } } } } } } }, "/credit-balance/{token}": { "get": { "tags": [ "Credits" ], "operationId": "get_public_credit_balance_short", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor/credit/balance/{harbor}": { "get": { "tags": [ "Sailor Credits" ], "operationId": "get_sailor_credit_balance", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return user credit balance in harbor", "content": { "application/json": { "schema": { "properties": { "balance": { "description": "Amount of currency left in user account for given harbor", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Credit balance for user in this harbor doesn't exists." } } } }, "/harbor/{harbor}/map/settings": { "get": { "tags": [ "Harbor map settings" ], "operationId": "get_harbor_map_settings_harbormap_setting_getsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborMapSettings" } } } } } }, "put": { "tags": [ "Harbor map settings" ], "operationId": "put_harbor_map_settings_harbormap_setting_postsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborMapSettingsForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborMapSettings" } } } } } }, "post": { "tags": [ "Harbor map settings" ], "operationId": "post_harbor_map_settings_harbormap_setting_postsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborMapSettingsForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborMapSettings" } } } } } } }, "/inbound": { "post": { "summary": "This endpoint is for receiving all inbound Nexmo API SMS messages from any number.", "responses": { "default": { "description": "" } } } }, "/translations/{name}": { "get": { "tags": [ "Translation" ], "summary": "Translate a generic translation to a language provided by the header", "operationId": "get_translation_translation_gettranslation", "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/utilities": { "get": { "tags": [ "Harbor Utility" ], "operationId": "get_utilities_list", "responses": { "200": { "description": "Success" } } } }, "/utilities/{utility}": { "get": { "tags": [ "Harbor Utility" ], "operationId": "get_utilities_view", "parameters": [ { "name": "utility", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/messages": { "get": { "tags": [ "Message" ], "operationId": "get_message_list", "parameters": [ { "name": "harbor", "in": "query", "description": "If provided will only show messages for this harbor", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Message" ], "operationId": "post_message_create", "responses": { "201": { "description": "Success" } } } }, "/messages/predefined": { "get": { "tags": [ "Message" ], "operationId": "get_message_list_predefined", "responses": { "200": { "description": "Success" } } } }, "/messages/{message}": { "get": { "tags": [ "Message" ], "operationId": "get_message_view", "parameters": [ { "name": "message", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/messages/preview": { "post": { "tags": [ "Message" ], "operationId": "post_message_preview", "responses": { "202": { "description": "Success" } } } }, "/messages/send-preview-email": { "post": { "tags": [ "Message" ], "operationId": "post_message_send_preview_email", "responses": { "200": { "description": "Success" } } } }, "/messages/limits/{harbor}": { "get": { "tags": [ "Message" ], "operationId": "get_message_limits", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/filter/list/{harbor}": { "get": { "tags": [ "Message filter" ], "operationId": "get_message_filter_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/filter/list-paginated/{harbor}": { "get": { "tags": [ "Message filter" ], "operationId": "get_message_filter_list_paginated", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/filter/create": { "post": { "tags": [ "Message filter" ], "operationId": "post_message_filter_create", "responses": { "201": { "description": "Success" } } } }, "/message/filter/view/{filter}": { "get": { "tags": [ "Message filter" ], "operationId": "get_message_filter_view", "parameters": [ { "name": "filter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/filter/edit/{filter}": { "put": { "tags": [ "Message filter" ], "operationId": "put_message_filter_edit", "parameters": [ { "name": "filter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/filter/list-users/{harbor}": { "post": { "tags": [ "Message filter" ], "operationId": "post_message_filter_list_users", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/filter/list-subscription-products/{harbor}": { "get": { "tags": [ "Message filter" ], "operationId": "get_message_filter_list_subscription_products", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/filter/{filter}": { "delete": { "tags": [ "Message filter" ], "operationId": "delete_message_filter_delete", "parameters": [ { "name": "filter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/message/recipient/{message}": { "get": { "tags": [ "Message recipient" ], "operationId": "get_message_recipient_list", "parameters": [ { "name": "message", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/template/{harbor}/list": { "get": { "tags": [ "Message template" ], "operationId": "get_message_template_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/template/{harbor}/list-paginated": { "get": { "tags": [ "Message template" ], "operationId": "get_message_template_list_paginated", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/template/{harbor}/create": { "post": { "tags": [ "Message template" ], "operationId": "post_message_template_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/message/template/{harbor}/view/{template}": { "get": { "tags": [ "Message template" ], "operationId": "get_message_template_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/template/{harbor}/edit/{template}": { "put": { "tags": [ "Message template" ], "operationId": "put_message_template_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/message/template/{harbor}/delete/{template}": { "delete": { "tags": [ "Message template" ], "operationId": "delete_message_template_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "template", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/sailor/waiting-list/{harbor}/setting": { "get": { "tags": [ "Sailor Waiting List" ], "operationId": "get_sailor_waiting_list_setting", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Waiting list settings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListSetting" } } } }, "204": { "description": "Harbor doesn't have waiting list settings." } } } }, "/sailor/waiting-list-entry/submit-preference/{entry}": { "post": { "tags": [ "Sailor Waiting List Entry" ], "summary": "MUST BE USED ONLY IF YEARLY FEE IS 0.", "operationId": "post_sailor_waiting_list_entry_submit_preference", "parameters": [ { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorWaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorWaitingListEntryPreferenceForm" } } } }, "responses": { "403": { "description": "Returns an error: either due date passed, already answered or wrong entry", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Either wrong boat or form field issue", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message", "type": "string" } }, "type": "object" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/sailor/waiting-list-entry/user-entries": { "get": { "tags": [ "Sailor Waiting List Entry" ], "operationId": "get_sailor_waiting_list_entry_user_entries", "responses": { "200": { "description": "List of user entries in all harbors", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListEntryDTO" } } } } } } } }, "/sailor/waiting-list-entry/user-active-preferences": { "get": { "tags": [ "Sailor Waiting List Entry" ], "operationId": "get_sailor_waiting_list_entry_user_active-preferences", "responses": { "200": { "$ref": { "schema": "SailorWaitingListEntryController", "type": "array", "items": { "$ref": "#/components/schemas/WaitingListPreferencesDTO" } } } } } }, "/sailor/waiting-list-entry/user-active-offers": { "get": { "tags": [ "Sailor Waiting List Entry" ], "operationId": "get_sailor_waiting_list_entry_user_active_offers", "responses": { "200": { "$ref": { "schema": "SailorWaitingListEntryController", "type": "array", "items": { "$ref": "#/components/schemas/SailorWaitingListOfferDTO" } } } } } }, "/sailor/waiting-list-entry/{entry}/remove": { "delete": { "tags": [ "Sailor Waiting List Entry" ], "operationId": "delete_sailor_waiting_list_entry_remove", "parameters": [ { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } }, "403": { "description": "Wrong entry passed", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message", "type": "string" } }, "type": "object" } } } } } } }, "/sailor/waiting-list-entry/{harbor}/sign-up": { "post": { "tags": [ "Sailor Waiting List Entry" ], "summary": "MUST ONLY BE USED WHEN REGISTRATION FEE IS 0.", "operationId": "post_sailor_waiting_list_entry_sign_up", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorWaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorWaitingListEntryForm" } } } }, "responses": { "201": { "description": "Returns newly created waiting list entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntry" } } } }, "204": { "description": "Either registration fee is not 0" }, "400": { "description": "Error thrown during sign up.", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } } } } } }, "/sailor/waiting-list-entry/{harbor}/{type}/product": { "get": { "tags": [ "Sailor Waiting List Entry" ], "operationId": "get_sailor_waiting_list_entry_get_product", "parameters": [ { "name": "categoryId", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns waiting list product.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingList" } } } } } } }, "/sailor/waiting-list-entry/{offerEntry}/accept": { "patch": { "tags": [ "Sailor Waiting List Entry" ], "operationId": "patch_sailor_waiting_list_entry_accept_offer", "parameters": [ { "name": "offerEntry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": { "schema": "SailorWaitingListEntryController", "properties": { "success": { "type": "boolean" } }, "type": "object" } }, "204": { "description": "Already responded." } } } }, "/sailor/waiting-list-entry/{offerEntry}/decline": { "patch": { "tags": [ "Sailor Waiting List Entry" ], "operationId": "patch_sailor_waiting_list_entry_decline_offer", "parameters": [ { "name": "offerEntry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Already responded." }, "200": { "$ref": { "schema": "SailorWaitingListEntryController", "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } }, "/waiting-list-category/{harbor}/list": { "get": { "tags": [ "Waiting List Category" ], "operationId": "get_waiting_list_category_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns waiting list categories", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListCategoryDTO" } } } } } } } }, "/waiting-list-category/{harbor}/create": { "post": { "tags": [ "Waiting List Category" ], "operationId": "post_waiting_list_category_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListCategoryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListCategoryForm" } } } }, "responses": { "400": { "description": "Something went wrong" }, "201": { "description": "Returns newly created waiting list category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListCategory" } } } } } } }, "/waiting-list-category/{harbor}/{category}/edit": { "put": { "tags": [ "Waiting List Category" ], "operationId": "put_waiting_list_category_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListCategoryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListCategoryForm" } } } }, "responses": { "400": { "description": "Either unrecognised field was passed to form or a required field is missing" }, "200": { "description": "Returns edited waiting list category.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListCategory" } } } } } } }, "/waiting-list-entry/{harbor}/list": { "get": { "tags": [ "Waiting List Entry" ], "operationId": "get_waiting_list_entry_list", "parameters": [ { "name": "page", "in": "query", "required": true }, { "name": "limit", "in": "query", "required": true }, { "name": "lengthFrom", "in": "query", "required": false }, { "name": "lengthTo", "in": "query", "required": false }, { "name": "widthFrom", "in": "query", "required": false }, { "name": "widthTo", "in": "query", "required": false }, { "name": "draftFrom", "in": "query", "required": false }, { "name": "draftTo", "in": "query", "required": false }, { "name": "zipSelection", "in": "query", "required": false }, { "name": "zipCodes", "in": "query", "required": false }, { "name": "preference", "in": "query", "required": false }, { "name": "waitingListCategory", "in": "query", "required": false }, { "name": "q", "in": "query", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns waiting list of a harbor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntryListProvider" } } } } } } }, "/waiting-list-entry/{harbor}/list/user-ids": { "post": { "tags": [ "Waiting List Entry" ], "operationId": "post_waiting_list_entry_list_user_ids", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns waiting list of user ids" } } } }, "/waiting-list-entry/{harbor}/list/all-ids": { "get": { "tags": [ "Waiting List Entry" ], "operationId": "get_waiting_list_entry_list_all_ids", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List all entry ids for selecting all entries in frontend", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntryListProvider" } } } } } } }, "/waiting-list-entry/{harbor}/create": { "post": { "tags": [ "Waiting List Entry" ], "operationId": "post_waiting_list_entry_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntryForm" } } } }, "responses": { "400": { "description": "Either unrecognised field was passed to form, a required field is missing or entry already exists for boat" }, "201": { "description": "Returns newly created waiting list entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntry2" } } } } } } }, "/waiting-list-entry/{harbor}/{entry}/edit": { "put": { "tags": [ "Waiting List Entry" ], "operationId": "put_waiting_list_entry_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntryForm" } } } }, "responses": { "400": { "description": "Either unrecognised field was passed to form or a required field is missing" }, "200": { "description": "Returns edited waiting list entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntry2" } } } } } } }, "/waiting-list-entry/{harbor}/delete": { "patch": { "tags": [ "Waiting List Entry" ], "operationId": "patch_waiting_list_entry_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "properties": { "entryIds": { "description": "Delete waiting list entries", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Deletes waiting list entries" } } } }, "/waiting-list-entry/{harbor}/{category}/{clientBoat}/exists": { "get": { "tags": [ "Waiting List Entry" ], "operationId": "get_waiting_list_entry_exists", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "category", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns whether waiting list entry exists.", "content": { "application/json": { "schema": { "properties": { "exists": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" } } } } } } }, "/waiting-list-entry/{harbor}/{entry}/view": { "get": { "tags": [ "Waiting List Entry" ], "operationId": "get_waiting_list_entry_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns waiting list entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntry3" } } } } } } }, "/waiting-list-entry/{harbor}/reset-preferences": { "post": { "tags": [ "Waiting List Entry" ], "operationId": "post_waiting_list_entry_reset_preferences", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "properties": { "entryIds": { "description": "Array of subscription product ids and periods", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Returns whether preferences have been reset", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/waiting-list-entry/{harbor}/reset-preferences-summary": { "post": { "tags": [ "Waiting List Entry" ], "operationId": "post_waiting_list_entry_reset_preferences_summary", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListEntryController", "required": true, "content": { "application/json": { "schema": { "properties": { "setting": { "properties": { "interestedForNextSeason": { "type": "boolean" }, "interestedInShortTerm": { "type": "boolean" } }, "type": "object" }, "prices": { "type": "array", "items": { "properties": { "category": { "type": "string" }, "price": { "type": "number", "format": "float" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "204": { "description": "No entries were selected" } } } }, "/waiting-list-entry/{harbor}/{entry}/edit-preference": { "put": { "tags": [ "Waiting List Entry" ], "operationId": "put_waiting_list_entry_edit_preference", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns waiting list entry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListEntry4" } } } } } } }, "/waiting-list-entry/{harbor}/{entry}/previous-yearly-invoice": { "get": { "tags": [ "Waiting List Entry" ], "operationId": "get_waiting_list_entry_get_previous_yearly_invoice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Returns nothing if invoice is not present." }, "200": { "description": "Returns invoice.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } } } } }, "/waiting-list-entry/import/{harbor}/{user}": { "post": { "tags": [ "Data import" ], "operationId": "post_waiting_list_entry_import_index", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/waiting-list-offer/{harbor}/make-offer": { "post": { "tags": [ "Waiting List Offer" ], "operationId": "post_waiting_list_offer_make_offer", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListOfferController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListOfferForm" } } } }, "responses": { "201": { "description": "Returns newly created offer entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListOffer" } } } } } } }, "/waiting-list-offer/{harbor}/confirm/{offer}/{entry}": { "patch": { "tags": [ "Waiting List Offer" ], "operationId": "patch_waiting_list_offer_confirm", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns whether confirmation was successfull", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/waiting-list-offer/{harbor}/list": { "get": { "tags": [ "Waiting List Offer" ], "operationId": "get_waiting_list_offer_list", "parameters": [ { "name": "page", "in": "query", "required": true }, { "name": "page", "in": "query", "required": true }, { "name": "dock", "in": "query", "required": false }, { "name": "slip", "in": "query", "required": false }, { "name": "q", "in": "query", "required": true }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns offers list of tables of a harbor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListOfferListProvider" } } } } } } }, "/waiting-list-offer/{harbor}/delete/{offer}/{entry}": { "delete": { "tags": [ "Waiting List Offer" ], "operationId": "delete_waiting_list_offer_delete_offer_entry", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes offer entry" } } } }, "/waiting-list-offer/{harbor}/delete/{offer}": { "delete": { "tags": [ "Waiting List Offer" ], "operationId": "delete_waiting_list_offer_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "offer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deletes offer and its entries" } } } }, "/waiting-list-offer/{harbor}/list/{harborClient}": { "get": { "tags": [ "Waiting List Offer" ], "operationId": "get_waiting_list_offer_list_for_customer", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns offers list for a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListOffer2" } } } } } } }, "/waiting-list-settings/{harbor}/view": { "get": { "tags": [ "Waiting List Settings" ], "operationId": "get_waiting_list_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Waiting list settings not found" }, "200": { "description": "Returns waiting list settings of a harbor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListSetting2" } } } } } } }, "/waiting-list-settings/{harbor}/create": { "post": { "tags": [ "Waiting List Settings" ], "operationId": "post_waiting_list_settings_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/waiting-list-settings/{harbor}/edit": { "put": { "tags": [ "Waiting List Settings" ], "operationId": "put_waiting_list_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/boat/attachment/list/{boat}": { "get": { "tags": [ "Boat attachments" ], "operationId": "get_boat_attachment_list", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/boats": { "get": { "tags": [ "Boat" ], "operationId": "get_user_boat_getboats", "responses": { "200": { "description": "Return a paginated list of all the boats" } } } }, "/boats/types_and_models": { "get": { "tags": [ "Boat" ], "summary": "Get boat types and models that are public.", "description": "Convenience method, forwards requests to appropriate endpoints", "operationId": "get_user_boat_getboatstypes_and_models", "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/boats/{boat}": { "get": { "tags": [ "Boat" ], "operationId": "get_user_boat_getboat", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string", "pattern": "(?!my|types_and_models).+" } } ], "responses": { "200": { "description": "Return a single boat. Only allows own boats or requires a role" } } }, "delete": { "tags": [ "Boat" ], "operationId": "delete_user_boat_deleteboat", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/boats/{boat}/image": { "post": { "tags": [ "Boat" ], "operationId": "post_user_boat_postboatsimage", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "patch": { "tags": [ "Boat" ], "operationId": "patch_user_boat_patchboatweight", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/boats/{boat}/{harbor}/attachments": { "post": { "tags": [ "Boat" ], "operationId": "post_user_boat_postboatsattachments", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/boats/{attachment}/{harbor}/remove_attachment": { "delete": { "tags": [ "Boat" ], "operationId": "delete_user_boat_postboatsremoveattachment", "parameters": [ { "name": "attachment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/boat/import/{harbor}/{user}": { "post": { "tags": [ "Boat import v2", "Data import v2" ], "operationId": "post_boat_import_index", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/boat_model/list": { "get": { "tags": [ "Boat Model v2" ], "operationId": "get_boat_model_list", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoatModel" } } } } } } } }, "/v2/boat_model/admin/list": { "get": { "tags": [ "Boat Model v2" ], "operationId": "get_boat_model_admin_list", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoatModel" } } } } } } } }, "/v2/boat_model/view/{boatModel}": { "get": { "tags": [ "Boat Model v2" ], "operationId": "get_boat_model_view", "parameters": [ { "name": "boatModel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatModel2" } } } } } } }, "/v2/boat_model/create": { "post": { "tags": [ "Boat Model v2" ], "operationId": "post_boat_model_user_boatmodel_create", "requestBody": { "request": "BoatModelController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatModelForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatModel2" } } } } } } }, "/v2/boat_model/edit/{boatModel}": { "patch": { "tags": [ "Boat Model v2" ], "operationId": "patch_boat_model_user_boatmodel_edit", "parameters": [ { "name": "boatModel", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "BoatModelController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatModelForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatModel2" } } } } } } }, "/v2/boat_model/delete/{boatModel}": { "delete": { "tags": [ "Boat Model v2" ], "operationId": "delete_boat_model_user_boatmodel_delete", "parameters": [ { "name": "boatModel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/v2/boat_model/delete/{deletedBoatModel}/replace/{boatModelReplacement}": { "delete": { "tags": [ "Boat Model v2" ], "operationId": "delete_boat_model_user_boatmodel_deleteandreplace", "parameters": [ { "name": "deletedBoatModel", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boatModelReplacement", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/v2/boat_model/count/{boatModel}": { "get": { "tags": [ "Boat Model v2" ], "operationId": "get_boat_model_user_boatmodel_boatcount", "parameters": [ { "name": "boatModel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count of how many boats use this boat model", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" } }, "type": "object" } } } } } } }, "/v2/boat_model/confirm/{boatModel}": { "patch": { "tags": [ "Boat Model v2" ], "operationId": "patch_boat_model_confirm", "parameters": [ { "name": "boatModel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatModel2" } } } } } } }, "/v2/boat_model/unconfirm/{boatModel}": { "patch": { "tags": [ "Boat Model v2" ], "operationId": "patch_boat_model_unconfirm", "parameters": [ { "name": "boatModel", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatModel2" } } } } } } }, "/v2/boat_type/list": { "get": { "tags": [ "Boat Type v2" ], "operationId": "get_boat_type_list", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoatType" } } } } } } } }, "/v2/boat_type/view/{boatType}": { "get": { "tags": [ "Boat Type v2" ], "operationId": "get_boat_type_view", "parameters": [ { "name": "boatType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatType2" } } } } } } }, "/v2/boat_type/create": { "post": { "tags": [ "Boat Type v2" ], "operationId": "post_boat_type_user_boattype_create", "requestBody": { "request": "BoatTypeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatTypeForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatType2" } } } } } } }, "/v2/boat_type/edit/{boatType}": { "patch": { "tags": [ "Boat Type v2" ], "operationId": "patch_boat_type_user_boattype_edit", "parameters": [ { "name": "boatType", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "BoatTypeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatTypeForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoatType2" } } } } } } }, "/login": { "post": { "tags": [ "Public" ], "operationId": "post_public_user_login", "responses": { "200": { "description": "Login successful, returns user and token" }, "401": { "description": "Bad credentials, user not found" } } } }, "/reset_password": { "post": { "tags": [ "Public" ], "operationId": "post_public_user_reset_password_post", "responses": { "200": { "description": "Success" } } } }, "/logout": { "get": { "tags": [ "Public" ], "operationId": "get_public_user_logout", "responses": { "204": { "description": "Success" } } } }, "/sailor/login": { "post": { "tags": [ "Sailor authentication" ], "operationId": "post_sailor_auth_login", "requestBody": { "request": "SailorAuthController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorLoginForm" } } } }, "responses": { "200": { "description": "Login successful, returns user token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserToken" } } } }, "400": { "description": "Bad credentials,duplicate users or don't have access to product", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "enum": [ "USER.LOGIN.DUPLICATE_USER_EMAIL", "USER.LOGIN.INCORRECT_CREDENTIALS", "USER.LOGIN.PRODUCT_FORBIDDEN_FOR_USER" ] } }, "type": "object" } } } }, "404": { "description": "User with given email not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "USER.LOGIN.USER_NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/verify_email": { "post": { "tags": [ "Sailor authentication" ], "operationId": "post_sailor_auth_verify_email", "requestBody": { "request": "SailorAuthController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorVerifyEmailForm" } } } }, "responses": { "200": { "description": "User has been found", "content": { "application/json": { "schema": { "description": "Returns true if user exists", "type": "boolean" } } } }, "400": { "description": "More than one user exists with same email", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "USER.LOGIN.DUPLICATE_USER_EMAIL" } }, "type": "object" } } } }, "404": { "description": "User with given email not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "USER.LOGIN.USER_NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/register": { "post": { "tags": [ "Sailor authentication" ], "operationId": "post_sailor_auth_register", "requestBody": { "request": "SailorAuthController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorRegistrationForm" } } } }, "responses": { "201": { "description": "User has been registered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserToken" } } } }, "400": { "description": "User already exists with given email", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "USER.REGISTER.USER_ALREADY_EXISTS" } }, "type": "object" } } } } } } }, "/sailor/request_password_reset": { "post": { "tags": [ "Sailor authentication" ], "operationId": "post_sailor_auth_request_password_reset", "requestBody": { "request": "SailorAuthController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorRequestPasswordResetForm" } } } }, "responses": { "200": { "description": "Email has been sent", "content": { "application/json": { "schema": { "description": "Returns true on success", "type": "boolean" } } } }, "400": { "description": "More than one user exists with same email", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "USER.LOGIN.DUPLICATE_USER_EMAIL" } }, "type": "object" } } } }, "404": { "description": "User with given email not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "USER.LOGIN.USER_NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/reset_password/{token}": { "put": { "tags": [ "Sailor authentication" ], "operationId": "put_sailor_auth_reset_password", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorAuthController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorResetPasswordForm" } } } }, "responses": { "200": { "description": "Password reset has been successful", "content": { "application/json": { "schema": { "description": "Returns true on success", "type": "boolean" } } } }, "404": { "description": "User with given token not found or token might be expired", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "USER.LOGIN.USER_NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/logout": { "get": { "tags": [ "Sailor authentication" ], "operationId": "get_sailor_auth_logout", "responses": { "200": { "description": "Logout" } } } }, "/sailor/boat/list": { "get": { "tags": [ "Sailor boat" ], "operationId": "get_sailor_boat_list", "responses": { "200": { "description": "Return current user boat list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Boat" } } } } } } } }, "/sailor/boat/view/{boat}": { "get": { "tags": [ "Sailor boat" ], "operationId": "get_sailor_boat_view", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return boat information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Boat2" } } } }, "404": { "description": "Boat by given id not found", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "BOAT.ERROR.NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/boat/create": { "post": { "tags": [ "Sailor boat" ], "operationId": "post_sailor_boat_create", "requestBody": { "request": "SailorBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBoatForm" } } } }, "responses": { "200": { "description": "Return created boat ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Boat3" } } } } } } }, "/sailor/boat/edit/{boat}/general-information": { "put": { "tags": [ "Sailor boat" ], "operationId": "put_sailor_boat_edit_general_information", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBoatGeneralInformationForm" } } } }, "responses": { "200": { "description": "Boat general information has been saved", "content": { "application/json": { "schema": { "description": "Returns true if everything went well", "type": "boolean" } } } }, "404": { "description": "Boat by given id not found, is deleted or doesn't belong to current user", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "BOAT.ERROR.NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/boat/edit/{boat}/technical-information": { "put": { "tags": [ "Sailor boat" ], "operationId": "put_sailor_boat_edit_technical_information", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBoatTechnicalInformationForm" } } } }, "responses": { "200": { "description": "Boat technical information has been saved", "content": { "application/json": { "schema": { "description": "Returns true if everything went well", "type": "boolean" } } } }, "404": { "description": "Boat by given id not found, is deleted or doesn't belong to current user", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "BOAT.ERROR.NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/boat/edit/{boat}/insurance-information": { "post": { "tags": [ "Sailor boat" ], "operationId": "post_sailor_boat_edit_insurance_information", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBoatInsuranceInformationForm" } } } }, "responses": { "200": { "description": "Boat insurance information has been saved", "content": { "application/json": { "schema": { "description": "Returns true if everything went well", "type": "boolean" } } } }, "404": { "description": "Boat by given id not found, is deleted or doesn't belong to current user", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "BOAT.ERROR.NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/boat/attachments/{boat}": { "get": { "tags": [ "Sailor boat" ], "operationId": "get_sailor_boat_get_boat_insurance_attachments", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of boat attachments.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBoatAttachmentsDTO" } } } }, "404": { "description": "Boat by given id not found, is deleted or doesn't belong to current user", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "BOAT.ERROR.NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/boat/attachments/remove": { "delete": { "tags": [ "Sailor boat" ], "operationId": "delete_sailor_boat_remove_selected_insurance_attachments", "requestBody": { "request": "SailorBoatController", "required": true, "content": { "application/json": { "schema": { "properties": { "ids": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Incorect data given." }, "200": { "description": "Attachments deleted successfully.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/sailor/boat/edit/{boat}/upload-image": { "post": { "tags": [ "Sailor boat" ], "operationId": "post_sailor_boat_edit_image", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageUploadType" } } } }, "responses": { "200": { "description": "Boat image has been uploaded. Return image and thumbnail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Boat4" } } } }, "404": { "description": "Boat by given id not found, is deleted or doesn't belong to current user", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "default": "BOAT.ERROR.NOT_FOUND" } }, "type": "object" } } } } } } }, "/sailor/boat/active-boat-usages/{boat}": { "get": { "tags": [ "Sailor boat" ], "operationId": "get_sailor_boat_active_boat_usages", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns whether boat has anything active.", "content": { "application/json": { "schema": { "properties": { "activeBooking": { "description": "Does boat have an active booking", "type": "boolean" }, "activeSubscription": { "description": "Does boat have an active subscription", "type": "boolean" }, "activeCraneReservation": { "description": "Does boat have an active crane reservation", "type": "boolean" } }, "type": "object" } } } } } } }, "/sailor/boat/delete/{boat}": { "delete": { "tags": [ "Sailor boat" ], "operationId": "delete_sailor_boat_delete_boat", "parameters": [ { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Indicates whether boat deletion was success or not.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/sailor/boat_model/list": { "get": { "tags": [ "Sailor boat model" ], "operationId": "get_sailor_boat_model_list", "parameters": [ { "name": "name", "in": "query", "description": "Boat model name or part of it to search by", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoatModel3" } } } } } } } }, "/sailor/boat_type/list": { "get": { "tags": [ "Sailor boat type" ], "operationId": "get_sailor_boat_type_list", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoatType" } } } } } } } }, "/sailor/user/me": { "get": { "tags": [ "Sailor user" ], "operationId": "get_sailor_user_user_me", "responses": { "200": { "description": "Get current user information", "content": { "application/json": { "schema": { "description": "Returns users info if user is found", "type": "boolean" } } } } } } }, "/sailor/user/name": { "put": { "tags": [ "Sailor user" ], "operationId": "put_sailor_user_name_edit", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorUserNameForm" } } } }, "responses": { "200": { "description": "User name has been updated", "content": { "application/json": { "schema": { "description": "Returns true if everything went well", "type": "boolean" } } } } } } }, "/sailor/user/address": { "put": { "tags": [ "Sailor user" ], "operationId": "put_sailor_user_address_edit", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorUserAddressForm" } } } }, "responses": { "200": { "description": "User address has been updated", "content": { "application/json": { "schema": { "description": "Returns true if everything went well", "type": "boolean" } } } } } } }, "/sailor/user/phone": { "put": { "tags": [ "Sailor user" ], "operationId": "put_sailor_user_phone_edit", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorUserPhoneForm" } } } }, "responses": { "200": { "description": "User phone number has been updated", "content": { "application/json": { "schema": { "description": "Returns true if everything went well", "type": "boolean" } } } } } } }, "/sailor/user/birthday": { "put": { "tags": [ "Sailor user" ], "operationId": "put_sailor_user_birthday_edit", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorUserBirthdayForm" } } } }, "responses": { "200": { "description": "User birthday has been updated", "content": { "application/json": { "schema": { "description": "Returns true if everything went well", "type": "boolean" } } } } } } }, "/sailor/user/units": { "patch": { "tags": [ "Sailor user" ], "operationId": "patch_sailor_user_measurement_system_select", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorUserMeasurmentSystemForm" } } } }, "responses": { "200": { "description": "User measurement system has been set", "content": { "application/json": { "schema": { "description": "Returns users selected measuremnet system", "type": "boolean" } } } } } } }, "/sailor/user/marketingConsent": { "patch": { "tags": [ "Sailor user" ], "operationId": "patch_sailor_user_marketing_consent", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorUserMarketingConsentForm" } } } }, "responses": { "200": { "description": "User marketing consent setting has been updated", "content": { "application/json": { "schema": { "description": "Returns true if user gave maketing consent", "type": "boolean" } } } } } } }, "/sailor/user/upload-image": { "post": { "tags": [ "Sailor user" ], "operationId": "post_sailor_user_upload_image", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageUploadType" } } } }, "responses": { "200": { "description": "User image has been uploaded. Return image and thumbnail", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } } } }, "/sailor/user/auto-renewal-settings": { "get": { "tags": [ "Sailor user" ], "operationId": "get_sailor_user_auto_renewal_settings", "responses": { "200": { "description": "Returns auto renewal information on different modules.", "content": { "application/json": { "schema": { "properties": { "autoRenewal": { "description": "General auto renewal setting", "type": "boolean" }, "differentModules": { "description": "Auto renewal setting of different modules", "properties": { "powerAutoRenewal": { "description": "Power auto renewal setting", "type": "boolean" } }, "type": "object" } }, "type": "object" } } } } } } }, "/sailor/user/update-license": { "post": { "tags": [ "Sailor user" ], "operationId": "post_sailor_user_update_license", "requestBody": { "request": "SailorUserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLicenseForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User2" } } } } } } }, "/users": { "get": { "tags": [ "User" ], "operationId": "get_user_list", "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "User" ], "operationId": "post_user_create", "requestBody": { "request": "UserController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User3" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User3" } } } } } } }, "/users/by_email": { "get": { "tags": [ "User" ], "operationId": "get_user_view_by_email", "responses": { "200": { "description": "Success" } } } }, "/users/extended": { "get": { "tags": [ "User" ], "operationId": "get_user_list_extended", "responses": { "200": { "description": "Success" } } } }, "/users/me": { "get": { "tags": [ "User" ], "operationId": "get_user_me", "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "User" ], "operationId": "put_user_edit_current", "responses": { "200": { "description": "Success" } } } }, "/users/remove_account": { "get": { "tags": [ "User" ], "operationId": "get_user_remove_account", "responses": { "200": { "description": "Success" } } } }, "/user": { "get": { "tags": [ "User" ], "operationId": "get_user_self_info", "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "User" ], "summary": "Alias for PUT /users/me", "operationId": "put_user_edit_current_alias", "responses": { "200": { "description": "Success" } } } }, "/users/{user}/boats": { "get": { "tags": [ "User" ], "operationId": "get_user_list_boats", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/users/bookings": { "get": { "tags": [ "User" ], "operationId": "get_user_list_booking", "responses": { "200": { "description": "Success" } } } }, "/users/{user}": { "get": { "tags": [ "User" ], "operationId": "get_user_view", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "User" ], "operationId": "put_user_edit", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "User" ], "operationId": "delete_user_delete", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/users/quick/{harbor}": { "post": { "tags": [ "User" ], "operationId": "post_user_send_invite", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/users/invite/{user}": { "get": { "tags": [ "User" ], "operationId": "get_user_send_invitation_email", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/users/import": { "post": { "tags": [ "User" ], "operationId": "post_user_import", "responses": { "200": { "description": "Success" } } } }, "/users/me/avatar": { "post": { "tags": [ "User" ], "operationId": "post_user_update_avatar", "responses": { "200": { "description": "Success" } } } }, "/users/quick/{harbor}/{user}": { "put": { "tags": [ "User" ], "operationId": "put_user_quick_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/user/{user}/has_logged/{harbor}": { "get": { "tags": [ "User" ], "operationId": "get_user_has_logged_ing", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/user/{user}/is_deletable": { "get": { "tags": [ "User" ], "summary": "Returns whether to show delete warning or not (if they have unpaid invoices, active booking and other (except subscriptions))\nIf user has any subscription, deletion will be refused.", "operationId": "get_user_is_deletable", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/user/import/{harbor}/{user}": { "post": { "tags": [ "User import v2", "Data import v2" ], "operationId": "post_user_import_index", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/user-logs/harbor/{harbor}/user/{user}/list": { "get": { "tags": [ "User logs" ], "operationId": "get_user_logs_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLog" } } } } } } }, "/user-logs/harbor/{harbor}/user/{user}/create": { "post": { "tags": [ "User logs" ], "operationId": "post_user_logs_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/user-logs/harbor/{harbor}/edit/{userLog}": { "put": { "tags": [ "User logs" ], "operationId": "put_user_logs_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userLog", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserLog" } } } } } } }, "/user-logs/harbor/{harbor}/delete/{userLog}": { "delete": { "tags": [ "User logs" ], "operationId": "delete_user_logs_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userLog", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/order/{harbor}/item/create/booking": { "post": { "tags": [ "Booking Order items" ], "operationId": "post_booking_order_items_order_bookingorderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "BookingOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/view/{orderItem}/booking/{booking}": { "get": { "tags": [ "Booking Order items" ], "operationId": "get_booking_order_items_order_bookingorderitem_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/edit/{orderItem}/booking/{booking}": { "patch": { "tags": [ "Booking Order items" ], "operationId": "patch_booking_order_items_order_bookingorderitem_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "BookingOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookingOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/delete/{orderItem}/booking/{booking}": { "delete": { "tags": [ "Booking Order items" ], "operationId": "delete_booking_order_items_order_bookingorderitem_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/order/{harbor}/item/create/camper": { "post": { "tags": [ "Camper Order items" ], "operationId": "post_camper_order_items_order_camperorderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CamperOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamperOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/view/{orderItem}/camper/{camper}": { "get": { "tags": [ "Camper Order items" ], "operationId": "get_camper_order_items_order_camperorderitem_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "camper", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/edit/{orderItem}/camper/{camper}": { "put": { "tags": [ "Camper Order items" ], "operationId": "put_camper_order_items_order_camperorderitem_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "camper", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CamperOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/create/crane_reservation": { "post": { "tags": [ "Crane Order items" ], "operationId": "post_crane_order_items_order_cranereservationorderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CraneReservationOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneReservationOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/view/{orderItem}/crane_reservation/{crane_reservation}": { "get": { "tags": [ "Crane Order items" ], "operationId": "get_crane_order_items_order_cranereservationorderitem_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "crane_reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/edit/{orderItem}/crane_reservation/{craneReservation}": { "patch": { "tags": [ "Crane Order items" ], "operationId": "patch_crane_order_items_order_cranereservationorderitem_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "craneReservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CraneReservationOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneReservationOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/delete/{orderItem}/crane_reservation/{craneReservation}": { "delete": { "tags": [ "Crane Order items" ], "operationId": "delete_crane_order_items_order_cranereservationorderitem_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "craneReservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/order/{harbor}/item/create/credit": { "post": { "tags": [ "Credit Order items" ], "operationId": "post_credit_order_items_order_creditorderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CreditOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/view/{orderItem}/credit/{credit}": { "get": { "tags": [ "Credit Order items" ], "operationId": "get_credit_order_items_order_creditorderitem_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credit", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/edit/{orderItem}/credit/{credit}": { "patch": { "tags": [ "Credit Order items" ], "operationId": "patch_credit_order_items_order_creditorderitem_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credit", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CreditOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/delete/{orderItem}/credit/{credit}": { "delete": { "tags": [ "Credit Order items" ], "operationId": "delete_credit_order_items_order_creditorderitem_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "credit", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/order/{harbor}/item/create/membership": { "post": { "tags": [ "Membership Order items" ], "operationId": "post_membership_order_items_order_membershiporderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "MembershipOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MembershipOrderItemDTO" } } } } } } }, "/order/{harbor}/list": { "get": { "tags": [ "Orders" ], "operationId": "get_orders_list", "parameters": [ { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "q", "in": "query", "description": "search query", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "module", "in": "query", "description": "comma seperated list e.g: shop,booking,subscription,access_control,camper,crane,credit,slipway,utility", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "comma seperated statuses e.g: new,canceled,confirmed,completed", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "comma seperated sources e.g: app,public,kiosk,manual", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "createdFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "createdTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "confirmedFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "confirmedTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "completedFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "completedTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/order/{harbor}/list/ids": { "get": { "tags": [ "Orders" ], "operationId": "get_orders_list_ids", "parameters": [ { "name": "q", "in": "query", "description": "search query", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "module", "in": "query", "description": "comma seperated list e.g: shop,booking,subscription,access_control,camper,crane,credit,slipway,utility", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "comma seperated statuses e.g: new,canceled,confirmed,completed", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "comma seperated sources e.g: app,public,kiosk,manual", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "createdFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "createdTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "confirmedFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "confirmedTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "completedFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "completedTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/order/{harbor}/view/{order}": { "get": { "tags": [ "Orders" ], "operationId": "get_orders_order_order_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order2" } } } } } } }, "/order/{harbor}/create": { "post": { "tags": [ "Orders" ], "operationId": "post_orders_order_order_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "OrderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order3" } } } } } } }, "/order/{harbor}/edit/{order}": { "patch": { "tags": [ "Orders" ], "operationId": "patch_orders_order_order_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "OrderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order3" } } } } } } }, "/order/{harbor}/edit/{order}/comment": { "patch": { "tags": [ "Orders" ], "operationId": "patch_orders_order_order_editcomment", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "OrderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderForm" } } } }, "responses": { "204": { "description": "Success" } } } }, "/order/{harbor}/delete/{order}": { "delete": { "tags": [ "Orders" ], "operationId": "delete_orders_order_order_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/order/{harbor}/confirm/{order}": { "patch": { "tags": [ "Orders" ], "operationId": "patch_orders_order_order_confirm", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmOrderForm" } } } } } } }, "/order/{harbor}/confirm-multiple": { "patch": { "tags": [ "Orders" ], "operationId": "patch_orders_order_order_confirmmultiple", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmMultipleOrdersForm" } } } } } } }, "/order/{harbor}/complete/{order}": { "patch": { "tags": [ "Orders" ], "operationId": "patch_orders_order_order_complete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/order/{harbor}/complete-multiple": { "patch": { "tags": [ "Orders" ], "operationId": "patch_orders_order_order_completemultiple", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteMultipleOrdersForm" } } } } } } }, "/order/{harbor}/confirm-complete/{order}": { "patch": { "tags": [ "Orders" ], "operationId": "patch_orders_order_order_confirmandcomplete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmOrderForm" } } } } } } }, "/order/{harbor}/item/create": { "post": { "tags": [ "Order items" ], "operationId": "post_order_items_order_orderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "OrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem2" } } } } } } }, "/order/{harbor}/item/edit/{orderItem}": { "patch": { "tags": [ "Order items" ], "operationId": "patch_order_items_order_orderitem_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "OrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemForm" } } } }, "responses": { "200": { "description": "Success" } } } }, "/order/{harbor}/item/delete/{orderItem}": { "delete": { "tags": [ "Order items" ], "operationId": "delete_order_items_order_orderitem_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/order/{harbor}/item/create/power": { "post": { "tags": [ "Power Order items" ], "operationId": "post_power_order_items_order_powerorderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "PowerOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/order/{harbor}/item/edit/power/{orderItem}": { "put": { "tags": [ "Power Order items" ], "operationId": "put_power_order_items_order_powerorderitem_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "PowerOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/sailor/order-item/{harbor}/{order}/booking/create": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_booking_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorBookingOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorOrderBookingForm" } } } }, "responses": { "201": { "description": "Returns order item id and booking id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicBookingOrderItemDTO" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "BOOKING.DATE_TO.BLANK", "BOOKING.DATE_TO.DATE", "BOOKING.DATE_FROM.DATE" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/booking/edit/{orderItem}": { "put": { "tags": [ "Sailor order item" ], "operationId": "put_sailor_booking_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorBookingOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorOrderBookingForm" } } } }, "responses": { "200": { "description": "Returns order item id and booking id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicBookingOrderItemDTO" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translateable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "BOOKING.DATE_TO.BLANK", "BOOKING.DATE_TO.DATE", "BOOKING.DATE_FROM.DATE" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/camper/create": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_camper_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorCamperOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCamperOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has camper order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CAMPER.VALIDATION.PRICE_BLANK", "CAMPER.VALIDATION.LOT_INVALID", "CAMPER.VALIDATION.DATE_FROM_BLANK", "CAMPER.VALIDATION.DATE_FROM_INVALID", "CAMPER.VALIDATION.DATE_TO_BLANK", "CAMPER.VALIDATION.DATE_TO_INVALID", "CAMPER.VALIDATION.PLATE_NUMBER_BLANK", "CAMPER.COUNTRY_INVALID" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/camper/edit/{orderItem}": { "put": { "tags": [ "Sailor order item" ], "operationId": "put_sailor_camper_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorCamperOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCamperOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CAMPER.VALIDATION.LOT_INVALID", "CAMPER.VALIDATION.DATE_FROM_BLANK", "CAMPER.VALIDATION.DATE_FROM_INVALID", "CAMPER.VALIDATION.DATE_TO_BLANK", "CAMPER.VALIDATION.DATE_TO_INVALID", "CAMPER.VALIDATION.PLATE_NUMBER_BLANK", "CAMPER.COUNTRY_INVALID" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/crane/create": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_crane_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorCraneOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCraneOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" }, "price": { "description": "Order item price", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has camper order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CRANE.VALIDATION.BOAT_REQUIRED", "CRANE.VALIDATION.DIRECTION_REQUIRED", "CRANE.VALIDATION.DATE_FROM_REQUIRED", "CRANE.VALIDATION.DATE_FROM_INVALID", "CRANE.VALIDATION.DATE_TO_REQUIRED", "CRANE.VALIDATION.DATE_TO_INVALID", "CRANE.VALIDATION.UPLIFT_REQUIRED" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/crane/edit/{orderItem}": { "put": { "tags": [ "Sailor order item" ], "operationId": "put_sailor_crane_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorCraneOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCraneOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" }, "price": { "description": "Order item price", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has camper order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CRANE.VALIDATION.BOAT_REQUIRED", "CRANE.VALIDATION.DIRECTION_REQUIRED", "CRANE.VALIDATION.DATE_FROM_REQUIRED", "CRANE.VALIDATION.DATE_FROM_INVALID", "CRANE.VALIDATION.DATE_TO_REQUIRED", "CRANE.VALIDATION.DATE_TO_INVALID", "CRANE.VALIDATION.UPLIFT_REQUIRED" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/crane/delete/{orderItem}/crane_reservation/{craneReservation}": { "delete": { "tags": [ "Sailor order item" ], "operationId": "delete_sailor_crane_order_items_order_sailor_sailorcraneorderitem_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "craneReservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor/order-item/{harbor}/{order}/credit/create": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_credit_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorCreditOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCreditOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CREDIT.VALIDATION.INVALID_AMOUNT" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/credit/edit/{orderItem}": { "put": { "tags": [ "Sailor order item" ], "operationId": "put_sailor_credit_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorCreditOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCreditOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CREDIT.VALIDATION.INVALID_AMOUNT" ] } } }, "type": "object" } } } } } } }, "/sailor/order/{harbor}/create": { "post": { "tags": [ "Sailor orders" ], "operationId": "post_sailor_orders_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorOrderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorOrderForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order4" } } } } } } }, "/sailor/order/{harbor}/confirm/{order}": { "post": { "tags": [ "Sailor orders" ], "operationId": "post_sailor_orders_confirm", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order status", "properties": { "status": { "description": "Order status after confirmation process", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order amount is not equal to 0.", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.CANT_CONFIRM_AMOUNT_NOT_ZERO", "COMMON.SERVER_ERROR" ] } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/power/create": { "post": { "tags": [ "Sailor power order item" ], "operationId": "post_sailor_power_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPowerOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPowerOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has power order item" } } } }, "/sailor/order-item/{harbor}/{order}/power/edit/{orderItem}": { "put": { "tags": [ "Sailor power order item" ], "operationId": "put_sailor_power_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPowerOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPowerOrderItemForm" } } } }, "responses": { "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/booking/create": { "post": { "tags": [ "Sailor public order item" ], "operationId": "post_sailor_public_booking_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicBookingOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicOrderBookingForm" } } } }, "responses": { "201": { "description": "Returns order item id and booking id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicBookingOrderItemDTO" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has booking order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "BOOKING.DATE_TO.BLANK", "BOOKING.DATE_TO.DATE", "BOOKING.DATE_FROM.DATE" ] } } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/booking/edit/{orderItem}": { "put": { "tags": [ "Sailor public order item" ], "operationId": "put_sailor_public_booking_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicBookingOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicOrderBookingForm" } } } }, "responses": { "200": { "description": "Returns order item id and booking id", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicBookingOrderItemDTO" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "BOOKING.DATE_TO.BLANK", "BOOKING.DATE_TO.DATE", "BOOKING.DATE_FROM.DATE" ] } } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/camper/create": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_public_camper_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicCamperOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicCamperOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has camper order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CAMPER.VALIDATION.PRICE_BLANK", "CAMPER.VALIDATION.LOT_INVALID", "CAMPER.VALIDATION.DATE_FROM_BLANK", "CAMPER.VALIDATION.DATE_FROM_INVALID", "CAMPER.VALIDATION.DATE_TO_BLANK", "CAMPER.VALIDATION.DATE_TO_INVALID", "CAMPER.VALIDATION.PLATE_NUMBER_BLANK", "CAMPER.COUNTRY_INVALID" ] } } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/camper/edit/{orderItem}": { "put": { "tags": [ "Sailor order item" ], "operationId": "put_sailor_public_camper_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicCamperOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicCamperOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CAMPER.VALIDATION.LOT_INVALID", "CAMPER.VALIDATION.DATE_FROM_BLANK", "CAMPER.VALIDATION.DATE_FROM_INVALID", "CAMPER.VALIDATION.DATE_TO_BLANK", "CAMPER.VALIDATION.DATE_TO_INVALID", "CAMPER.VALIDATION.PLATE_NUMBER_BLANK", "CAMPER.COUNTRY_INVALID" ] } } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/credit/create": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_public_credit_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicCreditOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCreditOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CREDIT.VALIDATION.INVALID_AMOUNT" ] } } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/credit/edit/{orderItem}": { "put": { "tags": [ "Sailor order item" ], "operationId": "put_sailor_public_credit_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicCreditOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCreditOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CREDIT.VALIDATION.INVALID_AMOUNT" ] } } }, "type": "object" } } } } } } }, "/sailor-public/order/{harbor}/create": { "post": { "tags": [ "Sailor orders" ], "operationId": "post_sailor_public_orders_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorOrderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorOrderForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order4" } } } } } } }, "/sailor-public/order/{harbor}/confirm/{order}": { "post": { "tags": [ "Sailor orders" ], "operationId": "post_sailor_public_orders_confirm", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order status", "properties": { "status": { "description": "Order status after confirmation process", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order amount is not equal to 0.", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.CANT_CONFIRM_AMOUNT_NOT_ZERO", "COMMON.SERVER_ERROR" ] } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/delete/{orderItem}": { "delete": { "tags": [ "Sailor public orders" ], "operationId": "delete_sailor_public_order_item_order_sailor_sailorpublicorderitem_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/sailor-public/order-item/{harbor}/{order}/power/create": { "post": { "tags": [ "Sailor power order item" ], "operationId": "post_sailor_public_power_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicPowerOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicPowerOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has power order item" } } } }, "/sailor-public/order-item/{harbor}/{order}/power/edit/{orderItem}": { "put": { "tags": [ "Sailor power order item" ], "operationId": "put_sailor_public_power_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicPowerOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicPowerOrderItemForm" } } } }, "responses": { "400": { "description": "Order doesn't belong to harbor or order already has credit order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/shop/update": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_public_shop_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicShopOrderItemController", "description": "product ID => Qty array", "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "products": { "ID": "Quantity" } } } } }, "responses": { "201": { "description": "Success" } } } }, "/sailor-public/order-item/{harbor}/{order}/slipway/create": { "post": { "tags": [ "Sailor order item" ], "operationId": "post_sailor_slipway_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorSlipwayOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicSlipwayOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has slipway order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_ALREADY_CREATED", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CAMPER.VALIDATION.PRICE_BLANK", "CAMPER.VALIDATION.LOT_INVALID", "CAMPER.VALIDATION.DATE_FROM_BLANK", "CAMPER.VALIDATION.DATE_FROM_INVALID", "CAMPER.VALIDATION.DATE_TO_BLANK", "CAMPER.VALIDATION.DATE_TO_INVALID", "CAMPER.VALIDATION.PLATE_NUMBER_BLANK", "CAMPER.COUNTRY_INVALID" ] } } }, "type": "object" } } } } } } }, "/sailor-public/order-item/{harbor}/{order}/slipway/edit/{orderItem}": { "put": { "tags": [ "Sailor order item" ], "operationId": "put_sailor_slipway_order_items_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderItem", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorSlipwayOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicSlipwayOrderItemForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order item", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Translatable string of error", "type": "string", "enum": [ "ORDER.ITEM_DOES_NOT_BELONG_TO_ORDER", "ORDER.ORDER_DOES_NOT_BELONG_TO_HARBOR" ] }, "errors": { "description": "Form errors", "type": "array", "items": { "type": "string", "enum": [ "CAMPER.VALIDATION.LOT_INVALID", "CAMPER.VALIDATION.DATE_FROM_BLANK", "CAMPER.VALIDATION.DATE_FROM_INVALID", "CAMPER.VALIDATION.DATE_TO_BLANK", "CAMPER.VALIDATION.DATE_TO_INVALID", "CAMPER.VALIDATION.PLATE_NUMBER_BLANK", "CAMPER.COUNTRY_INVALID" ] } } }, "type": "object" } } } } } } }, "/sailor/order-item/{harbor}/{order}/waiting-list/create": { "post": { "tags": [ "Sailor waiting list order item" ], "operationId": "post_sailor_waiting_list_order_items_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorWaitingListOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorWaitingListOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "description": "Returns order item id", "properties": { "id": { "description": "Order item ID", "type": "string" } }, "type": "object" } } } }, "400": { "description": "Order doesn't belong to harbor or order already has power order item" } } } }, "/order/{harbor}/item/{order}/create/waiting-list/{entry}": { "post": { "tags": [ "Waiting List Order items" ], "operationId": "post_waiting_list_order_items_order_waitinglistorderitem_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entry", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "WaitingListOrderItemController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WaitingListOrderItemForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItem" } } } } } } }, "/shop/settings/{harbor}": { "get": { "tags": [ "Shop V2" ], "operationId": "get_shop_settings_shop_shopsettings_getsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopSettings" } } } } } }, "put": { "tags": [ "Shop V2" ], "operationId": "put_shop_settings_shop_shopsettings_postsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ShopSettingsController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopSettingsForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopSettings" } } } } } }, "post": { "tags": [ "Shop V2" ], "operationId": "post_shop_settings_shop_shopsettings_postsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ShopSettingsController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopSettingsForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShopSettings" } } } } } } }, "/api/get-token": { "post": { "tags": [ "Api User" ], "operationId": "post_api_get_token", "requestBody": { "request": "ApiUserController", "required": true, "content": { "application/json": { "schema": { "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Token given", "content": { "application/json": { "schema": { "properties": { "token": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Incorrect credentials or other form issues", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } } } } } }, "/register": { "get": { "responses": { "default": { "description": "" } }, "deprecated": true }, "put": { "responses": { "default": { "description": "" } }, "deprecated": true }, "post": { "responses": { "default": { "description": "" } }, "deprecated": true }, "delete": { "responses": { "default": { "description": "" } }, "deprecated": true }, "options": { "responses": { "default": { "description": "" } }, "deprecated": true }, "head": { "responses": { "default": { "description": "" } }, "deprecated": true }, "patch": { "responses": { "default": { "description": "" } }, "deprecated": true }, "trace": { "responses": { "default": { "description": "" } }, "deprecated": true } }, "/payments/types": { "post": { "tags": [ "Payment" ], "summary": "Get a payment type by orderId. Used to identify payment publicly in harbakiosk", "operationId": "post_deprecated_payment_payment2_postpaymenttype", "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/utilities": { "get": { "tags": [ "Harbor Utility" ], "summary": "Get a list of utilities harbor offers. This is not paginated", "operationId": "get_harbor_utilities_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true }, "post": { "tags": [ "Harbor Utility" ], "summary": "Create a utility in harbor", "operationId": "post_harbor_utilities_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } }, "deprecated": true } }, "/harbors/{harbor}/utilities/{harborUtility}": { "get": { "tags": [ "Harbor Utility" ], "summary": "Get a single utility in harbor", "operationId": "get_harbor_utilities_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborUtility", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true }, "put": { "tags": [ "Harbor Utility" ], "summary": "Edit a utility in harbor", "operationId": "put_harbor_utilities_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborUtility", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true }, "delete": { "tags": [ "Harbor Utility" ], "summary": "Delete a utility in harbor", "operationId": "delete_harbor_utilities_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborUtility", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } }, "deprecated": true } }, "/bookings": { "get": { "tags": [ "Booking" ], "summary": "Get a paginated list of bookings for harbors assigned to user.", "operationId": "get_deprecated_booking_booking_getbookings", "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/my": { "get": { "tags": [ "Booking" ], "summary": "Get bookings that current user has created", "operationId": "get_deprecated_booking_booking_getbookingsmy", "responses": { "200": { "description": "Success" } }, "deprecated": true }, "post": { "tags": [ "Booking" ], "summary": "Post a booking as an actual user (client)", "operationId": "post_deprecated_booking_booking_postbookingsmy", "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/all": { "get": { "tags": [ "Booking" ], "summary": "Gets a paginated list of all bookings", "operationId": "get_deprecated_booking_booking_getbookingsall", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "bridge", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "position", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showInstant", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showRegular", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showManual", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/current": { "get": { "tags": [ "Booking" ], "summary": "Get a paginated list of current visitors of assigned harbors", "operationId": "get_deprecated_booking_booking_getbookingscurrent", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/reservations": { "get": { "tags": [ "Booking" ], "summary": "Get a paginated list of future reservations of assigned harbors", "operationId": "get_deprecated_booking_booking_getbookingsreservations", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/payments": { "get": { "tags": [ "Booking" ], "summary": "Get paginated list of payments got thought bookings of selected harbor", "operationId": "get_deprecated_booking_booking_getbookingspayments", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "bridge", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "position", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/payments_csv": { "get": { "tags": [ "Booking" ], "summary": "Get paginated list of payments got thought bookings of selected harbor", "operationId": "get_deprecated_booking_booking_getbookingspayments_csv", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "bridge", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "position", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/payments_summary": { "get": { "tags": [ "Booking" ], "summary": "Get summary of payments", "operationId": "get_deprecated_booking_booking_getbookingspayments_summary", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "bridge", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "position", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/all_my": { "get": { "tags": [ "Booking" ], "summary": "Gets a paginated list of all bookings", "operationId": "get_deprecated_booking_booking_getbookingsall_my", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "bridge", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "position", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showManual", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/{booking}": { "get": { "tags": [ "Booking" ], "summary": "Get a single booking\nUse Booking\\Controller\\BookingController::view", "operationId": "get_deprecated_booking_booking_getbooking", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true }, "delete": { "tags": [ "Booking" ], "summary": "Delete booking", "operationId": "delete_deprecated_booking_booking_deletebooking", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/stats": { "get": { "tags": [ "Booking" ], "operationId": "get_deprecated_booking_booking_getbookingstats", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "bridge", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "position", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showManual", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/stats-by-night": { "get": { "tags": [ "Booking" ], "operationId": "get_deprecated_booking_booking_getbookingstatsbynight", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "bridge", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "position", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sailorCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showManual", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "showCanceled", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatCountry", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "source", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/{booking}/confirm": { "patch": { "tags": [ "Booking" ], "summary": "Confirm booking", "operationId": "patch_deprecated_booking_booking_patchbookingconfirm", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/{booking}/decline": { "patch": { "tags": [ "Booking" ], "summary": "Decline booking", "operationId": "patch_deprecated_booking_booking_patchbookingdecline", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/{booking}/cancel": { "patch": { "tags": [ "Booking" ], "summary": "Cancel booking (for admin).", "operationId": "patch_deprecated_booking_booking_patchbookingcancel", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/send_receipt/{booking}/{email}": { "get": { "tags": [ "Booking" ], "summary": "Send booking's receipt email for sailor and update sailor's email in booking", "operationId": "get_deprecated_booking_booking_getbookingsendreceipt", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/send_sms_receipt/{booking}": { "get": { "tags": [ "Booking" ], "summary": "Send booking's receipt sms for sailor and update sailor's phone in booking", "operationId": "get_deprecated_booking_booking_getsendsmsbookingreceipt", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/{booking}/harbor_bridges": { "get": { "tags": [ "Booking" ], "summary": "Get harbor bridges and bridge positions for a particular booking\nUsed for bridge and position retrieval for booking confirmation", "operationId": "get_deprecated_booking_booking_getbookingharbor_bridges", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/current/pdf": { "get": { "tags": [ "Booking" ], "operationId": "get_deprecated_booking_booking_getbookingscurrentpdf", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "fields", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "user", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/reservations/pdf": { "get": { "tags": [ "Booking" ], "operationId": "get_deprecated_booking_booking_getbookingsreservationspdf", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "fields", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "user", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/anon": { "post": { "tags": [ "Booking" ], "summary": "Post a booking as an anonymous user (client)", "operationId": "post_deprecated_booking_booking_postbookingsanon", "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/check_prices": { "post": { "tags": [ "Booking" ], "summary": "Check price for provided booking. Does not save anything", "operationId": "post_deprecated_booking_booking_postbookingscheckprices", "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/check_manual_prices": { "post": { "tags": [ "Booking" ], "summary": "Check price for provided booking manual (no booking fee). Does not save anything\nUse Booking\\Controller\\BookingController::calculateBookingPrice", "operationId": "post_deprecated_booking_booking_postbookingscheckharbourprices", "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/bookings/{booking}/arrive": { "patch": { "tags": [ "Booking" ], "summary": "Toggle visitor arrived.", "description": "deprecated since 2025-05-12", "operationId": "patch_deprecated_booking_booking_patchbookingsarrive", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/admin/booking/{booking}/arrive": { "patch": { "tags": [ "Harbor bookings" ], "summary": "Toggle visitor arrived.", "operationId": "patch_admin_bookingbooking_admin_adminbookingdashboard_patchbookingsarrive", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/booking/{booking}/departed": { "patch": { "tags": [ "Harbor bookings" ], "summary": "Toggle visitor left.", "operationId": "patch_admin_bookingbooking_admin_adminbookingdashboard_customerleft", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/booking/{harbor}/list/all": { "get": { "tags": [ "Harbor bookings" ], "operationId": "get_bookingbooking_booking_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/booking/{harbor}/calculate-price": { "post": { "tags": [ "Harbor bookings" ], "summary": "Check price for provided booking manual (no booking fee). Does not save anything", "operationId": "post_bookingbooking_booking_calculatebookingprice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/booking/{harbor}/view/{booking}": { "get": { "tags": [ "Harbor bookings" ], "summary": "Get a single booking", "operationId": "get_bookingbooking_booking_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/booking/{harbor}/change-slip/{booking}": { "patch": { "tags": [ "Harbor bookings" ], "summary": "Get a single booking", "operationId": "patch_bookingbooking_booking_changeslip", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/booking/dashboard/current": { "get": { "tags": [ "Harbor bookings" ], "summary": "Get a paginated list of current visitors of assigned harbors", "operationId": "get_booking_dashboard_current", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get a paginated list of current visitors of assigned harbors", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total count", "type": "integer" }, "data": { "description": "Current page data", "type": "array", "items": { "$ref": "#/components/schemas/CurrentBookingDTO" } } }, "type": "object" } } } } } } }, "/booking/dashboard/hourly": { "get": { "tags": [ "Harbor bookings" ], "summary": "Get a paginated list of hourly bookings of assigned harbors", "operationId": "get_booking_dashboard_hourly", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get a paginated list of hourly bookings of assigned harbors", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total count", "type": "integer" }, "data": { "description": "Current page data", "type": "array", "items": { "$ref": "#/components/schemas/CurrentBookingDTO" } } }, "type": "object" } } } } } } }, "/booking/dashboard/upcoming": { "get": { "tags": [ "Harbor bookings" ], "summary": "Get a paginated list of upcoming visitors of assigned harbors", "operationId": "get_booking_dashboard_upcoming", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get a paginated list of upcoming visitors of assigned harbors", "content": { "application/json": { "schema": { "properties": { "total": { "description": "Total count", "type": "integer" }, "data": { "description": "Current page data", "type": "array", "items": { "$ref": "#/components/schemas/CurrentBookingDTO" } } }, "type": "object" } } } } } } }, "/booking/settings/{harbor}": { "get": { "tags": [ "Booking settings" ], "operationId": "get_booking_bookingsettings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "patch": { "tags": [ "Booking settings" ], "operationId": "patch_booking_bookingsettings_updatepricingtype", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor/booking/current-list": { "get": { "tags": [ "Sailor booking" ], "operationId": "get_sailor_booking_current_list", "parameters": [ { "name": "limit", "in": "query", "required": false }, { "name": "page", "in": "query", "required": false } ], "responses": { "200": { "description": "Returns an array of current user bookings (approved, pending or manual).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingCurrentListProvider" } } } } } } }, "/sailor/booking/past-list": { "get": { "tags": [ "Sailor booking" ], "operationId": "get_sailor_booking_past_list", "parameters": [ { "name": "limit", "in": "query", "required": false }, { "name": "page", "in": "query", "required": false } ], "responses": { "200": { "description": "Returns an array of past user bookings (approved, pending or manual).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingPastListProvider" } } } } } } }, "/sailor/booking/view/{booking}": { "get": { "tags": [ "Sailor booking" ], "operationId": "get_sailor_booking_view", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns details of a booking.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingDetailsDTO" } } } } } } }, "/sailor/booking/settings/{harbor}": { "get": { "tags": [ "Sailor booking" ], "operationId": "get_sailor_booking_harbor_settings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns details of selected harbor for booking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorHarborDetailsForBookingDTO" } } } } } } }, "/sailor/booking/price": { "post": { "tags": [ "Sailor booking" ], "operationId": "post_sailor_booking_price", "requestBody": { "request": "SailorBookingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingForm" } } } }, "responses": { "200": { "description": "Returns a preliminary price of a booking by selected options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingPriceDTO" } } } }, "400": { "description": "Either unrecognised field was passed to form or a required field is missing" } } } }, "/sailor-public/booking/settings/{harbor}": { "get": { "tags": [ "Sailor public booking" ], "operationId": "get_sailor_public_booking_harbor_settings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns details of selected harbor for booking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorHarborDetailsForBookingDTO" } } } } } } }, "/sailor-public/booking/view/{booking}": { "get": { "tags": [ "Sailor public booking" ], "operationId": "get_sailor_public_booking_view", "parameters": [ { "name": "booking", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns details of a booking.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingDetailsDTO" } } } } } } }, "/sailor-public/booking/price": { "post": { "tags": [ "Sailor public booking" ], "operationId": "post_sailor_public_booking_price", "requestBody": { "request": "SailorPublicBookingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingForm" } } } }, "responses": { "200": { "description": "Returns a preliminary price of a booking by selected options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorBookingPriceDTO" } } } }, "400": { "description": "Either unrecognised field was passed to form or a required field is missing" } } } }, "/contract/{harbor}/list": { "get": { "tags": [ "Contracts" ], "operationId": "get_contract_admin_admincontract_listcontracts", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/contract/{harbor}/create": { "post": { "tags": [ "Contracts" ], "operationId": "post_contract_admin_admincontract_createcontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/contract/{harbor}/view/{contract}": { "get": { "tags": [ "Contracts" ], "operationId": "get_contract_admin_admincontract_viewcontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/contract/{harbor}/check-saved-signature": { "get": { "tags": [ "Contracts" ], "operationId": "get_contract_admin_admincontract_checksavedsignature", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/contract/{harbor}/edit/{contract}": { "put": { "tags": [ "Contracts" ], "operationId": "put_contract_admin_admincontract_editcontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/contract/{harbor}/delete/{contract}": { "delete": { "tags": [ "Contracts" ], "operationId": "delete_contract_admin_admincontract_deletecontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/contract/{harbor}/send": { "post": { "tags": [ "Contracts" ], "operationId": "post_contract_admin_admincontract_sendcontracttosubscriber", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/contract/{harbor}/preview": { "post": { "tags": [ "Contracts" ], "operationId": "post_contract_admin_admincontract_previewcontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/contract/subscriber/{harbor}/list/{subscription}": { "get": { "tags": [ "Contracts" ], "operationId": "get_contract_admin_admincontractsubscriber_listcontracts", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/contract/subscriber/{harbor}/send-contract/{contractSubscriber}": { "get": { "tags": [ "Contracts" ], "operationId": "get_contract_admin_admincontractsubscriber_sendcontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractSubscriber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/contract/subscriber/{harbor}/upload-contract/{contractSubscriber}": { "post": { "tags": [ "Contracts" ], "operationId": "post_contract_admin_admincontractsubscriber_uploadcontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractSubscriber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/contract/subscriber/{harbor}/delete/{contractSubscriber}": { "delete": { "tags": [ "Contracts" ], "operationId": "delete_contract_admin_admincontractsubscriber_deletecontract", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractSubscriber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/power/cardholder/list/{harbor}": { "get": { "tags": [ "Power Cardholder" ], "operationId": "get_power_cardholder_list", "parameters": [ { "name": "limit", "in": "query", "required": false }, { "name": "page", "in": "query", "required": false }, { "name": "q", "in": "query", "required": false }, { "name": "status", "in": "query", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of harbor power cardholders.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardholderListProvider" } } } } } } }, "/power/cardholder/create/{harborClient}": { "post": { "tags": [ "Power Cardholder" ], "operationId": "post_power_cardholder_create", "parameters": [ { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CardholderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardholderForm" } } } }, "responses": { "201": { "description": "Returns newly created power cardholder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cardholder" } } } }, "400": { "description": "Either unrecognised field was passed to form or a required field is missing" }, "204": { "description": "Cardholder already exists" } } } }, "/power/cardholder/edit/{cardholder}": { "put": { "tags": [ "Power Cardholder" ], "operationId": "put_power_cardholder_edit", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "CardholderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardholderForm" } } } }, "responses": { "200": { "description": "Returns edited power cardholder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cardholder" } } } }, "400": { "description": "Either unrecognised field was passed to form or a required field is missing" }, "404": { "description": "Cardholder doesn't exist" } } } }, "/power/cardholder/view/{cardholder}": { "get": { "tags": [ "Power Cardholder" ], "operationId": "get_power_cardholder_view", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns power cardholder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cardholder2" } } } }, "404": { "description": "Cardholder doesn't exist" } } } }, "/power/cardholder/exists/{client}": { "get": { "tags": [ "Power Cardholder" ], "summary": "Checks whether client has cardholder or not.", "operationId": "get_power_cardholder_exists", "parameters": [ { "name": "client", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns true or false whether cardholder exists or not.", "content": { "application/json": { "schema": { "properties": { "exists": { "type": "boolean" } }, "type": "object" } } } } } } }, "/power/cardholder/{cardholder}/power-packages": { "get": { "tags": [ "Power Cardholder" ], "operationId": "get_power_cardholder_power_packages", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of cardholder bought power packages.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CardholderPowerProduct" } } } } } } } }, "/power/cardholder/{cardholder}/expired-power-packages": { "get": { "tags": [ "Power Cardholder" ], "operationId": "get_power_cardholder_expired_power_packages", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of cardholder expired power packages.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CardholderPowerProduct" } } } } } } } }, "/power/cardholder/{cardholder}/{powerProduct}/add-power-package": { "post": { "tags": [ "Power Cardholder" ], "operationId": "post_power_cardholder_add_power_package", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "powerProduct", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns newly added power package.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardholderPowerProduct2" } } } } } } }, "/power/pedestal/list/{harbor}": { "get": { "tags": [ "Power Pedestal" ], "operationId": "get_power_pedestal_list", "parameters": [ { "name": "page", "in": "query", "required": false }, { "name": "limit", "in": "query", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of harbor pedestals.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PedestalListProvider" } } } } } } }, "/power/pedestal/edit/{pedestal}": { "put": { "tags": [ "Power Pedestal" ], "operationId": "put_power_pedestal_edit", "parameters": [ { "name": "pedestal", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "PedestalController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PedestalForm" } } } }, "responses": { "200": { "description": "Pedestal was edited successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pedestal" } } } }, "400": { "description": "Invalid form" } } } }, "/power/pedestal/change-status/{pedestal}": { "patch": { "tags": [ "Power Pedestal" ], "operationId": "patch_power_pedestal_change_status", "parameters": [ { "name": "pedestal", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "PedestalController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PedestalStatusForm" } } } }, "responses": { "200": { "description": "Pedestal status was changed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pedestal" } } } }, "400": { "description": "Invalid request" } } } }, "/power/history/list/{harbor}": { "get": { "tags": [ "Power History" ], "operationId": "get_power_history_list", "parameters": [ { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "'createdAt' or 'packageTimes'", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "powerProduct", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of power package usage history.", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "powerId": { "type": "integer" }, "name": { "type": "string" }, "sold": { "type": "integer" }, "totalKwhSold": { "type": "string" }, "packageLength": { "type": "integer" }, "price": { "type": "string" }, "totalPrice": { "type": "string" }, "totalKwhUsed": { "type": "string" } }, "type": "object" } } } } } } } }, "/power/history/export/{harbor}": { "get": { "tags": [ "Power History" ], "operationId": "get_power_history_export", "parameters": [ { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFilter", "in": "query", "description": "'createdAt' or 'packageTimes'", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "powerProduct", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an XLSX file of selected range of history." } } } }, "/power-settings/{harbor}/view": { "get": { "tags": [ "Power Settings" ], "operationId": "get_power_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns power settings of a harbor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerSetting" } } } }, "204": { "description": "Power settings not found" } } } }, "/power-settings/{harbor}/create": { "post": { "tags": [ "Power Settings" ], "operationId": "post_power_settings_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "PowerSettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerSettingForm" } } } }, "responses": { "201": { "description": "Returns power settings of a harbor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerSetting" } } } }, "400": { "description": "Invalid form or unable to establish connection", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } } } } } }, "/power-settings/{harbor}/edit": { "put": { "tags": [ "Power Settings" ], "operationId": "put_power_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "PowerSettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerSettingForm" } } } }, "responses": { "200": { "description": "Returns power settings of a harbor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerSetting" } } } }, "400": { "description": "Invalid form or unable to establish connection", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } } }, "204": { "description": "Specified harbor doesn't have power settings" } } } }, "/power-settings/{harbor}/remove": { "delete": { "tags": [ "Power Settings" ], "operationId": "delete_power_settings_remove", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } }, "204": { "description": "Specified harbor doesn't have power settings" } } } }, "/power-settings/{harbor}/sync": { "get": { "tags": [ "Power Settings" ], "operationId": "get_power_settings_sync", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Synchronised successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } }, "400": { "description": "Invalid form or unable to establish connection", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "type": "object" } } } }, "204": { "description": "Specified harbor doesn't have power settings" } } } }, "/power-settings/{harbor}/{setting}/edit-tutorial": { "patch": { "tags": [ "Power Settings" ], "operationId": "patch_power_settings_patch_tutorial", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "setting", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "PowerSettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerSettingTutorialForm" } } } }, "responses": { "200": { "description": "Returns power settings of a harbor", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PowerSetting" } } } } } } }, "/sailor-public/power/cardholder/{harbor}/power-packages": { "get": { "tags": [ "Sailor Public Power Cardholder" ], "operationId": "get_sailor_public_power_cardholder_harbor_power_packages", "parameters": [ { "name": "type", "in": "query", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of harbor offered power packages.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Power" } } } } } } } }, "/sailor-public/power/enable-socket/{pedestal}": { "post": { "tags": [ "Sailor Public Power" ], "operationId": "post_sailorpublic_power_enable-socket", "parameters": [ { "name": "pedestal", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicPowerController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicEnableSocketForm" } } } }, "responses": { "200": { "description": "" } } } }, "/sailor/power/cardholder/edit/{cardholder}": { "patch": { "tags": [ "Sailor Power Cardholder" ], "operationId": "patch_sailor_power_cardholder_patch", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorCardholderController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCardholderForm" } } } }, "responses": { "200": { "description": "Returns edited power cardholder.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cardholder" } } } }, "400": { "description": "Either unrecognised field was passed to form or a required field is missing" }, "404": { "description": "Cardholder doesn't exist" } } } }, "/power/cardholder/sailor/{harbor}/power-packages": { "get": { "tags": [ "Power Cardholder Sailor" ], "operationId": "get_power_cardholder_sailor_harbor_power_packages", "parameters": [ { "name": "type", "in": "query", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns list of harbor offered power packages.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Power" } } } } } } } }, "/power/socket/list/{harbor}": { "get": { "tags": [ "Power Socket" ], "operationId": "get_power_socket_list", "parameters": [ { "name": "limit", "in": "query", "required": false }, { "name": "page", "in": "query", "required": false }, { "name": "dock", "in": "query", "required": false }, { "name": "occupancy", "in": "query", "required": false }, { "name": "q", "in": "query", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of harbor sockets", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocketListProvider" } } } } } } }, "/power/socket/change-status/{socket}": { "patch": { "tags": [ "Power Socket" ], "operationId": "patch_power_socket_change_status", "parameters": [ { "name": "socket", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SocketController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SocketStatusForm" } } } }, "responses": { "200": { "description": "Socket status was changed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Socket" } } } }, "400": { "description": "Invalid request" } } } }, "/webhook/power": { "post": { "tags": [ "Power Webhook" ], "operationId": "post_webhook_powerwebhook", "requestBody": { "request": "WebhookController", "required": true, "content": { "application/json": { "schema": { "properties": { "harborId": { "type": "string" }, "towerId": { "type": "integer" }, "deviceId": { "type": "integer" }, "cliId": { "type": "integer" }, "event": { "type": "string", "example": "power_on | power_off | low_credits" } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook received successfully", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } }, "400": { "description": "Error in request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Incorrect permissions", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean", "example": false }, "error": { "type": "string" } }, "type": "object" } } } } } } }, "/admin/power-lite/billing-batch/{harbor}/list-select-options": { "get": { "tags": [ "Admin power lite billing batch" ], "operationId": "get_PowerLite_BillingBatch_list_select_options", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/billing-batch/{harbor}/create": { "post": { "tags": [ "Admin power lite billing batch" ], "operationId": "post_PowerLite_BillingBatch_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/list": { "get": { "tags": [ "Admin power lite customer" ], "operationId": "get_PowerLite_Customer_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/ids": { "get": { "tags": [ "Admin power lite customer" ], "operationId": "get_PowerLite_Customer_ids", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/count-pending-submissions": { "post": { "tags": [ "Admin power lite customer" ], "operationId": "post_PowerLite_Customer_count_pending_submissions", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/user-ids": { "post": { "tags": [ "Admin power lite customer" ], "operationId": "post_PowerLite_Customer__user_ids", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/view/{customer}": { "get": { "tags": [ "Admin power lite customer" ], "operationId": "get_PowerLite_Customer_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/create": { "post": { "tags": [ "Admin power lite customer" ], "operationId": "post_PowerLite_Customer_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/edit/{customer}": { "put": { "tags": [ "Admin power lite customer" ], "operationId": "put_PowerLite_Customer_update", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/customer/{harbor}/delete/{customer}": { "delete": { "tags": [ "Admin power lite customer" ], "operationId": "delete_PowerLite_Customer_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/admin/power-lite/invoice/{harbor}/bulk-create": { "post": { "tags": [ "Admin power lite invoice" ], "operationId": "post_PowerLite_Invoice_bulk_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/meter/{harbor}/list": { "get": { "tags": [ "Admin power lite meter" ], "operationId": "get_PowerLite_Meter_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/meter/{harbor}/list-select-options": { "get": { "tags": [ "Admin power lite meter" ], "operationId": "get_PowerLite_Meter_list_select_options_for_customer", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/meter/{harbor}/view/{meter}": { "get": { "tags": [ "Admin power lite meter" ], "operationId": "get_PowerLite_Meter_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/meter/{harbor}/create": { "post": { "tags": [ "Admin power lite meter" ], "operationId": "post_PowerLite_Meter_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/meter/{harbor}/edit/{meter}": { "put": { "tags": [ "Admin power lite meter" ], "operationId": "put_PowerLite_Meter_update", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/meter/{harbor}/delete/{meter}": { "delete": { "tags": [ "Admin power lite meter" ], "operationId": "delete_PowerLite_Meter_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "meter", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/admin/power-lite/readings-history/{harbor}/list/{customer}": { "get": { "tags": [ "Admin power lite readings history" ], "operationId": "get_PowerLite_ReadingsHistory_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/readings-history/{harbor}/create": { "post": { "tags": [ "Admin power lite readings history" ], "operationId": "post_PowerLite_ReadingsHistory_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/readings-history/{harbor}/approve/{customer}": { "post": { "tags": [ "Admin power lite readings history" ], "operationId": "post_PowerLite_ReadingsHistory_approve", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/readings-history/{harbor}/decline/{customer}": { "post": { "tags": [ "Admin power lite readings history" ], "operationId": "post_PowerLite_ReadingsHistory_decline", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/readings-history/{harbor}/bulk-approve": { "post": { "tags": [ "Admin power lite readings history" ], "operationId": "post_PowerLite_ReadingsHistory_bulk_approve", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/admin/power-lite/settings/{harbor}/view": { "get": { "tags": [ "Admin power lite settings" ], "operationId": "get_PowerLite_Setting_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/settings/{harbor}/edit": { "put": { "tags": [ "Admin power lite settings" ], "operationId": "put_PowerLite_Setting_update", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/power-lite/import/{harbor}": { "post": { "tags": [ "Power lite import" ], "operationId": "post_power_lite_import_index", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor/power-lite/submit-reading": { "post": { "tags": [ "Sailor power lite submission" ], "operationId": "post_sailor_power_lite_submitReading", "requestBody": { "request": "SailorPowerLiteSubmissionController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPowerLiteSubmissionForm" } } } }, "responses": { "200": { "description": "" } } } }, "/sailor/subscription/list-harbors": { "get": { "tags": [ "Sailor subscription" ], "summary": "Current user subscription list\ndeprecated due to being paginated.", "operationId": "get_sailor_subscription_list_harbors", "parameters": [ { "name": "page", "in": "query", "required": false }, { "name": "limit", "in": "query", "required": false } ], "responses": { "200": { "description": "Return active subscription list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorSubscriptionHarborProvider" } } } } } }, "deprecated": true } }, "/sailor/subscription/subscribed-harbor-list": { "get": { "tags": [ "Sailor subscription" ], "summary": "Current user harbor list", "operationId": "get_sailor_subscription_subscribed_harbor_list", "responses": { "200": { "description": "Return harbor list", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true } }, "type": "object" } } } } } } } }, "/sailor/subscription/list": { "get": { "tags": [ "Sailor subscription" ], "summary": "Current user subscription list", "operationId": "get_sailor_subscription_list", "responses": { "200": { "description": "Return active subscription list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } } } } } } } }, "/sailor/subscription/view/{subscription}": { "get": { "tags": [ "Sailor subscription" ], "summary": "View subscription information by given ID", "operationId": "get_sailor_subscription_view", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Subscription by given id not found, is deleted or doesn't belong to current user" }, "200": { "description": "Return subscription information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorSubscriptionViewModel" } } } } } } }, "/sailor/subscription/view/{subscription}/boats": { "get": { "tags": [ "Sailor subscription" ], "summary": "View subscription boats", "operationId": "get_sailor_subscription_view_boats", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "404": { "description": "Subscription by given id not found, is deleted or doesn't belong to current user" }, "200": { "description": "Return subscription boat list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorSubscriptionViewModel" } } } } } } }, "/v2/subscription/advanced-invoicing/preview/price": { "post": { "tags": [ "Subscription - Advanced invoicing" ], "summary": "Calculate total price of subscription product settings, including invoicing in advance.", "operationId": "post_subscription_advanced_invoicing_preview_price", "requestBody": { "$ref": { "schema": "SubscriptionAdvancedInvoicingController", "type": "array", "items": { "$ref": "string" } } }, "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/advanced-invoicing/preview/revenue": { "post": { "tags": [ "Subscription - Advanced invoicing" ], "summary": "Calculate revenue per subscription product settings, including invoicing in advance.", "operationId": "post_subscription_advanced_invoicing_preview_revenue", "requestBody": { "$ref": { "schema": "SubscriptionAdvancedInvoicingController", "type": "array", "items": { "$ref": "string" } } }, "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/advanced-invoicing/available-billing-periods/{subscription}": { "get": { "tags": [ "Subscription - Advanced invoicing" ], "summary": "Returns available amount of advanced invoices for product. Used in \"Advance invoices\" column when creating invoice.", "operationId": "get_subscription_advanced_invoicing_available_billing_periods", "parameters": [ { "name": "subscription", "in": "query", "description": "Subscription ID for which invoice is being generated", "required": true }, { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/advanced-invoicing/{harbor}/generate-invoices": { "post": { "tags": [ "Subscription - Advanced invoicing" ], "operationId": "post_subscription_advanced_invoicing_generate_invoices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": { "schema": "SubscriptionAdvancedInvoicingController", "type": "json" } }, "responses": { "204": { "description": "Success" } } } }, "/v2/subscription/attachment/list/{subscription}": { "get": { "tags": [ "Subscription attachment" ], "operationId": "get_subscription_attachment_list", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/attachment/upload/{subscription}": { "post": { "tags": [ "Subscription attachment" ], "operationId": "post_subscription_attachment_upload", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/v2/subscription/attachment/delete/{subscriptionAttachment}": { "delete": { "tags": [ "Subscription attachment" ], "operationId": "delete_subscription_attachment_delete", "parameters": [ { "name": "subscriptionAttachment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/v2/subscription/view/{subscription}": { "get": { "tags": [ "Subscription - Subscriptions" ], "operationId": "get_subscription_view", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription2" } } } } } } }, "/v2/subscription/list": { "get": { "tags": [ "Subscription - Subscriptions" ], "operationId": "get_subscription_list", "parameters": [ { "name": "productType", "in": "query", "description": "Subscription harbor product type berth/storage/custom", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "productIds", "in": "query", "description": "Subscription harbor product ids, array of ids", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "paymentStatus", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "idVerification", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "q", "in": "query", "description": "Search param", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription3" } } } } } } }, "/v2/subscription/list/disabled": { "get": { "tags": [ "Subscription - Subscriptions" ], "operationId": "get_subscription_list-disabled", "parameters": [ { "name": "productType", "in": "query", "description": "Subscription harbor product type berth/storage/custom", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "productIds", "in": "query", "description": "Subscription harbor product ids, array of ids", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "paymentStatus", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "q", "in": "query", "description": "Search param", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription3" } } } } } } }, "/v2/subscription": { "post": { "tags": [ "Subscription - Subscriptions" ], "operationId": "post_subscription_add", "requestBody": { "request": "SubscriptionController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription4" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription3" } } } } } } }, "/v2/subscription/{subscriber}": { "put": { "tags": [ "Subscription - Subscriptions" ], "operationId": "put_subscription_edit", "parameters": [ { "name": "subscriber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SubscriptionController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription4" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription3" } } } } } }, "patch": { "tags": [ "Subscription - Subscriptions" ], "operationId": "patch_subscription_update", "parameters": [ { "name": "subscriber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SubscriptionController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription4" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription3" } } } } } } }, "/v2/subscription/is-subscriber/{customer}/{harbor}": { "get": { "tags": [ "Subscription - Subscriptions" ], "operationId": "get_subscription_is_subscriber", "parameters": [ { "name": "activeOnly", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "customer", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns subscription ID if subscriber exists" } } } }, "/v2/subscription/enable/{subscription}": { "patch": { "tags": [ "Subscription - Subscriptions" ], "operationId": "patch_subscription_enable", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Enables single subscription" } } } }, "/v2/subscription/disable/{subscription}": { "patch": { "tags": [ "Subscription - Subscriptions" ], "operationId": "patch_subscription_disable", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Disabled single subscription" } } } }, "/v2/subscription/disable/multiple": { "put": { "tags": [ "Subscription - Subscriptions" ], "operationId": "put_subscription_disable_multiple", "requestBody": { "request": "SubscriptionController", "required": true, "content": { "application/json": { "schema": { "properties": { "ids": { "description": "Array of subscriptions to disable", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Success" } } } }, "/v2/subscription/enable/multiple": { "put": { "tags": [ "Subscription - Subscriptions" ], "operationId": "put_subscription_enable_multiple", "requestBody": { "request": "SubscriptionController", "required": true, "content": { "application/json": { "schema": { "properties": { "ids": { "description": "Array of subscriptions to disable", "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "204": { "description": "Success" } } } }, "/v2/subscription/list/user-ids": { "post": { "tags": [ "Subscription - Subscriptions" ], "operationId": "post_subscription_list_user_ids", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/list/all-ids": { "get": { "tags": [ "Subscription - Subscriptions" ], "summary": "List all subscription ids for selecting all subscriptions in frontend", "operationId": "get_subscription_list_all_ids", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/list/all-ids/disabled": { "get": { "tags": [ "Subscription - Subscriptions" ], "summary": "List all disabled subscription ids for selecting all subscriptions in frontend", "operationId": "get_subscription_list_all_ids_disabled", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/email-details-to-sailor/{id}": { "patch": { "tags": [ "Subscription - Subscriptions" ], "operationId": "patch_subscription_email_details_to_user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/v2/subscription/pending-or-overdue": { "post": { "tags": [ "Subscription - Subscriptions" ], "operationId": "post_subscription_pending_or_overdue", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/subscriber_ids/{harbor}": { "post": { "tags": [ "Subscription - Subscriptions" ], "summary": "Gets subscriber IDs for selected harbor clients and harbor. Used in harbor client search modal for subscriber ID column.", "operationId": "post_subscription_subscriber_ids", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/export_pdf/{harbor}": { "post": { "tags": [ "Subscription - Subscriptions" ], "operationId": "post_subscription_export_pdf", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/export_invoices_xls/{harbor}": { "post": { "tags": [ "Subscription - Subscriptions" ], "summary": "Get an Excel file of exported subscription pending or overdue invoices.", "operationId": "post_subscription_export_invoices_xls", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/export": { "post": { "tags": [ "Subscription - Subscriptions" ], "summary": "Get an Excel file of selected subscriptions.", "operationId": "post_subscription_export", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/export_products": { "post": { "tags": [ "Subscription - Subscriptions" ], "summary": "Get an Excel file of selected subscribers subscribed products.", "operationId": "post_subscription_export_products", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/history/{harbor}": { "get": { "tags": [ "Subscription - History" ], "operationId": "get_subscription_history_list", "parameters": [ { "name": "q", "in": "query", "description": "search", "required": false }, { "name": "transferType", "in": "query", "description": "cash|card|betalings_service|bank_transfer|mobilepay|cheque", "required": false }, { "name": "dateFrom", "in": "query", "required": false }, { "name": "dateTo", "in": "query", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "Subscription\\Model\\SubscriptionHistoryListLine" } } } } } } } }, "/v2/subscription/history/{harbor}/turnover": { "get": { "tags": [ "Subscription - History" ], "operationId": "get_subscription_history_turnover", "parameters": [ { "name": "dateTo", "in": "query", "required": false }, { "name": "dateFrom", "in": "query", "required": false }, { "name": "transferType", "in": "query", "description": "cash|card|betalings_service|bank_transfer|mobilepay|cheque", "required": false }, { "name": "q", "in": "query", "description": "search", "required": false }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionHistoryListOverview" } } } } } } }, "/v2/subscription/history/{harbor}/export_xls": { "get": { "tags": [ "Subscription - History" ], "summary": "Get an Excel file of exported subscription payments.", "description": "Gets subscription payments of selected harbor", "operationId": "get_subscription_history_export_xls", "parameters": [ { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/import/{harbor}/{user}": { "post": { "tags": [ "Data import v2" ], "operationId": "post_subscription_import_index", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/insurance": { "get": { "tags": [ "Subscription - Insurance" ], "operationId": "get_subscription_insurance_list", "parameters": [ { "name": "harbor", "in": "query", "description": "Harbor ID", "required": true } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/insurance/all-ids": { "get": { "tags": [ "Subscription - Insurance" ], "operationId": "get_subscription_insurance_all_ids", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/insurance/user-ids": { "post": { "tags": [ "Subscription - Insurance" ], "operationId": "post_subscription_insurance_user_ids", "parameters": [ { "name": "harbor", "in": "query", "description": "Harbor ID", "required": true } ], "requestBody": { "$ref": { "schema": "SubscriptionInsuranceController", "type": "json" } }, "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/invoicing/list/{subscription}": { "get": { "tags": [ "Subscription - Invoicing" ], "operationId": "get_subscription_invoicing_invoice_list", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice2" } } } } } } }, "/v2/subscription/invoicing/send/preview/{harbor}": { "post": { "tags": [ "Subscription - Invoicing" ], "operationId": "post_subscription_invoicing_send_preview", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": { "schema": "SubscriptionInvoicingController", "type": "json" } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice3" } } } } } } }, "/v2/subscription/invoicing/send/{harbor}": { "post": { "tags": [ "Subscription - Invoicing" ], "operationId": "post_subscription_invoicing_send", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": { "schema": "SubscriptionInvoicingController", "type": "json" } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice3" } } } } } } }, "/v2/subscription/invoicing/products": { "post": { "tags": [ "Subscription - Invoicing" ], "operationId": "post_subscription_invoicing_products_list", "requestBody": { "$ref": { "schema": "SubscriptionInvoicingController", "type": "json" } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription5" } } } } } } }, "/v2/subscription/invoicing/list": { "post": { "tags": [ "Subscription - Invoicing" ], "summary": "List Subscriptions From Subscription Ids And Product Ids", "operationId": "post_subscription_invoicing_subscriptions_list", "requestBody": { "$ref": { "schema": "SubscriptionInvoicingController", "type": "json" } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting" } } } } } } }, "/v2/subscription/invoicing/{harbor}/generate-invoices": { "post": { "tags": [ "Subscription - Invoicing" ], "operationId": "post_subscription_invoicing_generate_invoices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": { "schema": "SubscriptionInvoicingController", "type": "json" } }, "responses": { "204": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting" } } } } } } }, "/v2/subscription/invoicing/preview/price": { "post": { "tags": [ "Subscription - Invoicing" ], "summary": "Calculate total price of subscription product settings", "operationId": "post_subscription_invoicing_preview_price", "requestBody": { "$ref": { "schema": "SubscriptionInvoicingController", "type": "array", "items": { "$ref": "string" } } }, "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/invoicing/preview/revenue": { "post": { "tags": [ "Subscription - Invoicing" ], "summary": "Calculate revenue per subscription product settings", "operationId": "post_subscription_invoicing_preview_revenue", "requestBody": { "$ref": { "schema": "SubscriptionInvoicingController", "type": "array", "items": { "$ref": "string" } } }, "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/invoicing/new_invoices_in_progress": { "post": { "tags": [ "Subscription - Invoicing" ], "summary": "Receives an array of subscription ids and the endpoint checks whether there are invoices being created (as batch items)\nfor selected subscriptions. If so, returns true, otherwise - false.", "description": "Used for warning popup.", "operationId": "post_subscription_invoicing_new_invoices_in_progress", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/invoicing/auto-generation-test/{region}": { "get": { "tags": [ "Subscription - Invoicing" ], "summary": "Only used for testing. After executing this endpoint, invoices for subscriptions that satisfy required conditions are auto-generated.", "operationId": "get_subscription_invoicing_auto_generation_test", "parameters": [ { "name": "region", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/log/list/{harborClient}": { "get": { "tags": [ "Subscription - Log" ], "operationId": "get_subscription_log_list", "parameters": [ { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLog" } } } } } } }, "/v2/subscription/product-setting/view/{id}": { "get": { "tags": [ "Subscription - Product setting" ], "operationId": "get_subscription_product_setting_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting" } } } } } } }, "/v2/subscription/product-setting/list/{subscription}": { "get": { "tags": [ "Subscription - Product setting" ], "operationId": "get_subscription_product_setting_list", "parameters": [ { "name": "expiration", "in": "query", "schema": { "type": "string", "enum": [ "all", "active", "expired" ] } }, { "name": "subscription", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting" } } } } } } }, "/v2/subscription/product-setting": { "post": { "tags": [ "Subscription - Product setting" ], "operationId": "post_subscription_product_setting_add", "requestBody": { "request": "SubscriptionProductSettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting" } } } } } } }, "/v2/subscription/product-setting/{product}": { "put": { "tags": [ "Subscription - Product setting" ], "operationId": "put_subscription_product_setting_edit", "parameters": [ { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SubscriptionProductSettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting" } } } } } }, "delete": { "tags": [ "Subscription - Product setting" ], "operationId": "delete_subscription_product_setting_delete", "parameters": [ { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionProductSetting" } } } } } } }, "/v2/subscription/product-setting/client-boat/{harbor}/{boat}": { "get": { "tags": [ "Subscription - Product setting" ], "summary": "Gets an active berth subscription product from client boat", "operationId": "get_subscription_product_setting_active_product_client_boat", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/product-setting/rack-by-client-boat/{harbor}/{clientBoat}": { "get": { "tags": [ "Subscription - Product setting" ], "summary": "List rack products by client boat", "operationId": "get_subscription_product_setting_active_rack_client_boat_products", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/product-setting/{product}/currently-used-count": { "get": { "tags": [ "Subscription - Product setting" ], "summary": "Returns count of how many given type of racks (or other subscription products) are used by subscribers.", "operationId": "get_subscription_product_setting_currently_used_count", "parameters": [ { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/product-setting/{product}/expiration-date": { "post": { "tags": [ "Subscription - Product setting" ], "summary": "Returns expiration date of a product depending on given parameters.", "operationId": "post_subscription_product_setting_expiration_date", "parameters": [ { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/product-setting/check-automation": { "post": { "tags": [ "Subscription - Product setting" ], "summary": "Receives: subscriber IDs and harbor product IDs.", "description": "Returns: subscriber ID, name and harbor product setting name which have automation enabled.", "operationId": "post_subscription_product_setting_check_automation", "responses": { "200": { "description": "Success" } } } }, "/v2/subscription/slips/{harbor}": { "get": { "tags": [ "Subscription - Slip list" ], "operationId": "get_subscription_slips_subscription_subscriptionslip_list", "parameters": [ { "name": "dock", "in": "query", "description": "bridge ID", "schema": { "type": "string" } }, { "name": "slip", "in": "query", "description": "position ID", "schema": { "type": "string" } }, { "name": "slipLengthMin", "in": "query", "schema": { "type": "number" } }, { "name": "slipLengthMax", "in": "query", "schema": { "type": "number" } }, { "name": "slipWidthMin", "in": "query", "schema": { "type": "number" } }, { "name": "slipWidthMax", "in": "query", "schema": { "type": "number" } }, { "name": "slipDepthMin", "in": "query", "schema": { "type": "number" } }, { "name": "slipDepthMax", "in": "query", "schema": { "type": "number" } }, { "name": "paymentStatus", "in": "query", "schema": { "type": "string", "enum": [ "new", "overdue", "paid" ] } }, { "name": "occupancy", "in": "query", "schema": { "type": "string", "enum": [ "occupied", "available" ] } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated list of positions according to filter" } } } }, "/v2/subscription/slips/slip_ids/{harbor}": { "get": { "tags": [ "Subscription - Slip list" ], "operationId": "get_subscription_slips_subscription_subscriptionslip_slipids", "parameters": [ { "name": "dock", "in": "query", "description": "bridge ID", "schema": { "type": "string" } }, { "name": "slip", "in": "query", "description": "position ID", "schema": { "type": "string" } }, { "name": "slipLengthMin", "in": "query", "schema": { "type": "number" } }, { "name": "slipLengthMax", "in": "query", "schema": { "type": "number" } }, { "name": "slipWidthMin", "in": "query", "schema": { "type": "number" } }, { "name": "slipWidthMax", "in": "query", "schema": { "type": "number" } }, { "name": "slipDepthMin", "in": "query", "schema": { "type": "number" } }, { "name": "slipDepthMax", "in": "query", "schema": { "type": "number" } }, { "name": "paymentStatus", "in": "query", "schema": { "type": "number", "enum": [ "0", "1", "2", "3" ] } }, { "name": "occupancy", "in": "query", "schema": { "type": "string", "enum": [ "occupied", "available" ] } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Unpaginated list position id's", "content": { "application/json": { "schema": { "description": "Bridge Position Id's", "type": "array", "items": { "type": "string" } } } } } } } }, "/admin/survey/answer/{harbor}/view/{module}/{entityId}": { "get": { "tags": [ "Survey" ], "operationId": "get_survey_admin_adminsurveyanswer_viewquestion", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/survey/{harbor}/view-by-module/{module}": { "get": { "tags": [ "Survey" ], "operationId": "get_survey_admin_adminsurvey_viewsurvey", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/survey/question/{harbor}/view/{question}": { "get": { "tags": [ "Survey" ], "operationId": "get_survey_admin_adminsurveyquestion_viewquestion", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "question", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/survey/question/{harbor}/create/{survey}": { "post": { "tags": [ "Survey" ], "operationId": "post_survey_admin_adminsurveyquestion_createquestion", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/survey/question/{harbor}/edit/{question}": { "put": { "tags": [ "Survey" ], "operationId": "put_survey_admin_adminsurveyquestion_editquestion", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "question", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/survey/question/{harbor}/delete/{question}": { "delete": { "tags": [ "Survey" ], "operationId": "delete_survey_admin_adminsurveyquestion_deletequestion", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "question", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/sailor-public/survey/{harbor}/view-by-module/{module}": { "get": { "tags": [ "Survey - sailor" ], "operationId": "get_survey_sailor_sailorpublicsurvey_viewsurvey", "parameters": [ { "name": "locale", "in": "query", "example": "en_US" }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorSurveyDTO" } } } } } } }, "/sailor-public/survey/{harbor}/submit/{survey}/{entityId}": { "post": { "tags": [ "Survey - sailor" ], "operationId": "post_survey_sailor_sailorpublicsurvey_submitsurvey", "parameters": [ { "name": "entityId", "in": "path", "description": "ID of the entity this survey has been filled for", "required": true, "schema": { "type": "string" } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicSurveyController", "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "survey": { "questions": { "UUID": { "text": "string", "options": { "UUID": "UUID" } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorSurveyAnswerDTO" } } } } } } }, "/sailor-public/survey/{harbor}/edit/{survey}/{answer}": { "put": { "tags": [ "Survey - sailor" ], "operationId": "put_survey_sailor_sailorpublicsurvey_editsurvey", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "survey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "answer", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "SailorPublicSurveyController", "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "survey": { "questions": { "UUID": { "text": "string", "options": { "UUID": "UUID" } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorSurveyAnswerDTO" } } } } } } }, "/harbor-client/{harbor}/boat/view/{clientBoat}": { "get": { "tags": [ "Harbor Client Boats" ], "operationId": "get_harbor_client_boat_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return client boat information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatDTO" } } } } } } }, "/harbor-client/{harbor}/boat/list/{harborClient}": { "get": { "tags": [ "Harbor Client Boats" ], "operationId": "get_harbor_client_boat_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return harbor client boat list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatListDTO" } } } } } } }, "/harbor-client/{harbor}/boat/trip-list/{harborClient}": { "get": { "tags": [ "Harbor Client Boats" ], "operationId": "get_harbor_client_boat_trip_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return harbor client boat list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatListDTO" } } } } } } }, "/harbor-client/{harbor}/boat/subscribed_boat_list/{harborClient}": { "get": { "tags": [ "Harbor Client Boats" ], "operationId": "get_harbor_client_boat_client_boats", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return harbor client boat list with subscription status", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/harbor-client/{harbor}/boat/create/{harborClient}": { "post": { "tags": [ "Harbor Client Boats" ], "operationId": "post_harbor_client_boat_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborClientBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatForm" } } } }, "responses": { "200": { "description": "Return created boat ID", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatDTO" } } } } } } }, "/harbor-client/{harbor}/boat/edit/{clientBoat}": { "put": { "tags": [ "Harbor Client Boats" ], "operationId": "put_harbor_client_boat_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborClientBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatForm" } } } }, "responses": { "200": { "description": "Return client boat information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatDTO" } } } } } } }, "/harbor-client/{harbor}/boat/change-location/{clientBoat}": { "patch": { "tags": [ "Harbor Client Boats" ], "operationId": "patch_harbor_client_boat_change-location", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborClientBoatController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborClientBoatLocationForm" } } } }, "responses": { "204": { "description": "" } } } }, "/harbor-client/{harbor}/boat/delete/{clientBoat}": { "delete": { "tags": [ "Harbor Client Boats" ], "operationId": "delete_harbor_client_boat_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Indicates whether boat deletion was success or not.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/harbor-client/{harbor}/boat/active-boat-usages/{clientBoat}": { "get": { "tags": [ "Harbor Client Boats" ], "operationId": "get_harbor_client_boat_active_boat_usages", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns whether boat has anything active.", "content": { "application/json": { "schema": { "properties": { "activeBooking": { "description": "Does boat have an active booking", "type": "boolean" }, "activeSubscription": { "description": "Does boat have an active subscription", "type": "boolean" }, "activeCraneReservation": { "description": "Does boat have an active crane reservation", "type": "boolean" } }, "type": "object" } } } } } } }, "/harbor-client/{harbor}/boat-image/list/{clientBoat}": { "get": { "tags": [ "Harbor client boat image" ], "operationId": "get_boat_image_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/boat-image/upload/{clientBoat}": { "post": { "tags": [ "Harbor client boat image" ], "operationId": "post_boat_image_upload", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "clientBoat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/harbor-client/{harbor}/boat-image/delete/{image}": { "delete": { "tags": [ "Harbor client boat image" ], "operationId": "delete_boat_image_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "image", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbor-client/{harbor}/view/{harborClient}": { "get": { "tags": [ "Harbor Clients" ], "operationId": "get_api_harbor_client_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/view-by-client-id/{harborClientId}": { "get": { "tags": [ "Harbor Clients" ], "operationId": "get_api_harbor_client_view_by_client_id", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/list": { "get": { "tags": [ "Harbor Clients" ], "operationId": "get_api_harbor_client_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/list-by-email": { "get": { "tags": [ "Harbor Clients" ], "operationId": "get_api_harbor_client_list-by-email", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/create-by-user/{user}": { "post": { "tags": [ "Harbor Clients" ], "operationId": "post_api_harbor_client_create_by_user", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/view-by-user/{user}": { "get": { "tags": [ "Harbor Clients" ], "operationId": "get_api_harbor_client_view_by_user", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/create": { "post": { "tags": [ "Harbor Clients" ], "operationId": "post_api_harbor_client_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/edit/{harborClient}": { "put": { "tags": [ "Harbor Clients" ], "operationId": "put_api_harbor_client_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/next-client-id": { "get": { "tags": [ "Harbor Clients" ], "operationId": "get_api_harbor_client_get_next_client_id", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/{harborClient}/terms": { "patch": { "tags": [ "Harbor Clients" ], "operationId": "patch_api_harbor_client_toggle_terms", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor-client/{harbor}/{harborClient}/reset_password": { "get": { "tags": [ "Harbor Clients" ], "operationId": "get_api_harbor_client_reset_password", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/report/balance/list/{harbor}": { "get": { "tags": [ "Balance Report" ], "operationId": "get_report_balancereport_balance_list", "parameters": [ { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/report/balance/view/{balance}": { "get": { "tags": [ "Balance Report" ], "operationId": "get_report_balancereport_balance_view", "parameters": [ { "name": "balance", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/report/balance/harbor/{harbor}": { "get": { "tags": [ "Balance Report" ], "summary": "Return active balance period data", "operationId": "get_report_balancereport_balance_balance", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/report/balance/harbor/{harbor}/create": { "post": { "tags": [ "Balance Report" ], "summary": "Create new balance record. Used when there are no previous balance records", "operationId": "post_report_balancereport_balance_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/report/balance/harbor/{harbor}/update-details/{balanceDetails}": { "put": { "tags": [ "Balance Report" ], "summary": "Edit balance details data", "operationId": "put_report_balancereport_balance_update", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "balanceDetails", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/report/balance/harbor/{harbor}/book/{balance}": { "patch": { "tags": [ "Balance Report" ], "summary": "Close current balance period and open new", "operationId": "patch_report_balancereport_balance_book", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "balance", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-manager/change-pin/{cardholder}": { "patch": { "tags": [ "Access Manager" ], "operationId": "patch_access_manager_change_pin", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an access manager cardholder entity whose PIN code was changed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessManagerCardholder" } } } } } } }, "/access-manager/remind-pin/{cardholder}": { "get": { "tags": [ "Access Manager" ], "operationId": "get_access_manager_remind_pin", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns true if it was success, false if not.", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" } }, "type": "object" } } } } } } }, "/sailor/access-manager/get-pin/{harbor}": { "get": { "tags": [ "Sailor Access Manager" ], "operationId": "get_sailor_access_manager_get-pin", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return user pin code", "content": { "application/json": { "schema": { "properties": { "pin": { "description": "Numeric pin code", "type": "string" } }, "type": "object" } } } }, "404": { "description": "Cardholder in this harbor doesn't exists." } } } }, "/sailor/access-manager/cardholders-info/{harbor}": { "get": { "tags": [ "Sailor Access Manager" ], "operationId": "get_sailor_access_manager_cardholders_info", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns both, power and ACT, cardholders and their respective info.", "content": { "application/json": { "schema": { "properties": { "accessControlCardholder": { "$ref": "#/components/schemas/Cardholder3" }, "powerCardholder": { "$ref": "#/components/schemas/Cardholder4" } }, "type": "object" } } } } } } }, "/kiosk/paper/report/{harbor}": { "get": { "tags": [ "HarbaKioskPaper" ], "operationId": "get_kiosk_paperharbakiosk_harbakioskpaper_getreportlowpaper", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/kiosk/setting/{harbor}": { "get": { "tags": [ "HarbaKiosk" ], "operationId": "get_kiosk_settingsharbakiosk_harbakiosksetting_getsettings", "parameters": [ { "name": "subtract", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/kiosk/edit-setting": { "put": { "tags": [ "HarbaKiosk" ], "operationId": "put_kiosk_settingsharbakiosk_harbakiosksetting_putsettings", "responses": { "200": { "description": "Success" } } } }, "/kiosk/status/report/{harbor}": { "patch": { "tags": [ "HarbaKioskStatus" ], "operationId": "patch_kiosk_paperharbakiosk_harbakioskstatus_sendkioskstatusupdate", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/kiosk/status/ping/{harbor}": { "patch": { "tags": [ "HarbaKioskStatus" ], "operationId": "patch_kiosk_paperharbakiosk_harbakioskstatus_sendkioskping", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/payouts": { "get": { "tags": [ "Payout" ], "operationId": "get_payouts_all", "responses": { "200": { "description": "Success" } } } }, "/payouts/{payout}/payments": { "get": { "tags": [ "Payout" ], "operationId": "get_payouts_payments", "parameters": [ { "name": "payout", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/payouts/{payout}/xls": { "get": { "tags": [ "Payout" ], "operationId": "get_payouts_xls", "parameters": [ { "name": "payout", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/payouts/{payout}/email": { "get": { "tags": [ "Payout" ], "operationId": "get_payouts_send_email", "parameters": [ { "name": "payout", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/payouts/{payout}": { "delete": { "tags": [ "Payout" ], "operationId": "delete_payouts_delete", "parameters": [ { "name": "payout", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } }, "patch": { "tags": [ "Payout" ], "operationId": "patch_payouts_mark_as_paid", "parameters": [ { "name": "payout", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/payouts/unpaid/{payout}": { "patch": { "tags": [ "Payout" ], "operationId": "patch_payouts_mark_as_unpaid", "parameters": [ { "name": "payout", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/payouts/history": { "get": { "tags": [ "Payout" ], "operationId": "get_payouts_history", "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholders/list/{harbor}": { "get": { "tags": [ "Access Control Cardholders" ], "operationId": "get_access_control_cardholderaccesscontrol_cardholder_getcardholders", "parameters": [ { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "expired|active" } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "guest|customer" } }, { "name": "doorGroup", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholders/view/{cardholder}": { "get": { "tags": [ "Access Control Cardholders" ], "operationId": "get_access_control_cardholderaccesscontrol_cardholder_getcardholder", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholders/edit-cardholder-groups/{harbor}/{user}": { "put": { "tags": [ "Access Control Cardholders" ], "operationId": "put_access_control_cardholderedit_cardholder_groups", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholders/edit/{cardholder}": { "put": { "tags": [ "Access Control Cardholders" ], "summary": "Primarily used for guest (not registered) cardholders.", "operationId": "put_access_control_cardholderedit_cardholder", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholders/view/{site}/{user}": { "get": { "tags": [ "Access Control Cardholders" ], "operationId": "get_access_control_cardholderaccesscontrol_cardholder_getcardholderbyuserandsite", "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholders/count-by-door-group/{doorGroup}": { "get": { "tags": [ "Access Control Cardholders" ], "operationId": "get_access_control_cardholderaccesscontrol_cardholder_getcardholdercountbydoorgroup", "parameters": [ { "name": "doorGroup", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholders/search/{harbor}": { "get": { "tags": [ "Access Control Cardholders" ], "operationId": "get_access_control_cardholderaccesscontrol_cardholder_searchcardholder", "parameters": [ { "name": "email", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "phone", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholder-groups/list/{site}": { "get": { "tags": [ "Access Control Cardholder Groups" ], "operationId": "get_access_control_cardholder_groups_list", "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholder-groups/list-by-door-group/{doorGroup}": { "get": { "tags": [ "Access Control Cardholder Groups" ], "operationId": "get_access_control_cardholder_groups_list_by_door_group", "parameters": [ { "name": "doorGroup", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/cardholder-groups/list/{site}/{user}": { "get": { "tags": [ "Access Control Cardholder Groups" ], "operationId": "get_access_control_cardholder_groups_user_groups_list", "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/doors/list/{harbor}": { "get": { "tags": [ "Access Control Doors" ], "operationId": "get_access_control_door_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/doors/view/{door}": { "get": { "tags": [ "Access Control Doors" ], "operationId": "get_access_control_door_view", "parameters": [ { "name": "door", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/doors/list-by-cardholder-group/{cardholderGroup}": { "get": { "tags": [ "Access Control Doors" ], "operationId": "get_access_control_door_list_by_cardholder_group", "parameters": [ { "name": "cardholderGroup", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/doors/edit/{door}": { "put": { "tags": [ "Access Control Doors" ], "operationId": "put_access_control_door_edit", "parameters": [ { "name": "door", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/door-groups/list/{site}": { "get": { "tags": [ "Access Control Door Groups" ], "operationId": "get_access_control_door_groups_list", "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/door-groups/view/{doorGroup}": { "get": { "tags": [ "Access Control Door Groups" ], "operationId": "get_access_control_door_groups_accesscontrol_doorgroup_getdoorgroup", "parameters": [ { "name": "doorGroup", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/door-groups/create/{harbor}": { "post": { "tags": [ "Access Control Door Groups" ], "operationId": "post_access_control_door_groups_accesscontrol_doorgroup_postdoorgroup", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/door-groups/edit/{doorGroup}": { "put": { "tags": [ "Access Control Door Groups" ], "operationId": "put_access_control_door_groups_accesscontrol_doorgroup_putdoorgroup", "parameters": [ { "name": "doorGroup", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/door-groups/delete/{doorGroup}/{cardholderGroup}": { "delete": { "tags": [ "Access Control Door Groups" ], "operationId": "delete_access_control_door_groups_accesscontrol_doorgroup_deletedoorgroup", "parameters": [ { "name": "doorGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardholderGroup", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/reports/list": { "get": { "tags": [ "Access control reports" ], "operationId": "get_access_control_reportsaccesscontrol_report_getlogs", "parameters": [ { "name": "q", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "endDate", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "startDate", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/reports/{cardholder}": { "get": { "tags": [ "Access control reports" ], "operationId": "get_access_control_reportsaccesscontrol_report_viewlogsbycardholder", "parameters": [ { "name": "cardholder", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor-public/access-control/prices/{harbor}": { "get": { "tags": [ "Access Control Public" ], "operationId": "get_sailor_public_act_accesscontrol_sailor_sailorpublicaccess_getcardholdergroupprices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor-public/access-control/cardholder/{orderId}": { "get": { "tags": [ "Access Control Public" ], "operationId": "get_sailor_public_act_accesscontrol_sailor_sailorpublicaccess_getcardholderpassword", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/settings/{harbor}": { "get": { "tags": [ "Access Control" ], "operationId": "get_access_control_settings_accesscontrol_setting_getsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Access Control" ], "operationId": "put_access_control_settings_accesscontrol_setting_putsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Access Control" ], "operationId": "post_access_control_settings_accesscontrol_setting_postsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/settings/test-settings/{harbor}": { "post": { "tags": [ "Access Control" ], "operationId": "post_access_control_settings_accesscontrol_setting_posttestsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/settings/synchronize/{harbor}": { "patch": { "tags": [ "Access Control" ], "operationId": "patch_access_control_settings_accesscontrol_setting_synchronize", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/access-control/webhook": { "post": { "tags": [ "Access Control" ], "operationId": "post_access_control_webhook_post", "responses": { "200": { "description": "Success" } } } }, "/reservation/settings/crane-day/{harbor}": { "get": { "tags": [ "Crane reservation time settings" ], "operationId": "get_reservation_settings_crane_day_get", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneDaySetting" } } } } } }, "post": { "tags": [ "Crane reservation time settings" ], "operationId": "post_reservation_settings_crane_day_post", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneDaySetting" } } } } } } }, "/reservation/settings/crane-day/{harbor}/day/{setting}": { "put": { "tags": [ "Crane reservation time settings" ], "operationId": "put_reservation_settings_crane_day_put", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "setting", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneDaySetting" } } } } } }, "delete": { "tags": [ "Crane reservation time settings" ], "operationId": "delete_reservation_settings_crane_day_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "setting", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneDaySetting" } } } } } } }, "/reservation/settings/{harbor}": { "get": { "tags": [ "Crane settings" ], "operationId": "get_crane_setting_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Crane settings" ], "operationId": "put_crane_setting_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation/settings/crane-time/{harbor}": { "get": { "tags": [ "Crane reservation time settings" ], "operationId": "get_reservation_settings_crane_time_get", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneTimeSetting" } } } } } }, "post": { "tags": [ "Crane reservation time settings" ], "operationId": "post_reservation_settings_crane_time_post", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneTimeSetting" } } } } } } }, "/reservation/settings/crane-time/{harbor}/time/{setting}": { "put": { "tags": [ "Crane reservation time settings" ], "operationId": "put_reservation_settings_crane_time_put", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "setting", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneTimeSetting" } } } } } }, "delete": { "tags": [ "Crane reservation time settings" ], "operationId": "delete_reservation_settings_crane_time_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "setting", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CraneTimeSetting" } } } } } } }, "/reservation/reservations": { "get": { "summary": "Get a list of reservations for provided time period. Defaults to today + 7 days", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "excludeStatus", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "to", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "from", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "default": { "description": "" } } } }, "/reservation/reservations/public": { "get": { "summary": "Get public reservations. This endpoint is used to disable unavailable dates in the calendar", "parameters": [ { "name": "to", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "from", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "type", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "default": { "description": "" } }, "deprecated": true } }, "/reservation/reservations/{reservation}": { "get": { "summary": "Get a single reservation", "parameters": [ { "name": "reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/reservation/print/reservations": { "get": { "parameters": [ { "name": "selectedIds", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "q", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "default": { "description": "" } } } }, "/reservation/reservations/check": { "post": { "summary": "Check whether reservation can be made for a particular time slot", "responses": { "default": { "description": "" } } } }, "/reservation/reservations/my": { "post": { "summary": "Create a reservation as a user", "responses": { "default": { "description": "" } } } }, "/reservation/reservations/{id}/dates": { "patch": { "summary": "Change reservation dates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/reservation/reservations/{id}/comment": { "patch": { "operationId": "patch_reservation_edit_comment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ReservationController", "description": "New harbor comment", "required": true, "content": { "application/json": { "schema": { "properties": { "harborComment": { "type": "string", "example": "Client would like a crane" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/reservation/reservations/{id}/uplift-period": { "patch": { "operationId": "patch_reservation_edit_uplift_period", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ReservationController", "description": "Edit uplift period", "required": true, "content": { "application/json": { "schema": { "properties": { "upliftPeriod": { "type": "string", "example": "Client would like a crane" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/reservation/harbor/{harbor}/client/{user}/checkfreecrane": { "get": { "summary": "Check if free crane reservations are available", "operationId": "get_reservation_is_crane_free", "parameters": [ { "name": "from", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation/{reservation}/done": { "post": { "parameters": [ { "name": "reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/reservation/{reservation}/check-boat-status": { "get": { "summary": "Check possible boat location after reservation is done", "parameters": [ { "name": "reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/reservation/{reservation}/not_arrived": { "post": { "summary": "Mark reservation as not arrived", "parameters": [ { "name": "reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/reservation/{reservation}/approve": { "patch": { "summary": "Mark reservation as approved", "parameters": [ { "name": "reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/reservation/{harbor}/ids": { "get": { "parameters": [ { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/reservation/{harbor}/approve-multiple": { "patch": { "operationId": "patch_reservation_approve_multiple", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/reservation/{reservation}/reject": { "patch": { "operationId": "patch_reservation_reject", "parameters": [ { "name": "reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation/{reservation}/cancel": { "patch": { "operationId": "patch_reservation_cancel", "parameters": [ { "name": "reservation", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation/latest_reservation/{harbor}/{boat}": { "post": { "operationId": "post_reservation_latest_reservation", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ReservationController", "description": "Date until which to get reservations.", "required": true, "content": { "application/json": { "schema": { "properties": { "dateUntil": { "type": "string", "example": "2022-03-06T16:25:20" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/reservation/latest-reservation/{harbor}/{boat}": { "post": { "operationId": "post_reservation_latest-reservation", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ReservationController", "description": "Date until which to get reservations.", "required": true, "content": { "application/json": { "schema": { "properties": { "dateUntil": { "type": "string", "example": "2022-03-06T16:25:20" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/reservation/non-working-times/{harbor}": { "get": { "summary": "Returns times that are opposite of getAvailableWorkingTimes (times that are outside of working hours)", "operationId": "get_reservation_non_working_times", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation/{harbor}/available-times": { "get": { "operationId": "get_reservation_available_times", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation_price/list/{harbor}/visible": { "get": { "tags": [ "Prices for reservation" ], "operationId": "get_reservation_price_list", "parameters": [ { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation_price/add/{harbor}": { "post": { "tags": [ "Prices for reservation" ], "operationId": "post_reservation_price_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "type" ], "properties": { "type": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "201": { "description": "Success" } } } }, "/reservation_price/edit/{reservationPrice}": { "put": { "tags": [ "Prices for reservation" ], "operationId": "put_reservation_price_edit", "parameters": [ { "name": "reservationPrice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/reservation_price/delete/{reservationPrice}": { "delete": { "tags": [ "Prices for reservation" ], "operationId": "delete_reservation_price_delete", "parameters": [ { "name": "reservationPrice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/sailor/crane/list": { "get": { "tags": [ "Sailor Crane" ], "operationId": "get_sailor_crane_list", "responses": { "200": { "description": "Returns an array of user crane reservations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCraneListProvider" } } } } } } }, "/sailor/crane/view/{crane}": { "get": { "tags": [ "Sailor Crane" ], "operationId": "get_sailor_crane_view", "parameters": [ { "name": "crane", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns crane reservation data.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCraneDTO" } } } } } } }, "/sailor/crane/{harbor}/{boat}/dock-and-slip-preselect": { "get": { "tags": [ "Sailor Crane" ], "operationId": "get_sailor_crane_dock_and_slip_preselect", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No dock or slip returned." }, "200": { "description": "Dock and slip returned.", "content": { "application/json": { "schema": { "properties": { "dock": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "slip": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "type": "object" } } } } } } }, "/sailor/crane/settings/{harbor}": { "get": { "tags": [ "Sailor Crane" ], "operationId": "get_sailor_crane_setting_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns crane settings for harbor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorCraneSettingDTO" } } } } } } }, "/sailor/crane-time/{harbor}/available-times": { "get": { "tags": [ "Sailor Crane" ], "operationId": "get_sailor_crane_time_available-times", "parameters": [ { "name": "date", "in": "query", "description": "Date for which the times should be returned", "required": true }, { "name": "direction", "in": "query", "description": "Boat is going up or down", "required": true }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns an array of available times for selected date and direction.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorCraneAvailableTimeDTO" } } } } } } } }, "/reservation/settings": { "get": { "summary": "Get all settings for this bundle. If settings are not set, defaults will be returned", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "default": { "description": "" } } }, "patch": { "summary": "Update bundle settings. Settings are sent as key value pairs. Only sent settings are updated", "parameters": [ { "name": "harbor", "in": "query", "description": "", "required": true, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "default": { "description": "" } } } }, "/opus/export/{harbor}/invoice/{invoice}": { "patch": { "tags": [ "Opus integration" ], "operationId": "patch_opus_exportinvoice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/opus/export/{harbor}/get-invoice-status/{invoice}": { "get": { "tags": [ "Opus integration" ], "operationId": "get_opus_exportget_invoice_status", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/opus/export/{harbor}/invoices": { "patch": { "tags": [ "Opus integration" ], "operationId": "patch_opus_exportaccounting_integration_opus_opus_exportinvoices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/opus/export/{harbor}/get-invoices-status": { "get": { "tags": [ "Opus integration" ], "operationId": "get_opus_exportaccounting_integration_opus_opus_getinvoicesstatus", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/opus/export/{harbor}/invoices-by-module": { "patch": { "tags": [ "Opus integration" ], "summary": "Export bulk invoices data", "operationId": "patch_opus_exportaccounting_integration_opus_opus_exportinvoicesbymodule", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/opus/settings/{harbor}": { "get": { "tags": [ "Accounting opus settings" ], "operationId": "get_accounting_opus_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpusSetting" } } } } } }, "put": { "tags": [ "Accounting opus settings" ], "operationId": "put_accounting_opus_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpusSetting" } } } } } }, "post": { "tags": [ "Accounting opus settings" ], "operationId": "post_accounting_opus_settings_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpusSetting" } } } } } } }, "/accounting/prisme365/export/{harbor}/bulk/invoices": { "get": { "tags": [ "Prisme365 export" ], "operationId": "get_bulk_invoices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "G19 formatted bulk file download" }, "400": { "description": "Something went wrong" } } } }, "/accounting/prisme365/settings/{harbor}": { "get": { "tags": [ "Accounting Prisme365" ], "operationId": "get_prisme365_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Prisme365SettingDTO" } } } } } }, "put": { "tags": [ "Accounting Prisme365" ], "operationId": "put_prisme365_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Prisme365SettingDTO" } } } } } } }, "/accounting/business-central/callback": { "get": { "tags": [ "Accounting Business Central" ], "operationId": "get_bc_callback_callback", "responses": { "200": { "description": "Success" } } } }, "/accounting/business-central/connect/{harbor}": { "get": { "tags": [ "Accounting Business Central" ], "operationId": "get_bc_connect_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "url": { "$ref": "string" } }, "type": "object" } } } } } } }, "/accounting/business-central/export/{harbor}/invoice/{invoice}": { "post": { "tags": [ "Business Central export" ], "operationId": "post_invoice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Something went wrong" } } } }, "/accounting/business-central/export/{harbor}/invoice/{invoice}/state": { "get": { "tags": [ "Business Central export" ], "operationId": "get_invoice_state", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/business-central/settings/{harbor}": { "get": { "tags": [ "Accounting Business Central" ], "operationId": "get_bc_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessCentralSettingDTO" } } } } } }, "put": { "tags": [ "Accounting Business Central" ], "operationId": "put_bc_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessCentralSettingDTO" } } } } } } }, "/betalings/export/invoice/{invoice}": { "get": { "tags": [ "BetalingsService export" ], "summary": "Export single invoice data", "operationId": "get_betalings_export_accounting_integration_betalingsservice_export_exportinvoice", "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/betalings/export/bulk/invoices/{harbor}": { "get": { "tags": [ "BetalingsService export" ], "summary": "Export bulk payments data", "operationId": "get_betalings_export_accounting_integration_betalingsservice_export_exportbulkinvoices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/betalings/import/{harbor}": { "post": { "tags": [ "BetalingsService import" ], "summary": "Import payment data from BetalingsService", "operationId": "post_betalings_import_payments", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/betalings/settings/{harbor}": { "get": { "tags": [ "BetalingsService export" ], "summary": "Get BetalingsService settings if they exist", "operationId": "get_betalings_settings_get", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetalingsServiceSetting" } } } } } }, "post": { "tags": [ "BetalingsService export" ], "summary": "Save BetalingsService settings", "operationId": "post_betalings_settings_post", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetalingsServiceSetting" } } } } } }, "delete": { "tags": [ "BetalingsService export" ], "summary": "Delete BetalingsService settings", "operationId": "delete_betalings_settings_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BetalingsServiceSetting" } } } } } } }, "/accounting/viva-wallet/settings/{harbor}/connect": { "get": { "tags": [ "Viva Wallet Integration" ], "operationId": "get_viva_wallet_settings_connect", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/viva-wallet/settings/{harbor}": { "get": { "tags": [ "Viva Wallet Integration" ], "operationId": "get_viva_wallet_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/viva-wallet/webhook": { "get": { "tags": [ "Viva Wallet Integration" ], "operationId": "get_viva_wallet_webhook_webhook", "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Viva Wallet Integration" ], "operationId": "post_viva_wallet_webhook_webhook", "responses": { "200": { "description": "Success" } } } }, "/sailor/stripe/checkout/settings/{harbor}": { "get": { "tags": [ "Sailor stripe checkout" ], "operationId": "get_sailor_stripe_checkout_settings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return public key for checkout by harbor country", "content": { "application/json": { "schema": { "properties": { "publicKey": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Unable to find stripe settings for harbor", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message", "type": "string" } }, "type": "object" } } } } } } }, "/sailor/stripe/payment-method/list": { "get": { "tags": [ "Sailor stripe payment method" ], "operationId": "get_sailor_stripe_payment_method_list", "responses": { "200": { "description": "Returns payment method list for current user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorStripePaymentMethodListProvider" } } } } } } }, "/sailor/stripe/payment-method/delete/{paymentMethod}": { "delete": { "tags": [ "Sailor stripe payment method" ], "operationId": "delete_sailor_stripe_payment_method_delete", "parameters": [ { "name": "paymentMethod", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns payment method list for current user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorStripePaymentMethodListProvider" } } } } } } }, "/sailor-public/stripe/checkout/settings/{harbor}": { "get": { "tags": [ "Sailor stripe checkout" ], "operationId": "get_sailor_public_stripe_checkout_settings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return public key for checkout by harbor country", "content": { "application/json": { "schema": { "properties": { "publicKey": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Unable to find stripe settings for harbor", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error message", "type": "string" } }, "type": "object" } } } } } } }, "/sailor-public/stripe/checkout/stripe/{orderNumber}": { "post": { "tags": [ "Sailor stripe checkout" ], "operationId": "post_sailor_public_stripe_checkout_create", "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "StripeSailorPublicCheckoutController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingCheckoutForm" } } } }, "responses": { "200": { "description": "Return payment intent information", "content": { "application/json": { "schema": { "properties": { "state": { "description": "Payment intent status", "type": "string" }, "amountString": { "description": "Payment amount", "type": "string" }, "clientSecret": { "description": "Client secret", "type": "string" } }, "type": "object" } } } } } } }, "/checkout/stripe/{orderNumber}": { "post": { "tags": [ "Accounting checkout" ], "operationId": "post_accounting_checkout_create", "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "StripeCheckoutController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingCheckoutForm" } } } }, "responses": { "200": { "description": "Return payment intent information", "content": { "application/json": { "schema": { "properties": { "state": { "description": "Payment intent status", "type": "string" }, "amountString": { "description": "Payment amount", "type": "string" }, "clientSecret": { "description": "Client secret", "type": "string" } }, "type": "object" } } } } } } }, "/checkout/stripe/credit-card/{orderNumber}/{order}": { "get": { "tags": [ "Accounting checkout" ], "operationId": "get_accounting_checkout_stripe_card", "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/checkout/success/{orderNumber}/{paymentToken}": { "get": { "tags": [ "Accounting checkout" ], "operationId": "get_accounting_checkout_success", "parameters": [ { "name": "orderNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "paymentToken", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/stripe/setup/confirm": { "get": { "tags": [ "Accounting stripe connect" ], "operationId": "get_accounting_stripe_confirm_setup_confirm", "responses": { "200": { "description": "Success" } } } }, "/accounting/stripe/setup/generate-link/{harbor}": { "get": { "tags": [ "Accounting stripe connect" ], "operationId": "get_accounting_stripe_confirm_setup_generate_link", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/stripe/setup/check-status/{harbor}": { "get": { "tags": [ "Accounting stripe connect" ], "operationId": "get_accounting_stripe_confirm_setup_check_status", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/stripe/country-default-fee/list": { "get": { "tags": [ "Accounting stripe default fees" ], "operationId": "get_accounting_country_default_fee_list", "responses": { "200": { "description": "Return list of default stripe fees", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountingStripeCountryDefaultFee" } } } } } } } }, "/accounting/stripe/country-default-fee/view-by-country/{country}": { "get": { "tags": [ "Accounting stripe default fees" ], "operationId": "get_accounting_country_default_fee_view_by_country", "parameters": [ { "name": "country", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return default fees by country", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingStripeCountryDefaultFee" } } } } } } }, "/accounting/stripe/country-default-fee/edit/{defaultFee}": { "put": { "tags": [ "Accounting stripe default fees" ], "operationId": "put_accounting_country_default_fee_edit", "parameters": [ { "name": "defaultFee", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "StripeCountryDefaultFeeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingStripeCountryDefaultFeeForm" } } } }, "responses": { "200": { "description": "Return updated object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingStripeCountryDefaultFee" } } } } } } }, "/accounting/stripe/country-default-fee/create": { "post": { "tags": [ "Accounting stripe default fees" ], "operationId": "post_accounting_country_default_fee_create", "requestBody": { "request": "StripeCountryDefaultFeeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingStripeCountryDefaultFeeForm" } } } }, "responses": { "200": { "description": "Return created object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingStripeCountryDefaultFee" } } } } } } }, "/accounting/stripe/webhook": { "post": { "tags": [ "Accounting webhooks" ], "operationId": "post_accounting_callback_stripe", "responses": { "200": { "description": "Success" } } } }, "/accounting/stripe/webhook/connect": { "post": { "tags": [ "Accounting webhooks" ], "operationId": "post_accounting_callback_stripe_connect", "responses": { "200": { "description": "Success" } } } }, "/accounting/stripe/webhook/ach": { "post": { "tags": [ "Accounting webhooks" ], "operationId": "post_accounting_callback_stripe_ach", "responses": { "200": { "description": "Success" } } } }, "/accounting/stripe/webhook/payout": { "post": { "tags": [ "Accounting webhooks" ], "operationId": "post_accounting_callback_stripe_payout", "responses": { "200": { "description": "Success" } } } }, "/accounting/export/{harbor}/get-invoice-status/{invoice}": { "get": { "tags": [ "Accounting product account number" ], "operationId": "get_accounting_export_get_invoice_status", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceExportStatusDTO" } } } } } } }, "/accounting/product-account-number/{harbor}/view/{productAccountNumber}": { "get": { "tags": [ "Accounting product account number" ], "operationId": "get_accounting_product_account_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productAccountNumber", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingProductAccountNumber" } } } } } } }, "/accounting/product-account-number/{harbor}/view-by-product-id/{product}": { "get": { "tags": [ "Accounting product account number" ], "operationId": "get_accounting_product_account_view_by_product_id", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingProductAccountNumber" } } } } } } }, "/accounting/product-account-number/{harbor}/edit-by-product-id/{product}": { "post": { "tags": [ "Accounting product account number" ], "operationId": "post_accounting_product_account_edit_by_product_id", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingProductAccountNumber" } } } } } } }, "/accounting/settings/{harbor}": { "get": { "tags": [ "Accounting settings" ], "operationId": "get_accounting_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingSetting" } } } } } }, "put": { "tags": [ "Accounting settings" ], "operationId": "put_accounting_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountingSetting" } } } } } } }, "/general-account-number/settings/{harbor}/view": { "get": { "tags": [ "General account number settings" ], "operationId": "get_general_account_number_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralAccountNumberSetting" } } } } } } }, "/general-account-number/settings/{harbor}/edit": { "post": { "tags": [ "General account number settings" ], "operationId": "post_general_account_number_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/visma-economic/{harbor}/export/invoice/{invoice}": { "post": { "tags": [ "Visma economic export" ], "operationId": "post_visma_economic_export_invoice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Something went wrong" } } } }, "/visma-economic/{harbor}/export/payment/{payment}": { "post": { "tags": [ "Visma economic export" ], "operationId": "post_visma_economic_export_payment", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "payment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" }, "400": { "description": "Something went wrong" } } } }, "/visma-economic/{harbor}/entry/payments": { "post": { "tags": [ "Visma economic entry" ], "operationId": "post_visma_economic_entry_payments", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "VismaEconomicEntryController", "required": true, "content": { "application/json": { "schema": { "properties": { "paymentIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/visma-economic/{harbor}/entry/invoices": { "post": { "tags": [ "Visma economic entry" ], "operationId": "post_visma_economic_entry_invoices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "VismaEconomicEntryController", "required": true, "content": { "application/json": { "schema": { "properties": { "invoiceIds": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/visma-economic/{harbor}/entry/invoice/{invoice}": { "get": { "tags": [ "Visma economic entry" ], "operationId": "get_visma_economic_entry_invoice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/visma-economic/settings/{harbor}/view": { "get": { "tags": [ "Visma Economic Integration" ], "operationId": "get_visma_economic_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VismaEconomicSetting" } } } } } } }, "/visma-economic/settings/{harbor}/edit": { "post": { "tags": [ "Visma Economic Integration" ], "operationId": "post_visma_economic_settings_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad request" }, "204": { "description": "E-conomic settings have been saved" } } } }, "/visma-economic/settings/{harbor}/list-accounts": { "get": { "tags": [ "Visma Economic Integration" ], "operationId": "get_visma_economic_settings_list_accounts", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad request" }, "200": { "description": "Success" } } } }, "/visma-economic/settings/{harbor}/validate": { "get": { "tags": [ "Visma Economic Integration" ], "summary": "Validate that Visma e-conomic settings are correct and are not throwing any errors", "operationId": "get_visma_economic_settings_validate", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Some settings are invalid. Details in the body" }, "200": { "description": "All settings are valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfModel" } } } } } } }, "/invoice/{harbor}/list": { "get": { "tags": [ "Invoice" ], "operationId": "get_invoice_list", "parameters": [ { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sentStatus", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "module", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "transferType", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harborClientId", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice3" } } } } } } }, "/invoice/{harbor}/customer-invoice-status/{harborClient}": { "get": { "tags": [ "Invoice" ], "operationId": "get_invoice_customer_invoice_status", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborClient", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/invoice/{harbor}/list/ids": { "get": { "tags": [ "Invoice" ], "operationId": "get_invoice_list_ids", "parameters": [ { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "order", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "status", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "sentStatus", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "module", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "transferType", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice3" } } } } } } }, "/invoice/{harbor}/view/{invoice}": { "get": { "tags": [ "Invoice" ], "operationId": "get_invoice_accounting_invoice_invoice_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice4" } } } } } } }, "/invoice/{harbor}/create": { "post": { "tags": [ "Invoice" ], "operationId": "post_invoice_accounting_invoice_invoice_create", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "InvoiceController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice5" } } } } } } }, "/invoice/{harbor}/add-payment": { "patch": { "tags": [ "Invoice" ], "operationId": "patch_invoice_accounting_invoice_invoice_addpayment", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "InvoiceController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceForm" } } } }, "responses": { "200": { "description": "Success" } } } }, "/invoice/{harbor}/create-credit-note/{invoice}": { "post": { "tags": [ "Invoice" ], "operationId": "post_invoice_accounting_invoice_invoice_createcreditnote", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "InvoiceController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceForm" } } } }, "responses": { "204": { "description": "Success" } } } }, "/invoice/{harbor}/list/for_messages": { "post": { "tags": [ "Invoice" ], "operationId": "post_invoice_list_for_messages", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "invoiceIds" ], "properties": { "invoiceIds": { "type": "array", "items": {}, "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "users": { "type": "array", "items": { "type": "string" } }, "harborClients": { "type": "array", "items": { "$ref": "#/components/schemas/HarborClient" } } }, "type": "object" } } } } } } }, "/invoice/{harbor}/export_xls": { "get": { "tags": [ "Invoice" ], "operationId": "get_invoice_export_xls", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/invoice-email/{harbor}/send-multiple-invoices/preview": { "post": { "tags": [ "Invoice email" ], "operationId": "post_invoice_email_accounting_invoice_invoiceemail_sendmultipleinvoicespreview", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "invoiceIds" ], "properties": { "invoiceIds": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/invoice-email/{harbor}/send-multiple-invoices": { "post": { "tags": [ "Invoice email" ], "operationId": "post_invoice_email_accounting_invoice_invoiceemail_sendmultipleinvoices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "InvoiceEmailController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendInvoicesForm" } } } }, "responses": { "204": { "description": "Success" } } } }, "/invoice-email/{harbor}/send-invoice/{invoice}": { "post": { "tags": [ "Invoice email" ], "operationId": "post_invoice_email_send_invoice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "harborMessage": { "type": "string", "default": null } }, "type": "object" } } } }, "responses": { "204": { "description": "Success" } } } }, "/sailor/invoice/list": { "get": { "tags": [ "Sailor invoice" ], "summary": "Current user invoice list", "operationId": "get_sailor_invoice_list", "parameters": [ { "name": "year", "in": "query", "description": "Fetch invoices for given year.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Fetch paid or unpaid invoices.", "schema": { "type": "string" } }, { "name": "harbor", "in": "query", "description": "Fetch invoices by harbor.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return current user invoice list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvoiceListProvider" } } } } } } }, "/sailor/invoice/view/{invoice}": { "get": { "tags": [ "Sailor invoice" ], "summary": "Invoice details", "operationId": "get_sailor_invoice_view", "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return invoice details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice6" } } } } } } }, "/invoice_batch/{harbor}": { "get": { "tags": [ "Invoice batch" ], "operationId": "get_invoice_batch_harbor_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceBatch" } } } } } } }, "/accounting/payment/{harbor}/list": { "get": { "tags": [ "Accounting Payments" ], "operationId": "get_accounting_paymentaccounting_payment_payment_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/payment/{harbor}/list/invoice/{invoice}": { "get": { "tags": [ "Accounting Payments" ], "summary": "v2 accounting", "operationId": "get_accounting_paymentaccounting_payment_payment_listinvoicepayments", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoice", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/payment/{harbor}/list/ids": { "get": { "tags": [ "Accounting Payments" ], "operationId": "get_accounting_paymentlist_ids", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/accounting/payment/{harbor}/delete/{payment}": { "delete": { "tags": [ "Accounting Payments" ], "operationId": "delete_accounting_paymentaccounting_payment_payment_deletepayment", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "payment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/accounting/payment/{harbor}/export": { "post": { "tags": [ "Accounting Payments" ], "summary": "Get an Excel file of selected payments.", "operationId": "post_accounting_paymentexport", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/payments/import/fi_code": { "post": { "responses": { "default": { "description": "" } } } }, "/admin/report/harbor-activity": { "get": { "tags": [ "Admin harbor report" ], "operationId": "get_harbor_admin_adminharborreport_harboractivityreport", "parameters": [ { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/harbor/{harbor}/slip/occupancy": { "get": { "tags": [ "Harbor bridge positions" ], "summary": "Returns bridge positions for harbor with status", "operationId": "get_harbor_bridge_positionharbor_admin_adminslipoccupancy_listoccupancy", "parameters": [ { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "subscription|booking" } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minWidth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minLength", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minDepth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxWidth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxLength", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxDepth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "hideGuestData", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/bridge/list": { "get": { "tags": [ "Harbor bridges" ], "operationId": "get_harbor_bridge_harbor_harborbridge_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborBridge" } } } } } } }, "/harbor/{harbor}/bridge/list/visible": { "get": { "tags": [ "Harbor bridges" ], "operationId": "get_harbor_bridge_harbor_harborbridge_listvisible", "parameters": [ { "name": "exclude", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborBridge2" } } } } } } }, "/harbor/{harbor}/bridge/{harborBridge}": { "get": { "tags": [ "Harbor bridges" ], "operationId": "get_harbor_bridge_harbor_harborbridge_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborBridge", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborBridge3" } } } } } }, "put": { "tags": [ "Harbor bridges" ], "operationId": "put_harbor_bridge_harbor_harborbridge_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborBridge", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborBridgeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborBridgeForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborBridge3" } } } } } }, "delete": { "tags": [ "Harbor bridges" ], "operationId": "delete_harbor_bridge_harbor_harborbridge_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "harborBridge", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbor/{harbor}/bridge": { "post": { "tags": [ "Harbor bridges" ], "operationId": "post_harbor_bridge_harbor_harborbridge_add", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborBridgeController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborBridgeForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborBridge3" } } } } } } }, "/harbor/{harbor}/bridge_position/occupancy": { "get": { "tags": [ "Harbor bridge positions" ], "summary": "Returns bridge positions for harbor with status", "operationId": "get_harbor_bridge_positionharbor_harborbridgeposition_listoccupancy", "parameters": [ { "name": "type", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "subscription|booking" } }, { "name": "dateFrom", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minWidth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minLength", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minDepth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxWidth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxLength", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxDepth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "deprecated": true } }, "/harbor/{harbor}/bridge_position/list": { "get": { "tags": [ "Harbor bridge positions" ], "summary": "Returns bridge positions for harbor", "operationId": "get_harbor_bridge_positionharbor_harborbridgeposition_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/bridge/{bridge}/position/{position}/coordinates": { "patch": { "tags": [ "Harbor bridge positions" ], "operationId": "patch_harbor_bridge_positionharbor_harborbridgeposition_editcoordinates", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborBridgePositionController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborPositionCoordinatesType" } } } }, "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/berth_count": { "get": { "tags": [ "Harbor bridge positions" ], "summary": "Retrieves berth (not deleted) count of a harbor", "operationId": "get_harbor_bridge_positionharbor_harborbridgeposition_getharborberthcount", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/contract_setting/{harbor}": { "get": { "tags": [ "Harbor contract setting" ], "operationId": "get_harbor_harborcontractsetting_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborContractSetting" } } } } } }, "put": { "tags": [ "Harbor contract setting" ], "operationId": "put_harbor_harborcontractsetting_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborContractSettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborContractSettingForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborContractSetting" } } } } } } }, "/harbor/contract_setting/{harbor}/upload-attachment": { "post": { "tags": [ "Harbor contract setting" ], "operationId": "post_harbor_harborcontractsetting_uploadattachment", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "HarborContractSettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborContractAttachmentForm" } } } }, "responses": { "204": { "description": "Success" } } } }, "/harbor/contract_setting/{harbor}/remove-attachment": { "delete": { "tags": [ "Harbor contract setting" ], "operationId": "delete_harbor_harborcontractsetting_removeattachment", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors": { "get": { "tags": [ "Harbor" ], "summary": "Gets all harbors", "operationId": "get_harbor_harbor_getharbors", "parameters": [ { "name": "country", "in": "query", "description": "", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Harbor" ], "summary": "Create a new harbor", "operationId": "post_harbor_harbor_postharbor", "responses": { "201": { "description": "Success" } } } }, "/harbors/visible": { "get": { "tags": [ "Harbor" ], "summary": "Gets harbors excluding ones that are invisible. Used in the app", "operationId": "get_get_harbors_visible", "responses": { "200": { "description": "Success" } } } }, "/harbors/visible/options": { "get": { "tags": [ "Harbor" ], "summary": "Gets harbors excluding ones that are invisible. Return only id and name", "operationId": "get_harbor_harbor_getharborsvisibleoptions", "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/map": { "get": { "tags": [ "Harbor" ], "operationId": "get_harbor_harbor_getharbormap", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/guest_setting": { "get": { "tags": [ "Harbor" ], "summary": "Public harbor guest setting", "operationId": "get_harbor_harbor_getharborguestsetting", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/my": { "get": { "tags": [ "Harbor" ], "summary": "Get harbors assigned to curent user. Non paginated", "operationId": "get_harbor_harbor_getharborsmy", "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/visma_economic": { "get": { "tags": [ "Harbor" ], "summary": "Get Visma Economic setting for harbor", "operationId": "get_harbor_harbor_getvismaeconomicharborsetting", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}": { "get": { "tags": [ "Harbor" ], "summary": "Get details of a single harbor", "operationId": "get_harbor_harbor_getharbor", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Harbor" ], "operationId": "put_harbor_harbor_putharbor", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor" ], "operationId": "delete_harbor_harbor_deleteharbor", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbors/{harbor}/image": { "post": { "tags": [ "Harbor" ], "summary": "Upload harbor image", "operationId": "post_harbor_harbor_postharborimage", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor" ], "operationId": "delete_harbor_harbor_deleteharborimage", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/toggle_full": { "put": { "tags": [ "Harbor" ], "operationId": "put_harbor_harbor_putharbortogglefull", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/set_closed": { "put": { "tags": [ "Harbor" ], "operationId": "put_harbor_harbor_putharborsetclosed", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/unset_closed": { "put": { "tags": [ "Harbor" ], "operationId": "put_harbor_harbor_putharborunsetclosed", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/detailed_map": { "post": { "tags": [ "Harbor" ], "operationId": "post_harbor_harbor_postharbordetailedmap", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor" ], "operationId": "delete_harbor_harbor_deleteharbordetailedmap", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/logo": { "post": { "tags": [ "Harbor" ], "operationId": "post_harbor_harbor_postharborlogo", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor" ], "operationId": "delete_harbor_harbor_deleteharborlogo", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/import_bridges": { "post": { "tags": [ "Harbor" ], "operationId": "post_harbor_harbor_postharborimport_bridges", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/export_bridges": { "get": { "tags": [ "Harbor" ], "operationId": "get_harbor_harbor_getharborexport_bridges", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "success" } } } }, "/harbors/{harbor}/my": { "put": { "tags": [ "Harbor" ], "operationId": "put_harbor_harbor_putharbormy", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/coordinates": { "patch": { "tags": [ "Harbor" ], "operationId": "patch_harbor_harbor_patchharborcoordinates", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/external-links/{harbor}": { "get": { "tags": [ "Harbor external links" ], "operationId": "get_harbor_external_linksharbor_harborexternallink_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/external-links/view/{id}": { "get": { "tags": [ "Harbor external links" ], "operationId": "get_harbor_external_linksharbor_harborexternallink_view", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/external-links": { "post": { "tags": [ "Harbor external links" ], "operationId": "post_harbor_external_links_add", "responses": { "201": { "description": "Success" } } } }, "/harbor/external-links/{externalLink}": { "put": { "tags": [ "Harbor external links" ], "operationId": "put_harbor_external_links_edit", "parameters": [ { "name": "externalLink", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor external links" ], "operationId": "delete_harbor_external_links_delete", "parameters": [ { "name": "externalLink", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbors/{harbor}/bridges/{bridge}/positions": { "get": { "tags": [ "Harbor Position" ], "summary": "Get a paginated list of harbor bridge positions", "operationId": "get_harbor_harborposition_getbridgepositions", "parameters": [ { "name": "showOffers", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "to", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "from", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "startDate", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxDepth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minDepth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxWidth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minWidth", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "maxLength", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "minLength", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "ignoreUsed", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "ignoreReserved", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Harbor Position" ], "summary": "Create a position for a bridge in harbor", "operationId": "post_harbor_harborposition_postbridgeposition", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/harbors/{harbor}/bridges/{bridge}/positions/visible": { "get": { "tags": [ "Harbor Position" ], "summary": "Get a non paginated list of all positions for provided bridge", "operationId": "get_harbor_harborposition_getbridgepositionsvisible", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/bridges/{bridge}/positions/{position}": { "get": { "tags": [ "Harbor Position" ], "summary": "Get a single harbor position", "operationId": "get_harbor_harborposition_getbridgeposition", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Harbor Position" ], "summary": "Create a position for a bridge in harbor", "operationId": "put_harbor_harborposition_putbridgeposition", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor Position" ], "summary": "Delete a position for a bridge in harbor", "operationId": "delete_harbor_harborposition_deletebridgeposition", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbors/{harbor}/bridges/{bridge}/positions/{position}/coordinates": { "patch": { "tags": [ "Harbor Position" ], "summary": "Update bridge position coordinates", "operationId": "patch_harbor_harborposition_patchbridgepositioncoordinates", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bridge", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "position", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/prices": { "get": { "tags": [ "Harbor Price" ], "summary": "Get a paginated list of all harbor prices", "operationId": "get_harbor_harborprice_getprices", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "post": { "tags": [ "Harbor Price" ], "summary": "Create a new price in harbor", "operationId": "post_harbor_harborprice_postprice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/harbors/{harbor}/prices/{price}": { "get": { "tags": [ "Harbor Price" ], "summary": "Get a single price", "operationId": "get_harbor_harborprice_getprice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "price", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Harbor Price" ], "summary": "Edit a price in harbor", "operationId": "put_harbor_harborprice_putprice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "price", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor Price" ], "summary": "Delete a price in harbor", "operationId": "delete_harbor_harborprice_deleteprice", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "price", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbors/{harbor}/prices/import": { "post": { "tags": [ "Harbor Price" ], "summary": "Upload a bridge and position list to harbor", "operationId": "post_harbor_harborprice_postpriceimport", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product-category/list": { "get": { "tags": [ "Harbor product category" ], "operationId": "get_harbor_product_category_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategory" } } } } } } }, "/harbor/{harbor}/product-category/add": { "post": { "tags": [ "Harbor product category" ], "operationId": "post_harbor_product_category_add", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ProductCategoryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategoryForm" } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategory" } } } } } } }, "/harbor/{harbor}/product-category/edit/{productCategory}": { "put": { "tags": [ "Harbor product category" ], "operationId": "put_harbor_product_category_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productCategory", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "ProductCategoryController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategoryForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCategory" } } } } } } }, "/harbor/{harbor}/product-category/delete/{productCategory}": { "delete": { "tags": [ "Harbor product category" ], "operationId": "delete_harbor_product_category_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productCategory", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/list/all": { "get": { "tags": [ "Harbor product" ], "operationId": "get_harbor_product_list_all", "parameters": [ { "name": "category", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d+$|null" } }, { "name": "q", "in": "query", "description": "search query", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/list": { "get": { "tags": [ "Harbor product" ], "operationId": "get_harbor_product_list", "parameters": [ { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "category", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "^\\d+$|null" } }, { "name": "q", "in": "query", "description": "search query", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/add": { "post": { "tags": [ "Harbor product" ], "operationId": "post_harbor_product_add", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/edit/{product}": { "put": { "tags": [ "Harbor product" ], "operationId": "put_harbor_product_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/view/{product}": { "get": { "tags": [ "Harbor product" ], "operationId": "get_harbor_product_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/view-by-product-reference-id/{referenceId}": { "get": { "tags": [ "Harbor product" ], "summary": "TODO (payment_rewrite) remove this endpoint", "operationId": "get_harbor_product_view_by_product_reference_id", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "referenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/delete-by-product-reference-id/{referenceId}": { "delete": { "tags": [ "Harbor product" ], "summary": "TODO (payment_rewrite) remove this endpoint", "operationId": "delete_harbor_product_delete_by_product_reference_id", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "referenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/delete/{product}": { "delete": { "tags": [ "Harbor product" ], "operationId": "delete_harbor_product_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/import": { "post": { "tags": [ "Harbor product" ], "operationId": "post_harbor_product_import", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/check_limit": { "get": { "tags": [ "Harbor product" ], "operationId": "get_harbor_product_check_limit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbor/{harbor}/product/{module}/power_package_price": { "get": { "tags": [ "Harbor product" ], "operationId": "get_harbor_product_get_power_package_price", "parameters": [ { "name": "kWhAmount", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns preliminary price", "content": { "application/json": { "schema": { "properties": { "price": { "type": "integer" } }, "type": "object" } } } }, "204": { "description": "Incorrect data given" } } } }, "/harbor/{harbor}/product/{module}/power-package-cardholder-count/{power}": { "get": { "tags": [ "Harbor product" ], "operationId": "get_harbor_product_get_power_package_cardholder_count", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "power", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Incorrect data given" }, "200": { "description": "Returns count of cardholders that are using that power package", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" } }, "type": "object" } } } } } } }, "/harbor/{harbor}/product/{module}/subscription-count/{product}": { "get": { "tags": [ "Harbor product" ], "operationId": "get_harbor_product_get_subscription_product_count", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "module", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "product", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns count of product subscribers", "content": { "application/json": { "schema": { "properties": { "count": { "type": "integer" } }, "type": "object" } } } } } } }, "/harbor-setting/{harbor}": { "get": { "tags": [ "Harbor Setting" ], "summary": "harbor settings array for dashboard", "operationId": "get_harbor_harborsetting_listsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "accounting": { "$ref": "#/components/schemas/AccountingSetting2" }, "contract": { "$ref": "#/components/schemas/HarborContractSetting2" } }, "type": "object" } } } } } } }, "/harbors/{harbor}/settings": { "get": { "tags": [ "Harbor Setting" ], "summary": "Get a NON paginated list of all SET harbor settings", "operationId": "get_harbor_harborsetting_getsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "patch": { "tags": [ "Harbor Setting" ], "summary": "Edit a harbor setting, if it doesn't exist, then create it in db", "operationId": "patch_harbor_harborsetting_patchsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/settings/{filter}": { "get": { "tags": [ "Harbor Setting" ], "summary": "Get a NON paginated list of all harbor settings with filter", "operationId": "get_harbor_harborsetting_getfilteredsettings", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filter", "in": "path", "required": true, "schema": { "type": "string", "pattern": "(?!payments|visma_economic|[0-9]).+" } } ], "responses": { "200": { "description": "Success" } } } }, "/harbors/{harbor}/settings/{setting}": { "delete": { "tags": [ "Harbor Setting" ], "summary": "Delete a harbor setting", "operationId": "delete_harbor_harborsetting_deletesetting", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "setting", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9].+" } } ], "responses": { "204": { "description": "Success" } } } }, "/harbors/{harbor}/settings/payments": { "get": { "tags": [ "Harbor Setting" ], "summary": "Get harbor payment settings. If settings are not set, then default settings will be returned", "operationId": "get_api_harbor_setting_payment_get", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HarborSettingPayment" } } } } }, "deprecated": true }, "post": { "tags": [ "Harbor Setting" ], "summary": "Save harbor payment settings. If settings exist will overwrite existing settings, if not will create new settings", "operationId": "post_api_harbor_setting_payment_post", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Harbor settings have been saved" }, "201": { "description": "Harbor settings have been created" }, "400": { "description": "Bad request" } }, "deprecated": true } }, "/harbor/settings/user": { "get": { "tags": [ "Harbor settings" ], "summary": "Returns all user harbors with settings", "operationId": "get_harbor_settingsharbor_harborsettings_userharborsettings", "responses": { "200": { "description": "Success" } } } }, "/harbor/terms/{harbor}": { "get": { "tags": [ "Harbor terms" ], "operationId": "get_harbor_harborterms_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "put": { "tags": [ "Harbor terms" ], "operationId": "put_harbor_harborterms_edit", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "Harbor terms" ], "operationId": "delete_harbor_harborterms_delete", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/sailor-public/product/shop-list/{harbor}": { "get": { "tags": [ "Product - sailor" ], "operationId": "get_shop_list", "parameters": [ { "name": "module", "in": "query", "example": "crane|booking" }, { "name": "locale", "in": "query", "example": "en_US" }, { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SailorPublicProductListDTO" } } } } } } }, "/sailor-public/dock/bookable-list/{harbor}": { "get": { "tags": [ "Sailor dock" ], "operationId": "get_sailor_public_dock_bookable_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns available docks for booking via app.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorBookableDockDTO" } } } } } } } }, "/sailor-public/dock/list/{harbor}": { "get": { "tags": [ "Sailor dock" ], "operationId": "get_sailor_public_dock_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all docks.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorDockDTO" } } } } } } } }, "/sailor-public/harbor/list-locations": { "get": { "tags": [ "Sailor public harbor" ], "operationId": "get_sailor_public_harbor_list_locations", "parameters": [ { "name": "latFrom", "in": "query", "description": "Latitude from", "required": false, "schema": { "type": "string" } }, { "name": "latTo", "in": "query", "description": "Latitude to", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PublicHarborListProvider" } } } } } } } }, "/sailor-public/harbor/{harbor}": { "get": { "tags": [ "Sailor public harbor" ], "operationId": "get_sailor_public_harbor_harbor_details", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicHarborDTO" } } } } } } }, "/sailor-public/harbor-price/{harbor}/list": { "get": { "tags": [ "Sailor harbor price" ], "operationId": "get_sailor_public_harbor_price_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns harbor price list for berths and/or mooring balls and by which measure it is calculated.", "content": { "application/json": { "schema": { "properties": { "pricingType": { "type": "string", "enum": [ "id", "by_boat_width", "by_boat_length" ] }, "dock": { "type": "array", "items": { "$ref": "#/components/schemas/SailorHarborPriceDTO" } }, "mooring_ball": { "type": "array", "items": { "$ref": "#/components/schemas/SailorHarborPriceDTO" } } }, "type": "object" } } } } } } }, "/sailor-public/slip/bookable-list/{dock}": { "get": { "tags": [ "Sailor slip" ], "operationId": "get_sailor_public_slip_bookable_list", "parameters": [ { "name": "boatDepth", "in": "query", "description": "Depth of the boat in meters", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatWidth", "in": "query", "description": "Width of the boat in meters", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "boatLength", "in": "query", "description": "Length of the boat in meters", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "Until which date to check", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateFrom", "in": "query", "description": "From which date to check", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dock", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns available slips of selected dock for booking via app.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorBookableSlipDTO" } } } } }, "204": { "description": "There are no slips in the dock that suit boat dimensions" }, "400": { "description": "Missing periods" } } } }, "/sailor-public/slip/list/{dock}": { "get": { "tags": [ "Sailor slip" ], "operationId": "get_sailor_public_slip_list", "parameters": [ { "name": "dock", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "There are no slips in the dock" }, "200": { "description": "Return slips of selected dock.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorSlipDTO" } } } } } } } }, "/sailor/dock/bookable-list/{harbor}": { "get": { "tags": [ "Sailor dock" ], "operationId": "get_sailor_dock_bookable_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns available docks for booking via app.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorBookableDockDTO" } } } } } } } }, "/sailor/dock/list/{harbor}": { "get": { "tags": [ "Sailor dock" ], "operationId": "get_sailor_dock_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all docks.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorDockDTO" } } } } } } } }, "/sailor/harbor-price/{harbor}/list": { "get": { "tags": [ "Sailor harbor price" ], "operationId": "get_sailor_harbor_price_list", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns harbor price list for berths and/or mooring balls and by which measure it is calculated.", "content": { "application/json": { "schema": { "properties": { "pricingType": { "type": "string", "enum": [ "by_boat_width", "by_boat_length" ] }, "dock": { "type": "array", "items": { "$ref": "#/components/schemas/SailorHarborPriceDTO" } }, "mooring_ball": { "type": "array", "items": { "$ref": "#/components/schemas/SailorHarborPriceDTO" } } }, "type": "object" } } } } }, "deprecated": true } }, "/sailor/slip/bookable-list/{dock}/{boat}": { "get": { "tags": [ "Sailor slip" ], "operationId": "get_sailor_slip_bookable_list", "parameters": [ { "name": "dateFrom", "in": "query", "description": "From which date to check", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dateTo", "in": "query", "description": "Until which date to check", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "dock", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boat", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns available slips of selected dock for booking via app.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorBookableSlipDTO" } } } } }, "204": { "description": "There are no slips in the dock that suit boat dimensions" }, "400": { "description": "Missing periods" } } } }, "/sailor/slip/list/{dock}": { "get": { "tags": [ "Sailor slip" ], "operationId": "get_sailor_slip_list", "parameters": [ { "name": "dock", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return slips of selected dock.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SailorSlipDTO" } } } } }, "204": { "description": "There are no slips in the dock" } } } }, "/sailor/harbor-terms/check/{harbor}": { "get": { "tags": [ "Sailor Harbor Terms" ], "operationId": "get_sailor_terms_check", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a date when terms were accepted or null (if they weren't accepted)", "content": { "application/json": { "schema": { "properties": { "acceptedAt": { "description": "Date or null", "type": "string", "format": "date-time" } }, "type": "object" } } } }, "204": { "description": "Harbor client doesn't exist" } } } }, "/sailor/harbor-terms/accept/{harbor}": { "patch": { "tags": [ "Sailor Harbor Terms" ], "operationId": "patch_sailor_terms_accept", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a date when terms were accepted", "content": { "application/json": { "schema": { "properties": { "acceptedAt": { "type": "string", "format": "date-time" } }, "type": "object" } } } }, "204": { "description": "Harbor client doesn't exist" } } } }, "/identity/idura/success": { "get": { "tags": [ "Idura MitID Integration" ], "summary": "Success page for MitID verification (handles callback results too).", "operationId": "get_identity_idura_success", "responses": { "default": { "description": "" } } } }, "/identity/idura/initiate/{harborClientId}": { "get": { "tags": [ "Idura MitID Integration" ], "summary": "Initiate MitID verification for a HarborClient.", "operationId": "get_identity_idura_initiate", "parameters": [ { "name": "harborClientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/identity/idura/user/{userId}/request-mitid-verification": { "post": { "tags": [ "Idura MitID Integration" ], "summary": "Send MitID verification request email to user.", "operationId": "post_identity_idura_request_mitid_verification_single_id", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } }, "deprecated": true } }, "/identity/idura/test-initiate": { "get": { "tags": [ "Idura MitID Integration" ], "operationId": "get_identity_idura_test_initiate", "responses": { "default": { "description": "" } } } }, "/admin/identity/{harbor}/request-id-verification": { "post": { "tags": [ "Identity for admin" ], "operationId": "post_admin_identity_request_id_verification", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/admin/identity/settings/{harbor}": { "get": { "tags": [ "Identity settings for admin" ], "operationId": "get_admin_identity_settings_view", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentitySettingDTO" } } } } } }, "put": { "tags": [ "Identity settings for admin" ], "operationId": "put_admin_identity_settings_update", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "request": "AdminIdentitySettingController", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentitySettingForm" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentitySettingDTO" } } } } } } }, "/admin/identity/settings/{harbor}/remove-user-verification/{user}": { "delete": { "tags": [ "Identity settings for admin" ], "operationId": "delete_admin_identity_settings_remove_user_verification", "parameters": [ { "name": "harbor", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership/list-by-user": { "get": { "tags": [ "Membership" ], "operationId": "get_admin_membership_list_by_user", "responses": { "200": { "description": "Success" } } } }, "/admin/membership/list": { "get": { "tags": [ "Membership" ], "operationId": "get_admin_membership_list", "responses": { "200": { "description": "Success" } } } }, "/admin/membership/list-harbors-user-can-enroll-in": { "get": { "tags": [ "Membership" ], "operationId": "get_admin_membership_list_harbors_user_can_enroll_in", "responses": { "200": { "description": "Success" } } } }, "/admin/membership/view/{membership}": { "get": { "tags": [ "Membership" ], "operationId": "get_admin_membership_view", "parameters": [ { "name": "membership", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership/create": { "post": { "tags": [ "Membership" ], "operationId": "post_admin_membership_create", "responses": { "201": { "description": "Success" } } } }, "/admin/membership/edit/{membership}": { "put": { "tags": [ "Membership" ], "operationId": "put_admin_membership_update", "parameters": [ { "name": "membership", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership/delete/{membership}": { "delete": { "tags": [ "Membership" ], "operationId": "delete_admin_membership_delete", "parameters": [ { "name": "membership", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/admin/membership-member/list": { "get": { "tags": [ "Membership Members" ], "operationId": "get_admin_membership_member_list", "parameters": [ { "name": "page", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "limit", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "active", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "membershipType", "in": "query", "description": "", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-member/view/{member}": { "get": { "tags": [ "Membership Members" ], "operationId": "get_admin_membership_member_view", "parameters": [ { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-member/is-user-a-member/{membership}/{user}": { "get": { "tags": [ "Membership Members" ], "operationId": "get_admin_membership_member_is_user_a_member", "parameters": [ { "name": "membership", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-member/create": { "post": { "tags": [ "Membership Members" ], "operationId": "post_admin_membership_member_create", "responses": { "201": { "description": "Success" } } } }, "/admin/membership-member/edit/{member}": { "put": { "tags": [ "Membership Members" ], "operationId": "put_admin_membership_member_update", "parameters": [ { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-member/delete/{member}": { "delete": { "tags": [ "Membership Members" ], "operationId": "delete_admin_membership_member_delete", "parameters": [ { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/admin/membership-member/revoke/{member}": { "put": { "tags": [ "Membership Members" ], "operationId": "put_admin_membership_member_revoke", "parameters": [ { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-member/update-invoice-status/{member}": { "put": { "tags": [ "Membership Members" ], "operationId": "put_admin_membership_member_update_invoiceStatus", "parameters": [ { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-member/logs/{member}": { "get": { "tags": [ "Membership Members" ], "operationId": "get_admin_membership_member_logs", "parameters": [ { "name": "member", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-type/list": { "get": { "tags": [ "Membership Types" ], "operationId": "get_admin_membership_type_list", "responses": { "200": { "description": "Success" } } } }, "/admin/membership-type/list-by-membership/{membership}": { "get": { "tags": [ "Membership Types" ], "operationId": "get_admin_membership_type_list_by_membership", "parameters": [ { "name": "membership", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-type/view/{type}": { "get": { "tags": [ "Membership Types" ], "operationId": "get_admin_membership_type_view", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-type/create": { "post": { "tags": [ "Membership Types" ], "operationId": "post_admin_membership_type_create", "responses": { "201": { "description": "Success" } } } }, "/admin/membership-type/edit/{type}": { "put": { "tags": [ "Membership Types" ], "operationId": "put_admin_membership_type_update", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/admin/membership-type/delete/{type}": { "delete": { "tags": [ "Membership Types" ], "operationId": "delete_admin_membership_type_delete", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/admin/membership-type/change-state/{type}": { "put": { "tags": [ "Membership Types" ], "operationId": "put_admin_membership_type_change_state", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Success" } } } }, "/admin/membership-permission/view": { "get": { "tags": [ "Membership permission" ], "operationId": "get_admin_membership_permission_view", "responses": { "200": { "description": "Success" } } } }, "/admin/membership-permission/manage": { "get": { "tags": [ "Membership permission" ], "operationId": "get_admin_membership_permission_manage", "responses": { "200": { "description": "Success" } } } }, "/admin/membership-permission/admin": { "get": { "tags": [ "Membership permission" ], "operationId": "get_admin_membership_permission_admin", "responses": { "200": { "description": "Success" } } } }, "/admin/membership-permission/module-enabled": { "get": { "tags": [ "Membership permission" ], "operationId": "get_admin_membership_permission_/module_enabled", "responses": { "200": { "description": "Success" } } } }, "/sailor-public/membership/lookup": { "get": { "tags": [ "Membership" ], "operationId": "get_sailor_membership_lookup", "parameters": [ { "name": "email", "in": "query", "required": true }, { "name": "harbor", "in": "query", "required": true } ], "responses": { "200": { "description": "Success" } } } }, "/api/doc.json": { "get": { "responses": { "default": { "description": "" } } } } }, "components": { "schemas": { "HarborEmployee": { "properties": { "id": { "type": "string" }, "harbor": { "$ref": "#/components/schemas/Harbor" }, "user": { "$ref": "#/components/schemas/User4" }, "isAdmin": { "type": "boolean" } }, "type": "object" }, "HarborEmployeeForm": { "required": [ "user", "isAdmin", "permissions" ], "properties": { "user": { "type": "string", "format": "User\\Entity\\User id" }, "isAdmin": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "HarborEmployee2": { "properties": { "id": { "type": "string" }, "harbor": { "$ref": "#/components/schemas/Harbor2" }, "user": { "$ref": "#/components/schemas/User5" }, "isAdmin": { "type": "boolean" } }, "type": "object" }, "MarketingMaterialDTO": { "properties": { "module": { "type": "string" }, "text": { "type": "string" }, "locale": { "type": "string" }, "videoUrl": { "type": "string" } }, "type": "object" }, "MarketingMaterialBulkForm": { "required": [ "texts" ], "properties": { "texts": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "GetSalesCallForm": { "required": [ "name", "harborName", "email", "phone" ], "properties": { "name": { "type": "string" }, "harborName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" }, "SailorTripReportForm": { "required": [ "harbor", "boat", "dateFrom", "dateTo" ], "properties": { "harbor": { "type": "string", "format": "Harbor\\Entity\\Harbor id" }, "boat": { "type": "string", "format": "User\\Entity\\Boat id" }, "dateFrom": { "type": "string", "format": "date" }, "dateTo": { "type": "string", "format": "date" }, "notes": { "type": "string" } }, "type": "object" }, "TripReportDTO": { "properties": {}, "type": "object" }, "TripReport": { "properties": { "user": { "$ref": "#/components/schemas/User6" }, "harborClient": { "$ref": "#/components/schemas/HarborClient2" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "boat": { "$ref": "#/components/schemas/Boat5" }, "clientBoat": { "$ref": "#/components/schemas/HarborClientBoat" }, "harbor": { "$ref": "#/components/schemas/Harbor3" }, "dock": { "$ref": "#/components/schemas/HarborBridge4" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition" } }, "type": "object" }, "TripReport2": { "properties": { "user": { "$ref": "#/components/schemas/User7" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "boat": { "$ref": "#/components/schemas/Boat6" }, "clientBoat": { "$ref": "#/components/schemas/HarborClientBoat2" }, "dock": { "$ref": "#/components/schemas/HarborBridge5" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition2" } }, "type": "object" }, "CamperReservationListDTO": { "properties": { "invoice": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "credited": { "type": "string" }, "paidOn": { "type": "string" } } } }, "harbor": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "user": { "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "type": "object" }, "order": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "camperLot": { "type": "string" }, "plateNumber": { "type": "string" }, "country": { "type": "string" }, "userFullName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "price": { "type": "string" }, "currencyCode": { "type": "string" }, "currency": { "type": "string" } }, "type": "object" }, "SailorCamperCurrentListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CamperReservation2" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "SailorCamperPastListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CamperReservation2" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "CamperReservation": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor4" }, "camperLot": { "$ref": "#/components/schemas/CamperLot" }, "user": { "$ref": "#/components/schemas/User8" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "userFullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "plateNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "country": { "type": "string" }, "paid": { "type": "boolean" }, "vatAmount": { "type": "number", "format": "double" }, "harborClient": { "$ref": "#/components/schemas/HarborClient3" }, "order": { "$ref": "#/components/schemas/Order5" }, "cashReservation": { "type": "boolean" }, "id": { "type": "integer" } }, "type": "object" }, "SailorPublicCamperLotDTO": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "SailorPublicCamperSettingDTO": { "properties": { "enabled": { "type": "boolean" }, "nationalityHidden": { "type": "boolean" }, "firstNameHidden": { "type": "boolean" }, "lastNameHidden": { "type": "boolean" }, "emailHidden": { "type": "boolean" }, "price": { "type": "string" } }, "type": "object" }, "SlipwayReservationListDTO": { "properties": { "invoice": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "credited": { "type": "string" }, "paidOn": { "type": "string" } } } }, "harbor": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "timezone": { "type": "string" } }, "type": "object" }, "user": { "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "type": "object" }, "order": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "plateNumber": { "type": "string" }, "country": { "type": "string" }, "userFullName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "price": { "type": "string" }, "currencyCode": { "type": "string" }, "currency": { "type": "string" } }, "type": "object" }, "CreditSettings": { "properties": { "sendLowCreditNotification": { "type": "boolean" }, "lowCreditAmount": { "type": "integer" } }, "type": "object" }, "CreditSettingsForm": { "properties": { "sendLowCreditNotification": { "type": "boolean" }, "lowCreditAmount": { "type": "number" } }, "type": "object" }, "HarborMapSettings": { "type": "object" }, "HarborMapSettingsForm": { "required": [ "zoom" ], "properties": { "zoom": { "type": "string" } }, "type": "object" }, "WaitingListSetting": { "type": "object" }, "SailorWaitingListEntryPreferenceForm": { "required": [ "boat", "interestedLongTerm", "interestedShortTerm" ], "properties": { "boat": { "type": "string", "format": "User\\Entity\\Boat id" }, "interestedLongTerm": { "type": "boolean" }, "interestedShortTerm": { "type": "boolean" } }, "type": "object" }, "WaitingListEntryDTO": { "properties": { "id": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListId": { "type": "string" }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOfferEntryDTO" } }, "preference": { "$ref": "#/components/schemas/WaitingListPreferencesDTO" }, "harbor": { "$ref": "#/components/schemas/PublicHarborGeneralDTO" }, "harborPreferenceSetting": { "$ref": "#/components/schemas/WaitingListPreferenceSettingDTO" }, "clientBoat": { "$ref": "#/components/schemas/HarborClientBoatMinimalDTO" }, "categoryId": { "type": "string" } }, "type": "object" }, "WaitingListPreferencesDTO": { "properties": { "id": { "type": "string" }, "answeredAt": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" } }, "type": "object" }, "SailorWaitingListOfferDTO": { "properties": { "id": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" }, "harbor": { "$ref": "#/components/schemas/PublicHarborGeneralDTO" }, "berth": { "type": "string" }, "slip": { "type": "string" }, "length": { "type": "string" }, "width": { "type": "string" }, "depth": { "type": "string" }, "product": { "type": "string" }, "price": { "type": "string" } }, "type": "object" }, "SailorWaitingListEntryForm": { "required": [ "boat" ], "properties": { "boat": { "type": "string", "format": "User\\Entity\\Boat id" } }, "type": "object" }, "WaitingListEntry": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor5" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat3" }, "harborClient": { "$ref": "#/components/schemas/HarborClient4" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory2" }, "id": { "type": "string" } }, "type": "object" }, "WaitingList": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber2" }, "id": { "type": "integer" }, "productType": { "type": "string" }, "category": { "$ref": "#/components/schemas/WaitingListCategory3" } }, "type": "object" }, "WaitingListCategoryDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "WaitingListCategoryForm": { "required": [ "name" ], "properties": { "name": { "type": "string" } }, "type": "object" }, "WaitingListCategory": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor6" }, "name": { "type": "string" }, "defaultCategory": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListEntryListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListEntry5" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "WaitingListEntryForm": { "required": [ "harborClient", "harborClientBoat", "waitingListEntryId", "waitingListCategory", "signUpDate", "comment" ], "properties": { "harborClient": { "type": "string", "format": "HarborClient\\Entity\\HarborClient id" }, "harborClientBoat": { "type": "string", "format": "HarborClient\\Entity\\HarborClientBoat id" }, "waitingListEntryId": { "type": "string" }, "waitingListCategory": { "type": "string", "format": "WaitingList\\Entity\\WaitingListCategory id" }, "signUpDate": { "type": "string", "format": "date" }, "comment": { "type": "string" } }, "type": "object" }, "WaitingListEntry2": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor7" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat4" }, "harborClient": { "$ref": "#/components/schemas/HarborClient5" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListPreference": { "$ref": "#/components/schemas/WaitingListPreference" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory4" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListEntry3": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor8" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat5" }, "harborClient": { "$ref": "#/components/schemas/HarborClient6" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListPreference": { "$ref": "#/components/schemas/WaitingListPreference2" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory5" }, "id": { "type": "string" }, "comment": { "type": "string" } }, "type": "object" }, "WaitingListEntry4": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor9" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat6" }, "harborClient": { "$ref": "#/components/schemas/HarborClient7" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListPreference": { "$ref": "#/components/schemas/WaitingListPreference3" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory6" }, "id": { "type": "string" } }, "type": "object" }, "Invoice": { "properties": { "hasPendingStripeCharge": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor10" }, "invoiceNumber": { "type": "integer" }, "debtorName": { "type": "string" }, "debtorEmail": { "type": "string" }, "debtorPhone": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "harborClientId": { "type": "integer" }, "currency": { "type": "string" }, "totalAmount": { "type": "number", "format": "double" }, "paidAmount": { "type": "number", "format": "double" }, "paidOn": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "publicToken": { "type": "string" }, "sentOn": { "type": "string", "format": "date-time" }, "sendInvoiceOn": { "type": "string", "format": "date-time" }, "pdfFilePath": { "type": "string" }, "status": { "type": "string" }, "creditNote": { "type": "boolean" }, "subscriberId": { "type": "string" }, "paymentId": { "title": "mapping for migration", "type": "integer" }, "order": { "$ref": "#/components/schemas/Order6" }, "type": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListOfferForm": { "required": [ "entryIds", "harborProduct", "dock", "slip", "comment", "subscriptionStartDate", "subscriptionExpirationDate" ], "properties": { "entryIds": { "type": "array", "items": { "type": "string" } }, "harborProduct": { "type": "string", "format": "Harbor\\Entity\\HarborProduct\\Subscription id" }, "dock": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" }, "slip": { "type": "string", "format": "Harbor\\Entity\\HarborBridgePosition id" }, "comment": { "type": "string" }, "subscriptionStartDate": { "type": "string", "format": "date" }, "subscriptionExpirationDate": { "type": "string", "format": "date" } }, "type": "object" }, "WaitingListOffer": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor11" }, "createdAt": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "dock": { "$ref": "#/components/schemas/HarborBridge6" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition3" }, "comment": { "title": "Field for product comments. Used for specifying additional info for storage, rack, custom and clubs", "type": "string" }, "subscriptionStartDate": { "type": "string", "format": "date-time" }, "subscriptionExpirationDate": { "type": "string", "format": "date-time" }, "offerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOfferEntry" } }, "id": { "type": "string" } }, "type": "object" }, "WaitingListOfferListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOffer3" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "WaitingListOffer2": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor12" }, "createdAt": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "dock": { "$ref": "#/components/schemas/HarborBridge7" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition4" }, "comment": { "title": "Field for product comments. Used for specifying additional info for storage, rack, custom and clubs", "type": "string" }, "subscriptionStartDate": { "type": "string", "format": "date-time" }, "subscriptionExpirationDate": { "type": "string", "format": "date-time" }, "offerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOfferEntry2" } }, "id": { "type": "string" } }, "type": "object" }, "WaitingListSetting2": { "properties": { "id": { "type": "string" } }, "type": "object" }, "BoatModel": { "properties": { "name": { "type": "string" }, "confirmed": { "type": "boolean" }, "mastHeight": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "depth": { "type": "number", "format": "double" } }, "type": "object" }, "BoatModel2": { "properties": { "name": { "type": "string" }, "confirmed": { "type": "boolean" }, "mastHeight": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "depth": { "type": "number", "format": "double" } }, "type": "object" }, "BoatModelForm": { "required": [ "name", "width", "length", "depth", "mastHeight" ], "properties": { "name": { "type": "string" }, "width": { "type": "number" }, "length": { "type": "number" }, "depth": { "type": "number" }, "mastHeight": { "type": "number" } }, "type": "object" }, "BoatType": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "BoatType2": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "BoatTypeForm": { "required": [ "name" ], "properties": { "name": { "type": "string" } }, "type": "object" }, "SailorLoginForm": { "required": [ "email", "password" ], "properties": { "email": { "type": "string" }, "password": { "type": "string", "format": "password" }, "product": { "type": "string" }, "productVersion": { "type": "string" }, "rememberMe": { "type": "boolean" } }, "type": "object" }, "UserToken": { "properties": { "token": { "type": "string" } }, "type": "object" }, "SailorVerifyEmailForm": { "required": [ "email" ], "properties": { "email": { "type": "string" } }, "type": "object" }, "SailorRegistrationForm": { "required": [ "firstName", "lastName", "email", "password", "phone", "marketingConsent", "country" ], "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string", "format": "password" }, "phone": { "type": "string" }, "locale": { "type": "string" }, "marketingConsent": { "type": "boolean" }, "country": { "type": "string" }, "product": { "type": "string" }, "productVersion": { "type": "string" } }, "type": "object" }, "SailorRequestPasswordResetForm": { "required": [ "email" ], "properties": { "email": { "type": "string" } }, "type": "object" }, "SailorResetPasswordForm": { "required": [ "password" ], "properties": { "password": { "required": [ "first", "second" ], "properties": { "first": { "type": "string", "format": "password" }, "second": { "type": "string", "format": "password" } }, "type": "object" } }, "type": "object" }, "Boat": { "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "assetPicture": { "type": "string" }, "thumbImage": { "type": "string" }, "image": { "type": "string" }, "freeharbor": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/BoatType3" }, "model": { "$ref": "#/components/schemas/BoatModel4" }, "harbor": { "$ref": "#/components/schemas/Harbor13" }, "year": { "type": "integer" }, "length": { "title": "DBREFACTOR: Change to BoatDimensions object", "type": "number", "format": "float" }, "depth": { "title": "DBREFACTOR: Change to BoatDimensions object", "type": "number", "format": "float" }, "width": { "title": "DBREFACTOR: Change to BoatDimensions object", "type": "number", "format": "float" }, "mastHeight": { "type": "number", "format": "float" }, "weight": { "type": "number", "format": "float" }, "plateNumber": { "type": "string" }, "VHFRadioCallsign": { "type": "string" }, "insuranceCompany": { "type": "string" }, "insurancePolicyNumber": { "type": "string" }, "kasko": { "type": "boolean" }, "insuranceExpirationDate": { "type": "string", "format": "date-time" }, "insuranceFileLastUploadedAt": { "type": "string", "format": "date-time" }, "hullNumber": { "type": "string" }, "registrationNumber": { "type": "string" }, "insuranceStatus": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Boat2": { "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "assetPicture": { "type": "string" }, "thumbImage": { "type": "string" }, "image": { "type": "string" }, "freeharbor": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/BoatType4" }, "model": { "$ref": "#/components/schemas/BoatModel5" }, "harbor": { "$ref": "#/components/schemas/Harbor14" }, "year": { "type": "integer" }, "length": { "title": "DBREFACTOR: Change to BoatDimensions object", "type": "number", "format": "float" }, "depth": { "title": "DBREFACTOR: Change to BoatDimensions object", "type": "number", "format": "float" }, "width": { "title": "DBREFACTOR: Change to BoatDimensions object", "type": "number", "format": "float" }, "mastHeight": { "type": "number", "format": "float" }, "weight": { "type": "number", "format": "float" }, "plateNumber": { "type": "string" }, "VHFRadioCallsign": { "type": "string" }, "insuranceCompany": { "type": "string" }, "insurancePolicyNumber": { "type": "string" }, "kasko": { "type": "boolean" }, "insuranceExpirationDate": { "type": "string", "format": "date-time" }, "insuranceFileLastUploadedAt": { "type": "string", "format": "date-time" }, "hullNumber": { "type": "string" }, "registrationNumber": { "type": "string" }, "insuranceStatus": { "type": "string" } }, "type": "object" }, "SailorBoatForm": { "required": [ "name", "type", "model", "length", "width", "depth", "freeharbor" ], "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "type": { "type": "string", "format": "User\\Entity\\BoatType id" }, "model": { "type": "string", "format": "User\\Entity\\BoatModel id" }, "length": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "year": { "type": "number" }, "freeharbor": { "type": "boolean" } }, "type": "object" }, "Boat3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "SailorBoatGeneralInformationForm": { "required": [ "name", "model" ], "properties": { "name": { "type": "string" }, "model": { "type": "string", "format": "User\\Entity\\BoatModel id" }, "year": { "type": "number" } }, "type": "object" }, "SailorBoatTechnicalInformationForm": { "required": [ "length", "width", "depth", "mastHeight", "weight", "VHFRadioCallsign", "hullNumber", "registrationNumber", "freeharbor" ], "properties": { "length": { "type": "number" }, "width": { "type": "number" }, "depth": { "type": "number" }, "mastHeight": { "type": "number" }, "weight": { "type": "number" }, "VHFRadioCallsign": { "type": "string" }, "hullNumber": { "type": "string" }, "registrationNumber": { "type": "string" }, "freeharbor": { "type": "boolean" } }, "type": "object" }, "SailorBoatInsuranceInformationForm": { "properties": { "insuranceCompany": { "type": "string" }, "insurancePolicyNumber": { "type": "string" }, "insuranceExpirationDate": { "type": "string", "format": "date" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/SailorBoatAttachmentUploadType" } } }, "type": "object" }, "SailorBoatAttachmentsDTO": { "properties": { "boatAttachments": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "publicPath": { "type": "string" } } } }, "remainingSpace": { "type": "integer" } }, "type": "object" }, "ImageUploadType": { "required": [ "file" ], "properties": { "file": {} }, "type": "object" }, "Boat4": { "properties": { "assetPicture": { "type": "string" }, "thumbImage": { "type": "string" }, "image": { "type": "string" } }, "type": "object" }, "BoatModel3": { "properties": { "name": { "type": "string" }, "confirmed": { "type": "boolean" }, "mastHeight": { "type": "number", "format": "double" }, "id": { "type": "string" }, "width": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "depth": { "type": "number", "format": "double" } }, "type": "object" }, "SailorUserNameForm": { "required": [ "firstName", "lastName" ], "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "type": "object" }, "SailorUserAddressForm": { "required": [ "country" ], "properties": { "address": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "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", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY", "DC" ] }, "zipCode": { "type": "string" } }, "type": "object" }, "SailorUserPhoneForm": { "required": [ "phone" ], "properties": { "phone": { "type": "string" } }, "type": "object" }, "SailorUserBirthdayForm": { "properties": { "birthday": { "type": "string", "format": "date" } }, "type": "object" }, "SailorUserMeasurmentSystemForm": { "required": [ "measurementSystem" ], "properties": { "measurementSystem": { "type": "string", "enum": [ "metric", "imperial" ] } }, "type": "object" }, "SailorUserMarketingConsentForm": { "required": [ "marketingConsent" ], "properties": { "marketingConsent": { "type": "boolean" } }, "type": "object" }, "User": { "properties": { "image": { "type": "string" } }, "type": "object" }, "UserLicenseForm": { "required": [ "hasLicense", "licenseNumber" ], "properties": { "hasLicense": { "type": "boolean" }, "licenseNumber": { "type": "string" } }, "type": "object" }, "User2": { "properties": { "locale": { "type": "string" }, "measurementSystem": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "edited": { "type": "string", "format": "date-time" }, "registered": { "type": "string", "format": "date-time" }, "termsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "license": { "$ref": "#/components/schemas/UserLicense" }, "marketingConsent": { "type": "boolean" }, "isHarbaEmployee": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "User3": { "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "image": { "type": "string" }, "rawImage": { "type": "string" }, "thumbImage": { "type": "string" }, "locale": { "type": "string" }, "measurementSystem": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "timezone": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "edited": { "type": "string", "format": "date-time" }, "registered": { "type": "string", "format": "date-time" }, "termsAccepted": { "type": "string", "format": "date-time" }, "fullUser": { "type": "boolean" }, "username": { "type": "string" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "license": { "$ref": "#/components/schemas/UserLicense2" }, "marketingConsent": { "type": "boolean" }, "isHarbaEmployee": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "UserLog": { "properties": { "user": { "$ref": "#/components/schemas/User9" }, "harborClientId": { "type": "integer" }, "message": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/components/schemas/User9" }, "harbor": { "$ref": "#/components/schemas/Harbor15" }, "autoCreated": { "type": "boolean" }, "type": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "BookingOrderItemForm": { "required": [ "order", "type", "bridge", "dateFrom", "dateTo", "price", "utilityProducts", "discountType" ], "properties": { "order": { "type": "string", "format": "Order\\Entity\\Order id" }, "type": { "type": "number", "enum": [ 0, 1 ] }, "bridge": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" }, "position": { "type": "string", "format": "Harbor\\Entity\\HarborBridgePosition id" }, "clientBoat": { "type": "string", "format": "HarborClient\\Entity\\HarborClientBoat id" }, "boat": { "type": "string", "format": "User\\Entity\\Boat id" }, "boatCountry": { "type": "string" }, "boatLength": { "type": "number" }, "boatWidth": { "type": "number" }, "boatDepth": { "type": "number" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "price": { "type": "number" }, "comment": { "type": "string" }, "freeCrewLimitReached": { "type": "boolean" }, "boatName": { "type": "string" }, "utilityProducts": { "type": "array", "format": "[Harbor\\Entity\\HarborProduct\\Utility id]", "items": { "type": "string" } }, "isFreeharbor": { "type": "boolean" }, "crewCount": { "type": "string" }, "discountType": { "type": "string", "enum": [ "amount", "percent" ] }, "discountAmount": { "type": "number" }, "pricingType": { "type": "string" } }, "type": "object" }, "OrderItem": { "properties": { "harborProductId": { "type": "integer" }, "bridgeId": { "type": "string" }, "bridgeName": { "type": "string" }, "berthId": { "type": "string" }, "berthName": { "type": "string" }, "productModule": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "quantity2": { "type": "number", "format": "double" }, "basePrice": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "pricePerUnit2": { "type": "number", "format": "double" }, "pricingScheme": { "type": "string" }, "vatPercent": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "unit2": { "type": "string" }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "paymentLineId": { "title": "mapping for migration", "type": "string" }, "entityId": { "title": "Id from other module record like camper.id", "type": "string" }, "discountType": { "type": "string" }, "discountAmount": { "type": "number", "format": "double" }, "actualDiscount": { "title": "Deducted amount from price.", "type": "number", "format": "double" }, "discountSource": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "CamperOrderItemForm": { "required": [ "order", "camperLot", "dateFrom", "dateTo", "plateNumber" ], "properties": { "order": { "type": "string", "format": "Order\\Entity\\Order id" }, "camperLot": { "type": "string", "format": "Camper\\Entity\\CamperLot id" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "plateNumber": { "type": "string" }, "country": { "type": "string" } }, "type": "object" }, "CreditOrderItemForm": { "required": [ "order", "amount" ], "properties": { "order": { "type": "string", "format": "Order\\Entity\\Order id" }, "amount": { "type": "number" } }, "type": "object" }, "CraneReservationOrderItemForm": { "required": [ "order", "dateFrom", "dateTo", "direction", "upliftPeriod", "bridge", "position", "boatType", "boatModel", "boatName", "boatLength", "boatWidth", "boatDepth", "boatWeight" ], "properties": { "order": { "type": "string", "format": "Order\\Entity\\Order id" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "harborComment": { "type": "string" }, "direction": { "type": "string", "enum": [ "up", "down" ] }, "upliftPeriod": { "type": "number" }, "clientBoat": { "type": "string", "format": "HarborClient\\Entity\\HarborClientBoat id" }, "bridge": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" }, "position": { "type": "string", "format": "Harbor\\Entity\\HarborBridgePosition id" }, "boatType": { "type": "string", "format": "User\\Entity\\BoatType id" }, "boatModel": { "type": "string", "format": "User\\Entity\\BoatModel id" }, "boatName": { "type": "string" }, "boatLength": { "type": "number" }, "boatWidth": { "type": "number" }, "boatDepth": { "type": "number" }, "boatMast": { "type": "number" }, "boatWeight": { "type": "number" }, "isFree": { "type": "number" } }, "type": "object" }, "MembershipOrderItemForm": { "required": [ "order", "membershipType", "membershipMember" ], "properties": { "order": { "type": "string", "format": "Order\\Entity\\Order id" }, "membershipType": { "type": "string", "format": "Membership\\Entity\\MembershipType id" }, "membershipMember": { "type": "string", "format": "Membership\\Entity\\MembershipMember id" } }, "type": "object" }, "MembershipOrderItemDTO": { "type": "object" }, "Order": { "properties": { "currency": { "type": "string" }, "user": { "$ref": "#/components/schemas/User10" }, "status": { "type": "string" }, "orderNumber": { "type": "string" }, "harborClientId": { "type": "integer" }, "harborClient": { "$ref": "#/components/schemas/HarborClient8" }, "paymentId": { "title": "mapping for migration", "type": "integer" }, "completedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "invoice": { "$ref": "#/components/schemas/Invoice7" }, "invoiceStatus": { "type": "string" }, "source": { "type": "string" }, "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string", "pattern": "[a-zA-Z0-9_\\-.+]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-.]+" }, "phone": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Order2": { "properties": { "currency": { "type": "string" }, "user": { "$ref": "#/components/schemas/User11" }, "status": { "type": "string" }, "orderNumber": { "type": "string" }, "harborClientId": { "type": "integer" }, "harborClient": { "$ref": "#/components/schemas/HarborClient9" }, "paymentId": { "title": "mapping for migration", "type": "integer" }, "orderItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem3" } }, "completedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "confirmOn": { "title": "If set order will confirm on this date", "type": "string", "format": "date-time" }, "invoice": { "$ref": "#/components/schemas/Invoice8" }, "invoiceStatus": { "type": "string" }, "source": { "type": "string" }, "comment": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "OrderForm": { "required": [ "firstName", "lastName", "email", "phone", "source", "comment" ], "properties": { "harborClientId": { "type": "string" }, "harborClient": { "type": "string", "format": "HarborClient\\Entity\\HarborClient id" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "source": { "type": "string" }, "confirmOn": { "type": "string", "format": "date" }, "comment": { "type": "string" } }, "type": "object" }, "Order3": { "properties": { "currency": { "type": "string" }, "user": { "$ref": "#/components/schemas/User12" }, "status": { "type": "string" }, "orderNumber": { "type": "string" }, "harborClientId": { "type": "integer" }, "harborClient": { "$ref": "#/components/schemas/HarborClient10" }, "paymentId": { "title": "mapping for migration", "type": "integer" }, "completedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "confirmOn": { "title": "If set order will confirm on this date", "type": "string", "format": "date-time" }, "invoice": { "$ref": "#/components/schemas/Invoice9" }, "invoiceStatus": { "type": "string" }, "source": { "type": "string" }, "comment": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "ConfirmOrderForm": { "required": [ "invoiceOptions" ], "properties": { "invoiceOptions": { "$ref": "#/components/schemas/InvoiceOptionsType" }, "markAsPaidOptions": { "$ref": "#/components/schemas/MarkInvoicesAsPaidForm" } }, "type": "object" }, "ConfirmMultipleOrdersForm": { "required": [ "ids", "invoiceOptions" ], "properties": { "ids": { "type": "array", "format": "[Order\\Entity\\Order id]", "items": { "type": "string" } }, "invoiceOptions": { "$ref": "#/components/schemas/MultipleInvoiceOptionsType" } }, "type": "object" }, "CompleteMultipleOrdersForm": { "required": [ "ids" ], "properties": { "ids": { "type": "array", "format": "[Order\\Entity\\Order id]", "items": { "type": "string" } } }, "type": "object" }, "OrderItemForm": { "required": [ "order", "name", "quantity", "quantity2", "pricePerUnit", "pricePerUnit2", "unit", "unit2", "pricingScheme", "productModule", "entityId", "discountType" ], "properties": { "order": { "type": "string", "format": "Order\\Entity\\Order id" }, "name": { "type": "string" }, "quantity": { "type": "number" }, "quantity2": { "type": "number" }, "pricePerUnit": { "type": "number" }, "pricePerUnit2": { "type": "number" }, "unit": { "type": "string", "enum": [ "pcs", "ppl", "units", "modules", "each", "pair", "percent", "cm", "m", "km", "yard", "inch", "feet", "miles", "g", "kg", "tonne", "gallon", "ounce", "pound", "cm3", "m3", "m2", "l", "ml", "hours", "days", "weeks", "months", "years", "kWh" ] }, "unit2": { "type": "string", "enum": [ "", "hours", "days", "weeks", "months", "years" ] }, "basePrice": { "type": "number" }, "pricingScheme": { "type": "string", "enum": [ "static", "boat_length", "boat_width", "boat_area", "berth_width", "berth_area", "boat_mast_height", "boat_length_ft", "boat_width_ft", "boat_area_ft", "berth_width_ft", "berth_area_ft", "boat_mast_height_ft", "add_2_prices", "multiply_by_second_unit" ] }, "vatPercent": { "type": "number" }, "harborProductId": { "type": "number" }, "productModule": { "type": "string" }, "bridgeId": { "type": "string" }, "bridgeName": { "type": "string" }, "berthId": { "type": "string" }, "berthName": { "type": "string" }, "periodFrom": { "type": "string", "format": "date" }, "periodTo": { "type": "string", "format": "date" }, "entityId": { "type": "string" }, "discountType": { "type": "string", "enum": [ "amount", "percent" ] }, "discountAmount": { "type": "number" } }, "type": "object" }, "OrderItem2": { "properties": { "harborProductId": { "type": "integer" }, "bridgeId": { "type": "string" }, "bridgeName": { "type": "string" }, "berthId": { "type": "string" }, "berthName": { "type": "string" }, "productModule": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "quantity2": { "type": "number", "format": "double" }, "basePrice": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "pricePerUnit2": { "type": "number", "format": "double" }, "pricingScheme": { "type": "string" }, "vatPercent": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "unit2": { "type": "string" }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "paymentLineId": { "title": "mapping for migration", "type": "string" }, "entityId": { "title": "Id from other module record like camper.id", "type": "string" }, "discountType": { "type": "string" }, "discountAmount": { "type": "number", "format": "double" }, "actualDiscount": { "title": "Deducted amount from price.", "type": "number", "format": "double" }, "discountSource": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "PowerOrderItemForm": { "required": [ "order", "powerPackage", "qty" ], "properties": { "order": { "type": "string", "format": "Order\\Entity\\Order id" }, "powerPackage": { "type": "string", "format": "Harbor\\Entity\\HarborProduct\\Power id" }, "qty": { "type": "integer" } }, "type": "object" }, "SailorOrderBookingForm": { "required": [ "dateTo", "dateFrom", "boat", "dock", "utilityProducts", "crewCount" ], "properties": { "dateTo": { "type": "string", "format": "date-time" }, "dateFrom": { "type": "string", "format": "date-time" }, "boat": { "type": "string", "format": "User\\Entity\\Boat id" }, "dock": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" }, "slip": { "type": "string", "format": "Harbor\\Entity\\HarborBridgePosition id" }, "utilityProducts": { "type": "array", "format": "[Harbor\\Entity\\HarborProduct\\Utility id]", "items": { "type": "string" } }, "freeCrewLimitReached": { "type": "boolean" }, "crewCount": { "type": "integer" }, "pricingType": { "type": "string" } }, "type": "object" }, "SailorPublicBookingOrderItemDTO": { "properties": { "id": { "title": "Order Item ID", "type": "string" }, "discountSource": { "type": "string" }, "discountType": { "type": "string" }, "totalDiscount": { "type": "string" }, "discountAmount": { "type": "string" }, "totalPrice": { "type": "string" }, "totalPriceBeforeDiscount": { "type": "string" }, "bookingId": { "type": "string" } }, "type": "object" }, "SailorCamperOrderItemForm": { "required": [ "price", "camperLot", "dateFrom", "dateTo", "plateNumber" ], "properties": { "price": { "type": "string" }, "camperLot": { "type": "string", "format": "Camper\\Entity\\CamperLot id" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "plateNumber": { "type": "string" }, "country": { "type": "string" } }, "type": "object" }, "SailorCraneOrderItemForm": { "required": [ "boat", "direction", "dateFrom", "dateTo", "upliftPeriod" ], "properties": { "boat": { "type": "string", "format": "User\\Entity\\Boat id" }, "bridge": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" }, "position": { "type": "string", "format": "Harbor\\Entity\\HarborBridgePosition id" }, "direction": { "type": "string", "enum": [ "up", "down" ] }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "upliftPeriod": { "type": "string", "enum": [ null, 5, 1, 2, 3, 4, 6 ] } }, "type": "object" }, "SailorCreditOrderItemForm": { "required": [ "amount" ], "properties": { "amount": { "type": "number" } }, "type": "object" }, "SailorOrderForm": { "required": [ "source" ], "properties": { "source": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "locale": { "type": "string" } }, "type": "object" }, "Order4": { "properties": { "currency": { "type": "string" }, "user": { "$ref": "#/components/schemas/User13" }, "status": { "type": "string" }, "orderNumber": { "type": "string" }, "harborClientId": { "type": "integer" }, "harborClient": { "$ref": "#/components/schemas/HarborClient11" }, "paymentId": { "title": "mapping for migration", "type": "integer" }, "completedAt": { "type": "string", "format": "date-time" }, "confirmedAt": { "type": "string", "format": "date-time" }, "confirmOn": { "title": "If set order will confirm on this date", "type": "string", "format": "date-time" }, "invoice": { "$ref": "#/components/schemas/Invoice10" }, "invoiceStatus": { "type": "string" }, "source": { "type": "string" }, "comment": { "type": "string" } }, "type": "object" }, "SailorPowerOrderItemForm": { "required": [ "powerPackage", "startDate", "qty", "autoRenewal" ], "properties": { "powerPackage": { "type": "string", "format": "Harbor\\Entity\\HarborProduct\\Power id" }, "startDate": { "type": "string", "format": "date" }, "qty": { "type": "integer" }, "autoRenewal": { "type": "boolean" } }, "type": "object" }, "SailorPublicOrderBookingForm": { "required": [ "dateTo", "dateFrom", "utilityProducts", "boatLength", "boatWidth", "boatDepth", "crewCount", "boatName", "boatCountry", "email" ], "properties": { "dateTo": { "type": "string", "format": "date-time" }, "dateFrom": { "type": "string", "format": "date-time" }, "utilityProducts": { "type": "array", "format": "[Harbor\\Entity\\HarborProduct\\Utility id]", "items": { "type": "string" } }, "freeCrewLimitReached": { "type": "boolean" }, "dock": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" }, "slip": { "type": "string", "format": "Harbor\\Entity\\HarborBridgePosition id" }, "boatLength": { "type": "number" }, "boatWidth": { "type": "number" }, "boatDepth": { "type": "number" }, "crewCount": { "type": "number" }, "boatName": { "type": "string" }, "boatModel": { "type": "string" }, "boatCountry": { "type": "string", "enum": [ "DK", "PL", "DE", "LT", "NO", "SE", "FR", "EE", "HR", "IT", "PT", "GB", "BD", "BE", "BF", "BG", "BA", "BB", "WF", "BL", "BM", "BN", "BO", "BH", "BI", "BJ", "BT", "JM", "BW", "WS", "BQ", "BR", "BS", "JE", "BY", "BZ", "RU", "RW", "RS", "TL", "RE", "TM", "TJ", "RO", "TK", "GW", "GU", "GT", "GS", "GR", "GQ", "GP", "JP", "GY", "GG", "GF", "GE", "GD", "GA", "SV", "GN", "GM", "GL", "GI", "GH", "OM", "TN", "JO", "HT", "HU", "HK", "HN", "VE", "PR", "PS", "PW", "SJ", "PY", "IQ", "PA", "PF", "PG", "PE", "PK", "PH", "PN", "PM", "ZM", "EH", "EG", "ZA", "EC", "VN", "SB", "ET", "SO", "ZW", "SA", "ES", "ER", "ME", "MD", "MG", "MF", "MA", "MC", "UZ", "MM", "ML", "MO", "MN", "MH", "MK", "MU", "MT", "MW", "MV", "MQ", "MP", "MS", "MR", "IM", "UG", "TZ", "MY", "MX", "IL", "IO", "SH", "FI", "FJ", "FK", "FM", "FO", "NI", "NL", "NA", "VU", "NC", "NE", "NF", "NG", "NZ", "NP", "NR", "NU", "CK", "XK", "CI", "CH", "CO", "CN", "CM", "CL", "CC", "CA", "CG", "CF", "CD", "CZ", "CY", "CX", "CR", "CW", "CU", "SZ", "SY", "KG", "KE", "SS", "SR", "KI", "KH", "KM", "ST", "SK", "KR", "SI", "KP", "KW", "SN", "SM", "SL", "SC", "KZ", "KY", "SG", "SD", "DO", "DM", "DJ", "VG", "YE", "DZ", "US", "UY", "YT", "UM", "LB", "LC", "LA", "TW", "TR", "LK", "LI", "LV", "TO", "LU", "LR", "LS", "TH", "TF", "TG", "TD", "TC", "LY", "VA", "VC", "AE", "AD", "AG", "AF", "AI", "VI", "IS", "IR", "AM", "AL", "AO", "AS", "AR", "AU", "AT", "AW", "IN", "AX", "AZ", "IE", "ID", "UA", "QA", "MZ" ] }, "isFreeharbor": { "type": "boolean" }, "email": { "type": "string" }, "phone": { "type": "string" }, "pricingType": { "type": "string" } }, "type": "object" }, "SailorPublicCamperOrderItemForm": { "required": [ "price", "camperLot", "dateFrom", "dateTo", "plateNumber" ], "properties": { "price": { "type": "string" }, "camperLot": { "type": "string", "format": "Camper\\Entity\\CamperLot id" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "plateNumber": { "type": "string" }, "country": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "type": "object" }, "SailorPublicPowerOrderItemForm": { "required": [ "powerPackage", "startDate", "qty", "email", "phone" ], "properties": { "powerPackage": { "type": "string", "format": "Harbor\\Entity\\HarborProduct\\Power id" }, "startDate": { "type": "string", "format": "date" }, "qty": { "type": "integer" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" }, "SailorPublicSlipwayOrderItemForm": { "required": [ "price", "dateFrom", "dateTo", "plateNumber" ], "properties": { "price": {}, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "country": { "type": "string" }, "plateNumber": { "type": "string" } }, "type": "object" }, "SailorWaitingListOrderItemForm": { "required": [ "boat", "product" ], "properties": { "boat": { "type": "string", "format": "User\\Entity\\Boat id" }, "product": { "type": "string", "format": "Harbor\\Entity\\HarborProduct\\WaitingList id" } }, "type": "object" }, "WaitingListOrderItemForm": { "required": [ "product" ], "properties": { "product": { "type": "string", "format": "Harbor\\Entity\\HarborProduct\\WaitingList id" } }, "type": "object" }, "ShopSettings": { "properties": { "enabledInHarbakiosk": { "type": "boolean" }, "enabledInPublicForm": { "type": "boolean" }, "includePaymentTermsInInvoices": { "type": "boolean" }, "sendOutOfStockNotifications": { "type": "boolean" }, "sendSmsNotifications": { "type": "boolean" }, "sendEmailNotifications": { "type": "boolean" }, "paymentTerms": { "type": "string" } }, "type": "object" }, "ShopSettingsForm": { "properties": { "enabledInHarbakiosk": { "type": "boolean" }, "enabledInPublicForm": { "type": "boolean" }, "includePaymentTermsInInvoices": { "type": "boolean" }, "sendOutOfStockNotifications": { "type": "boolean" }, "sendSmsNotifications": { "type": "boolean" }, "sendEmailNotifications": { "type": "boolean" }, "paymentTerms": { "type": "string" } }, "type": "object" }, "CurrentBookingDTO": { "properties": { "invoice": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "credited": { "type": "string" }, "paidOn": { "type": "string" } } } }, "harbor": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "timezone": { "type": "string" }, "country": { "type": "string" } }, "type": "object" }, "dock": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "slip": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "boat": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "country": { "type": "string" }, "homeHarbor": { "type": "string" }, "type": { "properties": { "name": { "type": "string" } }, "type": "object" }, "length": { "type": "string" }, "width": { "type": "string" } }, "type": "object" }, "user": { "properties": { "email": { "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "type": "object" }, "order": { "properties": { "id": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "cashBooking": { "type": "boolean" }, "status": { "type": "integer" }, "boatName": { "type": "string" }, "boatCountry": { "type": "string" }, "boatModel": { "type": "string" }, "userFullName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "boatLength": { "type": "string" }, "boatWidth": { "type": "string" }, "price": { "type": "string" }, "discount": { "type": "string" }, "harbaFee": { "type": "string" }, "currency": { "type": "string" }, "arrived": { "type": "boolean" }, "arrivedAt": { "type": "string", "format": "date-time" }, "departedAt": { "type": "string", "format": "date-time" }, "isFreeharbor": { "type": "boolean" }, "membershipName": { "type": "string" } }, "type": "object" }, "SailorBookingCurrentListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Booking" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "SailorBookingPastListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Booking" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "SailorBookingDetailsDTO": { "properties": { "utilities": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "code": { "type": "string" } } } }, "boat": { "properties": { "name": { "type": "string" }, "model": { "type": "string" } }, "type": "object" }, "harborId": { "type": "string" }, "dateFrom": { "type": "string" }, "dateTo": { "type": "string" }, "dock": { "type": "string" }, "slip": { "type": "string" }, "actCode": { "type": "integer" }, "harborAddress": { "type": "string" }, "harbormasterFullName": { "type": "string" }, "harborEmail": { "type": "string" }, "harborPhone": { "type": "string" }, "totalPrice": { "type": "number", "format": "float" }, "currency": { "type": "string" }, "status": { "type": "integer" }, "harborImage": { "type": "string" }, "pricingType": { "type": "string" } }, "type": "object" }, "SailorHarborDetailsForBookingDTO": { "properties": { "facilities": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "string" }, "type": { "type": "string" }, "chargedDaily": { "type": "boolean" } } } }, "harborId": { "type": "string" }, "currency": { "type": "string" }, "canBookInAdvance": { "type": "boolean" }, "canPayWhileInHarbor": { "type": "boolean" }, "oneDayOnly": { "type": "boolean" }, "cashOnly": { "type": "boolean" }, "hasFreeHarbor": { "type": "boolean" }, "freeCrewMemberCount": { "type": "integer" }, "crewMemberFeeType": { "type": "string" }, "requiresCrewMembers": { "type": "boolean" }, "localTaxType": { "type": "string" }, "localTax": { "type": "boolean" }, "hourlyBookingEnabled": { "type": "boolean" }, "bookingFormSettings": { "$ref": "#/components/schemas/SailorBookingFormSettingsDTO" } }, "type": "object" }, "SailorBookingForm": { "required": [ "dateTo", "dateFrom", "dock", "harbor", "facilities" ], "properties": { "dateTo": { "type": "string", "format": "date-time" }, "dateFrom": { "type": "string", "format": "date-time" }, "boat": { "type": "string", "format": "User\\Entity\\Boat id" }, "boatLength": { "type": "number" }, "boatWidth": { "type": "number" }, "boatDepth": { "type": "number" }, "boatMastHeight": { "type": "number" }, "hasFreeharborSelected": { "type": "boolean" }, "dock": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" }, "slip": { "type": "string", "format": "Harbor\\Entity\\HarborBridgePosition id" }, "harbor": { "type": "string", "format": "Harbor\\Entity\\Harbor id" }, "facilities": { "type": "array", "format": "[Harbor\\Entity\\HarborProduct\\Utility id]", "items": { "type": "string" } }, "freeCrewLimitReached": { "type": "boolean" }, "crewCount": { "type": "integer" }, "pricingType": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" }, "SailorBookingPriceDTO": { "properties": { "nights": { "type": "integer" }, "pricePerNight": { "type": "string" }, "stayPrice": { "type": "string" }, "frihavn": { "type": "string" }, "frihavnDiscount": { "type": "string" }, "localTax": { "type": "string" }, "facilitiesTotal": { "type": "string" }, "crewPrice": { "type": "string" }, "subTotal": { "type": "string" }, "total": { "type": "string" }, "discount": { "type": "string" }, "discountSource": { "type": "string" }, "discountType": { "type": "string" }, "discountAmount": { "type": "string" } }, "type": "object" }, "CardholderListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Cardholder5" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "CardholderForm": { "required": [ "status" ], "properties": { "status": { "type": "boolean" }, "accessManagerCardholder": { "$ref": "#/components/schemas/AccessManagerCardholderForm" } }, "type": "object" }, "Cardholder": { "properties": { "accessManagerCardholder": { "$ref": "#/components/schemas/AccessManagerCardholder2" }, "activeCardholderPowerProduct": { "$ref": "#/components/schemas/CardholderPowerProduct3" }, "status": { "type": "boolean" }, "externalId": { "type": "integer" }, "externalPinId": { "type": "integer" }, "powerProduct": { "$ref": "#/components/schemas/Power2" }, "autoRenewal": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "Cardholder2": { "properties": { "accessManagerCardholder": { "$ref": "#/components/schemas/AccessManagerCardholder3" }, "activeCardholderPowerProduct": { "$ref": "#/components/schemas/CardholderPowerProduct4" }, "status": { "type": "boolean" }, "externalId": { "type": "integer" }, "externalPinId": { "type": "integer" }, "powerProduct": { "$ref": "#/components/schemas/Power3" }, "autoRenewal": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "CardholderPowerProduct": { "properties": { "cardholder": { "$ref": "#/components/schemas/Cardholder6" }, "powerProduct": { "$ref": "#/components/schemas/Power4" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "consumedAmount": { "title": "Consumed amount in kWh.", "type": "number", "format": "double" }, "boughtAmount": { "title": "Bought amount in kWh.", "type": "number", "format": "double" }, "active": { "type": "boolean" }, "duration": { "type": "integer" }, "depleted": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "CardholderPowerProduct2": { "properties": { "cardholder": { "$ref": "#/components/schemas/Cardholder7" }, "powerProduct": { "$ref": "#/components/schemas/Power5" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "consumedAmount": { "title": "Consumed amount in kWh.", "type": "number", "format": "double" }, "boughtAmount": { "title": "Bought amount in kWh.", "type": "number", "format": "double" }, "active": { "type": "boolean" }, "duration": { "type": "integer" }, "depleted": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "PedestalListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Pedestal2" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "PedestalForm": { "required": [ "dock" ], "properties": { "dock": { "type": "string", "format": "Harbor\\Entity\\HarborBridge id" } }, "type": "object" }, "Pedestal": { "properties": { "name": { "type": "string" }, "dock": { "$ref": "#/components/schemas/HarborBridge8" }, "externalId": { "type": "integer" }, "status": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "PedestalStatusForm": { "required": [ "status" ], "properties": { "status": { "type": "boolean" } }, "type": "object" }, "PowerSetting": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor16" }, "url": { "type": "string" }, "username": { "type": "string" }, "tutorialUrl": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "PowerSettingForm": { "required": [ "url", "username", "password", "tutorialUrl" ], "properties": { "url": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "tutorialUrl": { "type": "string" } }, "type": "object" }, "PowerSettingTutorialForm": { "required": [ "tutorialUrl" ], "properties": { "tutorialUrl": { "type": "string" } }, "type": "object" }, "Power": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber3" }, "id": { "type": "integer" }, "type": { "type": "string" }, "kWhAmount": { "type": "integer" }, "duration": { "title": "duration in days for long term power packages", "type": "integer" } }, "type": "object" }, "SailorPublicEnableSocketForm": { "required": [ "email", "socket" ], "properties": { "email": { "type": "string" }, "socket": { "type": "string", "format": "Power\\Entity\\Socket id" } }, "type": "object" }, "SailorCardholderForm": { "required": [ "autoRenewal", "powerProduct" ], "properties": { "autoRenewal": { "type": "boolean" }, "powerProduct": { "type": "string", "format": "Harbor\\Entity\\HarborProduct\\Power id" } }, "type": "object" }, "SocketListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Socket2" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "SocketStatusForm": { "required": [ "status" ], "properties": { "status": { "type": "boolean" } }, "type": "object" }, "Socket": { "properties": { "pedestal": { "$ref": "#/components/schemas/Pedestal3" }, "name": { "type": "string" }, "externalId": { "type": "integer" }, "status": { "type": "boolean" }, "cardholder": { "$ref": "#/components/schemas/Cardholder8" }, "id": { "type": "string" } }, "type": "object" }, "SailorPowerLiteSubmissionForm": { "required": [ "customer", "toReading", "photo" ], "properties": { "customer": { "type": "string", "format": "PowerLite\\Entity\\PowerLiteCustomer id" }, "toReading": { "type": "string" }, "photo": {} }, "type": "object" }, "SailorSubscriptionHarborProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription6" } }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "Subscription": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor17" }, "id": { "type": "string" } }, "type": "object" }, "SailorSubscriptionViewModel": { "properties": { "subscriptions": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "details": { "type": "string" }, "price": { "type": "string" } }, "type": "object" } }, "harborContacts": { "properties": { "fullName": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" }, "harborTerms": { "type": "string" }, "currency": { "type": "string" } }, "type": "object" }, "SubscriptionInvoicableDatasetModel": { "properties": {}, "type": "object" }, "Subscription2": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor18" }, "harborClient": { "$ref": "#/components/schemas/HarborClient12" }, "subscriberId": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionProductSetting3" } }, "invoiceStatus": { "title": "Invoice status for quick checking", "type": "string" }, "active": { "title": "If subscription is active", "type": "boolean" }, "lastSubscribed": { "title": "Last time when contract was active", "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "Subscription3": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor19" }, "harborClient": { "$ref": "#/components/schemas/HarborClient13" }, "subscriberId": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionProductSetting4" } }, "invoiceStatus": { "title": "Invoice status for quick checking", "type": "string" }, "active": { "title": "If subscription is active", "type": "boolean" }, "lastSubscribed": { "title": "Last time when contract was active", "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "Subscription4": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor20" }, "harborClient": { "$ref": "#/components/schemas/HarborClient14" }, "subscriberId": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "active": { "title": "If subscription is active", "type": "boolean" }, "attachments": { "title": "What attachments belong to this subscription", "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionAttachment" } } }, "type": "object" }, "SubscriptionHistoryListOverview": { "properties": {}, "type": "object" }, "Invoice2": { "type": "object" }, "Invoice3": { "properties": { "hasPendingStripeCharge": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor21" }, "invoiceNumber": { "type": "integer" }, "debtorName": { "type": "string" }, "debtorEmail": { "type": "string" }, "debtorPhone": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "harborClientId": { "type": "integer" }, "currency": { "type": "string" }, "totalAmount": { "type": "number", "format": "double" }, "paidAmount": { "type": "number", "format": "double" }, "paidOn": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "publicToken": { "type": "string" }, "sentOn": { "type": "string", "format": "date-time" }, "sendInvoiceOn": { "type": "string", "format": "date-time" }, "pdfFilePath": { "type": "string" }, "status": { "type": "string" }, "creditNote": { "type": "boolean" }, "subscriberId": { "type": "string" }, "paymentId": { "title": "mapping for migration", "type": "integer" }, "order": { "$ref": "#/components/schemas/Order7" }, "type": { "type": "string" } }, "type": "object" }, "Subscription5": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber4" }, "capacity": { "type": "number", "format": "double" }, "productType": { "type": "string" }, "basePrice": { "type": "number", "format": "double" }, "vatPercent": { "type": "number", "format": "double" }, "referenceId": { "title": "mapping with old entity", "type": "integer" }, "recurrence": { "type": "string" } }, "type": "object" }, "SubscriptionProductSetting": { "properties": { "subscription": { "$ref": "#/components/schemas/Subscription7" }, "quantity": { "title": "Subscribed product amount.", "type": "integer" }, "dock": { "$ref": "#/components/schemas/HarborBridge9" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition5" }, "boat": { "$ref": "#/components/schemas/Boat7" }, "clientBoat": { "$ref": "#/components/schemas/HarborClientBoat7" }, "comment": { "title": "Field for product comments. Used for specifying additional info for storage, rack, custom and clubs", "type": "string" }, "startDate": { "title": "Date when this product becomes active for customer.", "type": "string", "format": "date-time" }, "expirationDate": { "title": "Date when this product completely expires for customer.", "type": "string", "format": "date-time" }, "capacity": { "title": "How much product requires space for rack subscription product", "type": "integer" }, "recurrenceSetting": { "$ref": "#/components/schemas/SubscriptionProductRecurrenceSetting" }, "discountSetting": { "$ref": "#/components/schemas/SubscriptionProductDiscountSetting" } }, "type": "object" }, "SubscriptionLog": { "properties": { "harborClient": { "$ref": "#/components/schemas/HarborClient15" }, "invoice": { "$ref": "#/components/schemas/Invoice11" }, "subscriptionProductSetting": { "$ref": "#/components/schemas/SubscriptionProductSetting5" }, "boatName": { "type": "string" }, "dockName": { "type": "string" }, "slipName": { "type": "string" }, "quantity": { "type": "string" }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "invoiceStatus": { "type": "string" }, "productType": { "type": "string" }, "price": { "type": "string" } }, "type": "object" }, "SubscriptionProductSetting2": { "properties": { "subscription": { "$ref": "#/components/schemas/Subscription8" }, "quantity": { "title": "Subscribed product amount.", "type": "integer" }, "dock": { "$ref": "#/components/schemas/HarborBridge10" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition6" }, "boat": { "$ref": "#/components/schemas/Boat8" }, "clientBoat": { "$ref": "#/components/schemas/HarborClientBoat8" }, "comment": { "title": "Field for product comments. Used for specifying additional info for storage, rack, custom and clubs", "type": "string" }, "startDate": { "title": "Date when this product becomes active for customer.", "type": "string", "format": "date-time" }, "capacity": { "title": "How much product requires space for rack subscription product", "type": "integer" }, "recurrenceSetting": { "$ref": "#/components/schemas/SubscriptionProductRecurrenceSetting2" }, "discountSetting": { "$ref": "#/components/schemas/SubscriptionProductDiscountSetting2" } }, "type": "object" }, "SailorSurveyDTO": { "properties": { "id": { "type": "string" }, "module": { "type": "string" }, "questions": { "type": "array", "items": { "$ref": "#/components/schemas/SailorSurveyQuestionDTO" } } }, "type": "object" }, "SailorSurveyAnswerDTO": { "properties": { "id": { "type": "string" }, "answers": { "type": "object", "additionalProperties": true } }, "type": "object" }, "HarborClientBoatDTO": { "properties": { "dimensions": { "type": "HarborClient\\DTO\\HarborClientBoat\\HarborClientBoatDimensionDTO" }, "id": { "type": "string" }, "name": { "type": "string" }, "year": { "type": "integer" }, "country": { "type": "string" }, "type": { "$ref": "#/components/schemas/BoatType5" }, "model": { "$ref": "#/components/schemas/BoatModel6" }, "plateNumber": { "type": "string" }, "hullNumber": { "type": "string" }, "registrationNumber": { "type": "string" }, "freeHarbor": { "type": "boolean" }, "image": { "type": "string" }, "callsign": { "type": "string" }, "insuranceCompany": { "type": "string" }, "insurancePolicyNumber": { "type": "string" }, "insuranceExpirationDate": { "type": "string", "format": "date-time" }, "insuranceFileLastUploadedAt": { "type": "string", "format": "date-time" }, "kasko": { "type": "boolean" }, "boatId": { "type": "string" }, "location": { "type": "string" } }, "type": "object" }, "HarborClientBoatListDTO": { "properties": { "clientBoats": { "type": "array", "items": { "$ref": "#/components/schemas/HarborClientBoatDTO" } } }, "type": "object" }, "HarborClientBoatForm": { "required": [ "name", "dimensions", "boat" ], "properties": { "name": { "type": "string" }, "year": { "type": "string" }, "country": { "type": "string" }, "type": { "type": "string", "format": "User\\Entity\\BoatType id" }, "model": { "type": "string", "format": "User\\Entity\\BoatModel id" }, "plateNumber": { "type": "string" }, "hullNumber": { "type": "string" }, "registrationNumber": { "type": "string" }, "callsign": { "type": "string" }, "freeHarbor": { "type": "boolean" }, "dimensions": { "$ref": "#/components/schemas/HarborClientBoatDimensionForm" }, "boat": { "$ref": "#/components/schemas/HarborClientBoatInsuranceForm" } }, "type": "object" }, "HarborClientBoatLocationForm": { "required": [ "location" ], "properties": { "location": { "type": "string" } }, "type": "object" }, "AccessManagerCardholder": { "properties": { "harborClient": { "$ref": "#/components/schemas/HarborClient16" }, "user": { "$ref": "#/components/schemas/User14" }, "harbor": { "$ref": "#/components/schemas/Harbor22" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "cards": { "type": "object", "additionalProperties": true }, "pin": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Cardholder3": { "type": "object" }, "Cardholder4": { "properties": { "accessManagerCardholder": { "$ref": "#/components/schemas/AccessManagerCardholder4" }, "activeCardholderPowerProduct": { "$ref": "#/components/schemas/CardholderPowerProduct5" }, "status": { "type": "boolean" }, "externalId": { "type": "integer" }, "externalPinId": { "type": "integer" }, "powerProduct": { "$ref": "#/components/schemas/Power6" }, "autoRenewal": { "type": "boolean" }, "activeSockets": { "type": "array", "items": { "$ref": "#/components/schemas/Socket3" } }, "id": { "type": "string" } }, "type": "object" }, "CraneDaySetting": { "properties": { "workFrom": { "type": "string" }, "workTo": { "type": "string" } }, "type": "object" }, "CraneTimeSetting": { "properties": { "weekday": { "type": "integer" }, "fromTime": { "type": "string" }, "toTime": { "type": "string" } }, "type": "object" }, "SailorCraneListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SailorCraneDTO" } }, "alias": { "type": "string" }, "qb": { "$ref": "#/components/schemas/QueryBuilder" }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "SailorCraneDTO": { "properties": { "id": { "type": "integer" }, "direction": { "type": "string" }, "status": { "type": "string" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "harborComment": { "type": "string" }, "harborDescription": { "type": "string" }, "harborName": { "type": "string" }, "harborId": { "type": "string" }, "harborImage": { "type": "string" }, "boat": { "type": "string" }, "cancelReason": { "type": "string" }, "dock": { "type": "string" }, "slip": { "type": "string" }, "upliftPeriod": { "type": "integer" } }, "type": "object" }, "SailorCraneSettingDTO": { "properties": { "note": { "type": "string" }, "minDaysBefore": { "type": "string" }, "dockRequired": { "type": "boolean" }, "showDockPicker": { "type": "boolean" }, "downliftPeriodRequired": { "type": "boolean" }, "nonWorkingDays": { "type": "object", "additionalProperties": true } }, "type": "object" }, "SailorCraneAvailableTimeDTO": { "properties": { "fromTime": { "type": "string" }, "toTime": { "type": "string" } }, "type": "object" }, "OpusSetting": { "properties": { "harborCode": { "type": "string" }, "municipality": { "title": "Referenced as user (bruger)", "type": "string" }, "cfcivilClaimTypeAccounts": { "title": "Claim type (95 \u2013 Fordringstype, CFCIVIL) mapping with account number", "type": "object", "additionalProperties": true }, "kfbadplClaimTypeAccounts": { "title": "Claim type (95 \u2013 Fordringstype, KFB\u00c5DPL) mapping with account number", "type": "object", "additionalProperties": true }, "dynamicClaimType": { "title": "for $kfbadplClaimTypeAccounts", "type": "string" }, "message": { "title": "45 \u2013 FaktTekst", "type": "object", "additionalProperties": true }, "paymentFetchingEnabled": { "type": "boolean" } }, "type": "object" }, "Prisme365SettingDTO": { "properties": { "dataProviderId": { "type": "string" }, "userNumber": { "type": "string" }, "areaNumber": { "type": "string" }, "claimType": { "type": "string" }, "emptyClaimTypeForAccountNumber": { "type": "string" } }, "type": "object" }, "BusinessCentralSettingDTO": { "properties": { "id": { "type": "string" }, "defaultCustomerNumber": { "type": "string" }, "tenantId": { "type": "string" }, "companyName": { "type": "string" }, "accessToken": { "type": "string" }, "journalNumber": { "type": "string" } }, "type": "object" }, "BetalingsServiceSetting": { "properties": { "cvrNumber": { "type": "integer" }, "pbsNumber": { "type": "integer" }, "creditorIdentification": { "type": "string" }, "subsystem": { "type": "string" }, "debtorGroupNumber": { "type": "string" } }, "type": "object" }, "SailorStripePaymentMethodListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/StripePaymentMethodDTO" } }, "alias": { "type": "string" }, "qb": { "$ref": "#/components/schemas/QueryBuilder" }, "total": { "type": "integer" }, "extra": { "type": "object", "additionalProperties": true } }, "type": "object" }, "AccountingCheckoutForm": { "required": [ "harborId", "orderNumber", "invoiceNumber", "amount", "currency" ], "properties": { "harborId": { "type": "string" }, "orderNumber": { "type": "string" }, "invoiceNumber": { "type": "string" }, "amount": { "type": "string" }, "currency": { "type": "string" }, "paymentMethodId": { "type": "string" } }, "type": "object" }, "AccountingStripeCountryDefaultFee": { "properties": { "country": { "type": "string" }, "cardFee": { "title": "amount of % for credit card application fee calculation", "type": "number", "format": "double" }, "achFee": { "title": "Amount money for ACH application fee", "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "AccountingStripeCountryDefaultFeeForm": { "required": [ "country", "cardFee", "achFee" ], "properties": { "country": { "type": "string" }, "cardFee": { "type": "string" }, "achFee": { "type": "string" } }, "type": "object" }, "InvoiceExportStatusDTO": { "properties": { "prisme365ExportDate": { "type": "string", "format": "date-time" }, "prisme365Exporter": { "type": "string" } }, "type": "object" }, "AccountingProductAccountNumber": { "properties": { "economicAccountNumber": { "type": "string" }, "opusAccountNumber": { "type": "string" }, "generalAccountNumber": { "type": "string" }, "businessCentralItemNumber": { "type": "string" }, "businessCentralVariantNumber": { "type": "string" }, "prisme365AccountNumber": { "type": "string" } }, "type": "object" }, "AccountingSetting": { "properties": { "nextInvoiceNumber": { "type": "integer" }, "kmdOpusEnabled": { "type": "boolean" }, "vismaEconomicEnabled": { "type": "boolean" }, "businessCentralEnabled": { "type": "boolean" }, "betalingsServiceEnabled": { "type": "boolean" }, "prisme365Enabled": { "type": "boolean" }, "generalAccountingEnabled": { "type": "boolean" }, "processingFeeEnabled": { "title": "2% processing fee", "type": "boolean" }, "paymentProvider": { "type": "string" }, "payoutPeriod": { "type": "string" }, "accountantEmails": { "type": "object", "additionalProperties": true }, "iban": { "title": "IBAN bank code to send payments to.", "type": "string" }, "registrationNumber": { "title": "Reg Number for bank accounts", "type": "string" }, "accountNumber": { "title": "kontoNr", "type": "string" }, "companyCode": { "type": "string" }, "vatCode": { "type": "string" }, "defaultVatPercent": { "type": "number", "format": "double" }, "bankAccountUpdatedOn": { "type": "string", "format": "date-time" }, "accountingPaymentMethodSetting": { "$ref": "#/components/schemas/AccountingPaymentMethodSetting" }, "feeSetting": { "$ref": "#/components/schemas/AccountingFeeSetting" }, "acceptBankPaymentsType": { "type": "string" }, "bankPaymentsCustomIban": { "title": "Custom filled in iban or something else in harbor settings for accepting bank payments", "type": "string" }, "stripeConnectedAccountId": { "type": "string" }, "stripeACHEnabled": { "title": "Enables Stripe ACH for US harbors.", "type": "boolean" }, "stripeDefaultCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripeDefaultAchFeeEnabled": { "title": "Should default ach fee be used.", "type": "boolean" }, "kioskDefaultFeeEnabled": { "title": "Should default kiosk fee be used.", "type": "boolean" }, "stripeCardFee": { "title": "Fee percentage for application fee amount", "type": "number", "format": "double" }, "stripeAchFee": { "title": "Fee amount in $ for ACH application fee amount", "type": "number", "format": "double" }, "kioskFee": { "title": "Fee amount in % for kiosk application fee amount", "type": "number", "format": "double" }, "defaultDueDateInterval": { "type": "integer" }, "vatPercentEnabled": { "type": "boolean" }, "createdInvoiceNotification": { "type": "boolean" }, "fiCodeEnabled": { "type": "boolean" }, "fiCodeCreditorNumber": { "type": "string" }, "fiCodeBankDetailsHidden": { "type": "boolean" }, "includeOnlyInvoiceID": { "type": "boolean" }, "companyName": { "type": "string" } }, "type": "object" }, "GeneralAccountNumberSetting": { "properties": { "bookingDefaultAccount": { "type": "integer" }, "subscriptionDefaultAccount": { "type": "integer" }, "camperDefaultAccount": { "type": "integer" }, "slipwayDefaultAccount": { "type": "integer" }, "craneDefaultAccount": { "type": "integer" }, "shopDefaultAccount": { "type": "integer" }, "powerDefaultAccount": { "type": "integer" }, "accessDefaultAccount": { "type": "integer" }, "waitingListDefaultAccount": { "type": "integer" } }, "type": "object" }, "VismaEconomicSetting": { "properties": { "grantToken": { "type": "string" }, "customerGroupNumber": { "type": "integer" }, "subscriberGroupNumber": { "type": "integer" }, "vatZoneNumber": { "type": "integer" }, "paymentTermsNumber": { "type": "integer" }, "journalNumber": { "type": "integer" }, "autoExport": { "type": "boolean" }, "accessControlDebitAccountNumber": { "type": "integer" }, "bookingDebitAccountNumber": { "type": "integer" }, "bookingCreditAccountNumber": { "type": "integer" }, "subscriptionDebitAccountNumber": { "type": "integer" }, "subscriptionCreditAccountNumber": { "type": "integer" }, "shopDebitAccountNumber": { "type": "integer" }, "shopCreditAccountNumber": { "type": "integer" }, "craneDebitAccountNumber": { "type": "integer" }, "craneCreditAccountNumber": { "type": "integer" }, "camperDebitAccountNumber": { "type": "integer" }, "waitingListDebitAccountNumber": { "type": "integer" }, "slipwayDebitAccountNumber": { "type": "integer" }, "powerDebitAccountNumber": { "type": "integer" }, "creditsDebitAccountNumber": { "type": "integer" }, "guestCustomerId": { "type": "integer" }, "harbaAssetAccount": { "type": "integer" }, "harbaFeeAccount": { "type": "integer" }, "cashAccount": { "type": "integer" }, "bankAccount": { "type": "integer" }, "mobilePayAccount": { "type": "integer" }, "chequeAccount": { "type": "integer" }, "creditCardAccount": { "type": "integer" }, "epayAccount": { "type": "integer" }, "betalingsServiceAccount": { "type": "integer" }, "netsAccount": { "type": "integer" }, "bankBalanceAccount": { "type": "integer" }, "bankBalanceDebitAccount": { "type": "integer" }, "bankBalanceCreditAccount": { "type": "integer" }, "cashBalanceAccount": { "type": "integer" }, "cashBalanceDebitAccount": { "type": "integer" }, "cashBalanceCreditAccount": { "type": "integer" }, "mobilePayBalanceAccount": { "type": "integer" }, "mobilePayBalanceDebitAccount": { "type": "integer" }, "mobilePayBalanceCreditAccount": { "type": "integer" }, "chequeBalanceAccount": { "type": "integer" }, "chequeBalanceDebitAccount": { "type": "integer" }, "chequeBalanceCreditAccount": { "type": "integer" } }, "type": "object" }, "SelfModel": { "properties": {}, "type": "object" }, "Invoice4": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor23" }, "debtorEmail": { "type": "string" }, "debtorCountry": { "type": "string" }, "debtorState": { "type": "string" }, "debtorPhone": { "type": "string" }, "subtotalAmount": { "type": "number", "format": "double" }, "vatAmount": { "type": "number", "format": "double" }, "user": { "$ref": "#/components/schemas/User15" }, "sentOn": { "type": "string", "format": "date-time" }, "sendInvoiceOn": { "type": "string", "format": "date-time" }, "harborMessage": { "type": "string" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" } }, "refundedInvoice": { "$ref": "#/components/schemas/Invoice12" }, "creditNotes": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice12" } } }, "type": "object" }, "InvoiceForm": { "required": [ "harbor", "invoiceDate", "dueDate", "currency", "locale", "orderId", "orderNumber", "invoiceLines", "paymentInstructions" ], "properties": { "user": { "type": "string", "format": "User\\Entity\\User id" }, "harbor": { "type": "string", "format": "Harbor\\Entity\\Harbor id" }, "debtorName": { "type": "string" }, "debtorEmail": { "type": "string" }, "debtorCountry": { "type": "string" }, "debtorAddress": { "type": "string" }, "debtorCity": { "type": "string" }, "debtorZip": { "type": "string" }, "debtorPhone": { "type": "string" }, "debtorCompanyCode": { "type": "string" }, "debtorVatCode": { "type": "string" }, "creditorName": { "type": "string" }, "creditorEmail": { "type": "string" }, "creditorCountry": { "type": "string" }, "creditorAddress": { "type": "string" }, "creditorCity": { "type": "string" }, "creditorZip": { "type": "string" }, "creditorPhone": { "type": "string" }, "creditorCvr": { "type": "string" }, "creditorVatCode": { "type": "string" }, "creditorLogoPath": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "currency": { "type": "string" }, "locale": { "type": "string" }, "invoiceNumber": { "type": "string" }, "harborClientId": { "type": "string" }, "registrationNumber": { "type": "string" }, "accountNumber": { "type": "string" }, "harborMessage": { "type": "string" }, "subscriberId": { "type": "string" }, "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineForm" } }, "paymentInstructions": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "Invoice5": { "properties": { "hasPendingStripeCharge": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor24" }, "invoiceNumber": { "type": "integer" }, "debtorName": { "type": "string" }, "debtorEmail": { "type": "string" }, "debtorCountry": { "type": "string" }, "debtorState": { "type": "string" }, "debtorPhone": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "harborClientId": { "type": "integer" }, "currency": { "type": "string" }, "subtotalAmount": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double" }, "paidAmount": { "type": "number", "format": "double" }, "vatAmount": { "type": "number", "format": "double" }, "paidOn": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/User16" }, "createdOn": { "type": "string", "format": "date-time" }, "publicToken": { "type": "string" }, "sentOn": { "type": "string", "format": "date-time" }, "sendInvoiceOn": { "type": "string", "format": "date-time" }, "pdfFilePath": { "type": "string" }, "status": { "type": "string" }, "harborMessage": { "type": "string" }, "creditNote": { "type": "boolean" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine2" } }, "refundedInvoice": { "$ref": "#/components/schemas/Invoice5" }, "creditNotes": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice5" } }, "subscriberId": { "type": "string" }, "paymentId": { "title": "mapping for migration", "type": "integer" }, "order": { "$ref": "#/components/schemas/Order8" }, "type": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClient": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "editedOn": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/User17" }, "editedBy": { "$ref": "#/components/schemas/User17" }, "deleted": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/User17" }, "harbor": { "$ref": "#/components/schemas/Harbor25" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" } }, "type": "object" }, "SendInvoicesForm": { "required": [ "invoices", "sendOnDate" ], "properties": { "invoices": { "type": "array", "format": "[Accounting\\Invoice\\Entity\\Invoice id]", "items": { "type": "string" } }, "sendOnDate": { "type": "string", "format": "date-time" }, "harborMessage": { "type": "string" } }, "type": "object" }, "UserInvoiceListProvider": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice13" } }, "nextYear": { "type": "integer" } }, "type": "object" }, "Invoice6": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor26" }, "invoiceNumber": { "type": "integer" }, "dueDate": { "type": "string", "format": "date-time" }, "currency": { "type": "string" }, "totalAmount": { "type": "number", "format": "double" }, "createdOn": { "type": "string", "format": "date-time" }, "publicToken": { "type": "string" }, "status": { "type": "string" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine3" } }, "order": { "$ref": "#/components/schemas/Order9" }, "id": { "type": "string" } }, "type": "object" }, "InvoiceBatch": { "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "HarborBridge": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "isGuest": { "type": "boolean" }, "deleted": { "type": "string", "format": "date-time" }, "lat": { "type": "string" }, "lon": { "type": "string" }, "degrees": { "type": "string" }, "isHiddenFromGuests": { "type": "boolean" } }, "type": "object" }, "HarborBridge2": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "isGuest": { "type": "boolean" }, "deleted": { "type": "string", "format": "date-time" }, "lat": { "type": "string" }, "lon": { "type": "string" }, "degrees": { "type": "string" }, "isHiddenFromGuests": { "type": "boolean" } }, "type": "object" }, "HarborBridge3": { "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "isGuest": { "type": "boolean" }, "deleted": { "type": "string", "format": "date-time" }, "lat": { "type": "string" }, "lon": { "type": "string" }, "degrees": { "type": "string" }, "isHiddenFromGuests": { "type": "boolean" } }, "type": "object" }, "HarborBridgeForm": { "required": [ "name", "isGuest", "type", "lat", "lon", "degrees", "isHiddenFromGuests" ], "properties": { "name": { "type": "string" }, "isGuest": { "type": "boolean" }, "type": { "type": "string", "enum": [ "dock", "mooring_ball" ] }, "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/CoordinatesType" } }, "lat": { "type": "string" }, "lon": { "type": "string" }, "degrees": { "type": "string" }, "positions": { "type": "array", "items": { "$ref": "#/components/schemas/HarborPositionCoordinatesType" } }, "isHiddenFromGuests": { "type": "boolean" } }, "type": "object" }, "HarborPositionCoordinatesType": { "required": [ "lat", "lon", "degrees" ], "properties": { "lat": { "type": "string" }, "lon": { "type": "string" }, "degrees": { "type": "string" } }, "type": "object" }, "HarborContractSetting": { "type": "object" }, "HarborContractSettingForm": { "required": [ "harborContractStatus", "isPayingHarbor", "recurringContractAmount", "currency", "paymentRecurrencePeriod", "berthLimit", "isGuestModuleEnabled", "isHarbakioskEnabled", "isSubscriptionModuleEnabled", "isShopModuleEnabled", "shopProductLimit", "isCraneModuleEnabled", "isMessagingModuleEnabled", "messagingSmsLimit", "messagingEmailLimit", "isAccessModuleEnabled", "accessDoorsAmount", "powerLiteModuleEnabled", "isPowerModuleEnabled", "powerPedestalAmount", "isWaitingListModuleEnabled", "isMapEnabled", "comment" ], "properties": { "harborContractStatus": { "type": "string", "enum": [ "free", "growth", "professional", "enterprise" ] }, "isPayingHarbor": { "type": "boolean" }, "recurringContractAmount": {}, "currency": { "type": "string" }, "paymentRecurrencePeriod": { "type": "string", "enum": [ "monthly", "quarterly", "yearly" ] }, "berthLimit": { "type": "integer" }, "isGuestModuleEnabled": { "type": "boolean" }, "isHarbakioskEnabled": { "type": "boolean" }, "isSubscriptionModuleEnabled": { "type": "boolean" }, "isShopModuleEnabled": { "type": "boolean" }, "shopProductLimit": { "type": "integer" }, "isCraneModuleEnabled": { "type": "boolean" }, "isMessagingModuleEnabled": { "type": "boolean" }, "messagingSmsLimit": { "type": "integer" }, "messagingEmailLimit": { "type": "integer" }, "isAccessModuleEnabled": { "type": "boolean" }, "accessDoorsAmount": { "type": "integer" }, "powerLiteModuleEnabled": { "type": "boolean" }, "isPowerModuleEnabled": { "type": "boolean" }, "powerPedestalAmount": { "type": "integer" }, "isWaitingListModuleEnabled": { "type": "boolean" }, "isMapEnabled": { "type": "boolean" }, "idVerificationEnabled": { "type": "boolean" }, "membershipModuleEnabled": { "type": "boolean" }, "comment": { "type": "string" } }, "type": "object" }, "HarborContractAttachmentForm": { "required": [ "file" ], "properties": { "file": {} }, "type": "object" }, "ProductCategory": { "properties": { "name": { "type": "string" }, "shopProductCategoryId": { "title": "mapping with old entity", "type": "integer" } }, "type": "object" }, "ProductCategoryForm": { "required": [ "name", "shopProductCategoryId" ], "properties": { "name": { "type": "string" }, "shopProductCategoryId": { "type": "number" } }, "type": "object" }, "AccountingSetting2": { "properties": { "nextInvoiceNumber": { "type": "integer" }, "kmdOpusEnabled": { "type": "boolean" }, "vismaEconomicEnabled": { "type": "boolean" }, "businessCentralEnabled": { "type": "boolean" }, "betalingsServiceEnabled": { "type": "boolean" }, "prisme365Enabled": { "type": "boolean" }, "generalAccountingEnabled": { "type": "boolean" }, "processingFeeEnabled": { "title": "2% processing fee", "type": "boolean" }, "paymentProvider": { "type": "string" }, "payoutPeriod": { "type": "string" }, "accountantEmails": { "type": "object", "additionalProperties": true }, "iban": { "title": "IBAN bank code to send payments to.", "type": "string" }, "registrationNumber": { "title": "Reg Number for bank accounts", "type": "string" }, "accountNumber": { "title": "kontoNr", "type": "string" }, "companyCode": { "type": "string" }, "vatCode": { "type": "string" }, "defaultVatPercent": { "type": "number", "format": "double" }, "bankAccountUpdatedOn": { "type": "string", "format": "date-time" }, "acceptBankPaymentsType": { "type": "string" }, "bankPaymentsCustomIban": { "title": "Custom filled in iban or something else in harbor settings for accepting bank payments", "type": "string" }, "stripeConnectedAccountId": { "type": "string" }, "stripeACHEnabled": { "title": "Enables Stripe ACH for US harbors.", "type": "boolean" }, "stripeDefaultCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripeDefaultAchFeeEnabled": { "title": "Should default ach fee be used.", "type": "boolean" }, "kioskDefaultFeeEnabled": { "title": "Should default kiosk fee be used.", "type": "boolean" }, "stripeCardFee": { "title": "Fee percentage for application fee amount", "type": "number", "format": "double" }, "stripeAchFee": { "title": "Fee amount in $ for ACH application fee amount", "type": "number", "format": "double" }, "kioskFee": { "title": "Fee amount in % for kiosk application fee amount", "type": "number", "format": "double" }, "defaultDueDateInterval": { "type": "integer" }, "vatPercentEnabled": { "type": "boolean" }, "createdInvoiceNotification": { "type": "boolean" }, "fiCodeEnabled": { "type": "boolean" }, "fiCodeCreditorNumber": { "type": "string" }, "fiCodeBankDetailsHidden": { "type": "boolean" }, "includeOnlyInvoiceID": { "type": "boolean" }, "companyName": { "type": "string" } }, "type": "object" }, "HarborContractSetting2": { "properties": { "harborContractStatus": { "type": "string" }, "isPayingHarbor": { "type": "boolean" }, "recurringContractAmount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "paymentRecurrencePeriod": { "type": "string" }, "berthLimit": { "type": "integer" }, "isGuestModuleEnabled": { "type": "boolean" }, "isHarbakioskEnabled": { "type": "boolean" }, "isSubscriptionModuleEnabled": { "type": "boolean" }, "isShopModuleEnabled": { "type": "boolean" }, "shopProductLimit": { "type": "integer" }, "isCraneModuleEnabled": { "type": "boolean" }, "isMessagingModuleEnabled": { "type": "boolean" }, "messagingSmsLimit": { "type": "integer" }, "messagingEmailLimit": { "type": "integer" }, "isAccessModuleEnabled": { "type": "boolean" }, "accessDoorsAmount": { "type": "integer" }, "powerLiteModuleEnabled": { "type": "boolean" }, "isPowerModuleEnabled": { "type": "boolean" }, "powerPedestalAmount": { "type": "integer" }, "isWaitingListModuleEnabled": { "type": "boolean" }, "isMapEnabled": { "type": "boolean" }, "idVerificationEnabled": { "type": "boolean" }, "membershipModuleEnabled": { "type": "boolean" }, "attachmentPath": { "type": "string" }, "comment": { "type": "string" } }, "type": "object" }, "HarborSettingPayment": { "properties": { "fiCodeEnabled": { "type": "boolean" }, "fiCodeKreditornummer": { "type": "string" }, "fiCodeHideBankDetails": { "type": "boolean" } }, "type": "object" }, "SailorPublicProductListDTO": { "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/SailorPublicProductDTO" } } }, "type": "object" }, "SailorBookableDockDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "hasBerths": { "type": "boolean" } }, "type": "object" }, "SailorDockDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "hasBerths": { "type": "boolean" } }, "type": "object" }, "PublicHarborListProvider": { "properties": { "data": { "type": "object", "additionalProperties": true } }, "type": "object" }, "PublicHarborDTO": { "type": "object" }, "SailorHarborPriceDTO": { "properties": { "lengthFrom": { "type": "string" }, "lengthTo": { "type": "string" }, "price": { "type": "string" } }, "type": "object" }, "SailorBookableSlipDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isAvailable": { "type": "boolean" }, "length": { "type": "number", "format": "float" }, "width": { "type": "number", "format": "float" }, "depth": { "type": "number", "format": "float" } }, "type": "object" }, "SailorSlipDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "IdentitySettingDTO": { "properties": { "contractSubscriberIdVerificationRequired": { "type": "boolean" }, "waitingListIdVerificationRequired": { "type": "boolean" }, "addressLookupEnabled": { "type": "boolean" }, "zipCodeRestrictionsEnabled": { "type": "boolean" } }, "type": "object" }, "IdentitySettingForm": { "properties": { "contractSubscriberIdVerificationRequired": { "type": "boolean" }, "waitingListIdVerificationRequired": { "type": "boolean" }, "addressLookupEnabled": { "type": "boolean" }, "zipCodeRestrictionsEnabled": { "type": "boolean" }, "zipCodeRestrictions": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "Harbor": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User4": { "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor2": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User5": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User6": { "type": "object" }, "HarborClient2": { "type": "object" }, "Boat5": { "type": "object" }, "HarborClientBoat": { "type": "object" }, "Harbor3": { "type": "object" }, "HarborBridge4": { "type": "object" }, "HarborBridgePosition": { "type": "object" }, "User7": { "type": "object" }, "Boat6": { "type": "object" }, "HarborClientBoat2": { "type": "object" }, "HarborBridge5": { "type": "object" }, "HarborBridgePosition2": { "type": "object" }, "CamperReservation2": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor27" }, "camperLot": { "$ref": "#/components/schemas/CamperLot2" }, "user": { "$ref": "#/components/schemas/User18" }, "dateFrom": { "type": "string", "format": "date-time" }, "dateTo": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "userFullName": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "plateNumber": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "country": { "type": "string" }, "paid": { "type": "boolean" }, "vatAmount": { "type": "number", "format": "double" }, "harborClient": { "$ref": "#/components/schemas/HarborClient17" }, "order": { "$ref": "#/components/schemas/Order10" }, "cashReservation": { "type": "boolean" }, "id": { "type": "integer" } }, "type": "object" }, "Harbor4": { "properties": { "image": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "CamperLot": { "properties": { "name": { "type": "string" }, "deleted": { "type": "boolean" }, "id": { "type": "integer" } }, "type": "object" }, "User8": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient3": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "Order5": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListOfferEntryDTO": { "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "berth": { "type": "string" }, "slip": { "type": "string" }, "length": { "type": "string" }, "width": { "type": "string" }, "depth": { "type": "string" }, "product": { "type": "string" }, "price": { "type": "string" } }, "type": "object" }, "PublicHarborGeneralDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "image": { "type": "string" }, "description": { "type": "string" }, "currency": { "type": "string" } }, "type": "object" }, "WaitingListPreferenceSettingDTO": { "properties": { "interestedForNextSeason": { "type": "boolean" }, "interestedInShortTerm": { "type": "boolean" } }, "type": "object" }, "HarborClientBoatMinimalDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "model": { "type": "string" }, "image": { "type": "string" }, "dimensions": { "$ref": "#/components/schemas/HarborClientBoatDimensionDTO" }, "boatId": { "type": "string" } }, "type": "object" }, "Harbor5": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient4": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "WaitingListCategory2": { "properties": { "id": { "type": "string" } }, "type": "object" }, "AccountingProductAccountNumber2": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "WaitingListCategory3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Harbor6": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListEntry5": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor28" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat9" }, "harborClient": { "$ref": "#/components/schemas/HarborClient18" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListPreference": { "$ref": "#/components/schemas/WaitingListPreference4" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory7" }, "entryOffers": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOfferEntry3" } }, "id": { "type": "string" } }, "type": "object" }, "Harbor7": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat4": { "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "image": { "type": "string" }, "callsign": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" }, "dimensions": { "$ref": "#/components/schemas/HarborClientBoatDimension" }, "location": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClient5": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "editedOn": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/User19" }, "editedBy": { "$ref": "#/components/schemas/User19" }, "deleted": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/User19" }, "harbor": { "$ref": "#/components/schemas/Harbor7" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense2" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "WaitingListPreference": { "properties": { "answeredAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "interestedLongTerm": { "type": "boolean" }, "interestedShortTerm": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListCategory4": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor7" }, "name": { "type": "string" }, "defaultCategory": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "Harbor8": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat5": { "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "image": { "type": "string" }, "callsign": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" }, "dimensions": { "$ref": "#/components/schemas/HarborClientBoatDimension2" }, "location": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClient6": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "editedOn": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/User20" }, "editedBy": { "$ref": "#/components/schemas/User20" }, "deleted": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/User20" }, "harbor": { "$ref": "#/components/schemas/Harbor8" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense3" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "WaitingListPreference2": { "properties": { "answeredAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "interestedLongTerm": { "type": "boolean" }, "interestedShortTerm": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListCategory5": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor8" }, "name": { "type": "string" }, "defaultCategory": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "Harbor9": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat6": { "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "image": { "type": "string" }, "callsign": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" }, "dimensions": { "$ref": "#/components/schemas/HarborClientBoatDimension3" }, "location": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClient7": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "editedOn": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/User21" }, "editedBy": { "$ref": "#/components/schemas/User21" }, "deleted": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/User21" }, "harbor": { "$ref": "#/components/schemas/Harbor9" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense4" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "WaitingListPreference3": { "properties": { "answeredAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "interestedLongTerm": { "type": "boolean" }, "interestedShortTerm": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListCategory6": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Harbor10": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Order6": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Harbor11": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborBridge6": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborBridgePosition3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListOfferEntry": { "properties": { "offer": { "$ref": "#/components/schemas/WaitingListOffer" }, "entry": { "$ref": "#/components/schemas/WaitingListEntry6" }, "status": { "type": "string" }, "price": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListOffer3": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor29" }, "createdAt": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "dock": { "$ref": "#/components/schemas/HarborBridge11" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition7" }, "comment": { "title": "Field for product comments. Used for specifying additional info for storage, rack, custom and clubs", "type": "string" }, "subscriptionStartDate": { "type": "string", "format": "date-time" }, "subscriptionExpirationDate": { "type": "string", "format": "date-time" }, "offerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOfferEntry4" } }, "id": { "type": "string" } }, "type": "object" }, "Harbor12": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborBridge7": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborBridgePosition4": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListOfferEntry2": { "properties": { "offer": { "$ref": "#/components/schemas/WaitingListOffer2" }, "entry": { "$ref": "#/components/schemas/WaitingListEntry7" }, "status": { "type": "string" }, "price": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "BoatType3": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "BoatModel4": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor13": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "BoatType4": { "type": "object" }, "BoatModel5": { "type": "object" }, "Harbor14": { "type": "object" }, "SailorBoatAttachmentUploadType": { "required": [ "file" ], "properties": { "file": {} }, "type": "object" }, "UserLicense": { "properties": { "hasLicense": { "type": "boolean" }, "licenseNumber": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "UserLicense2": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User9": { "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "image": { "type": "string" }, "rawImage": { "type": "string" }, "thumbImage": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "timezone": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "fullUser": { "type": "boolean" }, "username": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor15": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User10": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient8": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "Invoice7": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User11": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient9": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "OrderItem3": { "properties": { "harborProductId": { "type": "integer" }, "boatName": { "type": "string" }, "bridgeId": { "type": "string" }, "bridgeName": { "type": "string" }, "berthId": { "type": "string" }, "berthName": { "type": "string" }, "productModule": { "type": "string" }, "name": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "quantity2": { "type": "number", "format": "double" }, "basePrice": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "pricePerUnit2": { "type": "number", "format": "double" }, "pricingScheme": { "type": "string" }, "vatPercent": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "unit2": { "type": "string" }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "paymentLineId": { "title": "mapping for migration", "type": "string" }, "entityId": { "title": "Id from other module record like camper.id", "type": "string" }, "discountType": { "type": "string" }, "discountAmount": { "type": "number", "format": "double" }, "actualDiscount": { "title": "Deducted amount from price.", "type": "number", "format": "double" }, "discountSource": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Invoice8": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User12": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient10": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "Invoice9": { "properties": { "id": { "type": "string" } }, "type": "object" }, "InvoiceOptionsType": { "properties": { "invoiceDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date" }, "harborMessage": { "type": "string" }, "invoiceNumber": { "type": "number" }, "sendInvoice": { "type": "boolean" } }, "type": "object" }, "MarkInvoicesAsPaidForm": { "required": [ "paymentDate" ], "properties": { "invoices": { "type": "array", "format": "[Accounting\\Invoice\\Entity\\Invoice id]", "items": { "type": "string" } }, "paymentDate": { "type": "string", "format": "date-time" }, "transferType": { "type": "string" }, "transferComment": { "type": "string" }, "sendToCustomer": { "type": "boolean" } }, "type": "object" }, "MultipleInvoiceOptionsType": { "properties": { "invoiceDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date" }, "harborMessage": { "type": "string" } }, "type": "object" }, "User13": { "type": "object" }, "HarborClient11": { "type": "object" }, "Invoice10": { "type": "object" }, "Booking": { "properties": { "status": { "type": "integer" }, "dateFrom": { "title": "DBREFACTOR: name=\"date_from\", type=\"datetime\"", "type": "string", "format": "date-time" }, "dateTo": { "title": "DBREFACTOR: name=\"date_to\", type=\"datetime\"", "type": "string", "format": "date-time" }, "harbor": { "title": "DBREFACTOR: ORM\\JoinColumn(nullable=false)", "oneOf": [ { "$ref": "#/components/schemas/Harbor30" } ] }, "boat": { "$ref": "#/components/schemas/Boat9" }, "clientBoat": { "$ref": "#/components/schemas/HarborClientBoat10" } }, "type": "object" }, "SailorBookingFormSettingsDTO": { "properties": { "boatNameHidden": { "type": "boolean" }, "boatWidthHidden": { "type": "boolean" }, "boatLengthHidden": { "type": "boolean" }, "boatDraftHidden": { "type": "boolean" }, "phoneNumberHidden": { "type": "boolean" }, "boatModelRequired": { "type": "boolean" }, "dockRequired": { "type": "boolean" } }, "type": "object" }, "Cardholder5": { "properties": { "accessManagerCardholder": { "$ref": "#/components/schemas/AccessManagerCardholder5" }, "activeCardholderPowerProduct": { "$ref": "#/components/schemas/CardholderPowerProduct6" }, "status": { "type": "boolean" }, "externalId": { "type": "integer" }, "externalPinId": { "type": "integer" }, "powerProduct": { "$ref": "#/components/schemas/Power7" }, "autoRenewal": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "AccessManagerCardholderForm": { "properties": { "harborClient": { "type": "string", "format": "HarborClient\\Entity\\HarborClient id" }, "cards": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "AccessManagerCardholder2": { "properties": { "harborClient": { "$ref": "#/components/schemas/HarborClient19" }, "user": { "$ref": "#/components/schemas/User22" }, "harbor": { "$ref": "#/components/schemas/Harbor31" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "cards": { "type": "object", "additionalProperties": true }, "pin": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "CardholderPowerProduct3": { "properties": { "cardholder": { "$ref": "#/components/schemas/Cardholder" }, "powerProduct": { "$ref": "#/components/schemas/Power2" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "consumedAmount": { "title": "Consumed amount in kWh.", "type": "number", "format": "double" }, "boughtAmount": { "title": "Bought amount in kWh.", "type": "number", "format": "double" }, "active": { "type": "boolean" }, "duration": { "type": "integer" }, "depleted": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "Power2": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber5" }, "id": { "type": "integer" }, "type": { "type": "string" }, "kWhAmount": { "type": "integer" }, "duration": { "title": "duration in days for long term power packages", "type": "integer" } }, "type": "object" }, "AccessManagerCardholder3": { "properties": { "harborClient": { "$ref": "#/components/schemas/HarborClient20" }, "user": { "$ref": "#/components/schemas/User23" }, "harbor": { "$ref": "#/components/schemas/Harbor32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "cards": { "type": "object", "additionalProperties": true }, "pin": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "CardholderPowerProduct4": { "properties": { "cardholder": { "$ref": "#/components/schemas/Cardholder2" }, "powerProduct": { "$ref": "#/components/schemas/Power3" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "consumedAmount": { "title": "Consumed amount in kWh.", "type": "number", "format": "double" }, "boughtAmount": { "title": "Bought amount in kWh.", "type": "number", "format": "double" }, "active": { "type": "boolean" }, "duration": { "type": "integer" }, "depleted": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "Power3": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber6" }, "id": { "type": "integer" }, "type": { "type": "string" }, "kWhAmount": { "type": "integer" }, "duration": { "title": "duration in days for long term power packages", "type": "integer" } }, "type": "object" }, "Cardholder6": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Power4": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber7" }, "id": { "type": "integer" }, "type": { "type": "string" }, "kWhAmount": { "type": "integer" }, "duration": { "title": "duration in days for long term power packages", "type": "integer" } }, "type": "object" }, "Cardholder7": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Power5": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "Pedestal2": { "properties": { "name": { "type": "string" }, "dock": { "$ref": "#/components/schemas/HarborBridge12" }, "externalId": { "type": "integer" }, "status": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "HarborBridge8": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor16": { "properties": { "id": { "type": "string" } }, "type": "object" }, "AccountingProductAccountNumber3": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "Socket2": { "properties": { "pedestal": { "$ref": "#/components/schemas/Pedestal4" }, "name": { "type": "string" }, "externalId": { "type": "integer" }, "status": { "type": "boolean" }, "cardholder": { "$ref": "#/components/schemas/Cardholder9" }, "id": { "type": "string" } }, "type": "object" }, "Pedestal3": { "properties": { "name": { "type": "string" }, "dock": { "$ref": "#/components/schemas/HarborBridge13" }, "externalId": { "type": "integer" }, "status": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "Cardholder8": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Subscription6": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor33" }, "id": { "type": "string" } }, "type": "object" }, "Harbor17": { "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor18": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient12": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "SubscriptionProductSetting3": { "properties": { "subscription": { "$ref": "#/components/schemas/Subscription2" }, "quantity": { "title": "Subscribed product amount.", "type": "integer" }, "dock": { "$ref": "#/components/schemas/HarborBridge14" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition8" }, "boat": { "$ref": "#/components/schemas/Boat10" }, "clientBoat": { "$ref": "#/components/schemas/HarborClientBoat11" }, "comment": { "title": "Field for product comments. Used for specifying additional info for storage, rack, custom and clubs", "type": "string" }, "startDate": { "title": "Date when this product becomes active for customer.", "type": "string", "format": "date-time" }, "expirationDate": { "title": "Date when this product completely expires for customer.", "type": "string", "format": "date-time" }, "capacity": { "title": "How much product requires space for rack subscription product", "type": "integer" }, "recurrenceSetting": { "$ref": "#/components/schemas/SubscriptionProductRecurrenceSetting3" }, "discountSetting": { "$ref": "#/components/schemas/SubscriptionProductDiscountSetting3" }, "id": { "type": "string" } }, "type": "object" }, "Harbor19": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient13": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "user": { "$ref": "#/components/schemas/User24" }, "harbor": { "$ref": "#/components/schemas/Harbor19" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense5" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "SubscriptionProductSetting4": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Harbor20": { "type": "object" }, "HarborClient14": { "type": "object" }, "SubscriptionAttachment": { "type": "object" }, "Harbor21": { "type": "object" }, "Order7": { "type": "object" }, "AccountingProductAccountNumber4": { "type": "object" }, "Subscription7": { "type": "object" }, "HarborBridge9": { "type": "object" }, "HarborBridgePosition5": { "type": "object" }, "Boat7": { "type": "object" }, "HarborClientBoat7": { "type": "object" }, "SubscriptionProductRecurrenceSetting": { "type": "object" }, "SubscriptionProductDiscountSetting": { "type": "object" }, "HarborClient15": { "type": "object" }, "Invoice11": { "type": "object" }, "SubscriptionProductSetting5": { "type": "object" }, "Subscription8": { "type": "object" }, "HarborBridge10": { "type": "object" }, "HarborBridgePosition6": { "type": "object" }, "Boat8": { "type": "object" }, "HarborClientBoat8": { "type": "object" }, "SubscriptionProductRecurrenceSetting2": { "properties": { "recurring": { "title": "Some harbors want automatically recurring invoices, some want to be reminded.", "description": "When this checkbox is marked fields below appear:\n- autoCreateInvoice\n- autoSendInvoice\n- recurrenceStartDate\n- recurrencePeriod", "type": "boolean" }, "automaticInvoiceSendingEnabled": { "type": "boolean" }, "billingPeriods": { "title": "How many invoices should it send until stops", "type": "integer" }, "endlessBillingPeriods": { "type": "boolean" }, "billingDay": { "type": "integer" } }, "type": "object" }, "SubscriptionProductDiscountSetting2": { "properties": { "enabled": { "title": "If discount is enabled", "type": "boolean" }, "discountOccurence": { "title": "One time or recurring discount", "type": "string" }, "discountType": { "type": "string" }, "discountAmount": { "type": "number", "format": "double" } }, "type": "object" }, "SailorSurveyQuestionDTO": { "properties": { "id": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" }, "title": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SailorSurveyQuestionOptionDTO" } } }, "type": "object" }, "BoatType5": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "BoatModel6": { "properties": { "name": { "type": "string" }, "confirmed": { "type": "boolean" }, "mastHeight": { "type": "number", "format": "double" }, "id": { "type": "string" }, "width": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "depth": { "type": "number", "format": "double" } }, "type": "object" }, "HarborClientBoatDimensionForm": { "required": [ "draft", "length", "beam" ], "properties": { "draft": { "type": "number" }, "length": { "type": "number" }, "beam": { "type": "number" }, "mastHeight": { "type": "number" }, "weight": { "type": "number" } }, "type": "object" }, "HarborClientBoatInsuranceForm": { "properties": { "insuranceCompany": { "type": "string" }, "insurancePolicyNumber": { "type": "string" }, "kasko": { "type": "boolean" }, "insuranceExpirationDate": { "type": "string", "format": "date" } }, "type": "object" }, "HarborClient16": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "User14": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Harbor22": { "properties": { "id": { "type": "string" } }, "type": "object" }, "AccessManagerCardholder4": { "properties": { "id": { "type": "string" } }, "type": "object" }, "CardholderPowerProduct5": { "properties": { "cardholder": { "$ref": "#/components/schemas/Cardholder4" }, "powerProduct": { "$ref": "#/components/schemas/Power6" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "consumedAmount": { "title": "Consumed amount in kWh.", "type": "number", "format": "double" }, "boughtAmount": { "title": "Bought amount in kWh.", "type": "number", "format": "double" }, "active": { "type": "boolean" }, "duration": { "type": "integer" }, "depleted": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "Power6": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber8" }, "id": { "type": "integer" }, "type": { "type": "string" }, "kWhAmount": { "type": "integer" }, "duration": { "title": "duration in days for long term power packages", "type": "integer" } }, "type": "object" }, "Socket3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "QueryBuilder": { "properties": {}, "type": "object" }, "StripePaymentMethodDTO": { "properties": { "id": { "type": "string" }, "cardBrand": { "type": "string" }, "last4": { "type": "integer" }, "expirationMonth": { "type": "integer" }, "expirationYear": { "type": "integer" }, "approved": { "type": "boolean" }, "defaultPaymentSource": { "type": "boolean" }, "paymentMethodId": { "type": "string" } }, "type": "object" }, "AccountingPaymentMethodSetting": { "type": "object" }, "AccountingFeeSetting": { "properties": { "accountingSetting": { "$ref": "#/components/schemas/AccountingSetting" }, "stripeGuestCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripeGuestCardFee": { "type": "number", "format": "double" }, "stripeSubscriptionCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripeSubscriptionCardFee": { "title": "Fee percentage for application fee amount", "type": "number", "format": "double" }, "stripeCraneCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripeCraneCardFee": { "title": "Fee percentage for application fee amount", "type": "number", "format": "double" }, "stripeACTCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripeACTCardFee": { "title": "Fee percentage for application fee amount", "type": "number", "format": "double" }, "stripePowerCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripePowerCardFee": { "title": "Fee percentage for application fee amount", "type": "number", "format": "double" }, "stripeWaitingListCardFeeEnabled": { "title": "Should default credit card fee be used.", "type": "boolean" }, "stripeWaitingListCardFee": { "title": "Fee percentage for application fee amount", "type": "number", "format": "double" } }, "type": "object" }, "Harbor23": { "type": "object" }, "User15": { "type": "object" }, "InvoiceLine": { "properties": { "name": { "type": "string" }, "localName": { "title": "name in harbor locale", "type": "string" }, "quantity": { "type": "number", "format": "double" }, "quantity2": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "unit2": { "type": "string" }, "basePrice": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "pricePerUnit2": { "type": "number", "format": "double" }, "totalPriceBeforeVat": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" }, "vatPercent": { "type": "number", "format": "double" }, "entityId": { "title": "Id from other module record like camper.id", "type": "string" }, "entityModule": { "title": "Name of module that entity belongs to", "type": "string" }, "pricingScheme": { "type": "string" }, "boatName": { "type": "string" }, "discountType": { "type": "string" }, "discountAmount": { "type": "number", "format": "double" }, "actualDiscount": { "title": "Save deducted amount from price.", "type": "number", "format": "double" } }, "type": "object" }, "Invoice12": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor23" }, "debtorEmail": { "type": "string" }, "debtorCountry": { "type": "string" }, "debtorState": { "type": "string" }, "debtorPhone": { "type": "string" }, "subtotalAmount": { "type": "number", "format": "double" }, "vatAmount": { "type": "number", "format": "double" }, "user": { "$ref": "#/components/schemas/User15" }, "sentOn": { "type": "string", "format": "date-time" }, "sendInvoiceOn": { "type": "string", "format": "date-time" }, "harborMessage": { "type": "string" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" } }, "refundedInvoice": { "$ref": "#/components/schemas/Invoice12" }, "creditNotes": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice12" } } }, "type": "object" }, "InvoiceLineForm": { "required": [ "name", "quantity", "pricePerUnit", "totalPrice", "vatPercent", "entityId", "entityModule" ], "properties": { "name": { "type": "string" }, "quantity": { "type": "string" }, "unit": { "type": "string" }, "basePrice": { "type": "string" }, "pricePerUnit": { "type": "string" }, "totalPrice": { "type": "string" }, "vatPercent": { "type": "string" }, "entityId": { "type": "string" }, "entityModule": { "type": "string" }, "productId": { "type": "number" }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" } }, "type": "object" }, "Harbor24": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User16": { "properties": { "id": { "type": "string" } }, "type": "object" }, "InvoiceLine2": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Order8": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User17": { "type": "object" }, "Harbor25": { "type": "object" }, "HarborClientLicense": { "type": "object" }, "Invoice13": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor34" }, "invoiceNumber": { "type": "integer" }, "dueDate": { "type": "string", "format": "date-time" }, "currency": { "type": "string" }, "totalAmount": { "type": "number", "format": "double" }, "createdOn": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor26": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "InvoiceLine3": { "properties": { "name": { "type": "string" }, "totalPrice": { "type": "number", "format": "double" }, "periodFrom": { "type": "string", "format": "date-time" }, "periodTo": { "type": "string", "format": "date-time" }, "id": { "type": "string" } }, "type": "object" }, "Order9": { "properties": { "id": { "type": "string" } }, "type": "object" }, "CoordinatesType": { "required": [ "lat", "lng" ], "properties": { "lat": { "type": "string" }, "lng": { "type": "string" } }, "type": "object" }, "SailorPublicProductDTO": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "unit": { "type": "string" }, "price": { "type": "string" } }, "type": "object" }, "Harbor27": { "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "CamperLot2": { "properties": { "name": { "type": "string" }, "deleted": { "type": "boolean" }, "id": { "type": "integer" } }, "type": "object" }, "User18": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient17": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "Order10": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoatDimensionDTO": { "properties": { "id": { "type": "string" }, "draft": { "type": "string" }, "length": { "type": "string" }, "beam": { "type": "string" }, "mastHeight": { "type": "string" }, "weight": { "type": "string" } }, "type": "object" }, "Harbor28": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat9": { "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "image": { "type": "string" }, "callsign": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" }, "dimensions": { "$ref": "#/components/schemas/HarborClientBoatDimension4" }, "location": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClient18": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "editedOn": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/User25" }, "editedBy": { "$ref": "#/components/schemas/User25" }, "deleted": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/User25" }, "harbor": { "$ref": "#/components/schemas/Harbor28" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense6" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "WaitingListPreference4": { "properties": { "answeredAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "interestedLongTerm": { "type": "boolean" }, "interestedShortTerm": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListCategory7": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListOfferEntry3": { "properties": { "offer": { "$ref": "#/components/schemas/WaitingListOffer4" }, "entry": { "$ref": "#/components/schemas/WaitingListEntry8" }, "status": { "type": "string" }, "price": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "HarborClientBoatDimension": { "properties": { "draft": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "beam": { "type": "number", "format": "double" }, "mastHeight": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "User19": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientLicense2": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoatDimension2": { "properties": { "draft": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "beam": { "type": "number", "format": "double" }, "mastHeight": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "User20": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientLicense3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoatDimension3": { "properties": { "draft": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "beam": { "type": "number", "format": "double" }, "mastHeight": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "User21": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientLicense4": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListEntry6": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor11" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat12" }, "harborClient": { "$ref": "#/components/schemas/HarborClient21" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory8" }, "id": { "type": "string" } }, "type": "object" }, "Harbor29": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborBridge11": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborBridgePosition7": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListOfferEntry4": { "properties": { "offer": { "$ref": "#/components/schemas/WaitingListOffer5" }, "entry": { "$ref": "#/components/schemas/WaitingListEntry9" }, "status": { "type": "string" }, "price": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "WaitingListEntry7": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor12" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat13" }, "harborClient": { "$ref": "#/components/schemas/HarborClient22" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory9" }, "id": { "type": "string" } }, "type": "object" }, "Harbor30": { "properties": { "name": { "type": "string" }, "image": { "type": "string" } }, "type": "object" }, "Boat9": { "properties": { "name": { "type": "string" } }, "type": "object" }, "HarborClientBoat10": { "type": "object" }, "AccessManagerCardholder5": { "properties": { "harborClient": { "$ref": "#/components/schemas/HarborClient23" }, "user": { "$ref": "#/components/schemas/User26" }, "harbor": { "$ref": "#/components/schemas/Harbor35" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "cards": { "type": "object", "additionalProperties": true }, "pin": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "CardholderPowerProduct6": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Power7": { "properties": { "name": { "type": "string" }, "pricingScheme": { "type": "string" }, "pricePerUnit": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "accountingProductAccountNumber": { "$ref": "#/components/schemas/AccountingProductAccountNumber9" }, "id": { "type": "integer" }, "type": { "type": "string" }, "kWhAmount": { "type": "integer" }, "duration": { "title": "duration in days for long term power packages", "type": "integer" } }, "type": "object" }, "HarborClient19": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "User22": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Harbor31": { "properties": { "id": { "type": "string" } }, "type": "object" }, "AccountingProductAccountNumber5": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "HarborClient20": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "user": { "$ref": "#/components/schemas/User23" }, "harbor": { "$ref": "#/components/schemas/Harbor32" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense7" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "User23": { "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "image": { "type": "string" }, "rawImage": { "type": "string" }, "thumbImage": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "timezone": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "fullUser": { "type": "boolean" }, "username": { "type": "string" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor32": { "properties": { "id": { "type": "string" } }, "type": "object" }, "AccountingProductAccountNumber6": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "AccountingProductAccountNumber7": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "HarborBridge12": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Pedestal4": { "properties": { "name": { "type": "string" }, "dock": { "$ref": "#/components/schemas/HarborBridge15" }, "externalId": { "type": "integer" }, "status": { "type": "boolean" }, "id": { "type": "string" } }, "type": "object" }, "Cardholder9": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborBridge13": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "Harbor33": { "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborBridge14": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborBridgePosition8": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Boat10": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat11": { "properties": { "id": { "type": "string" } }, "type": "object" }, "SubscriptionProductRecurrenceSetting3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "SubscriptionProductDiscountSetting3": { "properties": { "id": { "type": "string" } }, "type": "object" }, "User24": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientLicense5": { "properties": { "id": { "type": "string" } }, "type": "object" }, "SailorSurveyQuestionOptionDTO": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "AccountingProductAccountNumber8": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "Harbor34": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClientBoatDimension4": { "properties": { "draft": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "beam": { "type": "number", "format": "double" }, "mastHeight": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "User25": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientLicense6": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListOffer4": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListEntry8": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor28" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat9" }, "harborClient": { "$ref": "#/components/schemas/HarborClient18" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListPreference": { "$ref": "#/components/schemas/WaitingListPreference4" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory7" }, "entryOffers": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOfferEntry3" } }, "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat12": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient21": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "WaitingListCategory8": { "properties": { "id": { "type": "string" } }, "type": "object" }, "WaitingListOffer5": { "properties": { "harbor": { "$ref": "#/components/schemas/Harbor29" }, "createdAt": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "dock": { "$ref": "#/components/schemas/HarborBridge11" }, "slip": { "$ref": "#/components/schemas/HarborBridgePosition7" }, "comment": { "title": "Field for product comments. Used for specifying additional info for storage, rack, custom and clubs", "type": "string" }, "subscriptionStartDate": { "type": "string", "format": "date-time" }, "subscriptionExpirationDate": { "type": "string", "format": "date-time" }, "offerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/WaitingListOfferEntry4" } }, "id": { "type": "string" } }, "type": "object" }, "WaitingListEntry9": { "properties": { "idVerified": { "type": "boolean" }, "harbor": { "$ref": "#/components/schemas/Harbor29" }, "harborClientBoat": { "$ref": "#/components/schemas/HarborClientBoat14" }, "harborClient": { "$ref": "#/components/schemas/HarborClient24" }, "waitingListEntryId": { "type": "string" }, "signUpDate": { "type": "string", "format": "date-time" }, "waitingListCategory": { "$ref": "#/components/schemas/WaitingListCategory10" }, "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat13": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient22": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "WaitingListCategory9": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClient23": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "User26": { "properties": { "id": { "type": "string" } }, "type": "object" }, "Harbor35": { "properties": { "id": { "type": "string" } }, "type": "object" }, "AccountingProductAccountNumber9": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "HarborClientLicense7": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborBridge15": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClientBoat14": { "properties": { "name": { "type": "string" }, "country": { "type": "string" }, "image": { "type": "string" }, "callsign": { "type": "string" }, "deleted": { "type": "string", "format": "date-time" }, "dimensions": { "$ref": "#/components/schemas/HarborClientBoatDimension5" }, "location": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "HarborClient24": { "properties": { "clientId": { "title": "Client ID for user in harbor", "type": "integer" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "title": "Denormalized full name for easier search", "type": "string" }, "phone": { "type": "string" }, "phone2": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "city": { "type": "string" }, "address": { "type": "string" }, "zipCode": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "editedOn": { "type": "string", "format": "date-time" }, "createdByUser": { "$ref": "#/components/schemas/User27" }, "editedBy": { "$ref": "#/components/schemas/User27" }, "deleted": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/User27" }, "harbor": { "$ref": "#/components/schemas/Harbor29" }, "harborTermsAccepted": { "type": "string", "format": "date-time" }, "isCompany": { "type": "boolean" }, "companyName": { "type": "string" }, "companyCode": { "type": "string" }, "companyVatCode": { "type": "string" }, "invoiceStatus": { "type": "string" }, "license": { "$ref": "#/components/schemas/HarborClientLicense8" }, "idVerified": { "type": "boolean" }, "idVerificationDate": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestedAt": { "type": "string", "format": "date-time" }, "lastIdVerificationRequestTrigger": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "WaitingListCategory10": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientBoatDimension5": { "properties": { "draft": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "beam": { "type": "number", "format": "double" }, "mastHeight": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "id": { "type": "string" } }, "type": "object" }, "User27": { "properties": { "id": { "type": "string" } }, "type": "object" }, "HarborClientLicense8": { "properties": { "id": { "type": "string" } }, "type": "object" } } } }