diff --git a/.gitignore b/.gitignore index 88aaf80..9343fc3 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,4 @@ dmypy.json /coverage.xml /.coverage +.DS_Store diff --git a/fixtures/longship_23-08-23.json b/fixtures/longship_23-08-23.json new file mode 100644 index 0000000..7c89953 --- /dev/null +++ b/fixtures/longship_23-08-23.json @@ -0,0 +1,15108 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Longship API", + "description": "Longship API for custom integrations.", + "termsOfService": "https://www.longship.io/terms", + "contact": { + "name": "Longship.IO", + "url": "https://longship.freshdesk.com/support/tickets/new", + "email": "support@longship.io" + }, + "license": { + "name": "MIT", + "url": "https://opensource.org/licenses/MIT" + }, + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.longship.io" + } + ], + "paths": { + "/v1/sessions/{id}": { + "get": { + "tags": [ + "sessions" + ], + "summary": "Gets the session.", + "description": "Gets the session base on the id.", + "operationId": "SessionGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sessionDto" + }, + "example": { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "transactionId": 0, + "ocppTransactionId": "string", + "connectorId": 0, + "sessionLocation": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "idTag": "string", + "startedByInfo": { + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "roamingPlatformType": "Hubject", + "authorizationState": "ApprovedByRemote", + "roamingPlatformConnectionId": "string", + "isGuestUsage": true + }, + "meterStartInWh": 0, + "sessionStart": "string", + "chargingPeriods": [ + { + "timestamp": "string", + "deltaKwh": 0, + "absoluteKwh": 0, + "price": 0 + } + ], + "chargingMeterValues": [ + { + "timestamp": "string", + "value": "string", + "measurand": "Energy.Active.Export.Register", + "unit": "Wh" + } + ], + "meterStopInWh": 0, + "sessionStop": "string", + "status": "ACTIVE", + "totalEnergyInKwh": 0, + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "tariffInfo": { + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "assertions": [ + { + "tariffType": "ReimbursementTariff", + "isTariffUsed": true, + "tariffResult": "string" + } + ] + }, + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "parkingTariff": 0, + "parkingStepSize": 0, + "delayInMinutes": 0 + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/locations/{id}": { + "get": { + "tags": [ + "locations" + ], + "summary": "Gets the location.", + "description": "Gets the location base on the id.", + "operationId": "LocationGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/locationDto" + }, + "example": { + "id": "string", + "country_code": "string", + "party_id": "string", + "publish": true, + "publish_allowed_to": [ + { + "uid": "string", + "type": "RFID", + "visual_number": "string", + "issuer": "string", + "group_id": "string" + } + ], + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "related_locations": [ + { + "latitude": "string", + "longitude": "string", + "name": { + "language": "string", + "text": "string" + } + } + ], + "parking_type": "ALONG_MOTORWAY", + "evses": [ + { + "id": "string", + "chargepointid": "string", + "latitude": 0, + "longitude": 0, + "uid": "string", + "evse_id": "string", + "status": "AVAILABLE", + "status_schedule": [ + { + "period_begin": "string", + "period_end": "string", + "status": "AVAILABLE" + } + ], + "capabilities": [ + "CHARGING_PROFILE_CAPABLE" + ], + "connectors": [ + { + "id": "string", + "standard": "CHADEMO", + "format": "SOCKET", + "power_type": "AC_1_PHASE", + "max_voltage": 0, + "max_amperage": 0, + "max_electric_power": 0, + "calc_max_electric_power": true, + "last_updated": "string" + } + ], + "floor_level": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "physical_reference": "string", + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "parking_restrictions": [ + "EV_ONLY" + ], + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "last_updated": "string" + } + ], + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "operator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "suboperator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "owner": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "facilities": [ + "HOTEL" + ], + "time_zone": "string", + "opening_times": { + "twentyfourseven": true, + "regular_hours": [ + { + "weekday": 0, + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_openings": [ + { + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_closings": [ + { + "period_begin": "string", + "period_end": "string" + } + ] + }, + "charging_when_closed": true, + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "energy_mix": { + "is_green_energy": true, + "energy_sources": [ + { + "source": "NUCLEAR", + "percentage": 0 + } + ], + "environ_impact": [ + { + "category": "NUCLEAR_WASTE", + "amount": 0 + } + ] + }, + "last_updated": "string", + "hasReimbursement": true, + "reimburseInfo": { + "type": "ORGANIZATIONUNIT", + "hasGuestUsage": true, + "hasGuestChargingReimbursementFee": true, + "countryCode": "string", + "partyId": "string", + "externalOrganizationUnitId": "string", + "externalOrganizationUnitName": "string", + "externalOrganizationUnitReference": "string", + "externalOrganizationUnitCode": "string", + "chargeCardEMAID": "string", + "chargeCardUID": "string", + "chargeCardIssuer": "string", + "tariffs": [ + { + "id": "string", + "dateCreated": "string", + "validFrom": "string", + "currency": "string", + "price": { + "excl_vat": 0, + "incl_vat": 0 + }, + "status": "PENDING" + } + ], + "bankDetails": [ + { + "bankaccount": "string", + "dateCreated": "string", + "validFrom": "string" + } + ], + "tariffDistributionId": "string", + "tariffDistributionHistory": [ + { + "id": "string", + "validFrom": "string" + } + ], + "ou": "string", + "ouId": "string", + "ouName": "string" + }, + "operatorId": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "externalReference1": "string", + "externalReference2": "string", + "externalReference3": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/chargepoint/{id}/status": { + "get": { + "tags": [ + "chargepoint status" + ], + "summary": "Gets the chargepointstatus.", + "description": "Gets the chargepointstatus base on the id.", + "operationId": "ChargepointStatusGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chargepointStatusDto" + }, + "example": { + "id": "string", + "displayName": "string", + "tenantId": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "timestamp": "string", + "connectivityStatus": "ONLINE", + "connectors": [ + { + "connectorNumber": 0, + "operationalStatus": "Available", + "timestamp": "string" + } + ], + "websocketConnected": "string", + "websocketDisconnected": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/chargepoints/{id}": { + "get": { + "tags": [ + "chargepoints" + ], + "summary": "Gets the chargepoint.", + "description": "Gets the chargepoint base on the id.", + "operationId": "ChargepointGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chargepointDto" + }, + "example": { + "id": "string", + "chargePointId": "string", + "dateDeleted": "string", + "displayName": "string", + "roamingName": "string", + "chargeBoxSerialNumber": "string", + "chargePointModel": "string", + "chargePointSerialNumber": "string", + "chargePointVendor": "string", + "firmwareVersion": "string", + "connectivityStatus": "ONLINE", + "iccid": "string", + "imsi": "string", + "meterSerialNumber": "string", + "meterType": "string", + "tenantId": "string", + "evses": [ + { + "evse_id": "string", + "connectors": [ + { + "id": "string", + "operationalStatus": "Available", + "standard": "CHADEMO", + "format": "SOCKET", + "powerType": "AC_1_PHASE", + "maxVoltage": 0, + "maxAmperage": 0, + "maxElectricPower": 0 + } + ] + } + ], + "isRoaming": true, + "hasGuestUsage": true, + "locationId": "string", + "allowAnyToken": true, + "dateCreated": "string", + "updated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "simCardNumber": "string", + "tokenGroups": [ + "string" + ], + "isNew": true, + "hasReimbursement": true, + "reimburseTariffId": "string", + "reimburseTariffName": "string", + "reimburseTariffPrice": 0, + "reimburseUID": "string", + "reimburseTokenId": "string", + "reimburseOU": "string", + "useTenantFee": true, + "maxCapacityInKw": 0 + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "put": { + "tags": [ + "chargepoints" + ], + "summary": "Updates a chargepoint.", + "description": "Updates a chargepoint.", + "operationId": "ChargepointPut", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The ChargepointPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chargepointPutDto" + }, + "example": { + "displayName": "string", + "roamingName": "string", + "allowAnyToken": true, + "ouCode": "string", + "tariffId": "string", + "simCardNumber": "string", + "isNew": true, + "maxCapacityInKw": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk,tariffeditor)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/cdrs/{id}": { + "get": { + "tags": [ + "cdrs" + ], + "summary": "Gets the cdr.", + "description": "Gets the cdr base on the id.", + "operationId": "CdrGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cdrDto" + }, + "example": { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "connectorId": 0, + "cdrLocation": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "startDatetime": "string", + "endDateTime": "string", + "sessionId": "string", + "token": "string", + "startedByInfo": { + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "roamingPlatformType": "Hubject", + "authorizationState": "ApprovedByRemote", + "roamingPlatformConnectionId": "string", + "isGuestUsage": true + }, + "totalEnergyInKwh": 0, + "totalTimeInHours": 0, + "chargingPeriods": [ + { + "timestamp": "string", + "deltaKwh": 0, + "absoluteKwh": 0, + "price": 0 + } + ], + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "localStartDateTime": "string", + "localEndDateTime": "string", + "approvalStatus": 0 + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,roamingadmin,basicuser,installer,helpdesk,developer,tariffeditor)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "patch": { + "tags": [ + "cdrs" + ], + "summary": "Patches the cdr.", + "description": "Patches the cdr based on the id.", + "operationId": "CdrPatch", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The CdrPatchDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cdrPatchDto" + }, + "example": { + "approvalStatus": 0 + } + } + } + }, + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cdrDto" + }, + "example": { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "connectorId": 0, + "cdrLocation": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "startDatetime": "string", + "endDateTime": "string", + "sessionId": "string", + "token": "string", + "startedByInfo": { + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "roamingPlatformType": "Hubject", + "authorizationState": "ApprovedByRemote", + "roamingPlatformConnectionId": "string", + "isGuestUsage": true + }, + "totalEnergyInKwh": 0, + "totalTimeInHours": 0, + "chargingPeriods": [ + { + "timestamp": "string", + "deltaKwh": 0, + "absoluteKwh": 0, + "price": 0 + } + ], + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "localStartDateTime": "string", + "localEndDateTime": "string", + "approvalStatus": 0 + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,roamingadmin,)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/reimbursementcdrs/{id}": { + "get": { + "tags": [ + "reimbursement" + ], + "summary": "Gets the ReimbursementCdr.", + "description": "Gets the ReimbursementCdr base on the id.", + "operationId": "ReimbursementCdrGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reimbursementCdrDto" + }, + "example": { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "connectorId": 0, + "locationId": "string", + "evseId": "string", + "location": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "startDatetime": "string", + "endDateTime": "string", + "sessionId": "string", + "startedByInfo": { + "idTag": "string", + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "authorizationState": "ApprovedByRemote", + "isGuestUsage": true + }, + "meterStartInWh": 0, + "meterStopInWh": 0, + "totalEnergyInKwh": 0, + "totalTimeInHours": 0, + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "reimburseTariffId": "string", + "reimburseTariffName": "string", + "reimburseTariffPrice": 0, + "reimburseTariffCalculated": true, + "reimbursePriceCalculatedOn": "string", + "bankAccount": "string", + "bankAccountCreatedOn": "string", + "bankAccountValidFrom": "string", + "reimburseTariffOriginalPrice": 0, + "hasGuestChargingReimbursementFee": true, + "reimburseTenantFee": 0, + "tenantFeeCalculated": true, + "tariffDistributionId": "string", + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "customerShare": 0, + "energyCompensation": 0, + "reimbursementCustomerShare": { + "customerShare": 0, + "energyCompensation": 0, + "tenantFee": 0 + }, + "localStartDateTime": "string", + "localEndDateTime": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,roamingadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/organizationalunits": { + "post": { + "tags": [ + "organizationunits" + ], + "summary": "Creates a organizationunit.", + "description": "Creates a new organizationunit.", + "operationId": "OrganizationUnitPost", + "requestBody": { + "description": "The OrganizationUnitPostDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organizationUnitPostDto" + }, + "example": { + "parentId": "string", + "name": "string", + "externalReference": "string", + "gridOwnerReference": "string", + "tenantReference": "string", + "customerReference": "string", + "address": "string", + "state": "string", + "country": "string", + "city": "string", + "houseNumber": "string", + "postalCode": "string", + "hotlinePhoneNumber": "string", + "companyEmail": "string", + "primaryContactperson": "string", + "primaryContactpersonEmail": "string", + "mspOuId": "string", + "mspOuName": "string", + "mspOuCode": "string", + "mspExternalId": "string", + "financialDetails": { + "beneficiaryName": "string", + "iban": "string", + "bic": "string" + } + } + } + } + }, + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + }, + "get": { + "tags": [ + "organizationunits" + ], + "summary": "Get a list of organizationunits.", + "description": "Get a paged list of organizationunits, taken the filters into account.", + "operationId": "GetAllOrganizationunits", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organizationUnitGetDtoArray" + }, + "example": [ + { + "id": "string", + "parentId": "string", + "name": "string", + "code": "string", + "externalReference": "string", + "gridOwnerReference": "string", + "tenantReference": "string", + "customerReference": "string", + "address": "string", + "state": "string", + "country": "string", + "city": "string", + "houseNumber": "string", + "postalCode": "string", + "hotlinePhoneNumber": "string", + "companyEmail": "string", + "primaryContactperson": "string", + "primaryContactpersonEmail": "string", + "directPaymentProfileId": "string", + "mspOuId": "string", + "mspOuName": "string", + "mspOuCode": "string", + "mspExternalId": "string", + "financialDetails": { + "beneficiaryName": "string", + "iban": "string", + "bic": "string" + } + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/organizationalunits/{id}": { + "get": { + "tags": [ + "organizationunits" + ], + "summary": "Gets the organizationunit.", + "description": "Gets the organizationunit base on the id.", + "operationId": "OrganizationUnitGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organizationUnitGetDto" + }, + "example": { + "id": "string", + "parentId": "string", + "name": "string", + "code": "string", + "externalReference": "string", + "gridOwnerReference": "string", + "tenantReference": "string", + "customerReference": "string", + "address": "string", + "state": "string", + "country": "string", + "city": "string", + "houseNumber": "string", + "postalCode": "string", + "hotlinePhoneNumber": "string", + "companyEmail": "string", + "primaryContactperson": "string", + "primaryContactpersonEmail": "string", + "directPaymentProfileId": "string", + "mspOuId": "string", + "mspOuName": "string", + "mspOuCode": "string", + "mspExternalId": "string", + "financialDetails": { + "beneficiaryName": "string", + "iban": "string", + "bic": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "put": { + "tags": [ + "organizationunits" + ], + "summary": "Updates a organizationunit.", + "description": "Updates a organizationunit.", + "operationId": "OrganizationUnitPut", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The OrganizationUnitPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organizationUnitPutDto" + }, + "example": { + "name": "string", + "externalReference": "string", + "gridOwnerReference": "string", + "tenantReference": "string", + "customerReference": "string", + "address": "string", + "state": "string", + "country": "string", + "city": "string", + "houseNumber": "string", + "postalCode": "string", + "hotlinePhoneNumber": "string", + "companyEmail": "string", + "primaryContactperson": "string", + "primaryContactpersonEmail": "string", + "mspOuId": "string", + "mspOuName": "string", + "mspOuCode": "string", + "mspExternalId": "string", + "financialDetails": { + "beneficiaryName": "string", + "iban": "string", + "bic": "string" + } + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "200": { + "description": "Request was successful.", + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/locations": { + "put": { + "tags": [ + "locations" + ], + "summary": "Updates a location.", + "description": "Updates a location.", + "operationId": "LocationPut", + "requestBody": { + "description": "The LocationPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/locationPutDto" + }, + "example": { + "id": "string", + "country_code": "string", + "party_id": "string", + "publish": true, + "publish_allowed_to": [ + { + "uid": "string", + "type": "RFID", + "visual_number": "string", + "issuer": "string", + "group_id": "string" + } + ], + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "related_locations": [ + { + "latitude": "string", + "longitude": "string", + "name": { + "language": "string", + "text": "string" + } + } + ], + "parking_type": "ALONG_MOTORWAY", + "evses": [ + { + "id": "string", + "chargepointid": "string", + "latitude": 0, + "longitude": 0, + "uid": "string", + "evse_id": "string", + "status": "AVAILABLE", + "status_schedule": [ + { + "period_begin": "string", + "period_end": "string", + "status": "AVAILABLE" + } + ], + "capabilities": [ + "CHARGING_PROFILE_CAPABLE" + ], + "connectors": [ + { + "id": "string", + "standard": "CHADEMO", + "format": "SOCKET", + "power_type": "AC_1_PHASE", + "max_voltage": 0, + "max_amperage": 0, + "max_electric_power": 0, + "calc_max_electric_power": true, + "last_updated": "string" + } + ], + "floor_level": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "physical_reference": "string", + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "parking_restrictions": [ + "EV_ONLY" + ], + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "last_updated": "string" + } + ], + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "operator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "suboperator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "owner": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "facilities": [ + "HOTEL" + ], + "time_zone": "string", + "opening_times": { + "twentyfourseven": true, + "regular_hours": [ + { + "weekday": 0, + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_openings": [ + { + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_closings": [ + { + "period_begin": "string", + "period_end": "string" + } + ] + }, + "charging_when_closed": true, + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "energy_mix": { + "is_green_energy": true, + "energy_sources": [ + { + "source": "NUCLEAR", + "percentage": 0 + } + ], + "environ_impact": [ + { + "category": "NUCLEAR_WASTE", + "amount": 0 + } + ] + }, + "last_updated": "string", + "hasReimbursement": true, + "reimburseInfo": { + "type": "ORGANIZATIONUNIT", + "hasGuestUsage": true, + "hasGuestChargingReimbursementFee": true, + "countryCode": "string", + "partyId": "string", + "externalOrganizationUnitId": "string", + "externalOrganizationUnitName": "string", + "externalOrganizationUnitReference": "string", + "externalOrganizationUnitCode": "string", + "chargeCardEMAID": "string", + "chargeCardUID": "string", + "chargeCardIssuer": "string", + "tariffs": [ + { + "id": "string", + "dateCreated": "string", + "validFrom": "string", + "currency": "string", + "price": { + "excl_vat": 0, + "incl_vat": 0 + }, + "status": "PENDING" + } + ], + "bankDetails": [ + { + "bankaccount": "string", + "dateCreated": "string", + "validFrom": "string" + } + ], + "tariffDistributionId": "string", + "tariffDistributionHistory": [ + { + "id": "string", + "validFrom": "string" + } + ], + "ou": "string", + "ouId": "string", + "ouName": "string" + }, + "ou": "string", + "ouId": "string", + "ouName": "string", + "externalReference1": "string", + "externalReference2": "string", + "externalReference3": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "content": { + "application/json": {} + } + } + } + }, + "post": { + "tags": [ + "locations" + ], + "summary": "Creates a location.", + "description": "Creates a new location.", + "operationId": "LocationPost", + "requestBody": { + "description": "The LocationPostDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/locationPostDto" + }, + "example": { + "id": "string", + "street": "string", + "city": "string", + "country": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "timezone": "string", + "publish": true, + "publishAllowedTo": [ + { + "uid": "string", + "type": "RFID", + "visual_number": "string", + "issuer": "string", + "group_id": "string" + } + ], + "name": "string", + "houseNumber": "string", + "postalCode": "string", + "state": "string", + "hotlinePhonenumber": "string", + "relatedLocations": [ + { + "latitude": "string", + "longitude": "string", + "name": { + "language": "string", + "text": "string" + } + } + ], + "parkingType": "ALONG_MOTORWAY", + "evses": [ + { + "id": "string", + "chargepointid": "string", + "latitude": 0, + "longitude": 0, + "uid": "string", + "evse_id": "string", + "status": "AVAILABLE", + "status_schedule": [ + { + "period_begin": "string", + "period_end": "string", + "status": "AVAILABLE" + } + ], + "capabilities": [ + "CHARGING_PROFILE_CAPABLE" + ], + "connectors": [ + { + "id": "string", + "standard": "CHADEMO", + "format": "SOCKET", + "power_type": "AC_1_PHASE", + "max_voltage": 0, + "max_amperage": 0, + "max_electric_power": 0, + "calc_max_electric_power": true, + "last_updated": "string" + } + ], + "floor_level": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "physical_reference": "string", + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "parking_restrictions": [ + "EV_ONLY" + ], + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "last_updated": "string" + } + ], + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "operator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "suboperator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "owner": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "facilities": [ + "HOTEL" + ], + "openingTimes": { + "twentyfourseven": true, + "regular_hours": [ + { + "weekday": 0, + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_openings": [ + { + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_closings": [ + { + "period_begin": "string", + "period_end": "string" + } + ] + }, + "chargingWhenClosed": true, + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "energyMix": { + "is_green_energy": true, + "energy_sources": [ + { + "source": "NUCLEAR", + "percentage": 0 + } + ], + "environ_impact": [ + { + "category": "NUCLEAR_WASTE", + "amount": 0 + } + ] + }, + "hasReimbursement": true, + "reimburseInfo": { + "type": "ORGANIZATIONUNIT", + "hasGuestUsage": true, + "hasGuestChargingReimbursementFee": true, + "countryCode": "string", + "partyId": "string", + "externalOrganizationUnitId": "string", + "externalOrganizationUnitName": "string", + "externalOrganizationUnitReference": "string", + "externalOrganizationUnitCode": "string", + "chargeCardEMAID": "string", + "chargeCardUID": "string", + "chargeCardIssuer": "string", + "tariffs": [ + { + "id": "string", + "dateCreated": "string", + "validFrom": "string", + "currency": "string", + "price": { + "excl_vat": 0, + "incl_vat": 0 + }, + "status": "PENDING" + } + ], + "bankDetails": [ + { + "bankaccount": "string", + "dateCreated": "string", + "validFrom": "string" + } + ], + "tariffDistributionId": "string", + "tariffDistributionHistory": [ + { + "id": "string", + "validFrom": "string" + } + ], + "ou": "string", + "ouId": "string", + "ouName": "string" + }, + "operatorId": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "externalReference1": "string", + "externalReference2": "string", + "externalReference3": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "409": { + "description": "Resource with this id already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + }, + "get": { + "tags": [ + "locations" + ], + "summary": "Get a list of locations.", + "description": "Get a paged list of locations, taken the filters into account.", + "operationId": "GetAllLocations", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "Orders the resultset by the property.", + "schema": { + "enum": [ + "name", + "address", + "ouname" + ], + "type": "string", + "default": "name" + } + }, + { + "name": "descending", + "in": "query", + "description": "When true, orders resultset descending.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/locationDtoArray" + }, + "example": [ + { + "id": "string", + "country_code": "string", + "party_id": "string", + "publish": true, + "publish_allowed_to": [ + { + "uid": "string", + "type": "RFID", + "visual_number": "string", + "issuer": "string", + "group_id": "string" + } + ], + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "related_locations": [ + { + "latitude": "string", + "longitude": "string", + "name": { + "language": "string", + "text": "string" + } + } + ], + "parking_type": "ALONG_MOTORWAY", + "evses": [ + { + "id": "string", + "chargepointid": "string", + "latitude": 0, + "longitude": 0, + "uid": "string", + "evse_id": "string", + "status": "AVAILABLE", + "status_schedule": [ + { + "period_begin": "string", + "period_end": "string", + "status": "AVAILABLE" + } + ], + "capabilities": [ + "CHARGING_PROFILE_CAPABLE" + ], + "connectors": [ + { + "id": "string", + "standard": "CHADEMO", + "format": "SOCKET", + "power_type": "AC_1_PHASE", + "max_voltage": 0, + "max_amperage": 0, + "max_electric_power": 0, + "calc_max_electric_power": true, + "last_updated": "string" + } + ], + "floor_level": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "physical_reference": "string", + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "parking_restrictions": [ + "EV_ONLY" + ], + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "last_updated": "string" + } + ], + "directions": [ + { + "language": "string", + "text": "string" + } + ], + "operator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "suboperator": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "owner": { + "name": "string", + "website": "string", + "image": { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + }, + "facilities": [ + "HOTEL" + ], + "time_zone": "string", + "opening_times": { + "twentyfourseven": true, + "regular_hours": [ + { + "weekday": 0, + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_openings": [ + { + "period_begin": "string", + "period_end": "string" + } + ], + "exceptional_closings": [ + { + "period_begin": "string", + "period_end": "string" + } + ] + }, + "charging_when_closed": true, + "images": [ + { + "url": "string", + "thumbnail": "string", + "category": "CHARGER", + "type": "string", + "width": 0, + "height": 0 + } + ], + "energy_mix": { + "is_green_energy": true, + "energy_sources": [ + { + "source": "NUCLEAR", + "percentage": 0 + } + ], + "environ_impact": [ + { + "category": "NUCLEAR_WASTE", + "amount": 0 + } + ] + }, + "last_updated": "string", + "hasReimbursement": true, + "reimburseInfo": { + "type": "ORGANIZATIONUNIT", + "hasGuestUsage": true, + "hasGuestChargingReimbursementFee": true, + "countryCode": "string", + "partyId": "string", + "externalOrganizationUnitId": "string", + "externalOrganizationUnitName": "string", + "externalOrganizationUnitReference": "string", + "externalOrganizationUnitCode": "string", + "chargeCardEMAID": "string", + "chargeCardUID": "string", + "chargeCardIssuer": "string", + "tariffs": [ + { + "id": "string", + "dateCreated": "string", + "validFrom": "string", + "currency": "string", + "price": { + "excl_vat": 0, + "incl_vat": 0 + }, + "status": "PENDING" + } + ], + "bankDetails": [ + { + "bankaccount": "string", + "dateCreated": "string", + "validFrom": "string" + } + ], + "tariffDistributionId": "string", + "tariffDistributionHistory": [ + { + "id": "string", + "validFrom": "string" + } + ], + "ou": "string", + "ouId": "string", + "ouName": "string" + }, + "operatorId": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "externalReference1": "string", + "externalReference2": "string", + "externalReference3": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/sessions": { + "get": { + "tags": [ + "sessions" + ], + "summary": "Get a list of sessions.", + "description": "Get a paged list of sessions, taken the filters into account.", + "operationId": "GetAllSessions", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + }, + { + "name": "connectorNumber", + "in": "query", + "description": "Format - int32. Only data from this connector will be returned.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "chargepointId", + "in": "query", + "description": "Only data from this chargepoint will be returned.", + "schema": { + "type": "string" + } + }, + { + "name": "runningOnly", + "in": "query", + "description": "A flag indicating to only return data that is running.", + "schema": { + "type": "boolean" + } + }, + { + "name": "completedOnly", + "in": "query", + "description": "A flag indicating to only return data that is completed", + "schema": { + "type": "boolean" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "Orders the resultset by the property.", + "schema": { + "enum": [ + "start", + "stop" + ], + "type": "string", + "default": "start" + } + }, + { + "name": "descending", + "in": "query", + "description": "When true, orders resultset descending.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sessionDtoArray" + }, + "example": [ + { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "transactionId": 0, + "ocppTransactionId": "string", + "connectorId": 0, + "sessionLocation": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "idTag": "string", + "startedByInfo": { + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "roamingPlatformType": "Hubject", + "authorizationState": "ApprovedByRemote", + "roamingPlatformConnectionId": "string", + "isGuestUsage": true + }, + "meterStartInWh": 0, + "sessionStart": "string", + "chargingPeriods": [ + { + "timestamp": "string", + "deltaKwh": 0, + "absoluteKwh": 0, + "price": 0 + } + ], + "chargingMeterValues": [ + { + "timestamp": "string", + "value": "string", + "measurand": "Energy.Active.Export.Register", + "unit": "Wh" + } + ], + "meterStopInWh": 0, + "sessionStop": "string", + "status": "ACTIVE", + "totalEnergyInKwh": 0, + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "tariffInfo": { + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "assertions": [ + { + "tariffType": "ReimbursementTariff", + "isTariffUsed": true, + "tariffResult": "string" + } + ] + }, + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "parkingTariff": 0, + "parkingStepSize": 0, + "delayInMinutes": 0 + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/reimbursementcdrs": { + "get": { + "tags": [ + "reimbursement" + ], + "summary": "Get a list of reimbursementcdrs.", + "description": "Get a paged list of reimbursementcdrs, taken the filters into account.", + "operationId": "GetAllReimbursementcdrs", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + }, + { + "name": "providerexclude", + "in": "query", + "description": "Excludes any provider from the results, use comma separated string (eg. NLLON,NLDEF).", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "Orders the resultset by the property.", + "schema": { + "enum": [ + "startdatetime", + "enddatetime" + ], + "type": "string", + "default": "startdatetime" + } + }, + { + "name": "descending", + "in": "query", + "description": "When true, orders resultset descending.", + "schema": { + "type": "boolean" + } + }, + { + "name": "from", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources from created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "to", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources to created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reimbursementCdrDtoArray" + }, + "example": [ + { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "connectorId": 0, + "locationId": "string", + "evseId": "string", + "location": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "startDatetime": "string", + "endDateTime": "string", + "sessionId": "string", + "startedByInfo": { + "idTag": "string", + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "authorizationState": "ApprovedByRemote", + "isGuestUsage": true + }, + "meterStartInWh": 0, + "meterStopInWh": 0, + "totalEnergyInKwh": 0, + "totalTimeInHours": 0, + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "reimburseTariffId": "string", + "reimburseTariffName": "string", + "reimburseTariffPrice": 0, + "reimburseTariffCalculated": true, + "reimbursePriceCalculatedOn": "string", + "bankAccount": "string", + "bankAccountCreatedOn": "string", + "bankAccountValidFrom": "string", + "reimburseTariffOriginalPrice": 0, + "hasGuestChargingReimbursementFee": true, + "reimburseTenantFee": 0, + "tenantFeeCalculated": true, + "tariffDistributionId": "string", + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "customerShare": 0, + "energyCompensation": 0, + "reimbursementCustomerShare": { + "customerShare": 0, + "energyCompensation": 0, + "tenantFee": 0 + }, + "localStartDateTime": "string", + "localEndDateTime": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,roamingadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/mspreimbursement/webhook/{id}": { + "post": { + "tags": [ + "mspreimbursement" + ], + "summary": "Creates a reimbursementwebhook.", + "description": "Creates a new reimbursementwebhook.", + "operationId": "ReimbursementWebhookPost", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "200": { + "description": "Request was successful.", + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/reset": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a ResetRequest.", + "description": "Sends a ResetRequest command to the chargepoint.", + "operationId": "SendResetRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The ResetRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/resetRequest" + }, + "example": { + "type": "Hard" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/remotestop": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a RemoteStopTransactionRequest.", + "description": "Sends a RemoteStopTransactionRequest command to the chargepoint.", + "operationId": "SendRemoteStopTransactionRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The RemoteStopTransactionRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/remoteStopTransactionRequest" + }, + "example": { + "transactionId": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/remotestart": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a RemoteStartTransactionRequest.", + "description": "Sends a RemoteStartTransactionRequest command to the chargepoint.", + "operationId": "SendRemoteStartTransactionRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The RemoteStartTransactionRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/remoteStartTransactionRequest" + }, + "example": { + "connectorId": 0, + "idTag": "string", + "chargingProfile": { + "chargingProfileId": 0, + "transactionId": 0, + "stackLevel": 0, + "chargingProfilePurpose": "ChargePointMaxProfile", + "chargingProfileKind": "Absolute", + "recurrencyKind": "Daily", + "validFrom": "string", + "validTo": "string", + "chargingSchedule": { + "duration": 0, + "startSchedule": "string", + "chargingRateUnit": "A", + "chargingSchedulePeriod": [ + { + "startPeriod": 0, + "limit": 0, + "numberPhases": 0 + } + ], + "minChargingRate": 0 + } + } + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/clearchargingprofile": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a ClearChargingProfileRequest.", + "description": "Sends a ClearChargingProfileRequest command to the chargepoint.", + "operationId": "SendClearChargingProfileRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The ClearChargingProfileRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/clearChargingProfileRequest" + }, + "example": { + "id": 0, + "connectorId": 0, + "chargingProfilePurpose": "ChargePointMaxProfile", + "stackLevel": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/getcompositeschedule": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a GetCompositeScheduleRequest.", + "description": "Sends a GetCompositeScheduleRequest command to the chargepoint.", + "operationId": "SendGetCompositeScheduleRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The GetCompositeScheduleRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/getCompositeScheduleRequest" + }, + "example": { + "connectorId": 0, + "duration": 0, + "chargingRateUnit": "A" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/setchargingprofile": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a SetChargingProfileRequest.", + "description": "Sends a SetChargingProfileRequest command to the chargepoint.", + "operationId": "SendSetChargingProfileRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The SetChargingProfileRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/setChargingProfileRequest" + }, + "example": { + "connectorId": 0, + "csChargingProfiles": { + "chargingProfileId": 0, + "transactionId": 0, + "stackLevel": 0, + "chargingProfilePurpose": "ChargePointMaxProfile", + "chargingProfileKind": "Absolute", + "recurrencyKind": "Daily", + "validFrom": "string", + "validTo": "string", + "chargingSchedule": { + "duration": 0, + "startSchedule": "string", + "chargingRateUnit": "A", + "chargingSchedulePeriod": [ + { + "startPeriod": 0, + "limit": 0, + "numberPhases": 0 + } + ], + "minChargingRate": 0 + } + } + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints": { + "get": { + "tags": [ + "chargepoints" + ], + "summary": "Get a list of chargepoints.", + "description": "Get a paged list of chargepoints, taken the filters into account.", + "operationId": "GetAllChargepoints", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "Orders the resultset by the property.", + "schema": { + "enum": [ + "name", + "ouname", + "model", + "serialnumber" + ], + "type": "string", + "default": "name" + } + }, + { + "name": "descending", + "in": "query", + "description": "When true, orders resultset descending.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chargepointDtoArray" + }, + "example": [ + { + "id": "string", + "chargePointId": "string", + "dateDeleted": "string", + "displayName": "string", + "roamingName": "string", + "chargeBoxSerialNumber": "string", + "chargePointModel": "string", + "chargePointSerialNumber": "string", + "chargePointVendor": "string", + "firmwareVersion": "string", + "connectivityStatus": "ONLINE", + "iccid": "string", + "imsi": "string", + "meterSerialNumber": "string", + "meterType": "string", + "tenantId": "string", + "evses": [ + { + "evse_id": "string", + "connectors": [ + { + "id": "string", + "operationalStatus": "Available", + "standard": "CHADEMO", + "format": "SOCKET", + "powerType": "AC_1_PHASE", + "maxVoltage": 0, + "maxAmperage": 0, + "maxElectricPower": 0 + } + ] + } + ], + "isRoaming": true, + "hasGuestUsage": true, + "locationId": "string", + "allowAnyToken": true, + "dateCreated": "string", + "updated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "simCardNumber": "string", + "tokenGroups": [ + "string" + ], + "isNew": true, + "hasReimbursement": true, + "reimburseTariffId": "string", + "reimburseTariffName": "string", + "reimburseTariffPrice": 0, + "reimburseUID": "string", + "reimburseTokenId": "string", + "reimburseOU": "string", + "useTenantFee": true, + "maxCapacityInKw": 0 + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/chargepointstatus": { + "get": { + "tags": [ + "chargepoint status" + ], + "summary": "Get a list of chargepointstatus.", + "description": "Get a paged list of chargepointstatus, taken the filters into account.", + "operationId": "GetAllChargepointstatus", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chargepointStatusDtoArray" + }, + "example": [ + { + "id": "string", + "displayName": "string", + "tenantId": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "timestamp": "string", + "connectivityStatus": "ONLINE", + "connectors": [ + { + "connectorNumber": 0, + "operationalStatus": "Available", + "timestamp": "string" + } + ], + "websocketConnected": "string", + "websocketDisconnected": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/chargepoints/{id}/messages": { + "get": { + "tags": [ + "chargepoints" + ], + "summary": "Get a list of chargepointmessages.", + "description": "Get a paged list of chargepointmessages, taken the filters into account.", + "operationId": "GetAllChargepointmessages", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. Returns the maximum number of lines visible near the portal search field, set a start and/or end date to filter further in the past", + "schema": { + "type": "string" + } + }, + { + "name": "from", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources from this datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "to", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources until this datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "transactionId", + "in": "query", + "description": "Return resources with this transaction id.", + "schema": { + "type": "string" + } + }, + { + "name": "responseOnly", + "in": "query", + "description": "A flag indicating to only return responses.", + "schema": { + "type": "boolean" + } + }, + { + "name": "requestOnly", + "in": "query", + "description": "A flag indicating to only return requests.", + "schema": { + "type": "boolean" + } + }, + { + "name": "chargerToCpoOnly", + "in": "query", + "description": "A flag indicating to only return data send from the charger to the cpo.", + "schema": { + "type": "boolean" + } + }, + { + "name": "cpoToChargerOnly", + "in": "query", + "description": "A flag indicating to only return data send from the cpo to the charger.", + "schema": { + "type": "boolean" + } + }, + { + "name": "messageId", + "in": "query", + "description": "Searches for messages with the this id.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/messageLogDtoArray" + }, + "example": [ + { + "id": "string", + "chargePointId": "string", + "messageId": "string", + "wampMessageType": "Unknown", + "ocppMessageType": "Authorize", + "direction": "Unknown", + "tenantId": "string", + "payload": "string", + "timestamp": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/cdrs": { + "get": { + "tags": [ + "cdrs" + ], + "summary": "Get a list of cdrs.", + "description": "Get a paged list of cdrs, taken the filters into account.", + "operationId": "GetAllCdrs", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + }, + { + "name": "providerexclude", + "in": "query", + "description": "Excludes any provider from the results, use comma separated string (eg. NLLON,NLDEF).", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "Orders the resultset by the property.", + "schema": { + "enum": [ + "startdatetime", + "enddatetime" + ], + "type": "string", + "default": "startdatetime" + } + }, + { + "name": "descending", + "in": "query", + "description": "When true, orders resultset descending.", + "schema": { + "type": "boolean" + } + }, + { + "name": "from", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources from the created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "to", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources to created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cdrDtoArray" + }, + "example": [ + { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "connectorId": 0, + "cdrLocation": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "startDatetime": "string", + "endDateTime": "string", + "sessionId": "string", + "token": "string", + "startedByInfo": { + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "roamingPlatformType": "Hubject", + "authorizationState": "ApprovedByRemote", + "roamingPlatformConnectionId": "string", + "isGuestUsage": true + }, + "totalEnergyInKwh": 0, + "totalTimeInHours": 0, + "chargingPeriods": [ + { + "timestamp": "string", + "deltaKwh": 0, + "absoluteKwh": 0, + "price": 0 + } + ], + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "tariffId": "string", + "tariffName": "string", + "startTariff": 0, + "tariffPrice": 0, + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "localStartDateTime": "string", + "localEndDateTime": "string", + "approvalStatus": 0 + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,roamingadmin,basicuser,installer,helpdesk,developer,tariffeditor)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/reimbursementcdrs/{id}/recalculate": { + "post": { + "tags": [ + "reimbursement" + ], + "summary": "Creates a recalculatereimbursementcdr.", + "description": "Creates a new recalculatereimbursementcdr.", + "operationId": "RecalculateReimbursementCdrPost", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reimbursementCdrDto" + }, + "example": { + "id": "string", + "tenantId": "string", + "chargePointId": "string", + "connectorId": 0, + "locationId": "string", + "evseId": "string", + "location": { + "id": "string", + "evseId": "string", + "powerType": "AC_1_PHASE", + "country_code": "string", + "party_id": "string", + "name": "string", + "houseNumber": "string", + "street": "string", + "city": "string", + "postal_code": "string", + "state": "string", + "country": "string", + "hotline_phonenumber": "string", + "coordinates": { + "latitude": "string", + "longitude": "string" + }, + "time_zone": "string", + "hasReimbursement": true + }, + "startDatetime": "string", + "endDateTime": "string", + "sessionId": "string", + "startedByInfo": { + "idTag": "string", + "tokenInfo": { + "uid": "string", + "authReference": "string", + "tokenType": "AD_HOC_USER", + "contractId": "string", + "authMethod": "AUTH_REQUEST", + "providerCountryCode": "string", + "providerPartyId": "string", + "tokenOUId": "string", + "tokenOUName": "string", + "tokenOU": "string" + }, + "authorizationState": "ApprovedByRemote", + "isGuestUsage": true + }, + "meterStartInWh": 0, + "meterStopInWh": 0, + "totalEnergyInKwh": 0, + "totalTimeInHours": 0, + "totalPrice": 0, + "created": "string", + "lastUpdated": "string", + "ou": "string", + "ouId": "string", + "ouName": "string", + "reimburseTariffId": "string", + "reimburseTariffName": "string", + "reimburseTariffPrice": 0, + "reimburseTariffCalculated": true, + "reimbursePriceCalculatedOn": "string", + "bankAccount": "string", + "bankAccountCreatedOn": "string", + "bankAccountValidFrom": "string", + "reimburseTariffOriginalPrice": 0, + "hasGuestChargingReimbursementFee": true, + "reimburseTenantFee": 0, + "tenantFeeCalculated": true, + "tariffDistributionId": "string", + "priceInfo": { + "startPrice": 0, + "energyPrice": 0, + "totalParkingTimeInMinutes": 0, + "totalParkingTimeSteps": 0, + "parkingTimePrice": 0, + "totalChargingTimeInMinutes": 0, + "totalChargingTimeSteps": 0, + "chargingTimePrice": 0, + "totalPrice": 0 + }, + "customerShare": 0, + "energyCompensation": 0, + "reimbursementCustomerShare": { + "customerShare": 0, + "energyCompensation": 0, + "tenantFee": 0 + }, + "localStartDateTime": "string", + "localEndDateTime": "string" + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,roamingadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/cdrs/export": { + "get": { + "tags": [ + "cdrs" + ], + "summary": "Get a list of interchangeformat.", + "description": "Get a paged list of interchangeformat, taken the filters into account.", + "operationId": "GetAllInterchangeformat", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "providerexclude", + "in": "query", + "description": "Excludes any provider from the results, use comma separated string (eg. NLLON,NLDEF).", + "schema": { + "type": "string" + } + }, + { + "name": "from", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources from the created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "to", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return resources to created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/interchangeFormatCdrArray" + }, + "example": [ + { + "cdrId": "string", + "startDateTime": "string", + "endDateTime": "string", + "duration": "string", + "volume": 0, + "chargePointAddress": "string", + "chargePointZip": "string", + "chargePointCity": "string", + "chargePointCountry": "string", + "chargePointType": "string", + "productType": "string", + "tariffType": "string", + "authenticationId": "string", + "contractId": "string", + "meterId": "string", + "obisCode": "string", + "chargePointId": "string", + "serviceProviderId": "string", + "infraProviderId": "string", + "calculatedCost": 0 + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk,developer)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/chargepoints/{id}/reservenow": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a ReserveNowRequest.", + "description": "Sends a ReserveNowRequest command to the chargepoint.", + "operationId": "SendReserveNowRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The ReserveNowRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/reserveNowRequest" + }, + "example": { + "connectorId": 0, + "expiryDate": "string", + "idTag": "string", + "parentIdTag": "string", + "reservationId": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/cancelreservation": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a CancelReservationRequest.", + "description": "Sends a CancelReservationRequest command to the chargepoint.", + "operationId": "SendCancelReservationRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The CancelReservationRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/cancelReservationRequest" + }, + "example": { + "reservationId": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/localtokengroups": { + "get": { + "tags": [ + "localtokengroups" + ], + "summary": "Get a list of localtokengroups.", + "description": "Get a paged list of localtokengroups, taken the filters into account.", + "operationId": "GetAllLocaltokengroups", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/localTokenGroupGetDtoArray" + }, + "example": [ + { + "id": "string", + "oucode": "string", + "tokenGroupName": "string", + "targetOUCodes": [ + "string" + ], + "tokens": [ + { + "isValid": true, + "name": "string", + "uid": "string", + "contractId": "string", + "normalizedContractId": "string" + } + ], + "targetChargepointIds": [ + "string" + ], + "created": "string", + "updated": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "localtokengroups" + ], + "summary": "Creates a localtokengroup.", + "description": "Creates a new localtokengroup.", + "operationId": "LocalTokenGroupPost", + "requestBody": { + "description": "The LocalTokenGroupPostDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/localTokenGroupPostDto" + }, + "example": { + "oucode": "string", + "tokenGroupName": "string", + "targetOUCodes": [ + "string" + ], + "tokens": [ + { + "isValid": true, + "name": "string", + "uid": "string", + "contractId": "string" + } + ], + "targetChargepointIds": [ + "string" + ] + } + } + } + }, + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/localtokengroups/{id}": { + "get": { + "tags": [ + "localtokengroups" + ], + "summary": "Gets the LocalTokenGroup.", + "description": "Gets the LocalTokenGroup base on the id.", + "operationId": "LocaltokengroupGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/localTokenGroupGetDto" + }, + "example": { + "id": "string", + "oucode": "string", + "tokenGroupName": "string", + "targetOUCodes": [ + "string" + ], + "tokens": [ + { + "isValid": true, + "name": "string", + "uid": "string", + "contractId": "string", + "normalizedContractId": "string" + } + ], + "targetChargepointIds": [ + "string" + ], + "created": "string", + "updated": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "delete": { + "tags": [ + "localtokengroups" + ], + "summary": "Deletes a localtokengroup.", + "description": "Deletes a localtokengroup.", + "operationId": "LocalTokenGroupDelete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "200": { + "description": "Request was successful.", + "content": { + "application/json": {} + } + } + } + }, + "put": { + "tags": [ + "localtokengroups" + ], + "summary": "Updates a localtokengroup.", + "description": "Updates a localtokengroup.", + "operationId": "LocalTokenGroupPut", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The LocalTokenGroupPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/localTokenGroupPutDto" + }, + "example": { + "oucode": "string", + "tokenGroupName": "string", + "targetOUCodes": [ + "string" + ], + "tokens": [ + { + "isValid": true, + "name": "string", + "uid": "string", + "contractId": "string" + } + ], + "targetChargepointIds": [ + "string" + ] + } + } + } + }, + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/webhooks/{id}": { + "delete": { + "tags": [ + "webhooks" + ], + "summary": "Deletes a webhook.", + "description": "Deletes a webhook.", + "operationId": "webhookDelete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "200": { + "description": "Request was successful.", + "content": { + "application/json": {} + } + } + } + }, + "get": { + "tags": [ + "webhooks" + ], + "summary": "Gets the webhook.", + "description": "Gets the webhook base on the id.", + "operationId": "WebhookGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhookGetDto" + }, + "example": { + "id": "string", + "name": "string", + "ouCode": "string", + "enabled": true, + "eventTypes": [ + "SESSION_START" + ], + "headers": [ + { + "name": "string", + "value": "string" + } + ], + "url": "string", + "created": "string", + "updated": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,developer)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "put": { + "tags": [ + "webhooks" + ], + "summary": "Updates a webhook.", + "description": "Updates a webhook.", + "operationId": "webhookPut", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The WebhookPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhookPutDto" + }, + "example": { + "name": "string", + "ouCode": "string", + "url": "string", + "enabled": true, + "eventTypes": [ + "SESSION_START" + ], + "headers": [ + { + "name": "string", + "value": "string" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhookGetDto" + }, + "example": { + "id": "string", + "name": "string", + "ouCode": "string", + "enabled": true, + "eventTypes": [ + "SESSION_START" + ], + "headers": [ + { + "name": "string", + "value": "string" + } + ], + "url": "string", + "created": "string", + "updated": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/webhooks": { + "get": { + "tags": [ + "webhooks" + ], + "summary": "Get a list of webhooks.", + "description": "Get a paged list of webhooks, taken the filters into account.", + "operationId": "GetAllWebhooks", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "Orders the resultset by the property.", + "schema": { + "enum": [ + "name" + ], + "type": "string", + "default": "name" + } + }, + { + "name": "descending", + "in": "query", + "description": "When true, orders resultset descending.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhookSummaryGetDtoArray" + }, + "example": [ + { + "id": "string", + "name": "string", + "enabled": true, + "eventTypes": [ + "SESSION_START" + ], + "created": "string", + "updated": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,developer)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "webhooks" + ], + "summary": "Creates a webhook.", + "description": "Creates a new webhook.", + "operationId": "webhookPost", + "requestBody": { + "description": "The WebhookPostDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhookPostDto" + }, + "example": { + "name": "string", + "ouCode": "string", + "enabled": true, + "eventTypes": [ + "SESSION_START" + ], + "headers": [ + { + "name": "string", + "value": "string" + } + ], + "url": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "409": { + "description": "Resource with this id already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/unlockconnector": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a UnlockConnectorRequest.", + "description": "Sends a UnlockConnectorRequest command to the chargepoint.", + "operationId": "SendUnlockConnectorRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The UnlockConnectorRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/unlockConnectorRequest" + }, + "example": { + "connectorId": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/tariffs": { + "post": { + "tags": [ + "tariffs" + ], + "summary": "Creates a tariff.", + "description": "Creates a new tariff.", + "operationId": "TariffPost", + "requestBody": { + "description": "The TariffPostDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffPostDto" + }, + "example": { + "name": "string", + "currency": "string", + "usageType": "SELL", + "privateEmpTariff": { + "country_code": "string", + "party_id": "string", + "powerType": "AC", + "usePublicTariffWhenKwhIsCheaper": true + }, + "startTariff": 0, + "price": 0, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "parkingTariffRestriction": { + "start_time": "string", + "end_time": "string", + "start_date": "string", + "end_date": "string", + "day_of_week": [ + 0 + ] + }, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "externalReference": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "409": { + "description": "Resource with this id already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + }, + "get": { + "tags": [ + "tariffs" + ], + "summary": "Get a list of tariffs.", + "description": "Get a paged list of tariffs, taken the filters into account.", + "operationId": "GetAllTariffs", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "orderBy", + "in": "query", + "description": "Orders the resultset by the property.", + "schema": { + "enum": [ + "name", + "kwH_PRICE", + "starT_PRICE" + ], + "type": "string", + "default": "name" + } + }, + { + "name": "descending", + "in": "query", + "description": "When true, orders resultset descending.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffDtoArray" + }, + "example": [ + { + "id": "string", + "ocpiId": "string", + "hubjectId": "string", + "tenantId": "string", + "name": "string", + "startTariff": 0, + "price": 0, + "priceInclVat": 0, + "currency": "string", + "last_updated": "string", + "usageType": "SELL", + "tariffType": "AD_HOC_PAYMENT", + "vat": 0, + "isVatRelevant": true, + "country_code": "string", + "party_id": "string", + "locationId": "string", + "isPrivateEmpTariff": true, + "privateEmpTariff": { + "country_code": "string", + "party_id": "string", + "powerType": "AC", + "usePublicTariffWhenKwhIsCheaper": true + }, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "parkingTariffRestriction": { + "start_time": "string", + "end_time": "string", + "start_date": "string", + "end_date": "string", + "day_of_week": [ + 0 + ] + }, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "priceHistory": [ + { + "createdTimestamp": "string", + "validFrom": "string", + "startTariff": 0, + "pricePerKwh": 0, + "pricePerKwhInclVat": 0, + "isVatRelevant": true, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "parkingTariffRestriction": { + "start_time": "string", + "end_time": "string", + "start_date": "string", + "end_date": "string", + "day_of_week": [ + 0 + ] + }, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "approvalStatus": "PENDING" + } + ], + "externalReference": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/tariffs/{id}": { + "put": { + "tags": [ + "tariffs" + ], + "summary": "Updates a tariff.", + "description": "Updates a tariff.", + "operationId": "TariffPut", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The TariffPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffPutDto" + }, + "example": { + "name": "string", + "hubjectId": "string", + "privateEmpTariff": { + "country_code": "string", + "party_id": "string", + "powerType": "AC", + "usePublicTariffWhenKwhIsCheaper": true + }, + "startTariff": 0, + "price": 0, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "parkingTariffRestriction": { + "start_time": "string", + "end_time": "string", + "start_date": "string", + "end_date": "string", + "day_of_week": [ + 0 + ] + }, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "externalReference": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "409": { + "description": "Resource with this id already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "content": { + "application/json": {} + } + } + } + }, + "get": { + "tags": [ + "tariffs" + ], + "summary": "Gets the Tariff.", + "description": "Gets the Tariff base on the id.", + "operationId": "TariffGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffDto" + }, + "example": { + "id": "string", + "ocpiId": "string", + "hubjectId": "string", + "tenantId": "string", + "name": "string", + "startTariff": 0, + "price": 0, + "priceInclVat": 0, + "currency": "string", + "last_updated": "string", + "usageType": "SELL", + "tariffType": "AD_HOC_PAYMENT", + "vat": 0, + "isVatRelevant": true, + "country_code": "string", + "party_id": "string", + "locationId": "string", + "isPrivateEmpTariff": true, + "privateEmpTariff": { + "country_code": "string", + "party_id": "string", + "powerType": "AC", + "usePublicTariffWhenKwhIsCheaper": true + }, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "parkingTariffRestriction": { + "start_time": "string", + "end_time": "string", + "start_date": "string", + "end_date": "string", + "day_of_week": [ + 0 + ] + }, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "priceHistory": [ + { + "createdTimestamp": "string", + "validFrom": "string", + "startTariff": 0, + "pricePerKwh": 0, + "pricePerKwhInclVat": 0, + "isVatRelevant": true, + "parkingTariff": 0, + "parkingStepSizeInMinutes": 0, + "parkingGracePeriodInMinutes": 0, + "parkingTariffRestriction": { + "start_time": "string", + "end_time": "string", + "start_date": "string", + "end_date": "string", + "day_of_week": [ + 0 + ] + }, + "timeTariff": 0, + "timeStepSizeInMinutes": 0, + "timeGracePeriodInMinutes": 0, + "approvalStatus": "PENDING" + } + ], + "externalReference": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/locations/{id}/chargepoints/{chargePointId}": { + "delete": { + "tags": [ + "locations" + ], + "summary": "Deletes a relation between location and charge point.", + "description": "Deletes a relation between location and charge point.", + "operationId": "relation-between-location-and-charge-pointDelete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "chargePointId", + "in": "path", + "description": "Id of the chargePoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/locations/{id}/chargepoints": { + "post": { + "tags": [ + "locations" + ], + "summary": "Creates a relation between location and charge point.", + "description": "Creates a new relation between location and charge point.", + "operationId": "relation-between-location-and-charge-pointPost", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The LocationChargePointDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/locationChargePointDto" + }, + "example": { + "chargePointId": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/updatefirmware": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a UpdateFirmwareRequest.", + "description": "Sends a UpdateFirmwareRequest command to the chargepoint.", + "operationId": "SendUpdateFirmwareRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The UpdateFirmwareRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/updateFirmwareRequest" + }, + "example": { + "location": "string", + "retries": 0, + "retrieveDate": "string", + "retryInterval": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/triggermessage": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a TriggerMessageRequest.", + "description": "Sends a TriggerMessageRequest command to the chargepoint.", + "operationId": "SendTriggerMessageRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The TriggerMessageRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/triggerMessageRequest" + }, + "example": { + "requestedMessage": "BootNotification", + "connectorId": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/getlocallistversion": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a GetLocalListVersionRequest.", + "description": "Sends a GetLocalListVersionRequest command to the chargepoint.", + "operationId": "SendGetLocalListVersionRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The GetLocalListVersionRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/getLocalListVersionRequest" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/getdiagnostics": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a GetDiagnosticsRequest.", + "description": "Sends a GetDiagnosticsRequest command to the chargepoint.", + "operationId": "SendGetDiagnosticsRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The GetDiagnosticsRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/getDiagnosticsRequest" + }, + "example": { + "location": "string", + "retries": 0, + "retryInterval": 0, + "startTime": "string", + "stopTime": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/getconfiguration": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a GetConfigurationRequest.", + "description": "Sends a GetConfigurationRequest command to the chargepoint.", + "operationId": "SendGetConfigurationRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The GetConfigurationRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/getConfigurationRequest" + }, + "example": { + "key": [ + "string" + ] + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/datatransfer": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a DataTransferRequest.", + "description": "Sends a DataTransferRequest command to the chargepoint.", + "operationId": "SendDataTransferRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The DataTransferRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dataTransferRequest" + }, + "example": { + "vendorId": "string", + "messageId": "string", + "data": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/changeconfiguration": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a ChangeConfigurationRequest.", + "description": "Sends a ChangeConfigurationRequest command to the chargepoint.", + "operationId": "SendChangeConfigurationRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The ChangeConfigurationRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/changeConfigurationRequest" + }, + "example": { + "key": "string", + "value": "string" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/changeavailability": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a ChangeAvailabilityRequest.", + "description": "Sends a ChangeAvailabilityRequest command to the chargepoint.", + "operationId": "SendChangeAvailabilityRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The ChangeAvailabilityRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/changeAvailabilityRequest" + }, + "example": { + "connectorId": 0, + "type": "Inoperative" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/cdrs/full-download": { + "get": { + "tags": [ + "cdrs" + ], + "summary": "Gets a file of full-download cdrs.", + "description": "Gets a file of full-download cdrs, taken the filters into account.", + "operationId": "GetFileFull-Download-Cdrs", + "parameters": [ + { + "name": "from", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return CDRs from the created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "to", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return CDRs to created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + } + ], + "responses": { + "200": { + "description": "Returns a binary file matching the specified filters.", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/fileContentResult" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/fileContentResult" + }, + "example": { + "fileContents": "string", + "contentType": "string", + "fileDownloadName": "string", + "lastModified": "string", + "entityTag": { + "tag": { + "buffer": "string", + "offset": 0, + "length": 0, + "value": "string", + "hasValue": true + }, + "isWeak": true + }, + "enableRangeProcessing": true + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk,developer)", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/cdrs/download": { + "get": { + "tags": [ + "cdrs" + ], + "summary": "Gets a file of intercharge cdrs.", + "description": "Gets a file of intercharge cdrs, taken the filters into account.", + "operationId": "GetFileIntercharge-Cdrs", + "parameters": [ + { + "name": "from", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return CDRs from the created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + }, + { + "name": "to", + "in": "query", + "description": "Format - date-time (as date-time in RFC3339). Return CDRs to created datetime.", + "schema": { + "type": "string", + "format": "date-time" + } + } + ], + "responses": { + "200": { + "description": "Returns a binary file matching the specified filters.", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/fileContentResult" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/fileContentResult" + }, + "example": { + "fileContents": "string", + "contentType": "string", + "fileDownloadName": "string", + "lastModified": "string", + "entityTag": { + "tag": { + "buffer": "string", + "offset": 0, + "length": 0, + "value": "string", + "hasValue": true + }, + "isWeak": true + }, + "enableRangeProcessing": true + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,helpdesk,developer)", + "content": { + "application/octet-stream": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "examples": { + "default": { + "value": null + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/tariffdistributions": { + "get": { + "tags": [ + "tariffdistributions" + ], + "summary": "Get a list of tariffdistributions.", + "description": "Get a paged list of tariffdistributions, taken the filters into account.", + "operationId": "GetAllTariffdistributions", + "parameters": [ + { + "name": "skip", + "in": "query", + "description": "Format - int32. Skip the first defined amount of resources.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "take", + "in": "query", + "description": "Format - int32. Take a number of resources, but note that you can never get more than 100.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "search", + "in": "query", + "description": "Searches for resources with the string, but note that not all fields are indexed. ", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffDistributionGetDtoArray" + }, + "example": [ + { + "id": "string", + "name": "string", + "ouCode": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0, + "priceHistory": [ + { + "validFrom": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0 + } + ], + "created": "string", + "deleted": "string", + "updated": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "post": { + "tags": [ + "tariffdistributions" + ], + "summary": "Creates a tariffdistribution.", + "description": "Creates a new tariffdistribution.", + "operationId": "tariffdistributionPost", + "requestBody": { + "description": "The TariffDistributionPostDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffDistributionPostDto" + }, + "example": { + "name": "string", + "ouCode": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0 + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/tariffdistributions/{id}": { + "get": { + "tags": [ + "tariffdistributions" + ], + "summary": "Gets the tariffdistribution.", + "description": "Gets the tariffdistribution base on the id.", + "operationId": "TariffdistributionGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffDistributionGetDto" + }, + "example": { + "id": "string", + "name": "string", + "ouCode": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0, + "priceHistory": [ + { + "validFrom": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0 + } + ], + "created": "string", + "deleted": "string", + "updated": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + }, + "put": { + "tags": [ + "tariffdistributions" + ], + "summary": "Updates a tariffdistribution.", + "description": "Updates a tariffdistribution.", + "operationId": "tariffdistributionPut", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The TariffDistributionPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffDistributionPutDto" + }, + "example": { + "name": "string", + "ouCode": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0 + } + } + } + }, + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/tariffDistributionGetDto" + }, + "example": { + "id": "string", + "name": "string", + "ouCode": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0, + "priceHistory": [ + { + "validFrom": "string", + "energyCompensation": 0, + "fixedTenantKWhFee": 0, + "percentageFeeCustomer": 0, + "percentageFeeTenant": 0 + } + ], + "created": "string", + "deleted": "string", + "updated": "string" + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/chargepoints/{id}/sendlocallist": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a SendLocalListRequest.", + "description": "Sends a SendLocalListRequest command to the chargepoint.", + "operationId": "SendSendLocalListRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The SendLocalListRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/sendLocalListRequest" + }, + "example": { + "listVersion": 0, + "localAuthorizationList": [ + { + "idTag": "string", + "idTagInfo": { + "expiryDate": "string", + "parentIdTag": "string", + "status": "Accepted" + } + } + ], + "updateType": "Differential" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/clearcache": { + "post": { + "tags": [ + "commands" + ], + "summary": "Sends a ClearCacheRequest.", + "description": "Sends a ClearCacheRequest command to the chargepoint.", + "operationId": "SendClearCacheRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the chargepoint.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The ClearCacheRequest payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/clearCacheRequest" + } + } + } + }, + "responses": { + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/chargepoints/{id}/configurationitems": { + "get": { + "tags": [ + "configurationitems" + ], + "summary": "Gets the configurationitem.", + "description": "Gets the configurationitem base on the id.", + "operationId": "ConfigurationitemGet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Returns all resources matching the specified filters.", + "headers": { + "Link": { + "description": "The url where the next page can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/chargepointConfigurationItemsDtoArray" + }, + "example": [ + { + "id": "string", + "readOnly": true, + "value": "string", + "created": "string", + "modified": "string", + "deleted": "string" + } + ] + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,installer,helpdesk,)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + } + } + } + }, + "/v1/localtokengroups/{id}/token/{tokenUid}": { + "delete": { + "tags": [ + "localtokengroupstoken" + ], + "summary": "Deletes a localtokengrouptoken.", + "description": "Deletes a localtokengrouptoken.", + "operationId": "LocalTokenGroupTokenDelete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tokenUid", + "in": "path", + "description": "Id of the token.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "200": { + "description": "Request was successful.", + "content": { + "application/json": {} + } + } + } + }, + "put": { + "tags": [ + "localtokengroupstoken" + ], + "summary": "Updates a localtokengrouptoken.", + "description": "Updates a localtokengrouptoken.", + "operationId": "LocalTokenGroupTokenPut", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tokenUid", + "in": "path", + "description": "Id of the token.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The LocalTokenGroupTokenPutDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/localTokenGroupTokenPutDto" + }, + "example": { + "isValid": true, + "name": "string", + "uid": "string", + "contractId": "string" + } + } + } + }, + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "422": { + "description": "The data provided was incorrect.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "409": { + "description": "Resource with this id already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "400": { + "description": "Content was not in the correct format.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "202": { + "description": "Request was handled correctly.", + "content": { + "application/json": {} + } + } + } + } + }, + "/v1/localtokengroups/{id}/token": { + "post": { + "tags": [ + "localtokengroupstoken" + ], + "summary": "Creates a localtokengrouptoken.", + "description": "Creates a new localtokengrouptoken.", + "operationId": "LocalTokenGroupTokenPost", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id of the resource.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The LocalTokenGroupTokenPostDto payload.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/localTokenGroupTokenPostDto" + }, + "example": { + "isValid": true, + "name": "string", + "uid": "string", + "contractId": "string" + } + } + } + }, + "responses": { + "404": { + "description": "The specified resource, or one of the related resources could not be found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "401": { + "description": "The provided credentials are not authorized to call this API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "500": { + "description": "A problem within the Longship system occured, use the referenceId when contacting our support team.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "403": { + "description": "The request tried to access resources that were not allowed for the provided credentials. (allowed roles: tenantadmin,basicuser,installer,developer,helpdesk,tariffeditor,roamingadmin)", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/longshipError" + }, + "example": { + "code": "string", + "errorDetails": { + "message": "string", + "referenceId": "string" + } + } + } + } + }, + "201": { + "description": "Resource was created.", + "headers": { + "Location": { + "description": "The url where the new resource can be fetched.", + "schema": { + "type": "string" + } + } + }, + "content": { + "application/json": {} + } + } + } + } + } + }, + "components": { + "schemas": { + "additionalGeoLocationDto": { + "type": "object", + "properties": { + "latitude": { + "type": "string" + }, + "longitude": { + "type": "string" + }, + "name": { + "$ref": "#/components/schemas/displayTextDto" + } + } + }, + "authorizationData": { + "required": [ + "idTag" + ], + "type": "object", + "properties": { + "idTag": { + "maxLength": 20, + "minLength": 0, + "type": "string" + }, + "idTagInfo": { + "$ref": "#/components/schemas/idTagInfo" + } + } + }, + "businessDetailsDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "website": { + "type": "string" + }, + "image": { + "$ref": "#/components/schemas/imageDto" + } + } + }, + "cancelReservationRequest": { + "required": [ + "reservationId" + ], + "type": "object", + "properties": { + "reservationId": { + "type": "integer", + "format": "int32" + } + } + }, + "cdrDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tenantId": { + "type": "string" + }, + "chargePointId": { + "type": "string" + }, + "connectorId": { + "type": "integer", + "format": "int32" + }, + "cdrLocation": { + "$ref": "#/components/schemas/cdrLocationDto" + }, + "startDatetime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + }, + "sessionId": { + "type": "string" + }, + "token": { + "type": "string" + }, + "startedByInfo": { + "$ref": "#/components/schemas/cdrStartedByInfoDto" + }, + "totalEnergyInKwh": { + "type": "number", + "format": "double" + }, + "totalTimeInHours": { + "type": "number", + "format": "double" + }, + "chargingPeriods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargingPeriodDto" + } + }, + "totalPrice": { + "type": "number", + "format": "double" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + }, + "tariffId": { + "type": "string" + }, + "tariffName": { + "type": "string" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "tariffPrice": { + "type": "number", + "format": "double" + }, + "priceInfo": { + "$ref": "#/components/schemas/priceInfoDto" + }, + "localStartDateTime": { + "type": "string", + "format": "date-time" + }, + "localEndDateTime": { + "type": "string", + "format": "date-time" + }, + "approvalStatus": { + "enum": [ + 0, + 1 + ], + "type": "integer", + "format": "int32", + "default": 0 + } + } + }, + "cdrGeoLocationDto": { + "type": "object", + "properties": { + "latitude": { + "type": "string" + }, + "longitude": { + "type": "string" + } + } + }, + "cdrLocationDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "evseId": { + "type": "string" + }, + "powerType": { + "enum": [ + "AC_1_PHASE", + "AC_3_PHASE", + "DC" + ], + "type": "string", + "default": "AC_1_PHASE" + }, + "country_code": { + "type": "string" + }, + "party_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "street": { + "type": "string" + }, + "city": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "hotline_phonenumber": { + "type": "string" + }, + "coordinates": { + "$ref": "#/components/schemas/cdrGeoLocationDto" + }, + "time_zone": { + "type": "string" + }, + "hasReimbursement": { + "type": "boolean" + } + } + }, + "cdrPatchDto": { + "type": "object", + "properties": { + "approvalStatus": { + "enum": [ + 0, + 1 + ], + "type": "integer", + "format": "int32", + "default": 0 + } + } + }, + "cdrStartedByInfoDto": { + "type": "object", + "properties": { + "tokenInfo": { + "$ref": "#/components/schemas/cdrStartedByTokenDto" + }, + "roamingPlatformType": { + "enum": [ + "Hubject", + "Ocpi" + ], + "type": "string", + "default": "Hubject" + }, + "authorizationState": { + "enum": [ + "ApprovedByRemote", + "ApprovedByLocalToken", + "ApprovedByAllowAny", + "ApprovedByRoamingPartner", + "ApprovedByAuthRequest", + "WaitingForRemoteStop", + "ErrorUnkownRemoteToken", + "ErrorInvalidLocalToken", + "ErrorNoLocalOrRemoteApproval", + "ErrorNoRoamingApproval" + ], + "type": "string", + "default": "ApprovedByRemote" + }, + "roamingPlatformConnectionId": { + "type": "string" + }, + "isGuestUsage": { + "type": "boolean" + } + } + }, + "cdrStartedByTokenDto": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "authReference": { + "type": "string" + }, + "tokenType": { + "enum": [ + "AD_HOC_USER", + "APP_USER", + "OTHER", + "RFID" + ], + "type": "string", + "default": "AD_HOC_USER" + }, + "contractId": { + "type": "string" + }, + "authMethod": { + "enum": [ + "AUTH_REQUEST", + "COMMAND", + "WHITELIST" + ], + "type": "string", + "default": "AUTH_REQUEST" + }, + "providerCountryCode": { + "type": "string" + }, + "providerPartyId": { + "type": "string" + }, + "tokenOUId": { + "type": "string" + }, + "tokenOUName": { + "type": "string" + }, + "tokenOU": { + "type": "string" + } + } + }, + "changeAvailabilityRequest": { + "required": [ + "connectorId", + "type" + ], + "type": "object", + "properties": { + "connectorId": { + "type": "integer", + "format": "int32" + }, + "type": { + "enum": [ + "Inoperative", + "Operative" + ], + "type": "string", + "default": "Inoperative" + } + } + }, + "changeConfigurationRequest": { + "required": [ + "key", + "value" + ], + "type": "object", + "properties": { + "key": { + "maxLength": 50, + "minLength": 0, + "type": "string" + }, + "value": { + "maxLength": 500, + "minLength": 0, + "type": "string" + } + } + }, + "chargepointConfigurationItemsDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "readOnly": { + "type": "boolean" + }, + "value": { + "type": "string" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "modified": { + "type": "string", + "format": "date-time" + }, + "deleted": { + "type": "string", + "format": "date-time" + } + } + }, + "chargepointConnectorDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "operationalStatus": { + "enum": [ + "Available", + "Preparing", + "Charging", + "SuspendedEVSE", + "SuspendedEV", + "Finishing", + "Reserved", + "Unavailable", + "Faulted" + ], + "type": "string", + "default": "Available" + }, + "standard": { + "enum": [ + "CHADEMO", + "DOMESTIC_A", + "DOMESTIC_B", + "DOMESTIC_C", + "DOMESTIC_D", + "DOMESTIC_E", + "DOMESTIC_F", + "DOMESTIC_G", + "DOMESTIC_H", + "DOMESTIC_I", + "DOMESTIC_J", + "DOMESTIC_K", + "DOMESTIC_L", + "IEC_60309_2_single_16", + "IEC_60309_2_three_16", + "IEC_60309_2_three_32", + "IEC_60309_2_three_64", + "IEC_62196_T1", + "IEC_62196_T1_COMBO", + "IEC_62196_T2", + "IEC_62196_T2_COMBO", + "IEC_62196_T3A", + "IEC_62196_T3C", + "PANTOGRAPH_BOTTOM_UP", + "PANTOGRAPH_TOP_DOWN", + "TESLA_R", + "TESLA_S" + ], + "type": "string", + "default": "CHADEMO" + }, + "format": { + "enum": [ + "SOCKET", + "CABLE" + ], + "type": "string", + "default": "SOCKET" + }, + "powerType": { + "enum": [ + "AC_1_PHASE", + "AC_3_PHASE", + "DC" + ], + "type": "string", + "default": "AC_1_PHASE" + }, + "maxVoltage": { + "type": "integer", + "format": "int32" + }, + "maxAmperage": { + "type": "integer", + "format": "int32" + }, + "maxElectricPower": { + "type": "integer", + "format": "int32" + } + } + }, + "chargepointDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "chargePointId": { + "type": "string" + }, + "dateDeleted": { + "type": "string", + "format": "date-time" + }, + "displayName": { + "type": "string" + }, + "roamingName": { + "type": "string" + }, + "chargeBoxSerialNumber": { + "type": "string" + }, + "chargePointModel": { + "type": "string" + }, + "chargePointSerialNumber": { + "type": "string" + }, + "chargePointVendor": { + "type": "string" + }, + "firmwareVersion": { + "type": "string" + }, + "connectivityStatus": { + "enum": [ + "ONLINE", + "OFFLINE" + ], + "type": "string", + "default": "ONLINE" + }, + "iccid": { + "type": "string" + }, + "imsi": { + "type": "string" + }, + "meterSerialNumber": { + "type": "string" + }, + "meterType": { + "type": "string" + }, + "tenantId": { + "type": "string" + }, + "evses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargepointEVSEDto" + } + }, + "isRoaming": { + "type": "boolean" + }, + "hasGuestUsage": { + "type": "boolean" + }, + "locationId": { + "type": "string" + }, + "allowAnyToken": { + "type": "boolean" + }, + "dateCreated": { + "type": "string", + "format": "date-time" + }, + "updated": { + "type": "string", + "format": "date-time" + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + }, + "tariffId": { + "type": "string" + }, + "tariffName": { + "type": "string" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "tariffPrice": { + "type": "number", + "format": "double" + }, + "simCardNumber": { + "type": "string" + }, + "tokenGroups": { + "type": "array", + "items": { + "type": "string" + } + }, + "isNew": { + "type": "boolean" + }, + "hasReimbursement": { + "type": "boolean" + }, + "reimburseTariffId": { + "type": "string" + }, + "reimburseTariffName": { + "type": "string" + }, + "reimburseTariffPrice": { + "type": "number", + "format": "double" + }, + "reimburseUID": { + "type": "string" + }, + "reimburseTokenId": { + "type": "string" + }, + "reimburseOU": { + "type": "string" + }, + "useTenantFee": { + "type": "boolean" + }, + "maxCapacityInKw": { + "type": "number", + "format": "double" + } + } + }, + "chargepointEVSEDto": { + "type": "object", + "properties": { + "evse_id": { + "type": "string" + }, + "connectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargepointConnectorDto" + } + } + } + }, + "chargepointPutDto": { + "type": "object", + "properties": { + "displayName": { + "type": "string" + }, + "roamingName": { + "type": "string" + }, + "allowAnyToken": { + "type": "boolean" + }, + "ouCode": { + "type": "string" + }, + "tariffId": { + "type": "string" + }, + "simCardNumber": { + "type": "string" + }, + "isNew": { + "type": "boolean" + }, + "maxCapacityInKw": { + "type": "number", + "format": "double" + } + } + }, + "chargepointStatusDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "tenantId": { + "type": "string" + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "connectivityStatus": { + "enum": [ + "ONLINE", + "OFFLINE" + ], + "type": "string", + "default": "ONLINE" + }, + "connectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connectorOperationalStatusDto" + } + }, + "websocketConnected": { + "type": "string", + "format": "date-time" + }, + "websocketDisconnected": { + "type": "string", + "format": "date-time" + } + } + }, + "chargingMeterValueDto": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time" + }, + "value": { + "type": "string" + }, + "measurand": { + "enum": [ + "Energy.Active.Export.Register", + "Energy.Active.Import.Register", + "Energy.Reactive.Export.Register", + "Energy.Reactive.Import.Register", + "Energy.Active.Export.Interval", + "Energy.Active.Import.Interval", + "Energy.Reactive.Export.Interval", + "Energy.Reactive.Import.Interval", + "Power.Active.Export", + "Power.Active.Import", + "Power.Offered", + "Power.Reactive.Export", + "Power.Reactive.Import", + "Power.Factor", + "Current.Import", + "Current.Export", + "Current.Offered", + "Voltage", + "Frequency", + "Temperature", + "SoC", + "RPM" + ], + "type": "string", + "default": "Energy.Active.Export.Register" + }, + "unit": { + "enum": [ + "Wh", + "kWh", + "varh", + "kvarh", + "W", + "kW", + "VA", + "kVA", + "var", + "kvar", + "A", + "V", + "K", + "Celcius", + "Fahrenheit", + "Percent" + ], + "type": "string", + "default": "Wh" + } + } + }, + "chargingPeriodDto": { + "type": "object", + "properties": { + "timestamp": { + "type": "string", + "format": "date-time" + }, + "deltaKwh": { + "type": "number", + "format": "double" + }, + "absoluteKwh": { + "type": "number", + "format": "double" + }, + "price": { + "type": "number", + "format": "double" + } + } + }, + "chargingProfile": { + "required": [ + "chargingProfileId", + "stackLevel", + "chargingProfilePurpose", + "chargingProfileKind", + "chargingSchedule" + ], + "type": "object", + "properties": { + "chargingProfileId": { + "type": "integer", + "format": "int32" + }, + "transactionId": { + "type": "integer", + "format": "int32" + }, + "stackLevel": { + "type": "integer", + "format": "int32" + }, + "chargingProfilePurpose": { + "enum": [ + "ChargePointMaxProfile", + "TxDefaultProfile", + "TxProfile" + ], + "type": "string", + "default": "ChargePointMaxProfile" + }, + "chargingProfileKind": { + "enum": [ + "Absolute", + "Recurring", + "Relative" + ], + "type": "string", + "default": "Absolute" + }, + "recurrencyKind": { + "enum": [ + "Daily", + "Weekly" + ], + "type": "string", + "default": "Daily" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "chargingSchedule": { + "$ref": "#/components/schemas/chargingSchedule" + } + } + }, + "chargingSchedule": { + "required": [ + "chargingRateUnit", + "chargingSchedulePeriod" + ], + "type": "object", + "properties": { + "duration": { + "type": "integer", + "format": "int32" + }, + "startSchedule": { + "type": "string", + "format": "date-time" + }, + "chargingRateUnit": { + "enum": [ + "A", + "W" + ], + "type": "string", + "default": "A" + }, + "chargingSchedulePeriod": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargingSchedulePeriod" + } + }, + "minChargingRate": { + "type": "number", + "format": "double" + } + } + }, + "chargingSchedulePeriod": { + "required": [ + "startPeriod", + "limit" + ], + "type": "object", + "properties": { + "startPeriod": { + "type": "integer", + "format": "int32" + }, + "limit": { + "type": "number", + "format": "double" + }, + "numberPhases": { + "type": "integer", + "format": "int32" + } + } + }, + "clearCacheRequest": { + "type": "object" + }, + "clearChargingProfileRequest": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "connectorId": { + "type": "integer", + "format": "int32" + }, + "chargingProfilePurpose": { + "enum": [ + "ChargePointMaxProfile", + "TxDefaultProfile", + "TxProfile" + ], + "type": "string", + "default": "ChargePointMaxProfile" + }, + "stackLevel": { + "type": "integer", + "format": "int32" + } + } + }, + "connectorDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "standard": { + "enum": [ + "CHADEMO", + "DOMESTIC_A", + "DOMESTIC_B", + "DOMESTIC_C", + "DOMESTIC_D", + "DOMESTIC_E", + "DOMESTIC_F", + "DOMESTIC_G", + "DOMESTIC_H", + "DOMESTIC_I", + "DOMESTIC_J", + "DOMESTIC_K", + "DOMESTIC_L", + "IEC_60309_2_single_16", + "IEC_60309_2_three_16", + "IEC_60309_2_three_32", + "IEC_60309_2_three_64", + "IEC_62196_T1", + "IEC_62196_T1_COMBO", + "IEC_62196_T2", + "IEC_62196_T2_COMBO", + "IEC_62196_T3A", + "IEC_62196_T3C", + "PANTOGRAPH_BOTTOM_UP", + "PANTOGRAPH_TOP_DOWN", + "TESLA_R", + "TESLA_S" + ], + "type": "string", + "default": "CHADEMO" + }, + "format": { + "enum": [ + "SOCKET", + "CABLE" + ], + "type": "string", + "default": "SOCKET" + }, + "power_type": { + "enum": [ + "AC_1_PHASE", + "AC_3_PHASE", + "DC" + ], + "type": "string", + "default": "AC_1_PHASE" + }, + "max_voltage": { + "type": "integer", + "format": "int32" + }, + "max_amperage": { + "type": "integer", + "format": "int32" + }, + "max_electric_power": { + "type": "integer", + "format": "int32" + }, + "calc_max_electric_power": { + "type": "boolean" + }, + "last_updated": { + "type": "string", + "format": "date-time" + } + } + }, + "connectorOperationalStatusDto": { + "type": "object", + "properties": { + "connectorNumber": { + "type": "integer", + "format": "int32" + }, + "operationalStatus": { + "enum": [ + "Available", + "Preparing", + "Charging", + "SuspendedEVSE", + "SuspendedEV", + "Finishing", + "Reserved", + "Unavailable", + "Faulted" + ], + "type": "string", + "default": "Available" + }, + "timestamp": { + "type": "string", + "format": "date-time" + } + } + }, + "csChargingProfiles": { + "required": [ + "chargingProfileId", + "stackLevel", + "chargingProfilePurpose", + "chargingProfileKind", + "chargingSchedule" + ], + "type": "object", + "properties": { + "chargingProfileId": { + "type": "integer", + "format": "int32" + }, + "transactionId": { + "type": "integer", + "format": "int32" + }, + "stackLevel": { + "type": "integer", + "format": "int32" + }, + "chargingProfilePurpose": { + "enum": [ + "ChargePointMaxProfile", + "TxDefaultProfile", + "TxProfile" + ], + "type": "string", + "default": "ChargePointMaxProfile" + }, + "chargingProfileKind": { + "enum": [ + "Absolute", + "Recurring", + "Relative" + ], + "type": "string", + "default": "Absolute" + }, + "recurrencyKind": { + "enum": [ + "Daily", + "Weekly" + ], + "type": "string", + "default": "Daily" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "chargingSchedule": { + "$ref": "#/components/schemas/chargingSchedule" + } + } + }, + "dataTransferRequest": { + "required": [ + "vendorId" + ], + "type": "object", + "properties": { + "vendorId": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "messageId": { + "maxLength": 50, + "minLength": 0, + "type": "string" + }, + "data": { + "type": "string" + } + } + }, + "displayTextDto": { + "type": "object", + "properties": { + "language": { + "type": "string" + }, + "text": { + "type": "string" + } + } + }, + "energyMixDto": { + "type": "object", + "properties": { + "is_green_energy": { + "type": "boolean" + }, + "energy_sources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/energySourceDto" + } + }, + "environ_impact": { + "type": "array", + "items": { + "$ref": "#/components/schemas/environmentalImpactDto" + } + } + } + }, + "energySourceDto": { + "type": "object", + "properties": { + "source": { + "enum": [ + "NUCLEAR", + "GENERAL_FOSSIL", + "COAL", + "GAS", + "GENERAL_GREEN", + "SOLAR", + "WIND", + "WATER" + ], + "type": "string", + "default": "NUCLEAR" + }, + "percentage": { + "type": "integer", + "format": "int32" + } + } + }, + "entityTagHeaderValue": { + "type": "object", + "properties": { + "tag": { + "$ref": "#/components/schemas/stringSegment" + }, + "isWeak": { + "type": "boolean" + } + } + }, + "environmentalImpactDto": { + "type": "object", + "properties": { + "category": { + "enum": [ + "NUCLEAR_WASTE", + "CARBON_DIOXIDE" + ], + "type": "string", + "default": "NUCLEAR_WASTE" + }, + "amount": { + "type": "integer", + "format": "int32" + } + } + }, + "exceptionalPeriodDto": { + "type": "object", + "properties": { + "period_begin": { + "type": "string", + "format": "date-time" + }, + "period_end": { + "type": "string", + "format": "date-time" + } + } + }, + "fileContentResult": { + "type": "object", + "properties": { + "fileContents": { + "type": "string", + "format": "binary" + }, + "contentType": { + "type": "string" + }, + "fileDownloadName": { + "type": "string" + }, + "lastModified": { + "type": "string", + "format": "date-time" + }, + "entityTag": { + "$ref": "#/components/schemas/entityTagHeaderValue" + }, + "enableRangeProcessing": { + "type": "boolean" + } + } + }, + "geoLocationDto": { + "type": "object", + "properties": { + "latitude": { + "type": "string" + }, + "longitude": { + "type": "string" + } + } + }, + "getCompositeScheduleRequest": { + "required": [ + "connectorId", + "duration" + ], + "type": "object", + "properties": { + "connectorId": { + "type": "integer", + "format": "int32" + }, + "duration": { + "type": "integer", + "format": "int32" + }, + "chargingRateUnit": { + "enum": [ + "A", + "W" + ], + "type": "string", + "default": "A" + } + } + }, + "getConfigurationRequest": { + "type": "object", + "properties": { + "key": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "getDiagnosticsRequest": { + "required": [ + "location" + ], + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "retries": { + "type": "integer", + "format": "int32" + }, + "retryInterval": { + "type": "integer", + "format": "int32" + }, + "startTime": { + "type": "string", + "format": "date-time" + }, + "stopTime": { + "type": "string", + "format": "date-time" + } + } + }, + "getLocalListVersionRequest": { + "type": "object" + }, + "hoursDto": { + "type": "object", + "properties": { + "twentyfourseven": { + "type": "boolean" + }, + "regular_hours": { + "type": "array", + "items": { + "$ref": "#/components/schemas/regularHoursDto" + } + }, + "exceptional_openings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/exceptionalPeriodDto" + } + }, + "exceptional_closings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/exceptionalPeriodDto" + } + } + } + }, + "idTagInfo": { + "required": [ + "status" + ], + "type": "object", + "properties": { + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "parentIdTag": { + "maxLength": 20, + "minLength": 0, + "type": "string" + }, + "status": { + "enum": [ + "Accepted", + "Blocked", + "Expired", + "Invalid", + "ConcurrentTx" + ], + "type": "string", + "default": "Accepted" + } + } + }, + "imageDto": { + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "thumbnail": { + "type": "string" + }, + "category": { + "enum": [ + "CHARGER", + "ENTRANCE", + "LOCATION", + "NETWORK", + "OPERATOR", + "OTHER", + "OWNER" + ], + "type": "string", + "default": "CHARGER" + }, + "type": { + "type": "string" + }, + "width": { + "type": "integer", + "format": "int32" + }, + "height": { + "type": "integer", + "format": "int32" + } + } + }, + "interchangeFormatCdr": { + "type": "object", + "properties": { + "cdrId": { + "type": "string" + }, + "startDateTime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + }, + "duration": { + "type": "string" + }, + "volume": { + "type": "number", + "format": "double" + }, + "chargePointAddress": { + "type": "string" + }, + "chargePointZip": { + "type": "string" + }, + "chargePointCity": { + "type": "string" + }, + "chargePointCountry": { + "type": "string" + }, + "chargePointType": { + "type": "string" + }, + "productType": { + "type": "string" + }, + "tariffType": { + "type": "string" + }, + "authenticationId": { + "type": "string" + }, + "contractId": { + "type": "string" + }, + "meterId": { + "type": "string" + }, + "obisCode": { + "type": "string" + }, + "chargePointId": { + "type": "string" + }, + "serviceProviderId": { + "type": "string" + }, + "infraProviderId": { + "type": "string" + }, + "calculatedCost": { + "type": "number", + "format": "double" + } + } + }, + "localTokenGroupGetDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "oucode": { + "type": "string" + }, + "tokenGroupName": { + "type": "string" + }, + "targetOUCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/localTokenGroupTokenGetDto" + } + }, + "targetChargepointIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "updated": { + "type": "string", + "format": "date-time" + } + } + }, + "localTokenGroupPostDto": { + "type": "object", + "properties": { + "oucode": { + "type": "string" + }, + "tokenGroupName": { + "type": "string" + }, + "targetOUCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/localTokenGroupTokenPostDto" + } + }, + "targetChargepointIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "localTokenGroupPutDto": { + "type": "object", + "properties": { + "oucode": { + "type": "string" + }, + "tokenGroupName": { + "type": "string" + }, + "targetOUCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "tokens": { + "type": "array", + "items": { + "$ref": "#/components/schemas/localTokenGroupTokenPutDto" + } + }, + "targetChargepointIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "localTokenGroupTokenGetDto": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "contractId": { + "type": "string" + }, + "normalizedContractId": { + "type": "string" + } + } + }, + "localTokenGroupTokenPostDto": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "contractId": { + "type": "string" + } + } + }, + "localTokenGroupTokenPutDto": { + "type": "object", + "properties": { + "isValid": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "uid": { + "type": "string" + }, + "contractId": { + "type": "string" + } + } + }, + "locationChargePointDto": { + "type": "object", + "properties": { + "chargePointId": { + "type": "string" + } + } + }, + "locationDto": { + "required": [ + "id", + "country_code", + "party_id", + "publish", + "street", + "city", + "country", + "coordinates", + "time_zone", + "last_updated" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "country_code": { + "type": "string" + }, + "party_id": { + "type": "string" + }, + "publish": { + "type": "boolean" + }, + "publish_allowed_to": { + "type": "array", + "items": { + "$ref": "#/components/schemas/publishTokenTypeDto" + } + }, + "name": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "street": { + "type": "string" + }, + "city": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "hotline_phonenumber": { + "type": "string" + }, + "coordinates": { + "$ref": "#/components/schemas/geoLocationDto" + }, + "related_locations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additionalGeoLocationDto" + } + }, + "parking_type": { + "enum": [ + "ALONG_MOTORWAY", + "PARKING_GARAGE", + "PARKING_LOT", + "ON_DRIVEWAY", + "ON_STREET", + "UNDERGROUND_GARAGE" + ], + "type": "string", + "default": "ALONG_MOTORWAY" + }, + "evses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/locationEVSEDto" + } + }, + "directions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/displayTextDto" + } + }, + "operator": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "suboperator": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "owner": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "facilities": { + "type": "array", + "items": { + "enum": [ + "HOTEL", + "RESTAURANT", + "CAFE", + "MALL", + "SUPERMARKET", + "SPORT", + "RECREATION_AREA", + "NATURE", + "MUSEUM", + "BIKE_SHARING", + "BUS_STOP", + "TAXI_STAND", + "TRAM_STOP", + "METRO_STATION", + "TRAIN_STATION", + "AIRPORT", + "PARKING_LOT", + "CARPOOL_PARKING", + "FUEL_STATION", + "WIFI" + ], + "type": "string", + "default": "HOTEL" + } + }, + "time_zone": { + "type": "string" + }, + "opening_times": { + "$ref": "#/components/schemas/hoursDto" + }, + "charging_when_closed": { + "type": "boolean" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/imageDto" + } + }, + "energy_mix": { + "$ref": "#/components/schemas/energyMixDto" + }, + "last_updated": { + "type": "string", + "format": "date-time" + }, + "hasReimbursement": { + "type": "boolean" + }, + "reimburseInfo": { + "$ref": "#/components/schemas/reimburseInfoDto" + }, + "operatorId": { + "type": "string" + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + }, + "externalReference1": { + "type": "string" + }, + "externalReference2": { + "type": "string" + }, + "externalReference3": { + "type": "string" + } + } + }, + "locationEVSEDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "chargepointid": { + "type": "string" + }, + "latitude": { + "type": "number", + "format": "double" + }, + "longitude": { + "type": "number", + "format": "double" + }, + "uid": { + "type": "string" + }, + "evse_id": { + "type": "string" + }, + "status": { + "enum": [ + "AVAILABLE", + "BLOCKED", + "CHARGING", + "INOPERATIVE", + "OUTOFORDER", + "PLANNED", + "REMOVED", + "RESERVED", + "UNKNOWN" + ], + "type": "string", + "default": "AVAILABLE" + }, + "status_schedule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/statusScheduleDto" + } + }, + "capabilities": { + "type": "array", + "items": { + "enum": [ + "CHARGING_PROFILE_CAPABLE", + "CHARGING_PREFERENCES_CAPABLE", + "CHIP_CARD_SUPPORT", + "CONTACTLESS_CARD_SUPPORT", + "CREDIT_CARD_PAYABLE", + "DEBIT_CARD_PAYABLE", + "PED_TERMINAL", + "REMOTE_START_STOP_CAPABLE", + "RESERVABLE", + "RFID_READER", + "TOKEN_GROUP_CAPABLE", + "UNLOCK_CAPABLE" + ], + "type": "string", + "default": "CHARGING_PROFILE_CAPABLE" + } + }, + "connectors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/connectorDto" + } + }, + "floor_level": { + "type": "string" + }, + "coordinates": { + "$ref": "#/components/schemas/geoLocationDto" + }, + "physical_reference": { + "type": "string" + }, + "directions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/displayTextDto" + } + }, + "parking_restrictions": { + "type": "array", + "items": { + "enum": [ + "EV_ONLY", + "PLUGGED", + "DISABLED", + "CUSTOMERS", + "MOTORCYCLES" + ], + "type": "string", + "default": "EV_ONLY" + } + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/imageDto" + } + }, + "last_updated": { + "type": "string", + "format": "date-time" + } + } + }, + "locationPostDto": { + "required": [ + "id", + "street", + "city", + "country", + "coordinates", + "timezone" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 39, + "minLength": 0, + "type": "string", + "description": "The unique id of the location." + }, + "street": { + "maxLength": 45, + "minLength": 0, + "type": "string" + }, + "city": { + "maxLength": 45, + "minLength": 0, + "type": "string" + }, + "country": { + "pattern": "^[A-Z]{3}$", + "type": "string", + "description": "The country code in ISO 3166-1 format." + }, + "coordinates": { + "$ref": "#/components/schemas/geoLocationDto" + }, + "timezone": { + "type": "string", + "description": "The timezone as specified by http://www.iana.org/time-zones." + }, + "publish": { + "type": "boolean", + "description": "Whether to publish this to roaming partners or not." + }, + "publishAllowedTo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/publishTokenTypeDto" + } + }, + "name": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "houseNumber": { + "maxLength": 10, + "minLength": 0, + "type": "string" + }, + "postalCode": { + "maxLength": 10, + "minLength": 0, + "type": "string" + }, + "state": { + "maxLength": 20, + "minLength": 0, + "type": "string" + }, + "hotlinePhonenumber": { + "pattern": "^\\+[0-9]{5,15}$", + "type": "string" + }, + "relatedLocations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additionalGeoLocationDto" + } + }, + "parkingType": { + "enum": [ + "ALONG_MOTORWAY", + "PARKING_GARAGE", + "PARKING_LOT", + "ON_DRIVEWAY", + "ON_STREET", + "UNDERGROUND_GARAGE" + ], + "type": "string" + }, + "evses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/locationEVSEDto" + } + }, + "directions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/displayTextDto" + } + }, + "operator": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "suboperator": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "owner": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "facilities": { + "type": "array", + "items": { + "enum": [ + "HOTEL", + "RESTAURANT", + "CAFE", + "MALL", + "SUPERMARKET", + "SPORT", + "RECREATION_AREA", + "NATURE", + "MUSEUM", + "BIKE_SHARING", + "BUS_STOP", + "TAXI_STAND", + "TRAM_STOP", + "METRO_STATION", + "TRAIN_STATION", + "AIRPORT", + "PARKING_LOT", + "CARPOOL_PARKING", + "FUEL_STATION", + "WIFI" + ], + "type": "string", + "default": "HOTEL" + } + }, + "openingTimes": { + "$ref": "#/components/schemas/hoursDto" + }, + "chargingWhenClosed": { + "type": "boolean" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/imageDto" + } + }, + "energyMix": { + "$ref": "#/components/schemas/energyMixDto" + }, + "hasReimbursement": { + "type": "boolean" + }, + "reimburseInfo": { + "$ref": "#/components/schemas/reimburseInfoDto" + }, + "operatorId": { + "type": "string" + }, + "ou": { + "maxLength": 255, + "minLength": 0, + "type": "string", + "description": "ou code like 0000-0001-00001." + }, + "ouId": { + "maxLength": 39, + "minLength": 0, + "type": "string", + "description": "Guid with ouId." + }, + "ouName": { + "maxLength": 255, + "minLength": 0, + "type": "string" + }, + "externalReference1": { + "type": "string" + }, + "externalReference2": { + "type": "string" + }, + "externalReference3": { + "type": "string" + } + } + }, + "locationPutDto": { + "required": [ + "id", + "country_code", + "party_id", + "publish", + "street", + "city", + "country", + "coordinates", + "time_zone", + "last_updated" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "country_code": { + "type": "string" + }, + "party_id": { + "type": "string" + }, + "publish": { + "type": "boolean" + }, + "publish_allowed_to": { + "type": "array", + "items": { + "$ref": "#/components/schemas/publishTokenTypeDto" + } + }, + "name": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "street": { + "type": "string" + }, + "city": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "hotline_phonenumber": { + "type": "string" + }, + "coordinates": { + "$ref": "#/components/schemas/geoLocationDto" + }, + "related_locations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/additionalGeoLocationDto" + } + }, + "parking_type": { + "enum": [ + "ALONG_MOTORWAY", + "PARKING_GARAGE", + "PARKING_LOT", + "ON_DRIVEWAY", + "ON_STREET", + "UNDERGROUND_GARAGE" + ], + "type": "string", + "default": "ALONG_MOTORWAY" + }, + "evses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/locationEVSEDto" + } + }, + "directions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/displayTextDto" + } + }, + "operator": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "suboperator": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "owner": { + "$ref": "#/components/schemas/businessDetailsDto" + }, + "facilities": { + "type": "array", + "items": { + "enum": [ + "HOTEL", + "RESTAURANT", + "CAFE", + "MALL", + "SUPERMARKET", + "SPORT", + "RECREATION_AREA", + "NATURE", + "MUSEUM", + "BIKE_SHARING", + "BUS_STOP", + "TAXI_STAND", + "TRAM_STOP", + "METRO_STATION", + "TRAIN_STATION", + "AIRPORT", + "PARKING_LOT", + "CARPOOL_PARKING", + "FUEL_STATION", + "WIFI" + ], + "type": "string", + "default": "HOTEL" + } + }, + "time_zone": { + "type": "string" + }, + "opening_times": { + "$ref": "#/components/schemas/hoursDto" + }, + "charging_when_closed": { + "type": "boolean" + }, + "images": { + "type": "array", + "items": { + "$ref": "#/components/schemas/imageDto" + } + }, + "energy_mix": { + "$ref": "#/components/schemas/energyMixDto" + }, + "last_updated": { + "type": "string", + "format": "date-time" + }, + "hasReimbursement": { + "type": "boolean" + }, + "reimburseInfo": { + "$ref": "#/components/schemas/reimburseInfoDto" + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + }, + "externalReference1": { + "type": "string" + }, + "externalReference2": { + "type": "string" + }, + "externalReference3": { + "type": "string" + } + } + }, + "locationTariffDistributionDto": { + "required": [ + "validFrom" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "validFrom": { + "type": "string", + "format": "date-time" + } + } + }, + "longshipError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "errorDetails": { + "$ref": "#/components/schemas/longshipErrorDetail" + } + } + }, + "longshipErrorDetail": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "Explains the error." + }, + "referenceId": { + "type": "string", + "description": "When provided, use when contacting support." + } + }, + "description": "More details about the error." + }, + "messageLogDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "chargePointId": { + "type": "string" + }, + "messageId": { + "type": "string" + }, + "wampMessageType": { + "enum": [ + "Unknown", + "Request", + "Response", + "Error" + ], + "type": "string", + "default": "Unknown" + }, + "ocppMessageType": { + "enum": [ + "Authorize", + "BootNotification", + "DiagnosticsStatusNotification", + "FirmwareStatusNotification", + "Heartbeat", + "MeterValues", + "Reset", + "StartTransaction", + "StatusNotification", + "StopTransaction", + "CancelReservation", + "ChangeAvailability", + "ChangeConfiguration", + "ClearCache", + "ClearCharchingProfile", + "GetCompositeSchedule", + "GetConfiguration", + "GetDiagnostics", + "GetLocalList", + "RemoteStartTransaction", + "RemoteStopTransaction", + "ReserveNow", + "SendLocalList", + "SetChargingProfile", + "TriggerMessage", + "UnlockConnector", + "UpdateFirmware", + "DataTransfer", + "TransactionEvent" + ], + "type": "string", + "default": "Authorize" + }, + "direction": { + "enum": [ + "Unknown", + "CpoToCharger", + "ChargerToCpo" + ], + "type": "string", + "default": "Unknown" + }, + "tenantId": { + "type": "string" + }, + "payload": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + } + } + }, + "organizationUnitFinancialDetailsDto": { + "type": "object", + "properties": { + "beneficiaryName": { + "type": "string" + }, + "iban": { + "type": "string" + }, + "bic": { + "type": "string" + } + } + }, + "organizationUnitGetDto": { + "required": [ + "id", + "code" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "parentId": { + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the ou." + }, + "code": { + "type": "string" + }, + "externalReference": { + "type": "string", + "description": "This property can be used to link this OU to another system." + }, + "gridOwnerReference": { + "type": "string", + "description": "This property can be used to link this OU to a grid owner." + }, + "tenantReference": { + "type": "string", + "description": "This property can be used to link this OU to a tenant." + }, + "customerReference": { + "type": "string", + "description": "This property can be used to link this OU to a customer." + }, + "address": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "city": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "postalCode": { + "type": "string" + }, + "hotlinePhoneNumber": { + "type": "string" + }, + "companyEmail": { + "type": "string" + }, + "primaryContactperson": { + "type": "string" + }, + "primaryContactpersonEmail": { + "type": "string" + }, + "directPaymentProfileId": { + "type": "string" + }, + "mspOuId": { + "type": "string", + "description": "The ou id used for the \"Msp Integration\" feature." + }, + "mspOuName": { + "type": "string", + "description": "The ou name used for the \"Msp Integration\" feature." + }, + "mspOuCode": { + "type": "string", + "description": "The ou code used for the \"Msp Integration\" feature." + }, + "mspExternalId": { + "type": "string", + "description": "The externalId from the \"Msp Integration\" feature." + }, + "financialDetails": { + "$ref": "#/components/schemas/organizationUnitFinancialDetailsDto" + } + } + }, + "organizationUnitPostDto": { + "required": [ + "parentId" + ], + "type": "object", + "properties": { + "parentId": { + "type": "string", + "description": "The id of parent ou." + }, + "name": { + "type": "string", + "description": "The name of the ou." + }, + "externalReference": { + "type": "string", + "description": "This property can be used to link this OU to another system." + }, + "gridOwnerReference": { + "type": "string", + "description": "This property can be used to link this OU to a grid owner." + }, + "tenantReference": { + "type": "string", + "description": "This property can be used to link this OU to a tenant." + }, + "customerReference": { + "type": "string", + "description": "This property can be used to link this OU to a customer." + }, + "address": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "city": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "postalCode": { + "type": "string" + }, + "hotlinePhoneNumber": { + "type": "string" + }, + "companyEmail": { + "type": "string" + }, + "primaryContactperson": { + "type": "string" + }, + "primaryContactpersonEmail": { + "type": "string" + }, + "mspOuId": { + "type": "string", + "description": "The ou id used for the \"Msp Integration\" feature." + }, + "mspOuName": { + "type": "string", + "description": "The ou name used for the \"Msp Integration\" feature." + }, + "mspOuCode": { + "type": "string", + "description": "The ou code used for the \"Msp Integration\" feature." + }, + "mspExternalId": { + "type": "string", + "description": "The externalId from the \"Msp Integration\" feature." + }, + "financialDetails": { + "$ref": "#/components/schemas/organizationUnitFinancialDetailsDto" + } + } + }, + "organizationUnitPutDto": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ou." + }, + "externalReference": { + "type": "string", + "description": "This property can be used to link this OU to another system." + }, + "gridOwnerReference": { + "type": "string", + "description": "This property can be used to link this OU to a grid owner." + }, + "tenantReference": { + "type": "string", + "description": "This property can be used to link this OU to a tenant." + }, + "customerReference": { + "type": "string", + "description": "This property can be used to link this OU to a customer." + }, + "address": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "city": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "postalCode": { + "type": "string" + }, + "hotlinePhoneNumber": { + "type": "string" + }, + "companyEmail": { + "type": "string" + }, + "primaryContactperson": { + "type": "string" + }, + "primaryContactpersonEmail": { + "type": "string" + }, + "mspOuId": { + "type": "string", + "description": "The ou id used for the \"Msp Integration\" feature." + }, + "mspOuName": { + "type": "string", + "description": "The ou name used for the \"Msp Integration\" feature." + }, + "mspOuCode": { + "type": "string", + "description": "The ou code used for the \"Msp Integration\" feature." + }, + "mspExternalId": { + "type": "string", + "description": "The externalId from the \"Msp Integration\" feature." + }, + "financialDetails": { + "$ref": "#/components/schemas/organizationUnitFinancialDetailsDto" + } + } + }, + "priceInfoDto": { + "type": "object", + "properties": { + "startPrice": { + "type": "number", + "format": "double" + }, + "energyPrice": { + "type": "number", + "format": "double" + }, + "totalParkingTimeInMinutes": { + "type": "number", + "format": "double" + }, + "totalParkingTimeSteps": { + "type": "integer", + "format": "int32" + }, + "parkingTimePrice": { + "type": "number", + "format": "double" + }, + "totalChargingTimeInMinutes": { + "type": "number", + "format": "double" + }, + "totalChargingTimeSteps": { + "type": "integer", + "format": "int32" + }, + "chargingTimePrice": { + "type": "number", + "format": "double" + }, + "totalPrice": { + "type": "number", + "format": "double" + } + } + }, + "privateEmpTariffDto": { + "type": "object", + "properties": { + "country_code": { + "type": "string" + }, + "party_id": { + "type": "string" + }, + "powerType": { + "enum": [ + "AC", + "DC" + ], + "type": "string", + "default": "AC" + }, + "usePublicTariffWhenKwhIsCheaper": { + "type": "boolean" + } + } + }, + "publishTokenTypeDto": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "type": { + "enum": [ + "RFID", + "AD_HOC_USER", + "APP_USER", + "OTHER" + ], + "type": "string", + "default": "RFID" + }, + "visual_number": { + "type": "string" + }, + "issuer": { + "type": "string" + }, + "group_id": { + "type": "string" + } + } + }, + "regularHoursDto": { + "type": "object", + "properties": { + "weekday": { + "type": "integer", + "format": "int32" + }, + "period_begin": { + "type": "string" + }, + "period_end": { + "type": "string" + } + } + }, + "reimburseInfoDto": { + "type": "object", + "properties": { + "type": { + "enum": [ + "ORGANIZATIONUNIT", + "TOKEN", + "NONE" + ], + "type": "string", + "default": "ORGANIZATIONUNIT" + }, + "hasGuestUsage": { + "type": "boolean" + }, + "hasGuestChargingReimbursementFee": { + "type": "boolean" + }, + "countryCode": { + "type": "string" + }, + "partyId": { + "type": "string" + }, + "externalOrganizationUnitId": { + "type": "string" + }, + "externalOrganizationUnitName": { + "type": "string" + }, + "externalOrganizationUnitReference": { + "type": "string" + }, + "externalOrganizationUnitCode": { + "type": "string" + }, + "chargeCardEMAID": { + "type": "string" + }, + "chargeCardUID": { + "type": "string" + }, + "chargeCardIssuer": { + "type": "string" + }, + "tariffs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reimbursementTariffDto" + } + }, + "bankDetails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reimbursementBankDetailsDto" + } + }, + "tariffDistributionId": { + "type": "string" + }, + "tariffDistributionHistory": { + "type": "array", + "items": { + "$ref": "#/components/schemas/locationTariffDistributionDto" + } + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + } + } + }, + "reimbursementBankDetailsDto": { + "type": "object", + "properties": { + "bankaccount": { + "type": "string" + }, + "dateCreated": { + "type": "string", + "format": "date-time" + }, + "validFrom": { + "type": "string", + "format": "date-time" + } + } + }, + "reimbursementCdrDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tenantId": { + "type": "string" + }, + "chargePointId": { + "type": "string" + }, + "connectorId": { + "type": "integer", + "format": "int32" + }, + "locationId": { + "type": "string" + }, + "evseId": { + "type": "string" + }, + "location": { + "$ref": "#/components/schemas/reimbursementCdrLocationDto" + }, + "startDatetime": { + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "format": "date-time" + }, + "sessionId": { + "type": "string" + }, + "startedByInfo": { + "$ref": "#/components/schemas/reimburseStartedByInfoDto" + }, + "meterStartInWh": { + "type": "integer", + "format": "int32" + }, + "meterStopInWh": { + "type": "integer", + "format": "int32" + }, + "totalEnergyInKwh": { + "type": "number", + "format": "double" + }, + "totalTimeInHours": { + "type": "number", + "format": "double" + }, + "totalPrice": { + "type": "number", + "format": "double" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + }, + "reimburseTariffId": { + "type": "string" + }, + "reimburseTariffName": { + "type": "string" + }, + "reimburseTariffPrice": { + "type": "number", + "format": "double" + }, + "reimburseTariffCalculated": { + "type": "boolean" + }, + "reimbursePriceCalculatedOn": { + "type": "string", + "format": "date-time" + }, + "bankAccount": { + "type": "string" + }, + "bankAccountCreatedOn": { + "type": "string", + "format": "date-time" + }, + "bankAccountValidFrom": { + "type": "string", + "format": "date-time" + }, + "reimburseTariffOriginalPrice": { + "type": "number", + "format": "double" + }, + "hasGuestChargingReimbursementFee": { + "type": "boolean" + }, + "reimburseTenantFee": { + "type": "number", + "format": "double" + }, + "tenantFeeCalculated": { + "type": "boolean" + }, + "tariffDistributionId": { + "type": "string" + }, + "priceInfo": { + "$ref": "#/components/schemas/priceInfoDto" + }, + "customerShare": { + "type": "number", + "format": "double" + }, + "energyCompensation": { + "type": "number", + "format": "double" + }, + "reimbursementCustomerShare": { + "$ref": "#/components/schemas/reimbursementCustomerShareDto" + }, + "localStartDateTime": { + "type": "string", + "format": "date-time" + }, + "localEndDateTime": { + "type": "string", + "format": "date-time" + } + } + }, + "reimbursementCdrGeoLocationDto": { + "type": "object", + "properties": { + "latitude": { + "type": "string" + }, + "longitude": { + "type": "string" + } + } + }, + "reimbursementCdrLocationDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "evseId": { + "type": "string" + }, + "powerType": { + "enum": [ + "AC_1_PHASE", + "AC_3_PHASE", + "DC" + ], + "type": "string", + "default": "AC_1_PHASE" + }, + "country_code": { + "type": "string" + }, + "party_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "street": { + "type": "string" + }, + "city": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "hotline_phonenumber": { + "type": "string" + }, + "coordinates": { + "$ref": "#/components/schemas/reimbursementCdrGeoLocationDto" + }, + "time_zone": { + "type": "string" + }, + "hasReimbursement": { + "type": "boolean" + } + } + }, + "reimbursementCustomerShareDto": { + "type": "object", + "properties": { + "customerShare": { + "type": "number", + "format": "double" + }, + "energyCompensation": { + "type": "number", + "format": "double" + }, + "tenantFee": { + "type": "number", + "format": "double" + } + } + }, + "reimbursementPriceDto": { + "type": "object", + "properties": { + "excl_vat": { + "type": "number", + "format": "double" + }, + "incl_vat": { + "type": "number", + "format": "double" + } + } + }, + "reimbursementTariffDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "dateCreated": { + "type": "string", + "format": "date-time" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "currency": { + "type": "string" + }, + "price": { + "$ref": "#/components/schemas/reimbursementPriceDto" + }, + "status": { + "enum": [ + "PENDING", + "APPROVED", + "REJECTED" + ], + "type": "string", + "default": "PENDING" + } + } + }, + "reimburseStartedByInfoDto": { + "type": "object", + "properties": { + "idTag": { + "type": "string" + }, + "tokenInfo": { + "$ref": "#/components/schemas/reimburseStartedByTokenDto" + }, + "authorizationState": { + "enum": [ + "ApprovedByRemote", + "ApprovedByLocalToken", + "ApprovedByAllowAny", + "ApprovedByRoamingPartner", + "ApprovedByAuthRequest", + "WaitingForRemoteStop", + "ErrorUnkownRemoteToken", + "ErrorInvalidLocalToken", + "ErrorNoLocalOrRemoteApproval", + "ErrorNoRoamingApproval" + ], + "type": "string", + "default": "ApprovedByRemote" + }, + "isGuestUsage": { + "type": "boolean" + } + } + }, + "reimburseStartedByTokenDto": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "authReference": { + "type": "string" + }, + "tokenType": { + "enum": [ + "AD_HOC_USER", + "APP_USER", + "OTHER", + "RFID" + ], + "type": "string", + "default": "AD_HOC_USER" + }, + "contractId": { + "type": "string" + }, + "authMethod": { + "enum": [ + "AUTH_REQUEST", + "COMMAND", + "WHITELIST" + ], + "type": "string", + "default": "AUTH_REQUEST" + }, + "providerCountryCode": { + "type": "string" + }, + "providerPartyId": { + "type": "string" + }, + "tokenOUId": { + "type": "string" + }, + "tokenOUName": { + "type": "string" + }, + "tokenOU": { + "type": "string" + } + } + }, + "remoteStartTransactionRequest": { + "required": [ + "idTag" + ], + "type": "object", + "properties": { + "connectorId": { + "type": "integer", + "format": "int32" + }, + "idTag": { + "maxLength": 20, + "minLength": 0, + "type": "string" + }, + "chargingProfile": { + "$ref": "#/components/schemas/chargingProfile" + } + } + }, + "remoteStopTransactionRequest": { + "required": [ + "transactionId" + ], + "type": "object", + "properties": { + "transactionId": { + "type": "integer", + "format": "int32" + } + } + }, + "reserveNowRequest": { + "required": [ + "connectorId", + "expiryDate", + "idTag", + "reservationId" + ], + "type": "object", + "properties": { + "connectorId": { + "type": "integer", + "format": "int32" + }, + "expiryDate": { + "type": "string", + "format": "date-time" + }, + "idTag": { + "maxLength": 20, + "minLength": 0, + "type": "string" + }, + "parentIdTag": { + "maxLength": 20, + "minLength": 0, + "type": "string" + }, + "reservationId": { + "type": "integer", + "format": "int32" + } + } + }, + "resetRequest": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "enum": [ + "Hard", + "Soft" + ], + "type": "string", + "default": "Hard" + } + } + }, + "sendLocalListRequest": { + "required": [ + "listVersion", + "updateType" + ], + "type": "object", + "properties": { + "listVersion": { + "type": "integer", + "format": "int32" + }, + "localAuthorizationList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/authorizationData" + } + }, + "updateType": { + "enum": [ + "Differential", + "Full" + ], + "type": "string", + "default": "Differential" + } + } + }, + "sessionDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tenantId": { + "type": "string" + }, + "chargePointId": { + "type": "string" + }, + "transactionId": { + "type": "integer", + "format": "int32" + }, + "ocppTransactionId": { + "type": "string" + }, + "connectorId": { + "type": "integer", + "format": "int32" + }, + "sessionLocation": { + "$ref": "#/components/schemas/sessionLocationDto" + }, + "idTag": { + "type": "string" + }, + "startedByInfo": { + "$ref": "#/components/schemas/startedByInfoDto" + }, + "meterStartInWh": { + "type": "integer", + "format": "int32" + }, + "sessionStart": { + "type": "string", + "format": "date-time" + }, + "chargingPeriods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargingPeriodDto" + } + }, + "chargingMeterValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargingMeterValueDto" + } + }, + "meterStopInWh": { + "type": "integer", + "format": "int32" + }, + "sessionStop": { + "type": "string", + "format": "date-time" + }, + "status": { + "enum": [ + "ACTIVE", + "COMPLETED", + "INVALID", + "PENDING", + "RESERVATION" + ], + "type": "string", + "default": "ACTIVE" + }, + "totalEnergyInKwh": { + "type": "number", + "format": "double" + }, + "totalPrice": { + "type": "number", + "format": "double" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "ou": { + "type": "string" + }, + "ouId": { + "type": "string" + }, + "ouName": { + "type": "string" + }, + "tariffInfo": { + "$ref": "#/components/schemas/tariffInfoDto" + }, + "priceInfo": { + "$ref": "#/components/schemas/priceInfoDto" + }, + "tariffId": { + "type": "string" + }, + "tariffName": { + "type": "string" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "tariffPrice": { + "type": "number", + "format": "double" + }, + "parkingTariff": { + "type": "number", + "format": "double" + }, + "parkingStepSize": { + "type": "integer", + "format": "int32" + }, + "delayInMinutes": { + "type": "integer", + "format": "int32" + } + } + }, + "sessionGeoLocationDto": { + "type": "object", + "properties": { + "latitude": { + "type": "string" + }, + "longitude": { + "type": "string" + } + } + }, + "sessionLocationDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "evseId": { + "type": "string" + }, + "powerType": { + "enum": [ + "AC_1_PHASE", + "AC_3_PHASE", + "DC" + ], + "type": "string", + "default": "AC_1_PHASE" + }, + "country_code": { + "type": "string" + }, + "party_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "houseNumber": { + "type": "string" + }, + "street": { + "type": "string" + }, + "city": { + "type": "string" + }, + "postal_code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "country": { + "type": "string" + }, + "hotline_phonenumber": { + "type": "string" + }, + "coordinates": { + "$ref": "#/components/schemas/sessionGeoLocationDto" + }, + "time_zone": { + "type": "string" + }, + "hasReimbursement": { + "type": "boolean" + } + } + }, + "setChargingProfileRequest": { + "required": [ + "connectorId", + "csChargingProfiles" + ], + "type": "object", + "properties": { + "connectorId": { + "type": "integer", + "format": "int32" + }, + "csChargingProfiles": { + "$ref": "#/components/schemas/csChargingProfiles" + } + } + }, + "startedByInfoDto": { + "type": "object", + "properties": { + "tokenInfo": { + "$ref": "#/components/schemas/startedByTokenDto" + }, + "roamingPlatformType": { + "enum": [ + "Hubject", + "Ocpi" + ], + "type": "string", + "default": "Hubject" + }, + "authorizationState": { + "enum": [ + "ApprovedByRemote", + "ApprovedByLocalToken", + "ApprovedByAllowAny", + "ApprovedByRoamingPartner", + "ApprovedByAuthRequest", + "WaitingForRemoteStop", + "ErrorUnkownRemoteToken", + "ErrorInvalidLocalToken", + "ErrorNoLocalOrRemoteApproval", + "ErrorNoRoamingApproval" + ], + "type": "string", + "default": "ApprovedByRemote" + }, + "roamingPlatformConnectionId": { + "type": "string" + }, + "isGuestUsage": { + "type": "boolean" + } + } + }, + "startedByTokenDto": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "authReference": { + "type": "string" + }, + "tokenType": { + "enum": [ + "AD_HOC_USER", + "APP_USER", + "OTHER", + "RFID" + ], + "type": "string", + "default": "AD_HOC_USER" + }, + "contractId": { + "type": "string" + }, + "authMethod": { + "enum": [ + "AUTH_REQUEST", + "COMMAND", + "WHITELIST" + ], + "type": "string", + "default": "AUTH_REQUEST" + }, + "providerCountryCode": { + "type": "string" + }, + "providerPartyId": { + "type": "string" + }, + "tokenOUId": { + "type": "string" + }, + "tokenOUName": { + "type": "string" + }, + "tokenOU": { + "type": "string" + } + } + }, + "statusScheduleDto": { + "type": "object", + "properties": { + "period_begin": { + "type": "string", + "format": "date-time" + }, + "period_end": { + "type": "string", + "format": "date-time" + }, + "status": { + "enum": [ + "AVAILABLE", + "BLOCKED", + "CHARGING", + "INOPERATIVE", + "OUTOFORDER", + "PLANNED", + "REMOVED", + "RESERVED", + "UNKNOWN" + ], + "type": "string", + "default": "AVAILABLE" + } + } + }, + "stringSegment": { + "type": "object", + "properties": { + "buffer": { + "type": "string" + }, + "offset": { + "type": "integer", + "format": "int32" + }, + "length": { + "type": "integer", + "format": "int32" + }, + "value": { + "type": "string" + }, + "hasValue": { + "type": "boolean" + } + } + }, + "tariffAssertionDto": { + "type": "object", + "properties": { + "tariffType": { + "enum": [ + "ReimbursementTariff", + "PrivateTariff", + "SellTariff", + "DefaultTariff" + ], + "type": "string", + "default": "ReimbursementTariff" + }, + "isTariffUsed": { + "type": "boolean" + }, + "tariffResult": { + "type": "string" + } + } + }, + "tariffDistributionGetDto": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ouCode": { + "type": "string" + }, + "energyCompensation": { + "type": "number", + "format": "double" + }, + "fixedTenantKWhFee": { + "type": "number", + "format": "double" + }, + "percentageFeeCustomer": { + "type": "number", + "format": "double" + }, + "percentageFeeTenant": { + "type": "number", + "format": "double" + }, + "priceHistory": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tariffDistributionHistoryDto" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "deleted": { + "type": "string", + "format": "date-time" + }, + "updated": { + "type": "string", + "format": "date-time" + } + } + }, + "tariffDistributionHistoryDto": { + "type": "object", + "properties": { + "validFrom": { + "type": "string", + "format": "date-time" + }, + "energyCompensation": { + "type": "number", + "format": "double" + }, + "fixedTenantKWhFee": { + "type": "number", + "format": "double" + }, + "percentageFeeCustomer": { + "type": "number", + "format": "double" + }, + "percentageFeeTenant": { + "type": "number", + "format": "double" + } + } + }, + "tariffDistributionPostDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "ouCode": { + "type": "string" + }, + "energyCompensation": { + "type": "number", + "format": "double" + }, + "fixedTenantKWhFee": { + "type": "number", + "format": "double" + }, + "percentageFeeCustomer": { + "type": "number", + "format": "double" + }, + "percentageFeeTenant": { + "type": "number", + "format": "double" + } + } + }, + "tariffDistributionPutDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "ouCode": { + "type": "string" + }, + "energyCompensation": { + "type": "number", + "format": "double" + }, + "fixedTenantKWhFee": { + "type": "number", + "format": "double" + }, + "percentageFeeCustomer": { + "type": "number", + "format": "double" + }, + "percentageFeeTenant": { + "type": "number", + "format": "double" + } + } + }, + "tariffDto": { + "required": [ + "tenantId" + ], + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "ocpiId": { + "type": "string" + }, + "hubjectId": { + "type": "string" + }, + "tenantId": { + "type": "string" + }, + "name": { + "type": "string" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "price": { + "type": "number", + "format": "double" + }, + "priceInclVat": { + "type": "number", + "format": "double" + }, + "currency": { + "type": "string" + }, + "last_updated": { + "type": "string", + "format": "date-time" + }, + "usageType": { + "enum": [ + "SELL", + "BUY", + "REIMBURSE", + "SELLPRIVATE", + "DEFAULT" + ], + "type": "string", + "default": "SELL" + }, + "tariffType": { + "enum": [ + "AD_HOC_PAYMENT", + "REGULAR" + ], + "type": "string", + "default": "AD_HOC_PAYMENT" + }, + "vat": { + "type": "number", + "format": "double" + }, + "isVatRelevant": { + "type": "boolean" + }, + "country_code": { + "type": "string" + }, + "party_id": { + "type": "string" + }, + "locationId": { + "type": "string" + }, + "isPrivateEmpTariff": { + "type": "boolean" + }, + "privateEmpTariff": { + "$ref": "#/components/schemas/privateEmpTariffDto" + }, + "parkingTariff": { + "type": "number", + "format": "double" + }, + "parkingStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingTariffRestriction": { + "$ref": "#/components/schemas/tariffRestriction" + }, + "timeTariff": { + "type": "number", + "format": "double" + }, + "timeStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "timeGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "priceHistory": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tariffPriceDto" + } + }, + "externalReference": { + "type": "string" + } + } + }, + "tariffInfoDto": { + "type": "object", + "properties": { + "tariffId": { + "type": "string" + }, + "tariffName": { + "type": "string" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "tariffPrice": { + "type": "number", + "format": "double" + }, + "parkingTariff": { + "type": "number", + "format": "double" + }, + "parkingStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "timeTariff": { + "type": "number", + "format": "double" + }, + "timeStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "timeGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "assertions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tariffAssertionDto" + } + } + } + }, + "tariffPostDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "currency": { + "type": "string" + }, + "usageType": { + "enum": [ + "SELL", + "BUY", + "REIMBURSE", + "SELLPRIVATE", + "DEFAULT" + ], + "type": "string", + "default": "SELL" + }, + "privateEmpTariff": { + "$ref": "#/components/schemas/privateEmpTariffDto" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "price": { + "type": "number", + "format": "double" + }, + "parkingTariff": { + "type": "number", + "format": "double" + }, + "parkingStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingTariffRestriction": { + "$ref": "#/components/schemas/tariffRestriction" + }, + "timeTariff": { + "type": "number", + "format": "double" + }, + "timeStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "timeGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "externalReference": { + "type": "string" + } + } + }, + "tariffPriceDto": { + "type": "object", + "properties": { + "createdTimestamp": { + "type": "string", + "format": "date-time" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "pricePerKwh": { + "type": "number", + "format": "double" + }, + "pricePerKwhInclVat": { + "type": "number", + "format": "double" + }, + "isVatRelevant": { + "type": "boolean" + }, + "parkingTariff": { + "type": "number", + "format": "double" + }, + "parkingStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingTariffRestriction": { + "$ref": "#/components/schemas/tariffRestriction" + }, + "timeTariff": { + "type": "number", + "format": "double" + }, + "timeStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "timeGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "approvalStatus": { + "enum": [ + "PENDING", + "APPROVED", + "REJECTED" + ], + "type": "string", + "default": "PENDING" + } + } + }, + "tariffPutDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "hubjectId": { + "type": "string" + }, + "privateEmpTariff": { + "$ref": "#/components/schemas/privateEmpTariffDto" + }, + "startTariff": { + "type": "number", + "format": "double" + }, + "price": { + "type": "number", + "format": "double" + }, + "parkingTariff": { + "type": "number", + "format": "double" + }, + "parkingStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "parkingTariffRestriction": { + "$ref": "#/components/schemas/tariffRestriction" + }, + "timeTariff": { + "type": "number", + "format": "double" + }, + "timeStepSizeInMinutes": { + "type": "integer", + "format": "int32" + }, + "timeGracePeriodInMinutes": { + "type": "integer", + "format": "int32" + }, + "externalReference": { + "type": "string" + } + } + }, + "tariffRestriction": { + "type": "object", + "properties": { + "start_time": { + "type": "string" + }, + "end_time": { + "type": "string" + }, + "start_date": { + "type": "string", + "format": "date-time" + }, + "end_date": { + "type": "string", + "format": "date-time" + }, + "day_of_week": { + "type": "array", + "items": { + "enum": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6 + ], + "type": "integer", + "format": "int32", + "default": 0 + } + } + } + }, + "triggerMessageRequest": { + "required": [ + "requestedMessage" + ], + "type": "object", + "properties": { + "requestedMessage": { + "enum": [ + "BootNotification", + "DiagnosticsStatusNotification", + "FirmwareStatusNotification", + "Heartbeat", + "MeterValues", + "StatusNotification" + ], + "type": "string", + "default": "BootNotification" + }, + "connectorId": { + "type": "integer", + "format": "int32" + } + } + }, + "unlockConnectorRequest": { + "required": [ + "connectorId" + ], + "type": "object", + "properties": { + "connectorId": { + "type": "integer", + "format": "int32" + } + } + }, + "updateFirmwareRequest": { + "required": [ + "location", + "retrieveDate" + ], + "type": "object", + "properties": { + "location": { + "type": "string" + }, + "retries": { + "type": "integer", + "format": "int32" + }, + "retrieveDate": { + "type": "string", + "format": "date-time" + }, + "retryInterval": { + "type": "integer", + "format": "int32" + } + } + }, + "webhookGetDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ouCode": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "eventTypes": { + "type": "array", + "items": { + "enum": [ + "SESSION_START", + "PING", + "SESSION_STOP", + "SESSION_UPDATE", + "OPERATIONAL_STATUS", + "CONNECTIVITY_STATUS", + "CHARGEPOINT_BOOTED", + "CDR_CREATED", + "LOCATION_CREATED", + "LOCATION_UPDATED", + "MSP_INVOICE_PROPOSAL_STATUS" + ], + "type": "string", + "default": "SESSION_START" + } + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhookHeaderDto" + } + }, + "url": { + "type": "string", + "format": "uri" + }, + "created": { + "type": "string", + "format": "date-time" + }, + "updated": { + "type": "string", + "format": "date-time" + } + } + }, + "webhookHeaderDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "webhookPostDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "ouCode": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "eventTypes": { + "type": "array", + "items": { + "enum": [ + "SESSION_START", + "PING", + "SESSION_STOP", + "SESSION_UPDATE", + "OPERATIONAL_STATUS", + "CONNECTIVITY_STATUS", + "CHARGEPOINT_BOOTED", + "CDR_CREATED", + "LOCATION_CREATED", + "LOCATION_UPDATED", + "MSP_INVOICE_PROPOSAL_STATUS" + ], + "type": "string", + "default": "SESSION_START" + } + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhookHeaderDto" + } + }, + "url": { + "type": "string", + "format": "uri" + } + } + }, + "webhookPutDto": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "ouCode": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "enabled": { + "type": "boolean" + }, + "eventTypes": { + "type": "array", + "items": { + "enum": [ + "SESSION_START", + "PING", + "SESSION_STOP", + "SESSION_UPDATE", + "OPERATIONAL_STATUS", + "CONNECTIVITY_STATUS", + "CHARGEPOINT_BOOTED", + "CDR_CREATED", + "LOCATION_CREATED", + "LOCATION_UPDATED", + "MSP_INVOICE_PROPOSAL_STATUS" + ], + "type": "string", + "default": "SESSION_START" + } + }, + "headers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhookHeaderDto" + } + } + } + }, + "webhookSummaryGetDto": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "eventTypes": { + "type": "array", + "items": { + "enum": [ + "SESSION_START", + "PING", + "SESSION_STOP", + "SESSION_UPDATE", + "OPERATIONAL_STATUS", + "CONNECTIVITY_STATUS", + "CHARGEPOINT_BOOTED", + "CDR_CREATED", + "LOCATION_CREATED", + "LOCATION_UPDATED", + "MSP_INVOICE_PROPOSAL_STATUS" + ], + "type": "string", + "default": "SESSION_START" + } + }, + "created": { + "type": "string", + "format": "date-time" + }, + "updated": { + "type": "string", + "format": "date-time" + } + } + }, + "webhookSummaryGetDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/webhookSummaryGetDto" + } + }, + "tariffDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tariffDto" + } + }, + "tariffDistributionGetDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tariffDistributionGetDto" + } + }, + "sessionDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/sessionDto" + } + }, + "reimbursementCdrDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/reimbursementCdrDto" + } + }, + "organizationUnitGetDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organizationUnitGetDto" + } + }, + "locationDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/locationDto" + } + }, + "localTokenGroupGetDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/localTokenGroupGetDto" + } + }, + "chargepointDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargepointDto" + } + }, + "chargepointConfigurationItemsDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargepointConfigurationItemsDto" + } + }, + "messageLogDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/messageLogDto" + } + }, + "chargepointStatusDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/chargepointStatusDto" + } + }, + "interchangeFormatCdrArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/interchangeFormatCdr" + } + }, + "cdrDtoArray": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cdrDto" + } + } + }, + "securitySchemes": { + "tenantKey": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + }, + "applicationKey": { + "type": "apiKey", + "name": "x-api-key", + "in": "header" + } + } + }, + "security": [ + { + "tenantKey": [] + }, + { + "applicationKey": [] + } + ] +} \ No newline at end of file diff --git a/longship_api_client/api/cdrs/cdr_patch.py b/longship_api_client/api/cdrs/cdr_patch.py new file mode 100644 index 0000000..6641cfe --- /dev/null +++ b/longship_api_client/api/cdrs/cdr_patch.py @@ -0,0 +1,201 @@ +from http import HTTPStatus +from typing import Any, Dict, Optional, Union + +import httpx + +from ... import errors +from ...client import Client +from ...models.cdr_dto import CdrDto +from ...models.cdr_patch_dto import CdrPatchDto +from ...models.longship_error import LongshipError +from ...types import Response + + +def _get_kwargs( + id: str, + *, + client: Client, + json_body: CdrPatchDto, +) -> Dict[str, Any]: + url = "{}/v1/cdrs/{id}".format(client.base_url, id=id) + + headers: Dict[str, str] = client.get_headers() + cookies: Dict[str, Any] = client.get_cookies() + + json_json_body = json_body.to_dict() + + return { + "method": "patch", + "url": url, + "headers": headers, + "cookies": cookies, + "timeout": client.get_timeout(), + "follow_redirects": client.follow_redirects, + "json": json_json_body, + } + + +def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[CdrDto, LongshipError]]: + if response.status_code == HTTPStatus.OK: + response_200 = CdrDto.from_dict(response.json()) + + return response_200 + if response.status_code == HTTPStatus.UNAUTHORIZED: + response_401 = LongshipError.from_dict(response.json()) + + return response_401 + if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR: + response_500 = LongshipError.from_dict(response.json()) + + return response_500 + if response.status_code == HTTPStatus.NOT_FOUND: + response_404 = LongshipError.from_dict(response.json()) + + return response_404 + if response.status_code == HTTPStatus.FORBIDDEN: + response_403 = LongshipError.from_dict(response.json()) + + return response_403 + if client.raise_on_unexpected_status: + raise errors.UnexpectedStatus(response.status_code, response.content) + else: + return None + + +def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[CdrDto, LongshipError]]: + return Response( + status_code=HTTPStatus(response.status_code), + content=response.content, + headers=response.headers, + parsed=_parse_response(client=client, response=response), + ) + + +def sync_detailed( + id: str, + *, + client: Client, + json_body: CdrPatchDto, +) -> Response[Union[CdrDto, LongshipError]]: + """Patches the cdr. + + Patches the cdr based on the id. + + Args: + id (str): + json_body (CdrPatchDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[CdrDto, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + client=client, + json_body=json_body, + ) + + response = httpx.request( + verify=client.verify_ssl, + **kwargs, + ) + + return _build_response(client=client, response=response) + + +def sync( + id: str, + *, + client: Client, + json_body: CdrPatchDto, +) -> Optional[Union[CdrDto, LongshipError]]: + """Patches the cdr. + + Patches the cdr based on the id. + + Args: + id (str): + json_body (CdrPatchDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[CdrDto, LongshipError] + """ + + return sync_detailed( + id=id, + client=client, + json_body=json_body, + ).parsed + + +async def asyncio_detailed( + id: str, + *, + client: Client, + json_body: CdrPatchDto, +) -> Response[Union[CdrDto, LongshipError]]: + """Patches the cdr. + + Patches the cdr based on the id. + + Args: + id (str): + json_body (CdrPatchDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[CdrDto, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + client=client, + json_body=json_body, + ) + + async with httpx.AsyncClient(verify=client.verify_ssl) as _client: + response = await _client.request(**kwargs) + + return _build_response(client=client, response=response) + + +async def asyncio( + id: str, + *, + client: Client, + json_body: CdrPatchDto, +) -> Optional[Union[CdrDto, LongshipError]]: + """Patches the cdr. + + Patches the cdr based on the id. + + Args: + id (str): + json_body (CdrPatchDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[CdrDto, LongshipError] + """ + + return ( + await asyncio_detailed( + id=id, + client=client, + json_body=json_body, + ) + ).parsed diff --git a/longship_api_client/api/configurationitems/__init__.py b/longship_api_client/api/configurationitems/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/longship_api_client/api/configurationitems/configurationitem_get.py b/longship_api_client/api/configurationitems/configurationitem_get.py new file mode 100644 index 0000000..1dff9c5 --- /dev/null +++ b/longship_api_client/api/configurationitems/configurationitem_get.py @@ -0,0 +1,197 @@ +from http import HTTPStatus +from typing import Any, Dict, List, Optional, Union + +import httpx + +from ... import errors +from ...client import Client +from ...models.chargepoint_configuration_items_dto import ChargepointConfigurationItemsDto +from ...models.longship_error import LongshipError +from ...types import Response + + +def _get_kwargs( + id: str, + *, + client: Client, +) -> Dict[str, Any]: + url = "{}/v1/chargepoints/{id}/configurationitems".format(client.base_url, id=id) + + headers: Dict[str, str] = client.get_headers() + cookies: Dict[str, Any] = client.get_cookies() + + return { + "method": "get", + "url": url, + "headers": headers, + "cookies": cookies, + "timeout": client.get_timeout(), + "follow_redirects": client.follow_redirects, + } + + +def _parse_response( + *, client: Client, response: httpx.Response +) -> Optional[Union[List["ChargepointConfigurationItemsDto"], LongshipError]]: + if response.status_code == HTTPStatus.OK: + response_200 = [] + _response_200 = response.json() + for componentsschemaschargepoint_configuration_items_dto_array_item_data in _response_200: + componentsschemaschargepoint_configuration_items_dto_array_item = ( + ChargepointConfigurationItemsDto.from_dict( + componentsschemaschargepoint_configuration_items_dto_array_item_data + ) + ) + + response_200.append(componentsschemaschargepoint_configuration_items_dto_array_item) + + return response_200 + if response.status_code == HTTPStatus.UNAUTHORIZED: + response_401 = LongshipError.from_dict(response.json()) + + return response_401 + if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR: + response_500 = LongshipError.from_dict(response.json()) + + return response_500 + if response.status_code == HTTPStatus.NOT_FOUND: + response_404 = LongshipError.from_dict(response.json()) + + return response_404 + if response.status_code == HTTPStatus.FORBIDDEN: + response_403 = LongshipError.from_dict(response.json()) + + return response_403 + if client.raise_on_unexpected_status: + raise errors.UnexpectedStatus(response.status_code, response.content) + else: + return None + + +def _build_response( + *, client: Client, response: httpx.Response +) -> Response[Union[List["ChargepointConfigurationItemsDto"], LongshipError]]: + return Response( + status_code=HTTPStatus(response.status_code), + content=response.content, + headers=response.headers, + parsed=_parse_response(client=client, response=response), + ) + + +def sync_detailed( + id: str, + *, + client: Client, +) -> Response[Union[List["ChargepointConfigurationItemsDto"], LongshipError]]: + """Gets the configurationitem. + + Gets the configurationitem base on the id. + + Args: + id (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[List['ChargepointConfigurationItemsDto'], LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + client=client, + ) + + response = httpx.request( + verify=client.verify_ssl, + **kwargs, + ) + + return _build_response(client=client, response=response) + + +def sync( + id: str, + *, + client: Client, +) -> Optional[Union[List["ChargepointConfigurationItemsDto"], LongshipError]]: + """Gets the configurationitem. + + Gets the configurationitem base on the id. + + Args: + id (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[List['ChargepointConfigurationItemsDto'], LongshipError] + """ + + return sync_detailed( + id=id, + client=client, + ).parsed + + +async def asyncio_detailed( + id: str, + *, + client: Client, +) -> Response[Union[List["ChargepointConfigurationItemsDto"], LongshipError]]: + """Gets the configurationitem. + + Gets the configurationitem base on the id. + + Args: + id (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[List['ChargepointConfigurationItemsDto'], LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + client=client, + ) + + async with httpx.AsyncClient(verify=client.verify_ssl) as _client: + response = await _client.request(**kwargs) + + return _build_response(client=client, response=response) + + +async def asyncio( + id: str, + *, + client: Client, +) -> Optional[Union[List["ChargepointConfigurationItemsDto"], LongshipError]]: + """Gets the configurationitem. + + Gets the configurationitem base on the id. + + Args: + id (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[List['ChargepointConfigurationItemsDto'], LongshipError] + """ + + return ( + await asyncio_detailed( + id=id, + client=client, + ) + ).parsed diff --git a/longship_api_client/api/localtokengroupstoken/__init__.py b/longship_api_client/api/localtokengroupstoken/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/longship_api_client/api/localtokengroupstoken/local_token_group_token_delete.py b/longship_api_client/api/localtokengroupstoken/local_token_group_token_delete.py new file mode 100644 index 0000000..166d98e --- /dev/null +++ b/longship_api_client/api/localtokengroupstoken/local_token_group_token_delete.py @@ -0,0 +1,195 @@ +from http import HTTPStatus +from typing import Any, Dict, Optional, Union, cast + +import httpx + +from ... import errors +from ...client import Client +from ...models.longship_error import LongshipError +from ...types import Response + + +def _get_kwargs( + id: str, + token_uid: str, + *, + client: Client, +) -> Dict[str, Any]: + url = "{}/v1/localtokengroups/{id}/token/{tokenUid}".format(client.base_url, id=id, tokenUid=token_uid) + + headers: Dict[str, str] = client.get_headers() + cookies: Dict[str, Any] = client.get_cookies() + + return { + "method": "delete", + "url": url, + "headers": headers, + "cookies": cookies, + "timeout": client.get_timeout(), + "follow_redirects": client.follow_redirects, + } + + +def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[Any, LongshipError]]: + if response.status_code == HTTPStatus.NOT_FOUND: + response_404 = LongshipError.from_dict(response.json()) + + return response_404 + if response.status_code == HTTPStatus.UNAUTHORIZED: + response_401 = LongshipError.from_dict(response.json()) + + return response_401 + if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR: + response_500 = LongshipError.from_dict(response.json()) + + return response_500 + if response.status_code == HTTPStatus.FORBIDDEN: + response_403 = LongshipError.from_dict(response.json()) + + return response_403 + if response.status_code == HTTPStatus.OK: + response_200 = cast(Any, None) + return response_200 + if client.raise_on_unexpected_status: + raise errors.UnexpectedStatus(response.status_code, response.content) + else: + return None + + +def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[Any, LongshipError]]: + return Response( + status_code=HTTPStatus(response.status_code), + content=response.content, + headers=response.headers, + parsed=_parse_response(client=client, response=response), + ) + + +def sync_detailed( + id: str, + token_uid: str, + *, + client: Client, +) -> Response[Union[Any, LongshipError]]: + """Deletes a localtokengrouptoken. + + Deletes a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[Any, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + token_uid=token_uid, + client=client, + ) + + response = httpx.request( + verify=client.verify_ssl, + **kwargs, + ) + + return _build_response(client=client, response=response) + + +def sync( + id: str, + token_uid: str, + *, + client: Client, +) -> Optional[Union[Any, LongshipError]]: + """Deletes a localtokengrouptoken. + + Deletes a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[Any, LongshipError] + """ + + return sync_detailed( + id=id, + token_uid=token_uid, + client=client, + ).parsed + + +async def asyncio_detailed( + id: str, + token_uid: str, + *, + client: Client, +) -> Response[Union[Any, LongshipError]]: + """Deletes a localtokengrouptoken. + + Deletes a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[Any, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + token_uid=token_uid, + client=client, + ) + + async with httpx.AsyncClient(verify=client.verify_ssl) as _client: + response = await _client.request(**kwargs) + + return _build_response(client=client, response=response) + + +async def asyncio( + id: str, + token_uid: str, + *, + client: Client, +) -> Optional[Union[Any, LongshipError]]: + """Deletes a localtokengrouptoken. + + Deletes a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[Any, LongshipError] + """ + + return ( + await asyncio_detailed( + id=id, + token_uid=token_uid, + client=client, + ) + ).parsed diff --git a/longship_api_client/api/localtokengroupstoken/local_token_group_token_post.py b/longship_api_client/api/localtokengroupstoken/local_token_group_token_post.py new file mode 100644 index 0000000..a766150 --- /dev/null +++ b/longship_api_client/api/localtokengroupstoken/local_token_group_token_post.py @@ -0,0 +1,199 @@ +from http import HTTPStatus +from typing import Any, Dict, Optional, Union, cast + +import httpx + +from ... import errors +from ...client import Client +from ...models.local_token_group_token_post_dto import LocalTokenGroupTokenPostDto +from ...models.longship_error import LongshipError +from ...types import Response + + +def _get_kwargs( + id: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPostDto, +) -> Dict[str, Any]: + url = "{}/v1/localtokengroups/{id}/token".format(client.base_url, id=id) + + headers: Dict[str, str] = client.get_headers() + cookies: Dict[str, Any] = client.get_cookies() + + json_json_body = json_body.to_dict() + + return { + "method": "post", + "url": url, + "headers": headers, + "cookies": cookies, + "timeout": client.get_timeout(), + "follow_redirects": client.follow_redirects, + "json": json_json_body, + } + + +def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[Any, LongshipError]]: + if response.status_code == HTTPStatus.NOT_FOUND: + response_404 = LongshipError.from_dict(response.json()) + + return response_404 + if response.status_code == HTTPStatus.UNAUTHORIZED: + response_401 = LongshipError.from_dict(response.json()) + + return response_401 + if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR: + response_500 = LongshipError.from_dict(response.json()) + + return response_500 + if response.status_code == HTTPStatus.FORBIDDEN: + response_403 = LongshipError.from_dict(response.json()) + + return response_403 + if response.status_code == HTTPStatus.CREATED: + response_201 = cast(Any, None) + return response_201 + if client.raise_on_unexpected_status: + raise errors.UnexpectedStatus(response.status_code, response.content) + else: + return None + + +def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[Any, LongshipError]]: + return Response( + status_code=HTTPStatus(response.status_code), + content=response.content, + headers=response.headers, + parsed=_parse_response(client=client, response=response), + ) + + +def sync_detailed( + id: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPostDto, +) -> Response[Union[Any, LongshipError]]: + """Creates a localtokengrouptoken. + + Creates a new localtokengrouptoken. + + Args: + id (str): + json_body (LocalTokenGroupTokenPostDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[Any, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + client=client, + json_body=json_body, + ) + + response = httpx.request( + verify=client.verify_ssl, + **kwargs, + ) + + return _build_response(client=client, response=response) + + +def sync( + id: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPostDto, +) -> Optional[Union[Any, LongshipError]]: + """Creates a localtokengrouptoken. + + Creates a new localtokengrouptoken. + + Args: + id (str): + json_body (LocalTokenGroupTokenPostDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[Any, LongshipError] + """ + + return sync_detailed( + id=id, + client=client, + json_body=json_body, + ).parsed + + +async def asyncio_detailed( + id: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPostDto, +) -> Response[Union[Any, LongshipError]]: + """Creates a localtokengrouptoken. + + Creates a new localtokengrouptoken. + + Args: + id (str): + json_body (LocalTokenGroupTokenPostDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[Any, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + client=client, + json_body=json_body, + ) + + async with httpx.AsyncClient(verify=client.verify_ssl) as _client: + response = await _client.request(**kwargs) + + return _build_response(client=client, response=response) + + +async def asyncio( + id: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPostDto, +) -> Optional[Union[Any, LongshipError]]: + """Creates a localtokengrouptoken. + + Creates a new localtokengrouptoken. + + Args: + id (str): + json_body (LocalTokenGroupTokenPostDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[Any, LongshipError] + """ + + return ( + await asyncio_detailed( + id=id, + client=client, + json_body=json_body, + ) + ).parsed diff --git a/longship_api_client/api/localtokengroupstoken/local_token_group_token_put.py b/longship_api_client/api/localtokengroupstoken/local_token_group_token_put.py new file mode 100644 index 0000000..a705d64 --- /dev/null +++ b/longship_api_client/api/localtokengroupstoken/local_token_group_token_put.py @@ -0,0 +1,224 @@ +from http import HTTPStatus +from typing import Any, Dict, Optional, Union, cast + +import httpx + +from ... import errors +from ...client import Client +from ...models.local_token_group_token_put_dto import LocalTokenGroupTokenPutDto +from ...models.longship_error import LongshipError +from ...types import Response + + +def _get_kwargs( + id: str, + token_uid: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPutDto, +) -> Dict[str, Any]: + url = "{}/v1/localtokengroups/{id}/token/{tokenUid}".format(client.base_url, id=id, tokenUid=token_uid) + + headers: Dict[str, str] = client.get_headers() + cookies: Dict[str, Any] = client.get_cookies() + + json_json_body = json_body.to_dict() + + return { + "method": "put", + "url": url, + "headers": headers, + "cookies": cookies, + "timeout": client.get_timeout(), + "follow_redirects": client.follow_redirects, + "json": json_json_body, + } + + +def _parse_response(*, client: Client, response: httpx.Response) -> Optional[Union[Any, LongshipError]]: + if response.status_code == HTTPStatus.NOT_FOUND: + response_404 = LongshipError.from_dict(response.json()) + + return response_404 + if response.status_code == HTTPStatus.UNPROCESSABLE_ENTITY: + response_422 = LongshipError.from_dict(response.json()) + + return response_422 + if response.status_code == HTTPStatus.CONFLICT: + response_409 = LongshipError.from_dict(response.json()) + + return response_409 + if response.status_code == HTTPStatus.BAD_REQUEST: + response_400 = LongshipError.from_dict(response.json()) + + return response_400 + if response.status_code == HTTPStatus.UNAUTHORIZED: + response_401 = LongshipError.from_dict(response.json()) + + return response_401 + if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR: + response_500 = LongshipError.from_dict(response.json()) + + return response_500 + if response.status_code == HTTPStatus.FORBIDDEN: + response_403 = LongshipError.from_dict(response.json()) + + return response_403 + if response.status_code == HTTPStatus.ACCEPTED: + response_202 = cast(Any, None) + return response_202 + if client.raise_on_unexpected_status: + raise errors.UnexpectedStatus(response.status_code, response.content) + else: + return None + + +def _build_response(*, client: Client, response: httpx.Response) -> Response[Union[Any, LongshipError]]: + return Response( + status_code=HTTPStatus(response.status_code), + content=response.content, + headers=response.headers, + parsed=_parse_response(client=client, response=response), + ) + + +def sync_detailed( + id: str, + token_uid: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPutDto, +) -> Response[Union[Any, LongshipError]]: + """Updates a localtokengrouptoken. + + Updates a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + json_body (LocalTokenGroupTokenPutDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[Any, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + token_uid=token_uid, + client=client, + json_body=json_body, + ) + + response = httpx.request( + verify=client.verify_ssl, + **kwargs, + ) + + return _build_response(client=client, response=response) + + +def sync( + id: str, + token_uid: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPutDto, +) -> Optional[Union[Any, LongshipError]]: + """Updates a localtokengrouptoken. + + Updates a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + json_body (LocalTokenGroupTokenPutDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[Any, LongshipError] + """ + + return sync_detailed( + id=id, + token_uid=token_uid, + client=client, + json_body=json_body, + ).parsed + + +async def asyncio_detailed( + id: str, + token_uid: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPutDto, +) -> Response[Union[Any, LongshipError]]: + """Updates a localtokengrouptoken. + + Updates a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + json_body (LocalTokenGroupTokenPutDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Response[Union[Any, LongshipError]] + """ + + kwargs = _get_kwargs( + id=id, + token_uid=token_uid, + client=client, + json_body=json_body, + ) + + async with httpx.AsyncClient(verify=client.verify_ssl) as _client: + response = await _client.request(**kwargs) + + return _build_response(client=client, response=response) + + +async def asyncio( + id: str, + token_uid: str, + *, + client: Client, + json_body: LocalTokenGroupTokenPutDto, +) -> Optional[Union[Any, LongshipError]]: + """Updates a localtokengrouptoken. + + Updates a localtokengrouptoken. + + Args: + id (str): + token_uid (str): + json_body (LocalTokenGroupTokenPutDto): + + Raises: + errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True. + httpx.TimeoutException: If the request takes longer than Client.timeout. + + Returns: + Union[Any, LongshipError] + """ + + return ( + await asyncio_detailed( + id=id, + token_uid=token_uid, + client=client, + json_body=json_body, + ) + ).parsed diff --git a/longship_api_client/models/__init__.py b/longship_api_client/models/__init__.py index 35e378e..f49e077 100644 --- a/longship_api_client/models/__init__.py +++ b/longship_api_client/models/__init__.py @@ -5,9 +5,12 @@ from .business_details_dto import BusinessDetailsDto from .cancel_reservation_request import CancelReservationRequest from .cdr_dto import CdrDto +from .cdr_dto_approval_status import CdrDtoApprovalStatus from .cdr_geo_location_dto import CdrGeoLocationDto from .cdr_location_dto import CdrLocationDto from .cdr_location_dto_power_type import CdrLocationDtoPowerType +from .cdr_patch_dto import CdrPatchDto +from .cdr_patch_dto_approval_status import CdrPatchDtoApprovalStatus from .cdr_started_by_info_dto import CdrStartedByInfoDto from .cdr_started_by_info_dto_authorization_state import CdrStartedByInfoDtoAuthorizationState from .cdr_started_by_info_dto_roaming_platform_type import CdrStartedByInfoDtoRoamingPlatformType @@ -17,6 +20,7 @@ from .change_availability_request import ChangeAvailabilityRequest from .change_availability_request_type import ChangeAvailabilityRequestType from .change_configuration_request import ChangeConfigurationRequest +from .chargepoint_configuration_items_dto import ChargepointConfigurationItemsDto from .chargepoint_connector_dto import ChargepointConnectorDto from .chargepoint_connector_dto_format import ChargepointConnectorDtoFormat from .chargepoint_connector_dto_operational_status import ChargepointConnectorDtoOperationalStatus @@ -171,6 +175,8 @@ from .tariff_price_dto import TariffPriceDto from .tariff_price_dto_approval_status import TariffPriceDtoApprovalStatus from .tariff_put_dto import TariffPutDto +from .tariff_restriction import TariffRestriction +from .tariff_restriction_day_of_week_item import TariffRestrictionDayOfWeekItem from .trigger_message_request import TriggerMessageRequest from .trigger_message_request_requested_message import TriggerMessageRequestRequestedMessage from .unlock_connector_request import UnlockConnectorRequest @@ -191,9 +197,12 @@ "BusinessDetailsDto", "CancelReservationRequest", "CdrDto", + "CdrDtoApprovalStatus", "CdrGeoLocationDto", "CdrLocationDto", "CdrLocationDtoPowerType", + "CdrPatchDto", + "CdrPatchDtoApprovalStatus", "CdrStartedByInfoDto", "CdrStartedByInfoDtoAuthorizationState", "CdrStartedByInfoDtoRoamingPlatformType", @@ -203,6 +212,7 @@ "ChangeAvailabilityRequest", "ChangeAvailabilityRequestType", "ChangeConfigurationRequest", + "ChargepointConfigurationItemsDto", "ChargepointConnectorDto", "ChargepointConnectorDtoFormat", "ChargepointConnectorDtoOperationalStatus", @@ -357,6 +367,8 @@ "TariffPriceDto", "TariffPriceDtoApprovalStatus", "TariffPutDto", + "TariffRestriction", + "TariffRestrictionDayOfWeekItem", "TriggerMessageRequest", "TriggerMessageRequestRequestedMessage", "UnlockConnectorRequest", diff --git a/longship_api_client/models/cdr_dto.py b/longship_api_client/models/cdr_dto.py index e5ae903..66f7fc7 100644 --- a/longship_api_client/models/cdr_dto.py +++ b/longship_api_client/models/cdr_dto.py @@ -4,6 +4,7 @@ import attr from dateutil.parser import isoparse +from ..models.cdr_dto_approval_status import CdrDtoApprovalStatus from ..types import UNSET, Unset if TYPE_CHECKING: @@ -46,6 +47,7 @@ class CdrDto: price_info (Union[Unset, PriceInfoDto]): local_start_date_time (Union[Unset, datetime.datetime]): local_end_date_time (Union[Unset, datetime.datetime]): + approval_status (Union[Unset, CdrDtoApprovalStatus]): Default: CdrDtoApprovalStatus.VALUE_0. """ id: Union[Unset, str] = UNSET @@ -74,6 +76,7 @@ class CdrDto: price_info: Union[Unset, "PriceInfoDto"] = UNSET local_start_date_time: Union[Unset, datetime.datetime] = UNSET local_end_date_time: Union[Unset, datetime.datetime] = UNSET + approval_status: Union[Unset, CdrDtoApprovalStatus] = CdrDtoApprovalStatus.VALUE_0 additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) def to_dict(self) -> Dict[str, Any]: @@ -137,6 +140,10 @@ def to_dict(self) -> Dict[str, Any]: if not isinstance(self.local_end_date_time, Unset): local_end_date_time = self.local_end_date_time.isoformat() + approval_status: Union[Unset, int] = UNSET + if not isinstance(self.approval_status, Unset): + approval_status = self.approval_status.value + field_dict: Dict[str, Any] = {} field_dict.update(self.additional_properties) field_dict.update({}) @@ -192,6 +199,8 @@ def to_dict(self) -> Dict[str, Any]: field_dict["localStartDateTime"] = local_start_date_time if local_end_date_time is not UNSET: field_dict["localEndDateTime"] = local_end_date_time + if approval_status is not UNSET: + field_dict["approvalStatus"] = approval_status return field_dict @@ -305,6 +314,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: else: local_end_date_time = isoparse(_local_end_date_time) + _approval_status = d.pop("approvalStatus", UNSET) + approval_status: Union[Unset, CdrDtoApprovalStatus] + if isinstance(_approval_status, Unset): + approval_status = UNSET + else: + approval_status = CdrDtoApprovalStatus(_approval_status) + cdr_dto = cls( id=id, tenant_id=tenant_id, @@ -332,6 +348,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: price_info=price_info, local_start_date_time=local_start_date_time, local_end_date_time=local_end_date_time, + approval_status=approval_status, ) cdr_dto.additional_properties = d diff --git a/longship_api_client/models/cdr_dto_approval_status.py b/longship_api_client/models/cdr_dto_approval_status.py new file mode 100644 index 0000000..e986bb4 --- /dev/null +++ b/longship_api_client/models/cdr_dto_approval_status.py @@ -0,0 +1,9 @@ +from enum import IntEnum + + +class CdrDtoApprovalStatus(IntEnum): + VALUE_0 = 0 + VALUE_1 = 1 + + def __str__(self) -> str: + return str(self.value) diff --git a/longship_api_client/models/cdr_patch_dto.py b/longship_api_client/models/cdr_patch_dto.py new file mode 100644 index 0000000..95fa15f --- /dev/null +++ b/longship_api_client/models/cdr_patch_dto.py @@ -0,0 +1,65 @@ +from typing import Any, Dict, List, Type, TypeVar, Union + +import attr + +from ..models.cdr_patch_dto_approval_status import CdrPatchDtoApprovalStatus +from ..types import UNSET, Unset + +T = TypeVar("T", bound="CdrPatchDto") + + +@attr.s(auto_attribs=True) +class CdrPatchDto: + """ + Attributes: + approval_status (Union[Unset, CdrPatchDtoApprovalStatus]): Default: CdrPatchDtoApprovalStatus.VALUE_0. + """ + + approval_status: Union[Unset, CdrPatchDtoApprovalStatus] = CdrPatchDtoApprovalStatus.VALUE_0 + additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) + + def to_dict(self) -> Dict[str, Any]: + approval_status: Union[Unset, int] = UNSET + if not isinstance(self.approval_status, Unset): + approval_status = self.approval_status.value + + field_dict: Dict[str, Any] = {} + field_dict.update(self.additional_properties) + field_dict.update({}) + if approval_status is not UNSET: + field_dict["approvalStatus"] = approval_status + + return field_dict + + @classmethod + def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: + d = src_dict.copy() + _approval_status = d.pop("approvalStatus", UNSET) + approval_status: Union[Unset, CdrPatchDtoApprovalStatus] + if isinstance(_approval_status, Unset): + approval_status = UNSET + else: + approval_status = CdrPatchDtoApprovalStatus(_approval_status) + + cdr_patch_dto = cls( + approval_status=approval_status, + ) + + cdr_patch_dto.additional_properties = d + return cdr_patch_dto + + @property + def additional_keys(self) -> List[str]: + return list(self.additional_properties.keys()) + + def __getitem__(self, key: str) -> Any: + return self.additional_properties[key] + + def __setitem__(self, key: str, value: Any) -> None: + self.additional_properties[key] = value + + def __delitem__(self, key: str) -> None: + del self.additional_properties[key] + + def __contains__(self, key: str) -> bool: + return key in self.additional_properties diff --git a/longship_api_client/models/cdr_patch_dto_approval_status.py b/longship_api_client/models/cdr_patch_dto_approval_status.py new file mode 100644 index 0000000..ed105c6 --- /dev/null +++ b/longship_api_client/models/cdr_patch_dto_approval_status.py @@ -0,0 +1,9 @@ +from enum import IntEnum + + +class CdrPatchDtoApprovalStatus(IntEnum): + VALUE_0 = 0 + VALUE_1 = 1 + + def __str__(self) -> str: + return str(self.value) diff --git a/longship_api_client/models/chargepoint_configuration_items_dto.py b/longship_api_client/models/chargepoint_configuration_items_dto.py new file mode 100644 index 0000000..8d59386 --- /dev/null +++ b/longship_api_client/models/chargepoint_configuration_items_dto.py @@ -0,0 +1,122 @@ +import datetime +from typing import Any, Dict, List, Type, TypeVar, Union + +import attr +from dateutil.parser import isoparse + +from ..types import UNSET, Unset + +T = TypeVar("T", bound="ChargepointConfigurationItemsDto") + + +@attr.s(auto_attribs=True) +class ChargepointConfigurationItemsDto: + """ + Attributes: + id (Union[Unset, str]): + read_only (Union[Unset, bool]): + value (Union[Unset, str]): + created (Union[Unset, datetime.datetime]): + modified (Union[Unset, datetime.datetime]): + deleted (Union[Unset, datetime.datetime]): + """ + + id: Union[Unset, str] = UNSET + read_only: Union[Unset, bool] = UNSET + value: Union[Unset, str] = UNSET + created: Union[Unset, datetime.datetime] = UNSET + modified: Union[Unset, datetime.datetime] = UNSET + deleted: Union[Unset, datetime.datetime] = UNSET + additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) + + def to_dict(self) -> Dict[str, Any]: + id = self.id + read_only = self.read_only + value = self.value + created: Union[Unset, str] = UNSET + if not isinstance(self.created, Unset): + created = self.created.isoformat() + + modified: Union[Unset, str] = UNSET + if not isinstance(self.modified, Unset): + modified = self.modified.isoformat() + + deleted: Union[Unset, str] = UNSET + if not isinstance(self.deleted, Unset): + deleted = self.deleted.isoformat() + + field_dict: Dict[str, Any] = {} + field_dict.update(self.additional_properties) + field_dict.update({}) + if id is not UNSET: + field_dict["id"] = id + if read_only is not UNSET: + field_dict["readOnly"] = read_only + if value is not UNSET: + field_dict["value"] = value + if created is not UNSET: + field_dict["created"] = created + if modified is not UNSET: + field_dict["modified"] = modified + if deleted is not UNSET: + field_dict["deleted"] = deleted + + return field_dict + + @classmethod + def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: + d = src_dict.copy() + id = d.pop("id", UNSET) + + read_only = d.pop("readOnly", UNSET) + + value = d.pop("value", UNSET) + + _created = d.pop("created", UNSET) + created: Union[Unset, datetime.datetime] + if isinstance(_created, Unset): + created = UNSET + else: + created = isoparse(_created) + + _modified = d.pop("modified", UNSET) + modified: Union[Unset, datetime.datetime] + if isinstance(_modified, Unset): + modified = UNSET + else: + modified = isoparse(_modified) + + _deleted = d.pop("deleted", UNSET) + deleted: Union[Unset, datetime.datetime] + if isinstance(_deleted, Unset): + deleted = UNSET + else: + deleted = isoparse(_deleted) + + chargepoint_configuration_items_dto = cls( + id=id, + read_only=read_only, + value=value, + created=created, + modified=modified, + deleted=deleted, + ) + + chargepoint_configuration_items_dto.additional_properties = d + return chargepoint_configuration_items_dto + + @property + def additional_keys(self) -> List[str]: + return list(self.additional_properties.keys()) + + def __getitem__(self, key: str) -> Any: + return self.additional_properties[key] + + def __setitem__(self, key: str, value: Any) -> None: + self.additional_properties[key] = value + + def __delitem__(self, key: str) -> None: + del self.additional_properties[key] + + def __contains__(self, key: str) -> bool: + return key in self.additional_properties diff --git a/longship_api_client/models/chargepoint_dto.py b/longship_api_client/models/chargepoint_dto.py index 45f12d4..c658ba1 100644 --- a/longship_api_client/models/chargepoint_dto.py +++ b/longship_api_client/models/chargepoint_dto.py @@ -20,7 +20,7 @@ class ChargepointDto: Attributes: id (Union[Unset, str]): charge_point_id (Union[Unset, str]): - date_deleted (Union[Unset, None, datetime.datetime]): + date_deleted (Union[Unset, datetime.datetime]): display_name (Union[Unset, str]): roaming_name (Union[Unset, str]): charge_box_serial_number (Union[Unset, str]): @@ -32,12 +32,12 @@ class ChargepointDto: ChargepointDtoConnectivityStatus.ONLINE. iccid (Union[Unset, str]): imsi (Union[Unset, str]): - meter_serial_number (Union[Unset, None, str]): - meter_type (Union[Unset, None, str]): + meter_serial_number (Union[Unset, str]): + meter_type (Union[Unset, str]): tenant_id (Union[Unset, str]): evses (Union[Unset, List['ChargepointEVSEDto']]): is_roaming (Union[Unset, bool]): - has_guest_usage (Union[Unset, None, bool]): + has_guest_usage (Union[Unset, bool]): location_id (Union[Unset, str]): allow_any_token (Union[Unset, bool]): date_created (Union[Unset, datetime.datetime]): @@ -46,26 +46,26 @@ class ChargepointDto: ou_id (Union[Unset, str]): ou_name (Union[Unset, str]): tariff_id (Union[Unset, str]): - tariff_name (Union[Unset, None, str]): - start_tariff (Union[Unset, None, float]): - tariff_price (Union[Unset, None, float]): + tariff_name (Union[Unset, str]): + start_tariff (Union[Unset, float]): + tariff_price (Union[Unset, float]): sim_card_number (Union[Unset, str]): - token_groups (Union[Unset, None, List[str]]): + token_groups (Union[Unset, List[str]]): is_new (Union[Unset, bool]): - has_reimbursement (Union[Unset, None, bool]): - reimburse_tariff_id (Union[Unset, None, str]): - reimburse_tariff_name (Union[Unset, None, str]): - reimburse_tariff_price (Union[Unset, None, float]): - reimburse_uid (Union[Unset, None, str]): - reimburse_token_id (Union[Unset, None, str]): - reimburse_ou (Union[Unset, None, str]): - use_tenant_fee (Union[Unset, None, bool]): + has_reimbursement (Union[Unset, bool]): + reimburse_tariff_id (Union[Unset, str]): + reimburse_tariff_name (Union[Unset, str]): + reimburse_tariff_price (Union[Unset, float]): + reimburse_uid (Union[Unset, str]): + reimburse_token_id (Union[Unset, str]): + reimburse_ou (Union[Unset, str]): + use_tenant_fee (Union[Unset, bool]): max_capacity_in_kw (Union[Unset, float]): """ id: Union[Unset, str] = UNSET charge_point_id: Union[Unset, str] = UNSET - date_deleted: Union[Unset, None, datetime.datetime] = UNSET + date_deleted: Union[Unset, datetime.datetime] = UNSET display_name: Union[Unset, str] = UNSET roaming_name: Union[Unset, str] = UNSET charge_box_serial_number: Union[Unset, str] = UNSET @@ -76,12 +76,12 @@ class ChargepointDto: connectivity_status: Union[Unset, ChargepointDtoConnectivityStatus] = ChargepointDtoConnectivityStatus.ONLINE iccid: Union[Unset, str] = UNSET imsi: Union[Unset, str] = UNSET - meter_serial_number: Union[Unset, None, str] = UNSET - meter_type: Union[Unset, None, str] = UNSET + meter_serial_number: Union[Unset, str] = UNSET + meter_type: Union[Unset, str] = UNSET tenant_id: Union[Unset, str] = UNSET evses: Union[Unset, List["ChargepointEVSEDto"]] = UNSET is_roaming: Union[Unset, bool] = UNSET - has_guest_usage: Union[Unset, None, bool] = UNSET + has_guest_usage: Union[Unset, bool] = UNSET location_id: Union[Unset, str] = UNSET allow_any_token: Union[Unset, bool] = UNSET date_created: Union[Unset, datetime.datetime] = UNSET @@ -90,29 +90,29 @@ class ChargepointDto: ou_id: Union[Unset, str] = UNSET ou_name: Union[Unset, str] = UNSET tariff_id: Union[Unset, str] = UNSET - tariff_name: Union[Unset, None, str] = UNSET - start_tariff: Union[Unset, None, float] = UNSET - tariff_price: Union[Unset, None, float] = UNSET + tariff_name: Union[Unset, str] = UNSET + start_tariff: Union[Unset, float] = UNSET + tariff_price: Union[Unset, float] = UNSET sim_card_number: Union[Unset, str] = UNSET - token_groups: Union[Unset, None, List[str]] = UNSET + token_groups: Union[Unset, List[str]] = UNSET is_new: Union[Unset, bool] = UNSET - has_reimbursement: Union[Unset, None, bool] = UNSET - reimburse_tariff_id: Union[Unset, None, str] = UNSET - reimburse_tariff_name: Union[Unset, None, str] = UNSET - reimburse_tariff_price: Union[Unset, None, float] = UNSET - reimburse_uid: Union[Unset, None, str] = UNSET - reimburse_token_id: Union[Unset, None, str] = UNSET - reimburse_ou: Union[Unset, None, str] = UNSET - use_tenant_fee: Union[Unset, None, bool] = UNSET + has_reimbursement: Union[Unset, bool] = UNSET + reimburse_tariff_id: Union[Unset, str] = UNSET + reimburse_tariff_name: Union[Unset, str] = UNSET + reimburse_tariff_price: Union[Unset, float] = UNSET + reimburse_uid: Union[Unset, str] = UNSET + reimburse_token_id: Union[Unset, str] = UNSET + reimburse_ou: Union[Unset, str] = UNSET + use_tenant_fee: Union[Unset, bool] = UNSET max_capacity_in_kw: Union[Unset, float] = UNSET additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) def to_dict(self) -> Dict[str, Any]: id = self.id charge_point_id = self.charge_point_id - date_deleted: Union[Unset, None, str] = UNSET + date_deleted: Union[Unset, str] = UNSET if not isinstance(self.date_deleted, Unset): - date_deleted = self.date_deleted.isoformat() if self.date_deleted else None + date_deleted = self.date_deleted.isoformat() display_name = self.display_name roaming_name = self.roaming_name @@ -158,12 +158,9 @@ def to_dict(self) -> Dict[str, Any]: start_tariff = self.start_tariff tariff_price = self.tariff_price sim_card_number = self.sim_card_number - token_groups: Union[Unset, None, List[str]] = UNSET + token_groups: Union[Unset, List[str]] = UNSET if not isinstance(self.token_groups, Unset): - if self.token_groups is None: - token_groups = None - else: - token_groups = self.token_groups + token_groups = self.token_groups is_new = self.is_new has_reimbursement = self.has_reimbursement @@ -276,10 +273,8 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: charge_point_id = d.pop("chargePointId", UNSET) _date_deleted = d.pop("dateDeleted", UNSET) - date_deleted: Union[Unset, None, datetime.datetime] - if _date_deleted is None: - date_deleted = None - elif isinstance(_date_deleted, Unset): + date_deleted: Union[Unset, datetime.datetime] + if isinstance(_date_deleted, Unset): date_deleted = UNSET else: date_deleted = isoparse(_date_deleted) diff --git a/longship_api_client/models/location_dto.py b/longship_api_client/models/location_dto.py index 0c8dd2a..b8917a0 100644 --- a/longship_api_client/models/location_dto.py +++ b/longship_api_client/models/location_dto.py @@ -62,6 +62,9 @@ class LocationDto: ou (Union[Unset, str]): ou_id (Union[Unset, str]): ou_name (Union[Unset, str]): + external_reference_1 (Union[Unset, str]): + external_reference_2 (Union[Unset, str]): + external_reference_3 (Union[Unset, str]): """ id: str @@ -98,6 +101,9 @@ class LocationDto: ou: Union[Unset, str] = UNSET ou_id: Union[Unset, str] = UNSET ou_name: Union[Unset, str] = UNSET + external_reference_1: Union[Unset, str] = UNSET + external_reference_2: Union[Unset, str] = UNSET + external_reference_3: Union[Unset, str] = UNSET additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) def to_dict(self) -> Dict[str, Any]: @@ -200,6 +206,9 @@ def to_dict(self) -> Dict[str, Any]: ou = self.ou ou_id = self.ou_id ou_name = self.ou_name + external_reference_1 = self.external_reference_1 + external_reference_2 = self.external_reference_2 + external_reference_3 = self.external_reference_3 field_dict: Dict[str, Any] = {} field_dict.update(self.additional_properties) @@ -265,6 +274,12 @@ def to_dict(self) -> Dict[str, Any]: field_dict["ouId"] = ou_id if ou_name is not UNSET: field_dict["ouName"] = ou_name + if external_reference_1 is not UNSET: + field_dict["externalReference1"] = external_reference_1 + if external_reference_2 is not UNSET: + field_dict["externalReference2"] = external_reference_2 + if external_reference_3 is not UNSET: + field_dict["externalReference3"] = external_reference_3 return field_dict @@ -415,6 +430,12 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: ou_name = d.pop("ouName", UNSET) + external_reference_1 = d.pop("externalReference1", UNSET) + + external_reference_2 = d.pop("externalReference2", UNSET) + + external_reference_3 = d.pop("externalReference3", UNSET) + location_dto = cls( id=id, country_code=country_code, @@ -450,6 +471,9 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: ou=ou, ou_id=ou_id, ou_name=ou_name, + external_reference_1=external_reference_1, + external_reference_2=external_reference_2, + external_reference_3=external_reference_3, ) location_dto.additional_properties = d diff --git a/longship_api_client/models/location_post_dto.py b/longship_api_client/models/location_post_dto.py index 6ec5831..9713f61 100644 --- a/longship_api_client/models/location_post_dto.py +++ b/longship_api_client/models/location_post_dto.py @@ -57,6 +57,9 @@ class LocationPostDto: ou (Union[Unset, str]): ou code like 0000-0001-00001. ou_id (Union[Unset, str]): Guid with ouId. ou_name (Union[Unset, str]): + external_reference_1 (Union[Unset, str]): + external_reference_2 (Union[Unset, str]): + external_reference_3 (Union[Unset, str]): """ id: str @@ -90,6 +93,9 @@ class LocationPostDto: ou: Union[Unset, str] = UNSET ou_id: Union[Unset, str] = UNSET ou_name: Union[Unset, str] = UNSET + external_reference_1: Union[Unset, str] = UNSET + external_reference_2: Union[Unset, str] = UNSET + external_reference_3: Union[Unset, str] = UNSET additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) def to_dict(self) -> Dict[str, Any]: @@ -188,6 +194,9 @@ def to_dict(self) -> Dict[str, Any]: ou = self.ou ou_id = self.ou_id ou_name = self.ou_name + external_reference_1 = self.external_reference_1 + external_reference_2 = self.external_reference_2 + external_reference_3 = self.external_reference_3 field_dict: Dict[str, Any] = {} field_dict.update(self.additional_properties) @@ -251,6 +260,12 @@ def to_dict(self) -> Dict[str, Any]: field_dict["ouId"] = ou_id if ou_name is not UNSET: field_dict["ouName"] = ou_name + if external_reference_1 is not UNSET: + field_dict["externalReference1"] = external_reference_1 + if external_reference_2 is not UNSET: + field_dict["externalReference2"] = external_reference_2 + if external_reference_3 is not UNSET: + field_dict["externalReference3"] = external_reference_3 return field_dict @@ -395,6 +410,12 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: ou_name = d.pop("ouName", UNSET) + external_reference_1 = d.pop("externalReference1", UNSET) + + external_reference_2 = d.pop("externalReference2", UNSET) + + external_reference_3 = d.pop("externalReference3", UNSET) + location_post_dto = cls( id=id, street=street, @@ -427,6 +448,9 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: ou=ou, ou_id=ou_id, ou_name=ou_name, + external_reference_1=external_reference_1, + external_reference_2=external_reference_2, + external_reference_3=external_reference_3, ) location_post_dto.additional_properties = d diff --git a/longship_api_client/models/location_put_dto.py b/longship_api_client/models/location_put_dto.py index 6adc8a1..3faad64 100644 --- a/longship_api_client/models/location_put_dto.py +++ b/longship_api_client/models/location_put_dto.py @@ -61,6 +61,9 @@ class LocationPutDto: ou (Union[Unset, str]): ou_id (Union[Unset, str]): ou_name (Union[Unset, str]): + external_reference_1 (Union[Unset, str]): + external_reference_2 (Union[Unset, str]): + external_reference_3 (Union[Unset, str]): """ id: str @@ -96,6 +99,9 @@ class LocationPutDto: ou: Union[Unset, str] = UNSET ou_id: Union[Unset, str] = UNSET ou_name: Union[Unset, str] = UNSET + external_reference_1: Union[Unset, str] = UNSET + external_reference_2: Union[Unset, str] = UNSET + external_reference_3: Union[Unset, str] = UNSET additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) def to_dict(self) -> Dict[str, Any]: @@ -197,6 +203,9 @@ def to_dict(self) -> Dict[str, Any]: ou = self.ou ou_id = self.ou_id ou_name = self.ou_name + external_reference_1 = self.external_reference_1 + external_reference_2 = self.external_reference_2 + external_reference_3 = self.external_reference_3 field_dict: Dict[str, Any] = {} field_dict.update(self.additional_properties) @@ -260,6 +269,12 @@ def to_dict(self) -> Dict[str, Any]: field_dict["ouId"] = ou_id if ou_name is not UNSET: field_dict["ouName"] = ou_name + if external_reference_1 is not UNSET: + field_dict["externalReference1"] = external_reference_1 + if external_reference_2 is not UNSET: + field_dict["externalReference2"] = external_reference_2 + if external_reference_3 is not UNSET: + field_dict["externalReference3"] = external_reference_3 return field_dict @@ -408,6 +423,12 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: ou_name = d.pop("ouName", UNSET) + external_reference_1 = d.pop("externalReference1", UNSET) + + external_reference_2 = d.pop("externalReference2", UNSET) + + external_reference_3 = d.pop("externalReference3", UNSET) + location_put_dto = cls( id=id, country_code=country_code, @@ -442,6 +463,9 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: ou=ou, ou_id=ou_id, ou_name=ou_name, + external_reference_1=external_reference_1, + external_reference_2=external_reference_2, + external_reference_3=external_reference_3, ) location_put_dto.additional_properties = d diff --git a/longship_api_client/models/organization_unit_get_dto.py b/longship_api_client/models/organization_unit_get_dto.py index 1c2c68c..c79e437 100644 --- a/longship_api_client/models/organization_unit_get_dto.py +++ b/longship_api_client/models/organization_unit_get_dto.py @@ -19,7 +19,10 @@ class OrganizationUnitGetDto: code (str): parent_id (Union[Unset, str]): name (Union[Unset, str]): The name of the ou. - external_reference (Union[Unset, str]): A properties which can be used to link this OU to another system. + external_reference (Union[Unset, str]): This property can be used to link this OU to another system. + grid_owner_reference (Union[Unset, str]): This property can be used to link this OU to a grid owner. + tenant_reference (Union[Unset, str]): This property can be used to link this OU to a tenant. + customer_reference (Union[Unset, str]): This property can be used to link this OU to a customer. address (Union[Unset, str]): state (Union[Unset, str]): country (Union[Unset, str]): @@ -43,6 +46,9 @@ class OrganizationUnitGetDto: parent_id: Union[Unset, str] = UNSET name: Union[Unset, str] = UNSET external_reference: Union[Unset, str] = UNSET + grid_owner_reference: Union[Unset, str] = UNSET + tenant_reference: Union[Unset, str] = UNSET + customer_reference: Union[Unset, str] = UNSET address: Union[Unset, str] = UNSET state: Union[Unset, str] = UNSET country: Union[Unset, str] = UNSET @@ -67,6 +73,9 @@ def to_dict(self) -> Dict[str, Any]: parent_id = self.parent_id name = self.name external_reference = self.external_reference + grid_owner_reference = self.grid_owner_reference + tenant_reference = self.tenant_reference + customer_reference = self.customer_reference address = self.address state = self.state country = self.country @@ -100,6 +109,12 @@ def to_dict(self) -> Dict[str, Any]: field_dict["name"] = name if external_reference is not UNSET: field_dict["externalReference"] = external_reference + if grid_owner_reference is not UNSET: + field_dict["gridOwnerReference"] = grid_owner_reference + if tenant_reference is not UNSET: + field_dict["tenantReference"] = tenant_reference + if customer_reference is not UNSET: + field_dict["customerReference"] = customer_reference if address is not UNSET: field_dict["address"] = address if state is not UNSET: @@ -150,6 +165,12 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: external_reference = d.pop("externalReference", UNSET) + grid_owner_reference = d.pop("gridOwnerReference", UNSET) + + tenant_reference = d.pop("tenantReference", UNSET) + + customer_reference = d.pop("customerReference", UNSET) + address = d.pop("address", UNSET) state = d.pop("state", UNSET) @@ -193,6 +214,9 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parent_id=parent_id, name=name, external_reference=external_reference, + grid_owner_reference=grid_owner_reference, + tenant_reference=tenant_reference, + customer_reference=customer_reference, address=address, state=state, country=country, diff --git a/longship_api_client/models/organization_unit_post_dto.py b/longship_api_client/models/organization_unit_post_dto.py index 2d8e6e9..2688ded 100644 --- a/longship_api_client/models/organization_unit_post_dto.py +++ b/longship_api_client/models/organization_unit_post_dto.py @@ -17,7 +17,10 @@ class OrganizationUnitPostDto: Attributes: parent_id (str): The id of parent ou. name (Union[Unset, str]): The name of the ou. - external_reference (Union[Unset, str]): A properties which can be used to link this OU to another system. + external_reference (Union[Unset, str]): This property can be used to link this OU to another system. + grid_owner_reference (Union[Unset, str]): This property can be used to link this OU to a grid owner. + tenant_reference (Union[Unset, str]): This property can be used to link this OU to a tenant. + customer_reference (Union[Unset, str]): This property can be used to link this OU to a customer. address (Union[Unset, str]): state (Union[Unset, str]): country (Union[Unset, str]): @@ -38,6 +41,9 @@ class OrganizationUnitPostDto: parent_id: str name: Union[Unset, str] = UNSET external_reference: Union[Unset, str] = UNSET + grid_owner_reference: Union[Unset, str] = UNSET + tenant_reference: Union[Unset, str] = UNSET + customer_reference: Union[Unset, str] = UNSET address: Union[Unset, str] = UNSET state: Union[Unset, str] = UNSET country: Union[Unset, str] = UNSET @@ -59,6 +65,9 @@ def to_dict(self) -> Dict[str, Any]: parent_id = self.parent_id name = self.name external_reference = self.external_reference + grid_owner_reference = self.grid_owner_reference + tenant_reference = self.tenant_reference + customer_reference = self.customer_reference address = self.address state = self.state country = self.country @@ -88,6 +97,12 @@ def to_dict(self) -> Dict[str, Any]: field_dict["name"] = name if external_reference is not UNSET: field_dict["externalReference"] = external_reference + if grid_owner_reference is not UNSET: + field_dict["gridOwnerReference"] = grid_owner_reference + if tenant_reference is not UNSET: + field_dict["tenantReference"] = tenant_reference + if customer_reference is not UNSET: + field_dict["customerReference"] = customer_reference if address is not UNSET: field_dict["address"] = address if state is not UNSET: @@ -132,6 +147,12 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: external_reference = d.pop("externalReference", UNSET) + grid_owner_reference = d.pop("gridOwnerReference", UNSET) + + tenant_reference = d.pop("tenantReference", UNSET) + + customer_reference = d.pop("customerReference", UNSET) + address = d.pop("address", UNSET) state = d.pop("state", UNSET) @@ -171,6 +192,9 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parent_id=parent_id, name=name, external_reference=external_reference, + grid_owner_reference=grid_owner_reference, + tenant_reference=tenant_reference, + customer_reference=customer_reference, address=address, state=state, country=country, diff --git a/longship_api_client/models/organization_unit_put_dto.py b/longship_api_client/models/organization_unit_put_dto.py index a98f068..58188f1 100644 --- a/longship_api_client/models/organization_unit_put_dto.py +++ b/longship_api_client/models/organization_unit_put_dto.py @@ -16,7 +16,10 @@ class OrganizationUnitPutDto: """ Attributes: name (Union[Unset, str]): The name of the ou. - external_reference (Union[Unset, str]): A properties which can be used to link this OU to another system. + external_reference (Union[Unset, str]): This property can be used to link this OU to another system. + grid_owner_reference (Union[Unset, str]): This property can be used to link this OU to a grid owner. + tenant_reference (Union[Unset, str]): This property can be used to link this OU to a tenant. + customer_reference (Union[Unset, str]): This property can be used to link this OU to a customer. address (Union[Unset, str]): state (Union[Unset, str]): country (Union[Unset, str]): @@ -36,6 +39,9 @@ class OrganizationUnitPutDto: name: Union[Unset, str] = UNSET external_reference: Union[Unset, str] = UNSET + grid_owner_reference: Union[Unset, str] = UNSET + tenant_reference: Union[Unset, str] = UNSET + customer_reference: Union[Unset, str] = UNSET address: Union[Unset, str] = UNSET state: Union[Unset, str] = UNSET country: Union[Unset, str] = UNSET @@ -56,6 +62,9 @@ class OrganizationUnitPutDto: def to_dict(self) -> Dict[str, Any]: name = self.name external_reference = self.external_reference + grid_owner_reference = self.grid_owner_reference + tenant_reference = self.tenant_reference + customer_reference = self.customer_reference address = self.address state = self.state country = self.country @@ -81,6 +90,12 @@ def to_dict(self) -> Dict[str, Any]: field_dict["name"] = name if external_reference is not UNSET: field_dict["externalReference"] = external_reference + if grid_owner_reference is not UNSET: + field_dict["gridOwnerReference"] = grid_owner_reference + if tenant_reference is not UNSET: + field_dict["tenantReference"] = tenant_reference + if customer_reference is not UNSET: + field_dict["customerReference"] = customer_reference if address is not UNSET: field_dict["address"] = address if state is not UNSET: @@ -123,6 +138,12 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: external_reference = d.pop("externalReference", UNSET) + grid_owner_reference = d.pop("gridOwnerReference", UNSET) + + tenant_reference = d.pop("tenantReference", UNSET) + + customer_reference = d.pop("customerReference", UNSET) + address = d.pop("address", UNSET) state = d.pop("state", UNSET) @@ -161,6 +182,9 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: organization_unit_put_dto = cls( name=name, external_reference=external_reference, + grid_owner_reference=grid_owner_reference, + tenant_reference=tenant_reference, + customer_reference=customer_reference, address=address, state=state, country=country, diff --git a/longship_api_client/models/tariff_dto.py b/longship_api_client/models/tariff_dto.py index 875349a..9eb654a 100644 --- a/longship_api_client/models/tariff_dto.py +++ b/longship_api_client/models/tariff_dto.py @@ -11,6 +11,7 @@ if TYPE_CHECKING: from ..models.private_emp_tariff_dto import PrivateEmpTariffDto from ..models.tariff_price_dto import TariffPriceDto + from ..models.tariff_restriction import TariffRestriction T = TypeVar("T", bound="TariffDto") @@ -42,6 +43,7 @@ class TariffDto: parking_tariff (Union[Unset, float]): parking_step_size_in_minutes (Union[Unset, int]): parking_grace_period_in_minutes (Union[Unset, int]): + parking_tariff_restriction (Union[Unset, TariffRestriction]): time_tariff (Union[Unset, float]): time_step_size_in_minutes (Union[Unset, int]): time_grace_period_in_minutes (Union[Unset, int]): @@ -71,6 +73,7 @@ class TariffDto: parking_tariff: Union[Unset, float] = UNSET parking_step_size_in_minutes: Union[Unset, int] = UNSET parking_grace_period_in_minutes: Union[Unset, int] = UNSET + parking_tariff_restriction: Union[Unset, "TariffRestriction"] = UNSET time_tariff: Union[Unset, float] = UNSET time_step_size_in_minutes: Union[Unset, int] = UNSET time_grace_period_in_minutes: Union[Unset, int] = UNSET @@ -113,6 +116,10 @@ def to_dict(self) -> Dict[str, Any]: parking_tariff = self.parking_tariff parking_step_size_in_minutes = self.parking_step_size_in_minutes parking_grace_period_in_minutes = self.parking_grace_period_in_minutes + parking_tariff_restriction: Union[Unset, Dict[str, Any]] = UNSET + if not isinstance(self.parking_tariff_restriction, Unset): + parking_tariff_restriction = self.parking_tariff_restriction.to_dict() + time_tariff = self.time_tariff time_step_size_in_minutes = self.time_step_size_in_minutes time_grace_period_in_minutes = self.time_grace_period_in_minutes @@ -175,6 +182,8 @@ def to_dict(self) -> Dict[str, Any]: field_dict["parkingStepSizeInMinutes"] = parking_step_size_in_minutes if parking_grace_period_in_minutes is not UNSET: field_dict["parkingGracePeriodInMinutes"] = parking_grace_period_in_minutes + if parking_tariff_restriction is not UNSET: + field_dict["parkingTariffRestriction"] = parking_tariff_restriction if time_tariff is not UNSET: field_dict["timeTariff"] = time_tariff if time_step_size_in_minutes is not UNSET: @@ -192,6 +201,7 @@ def to_dict(self) -> Dict[str, Any]: def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: from ..models.private_emp_tariff_dto import PrivateEmpTariffDto from ..models.tariff_price_dto import TariffPriceDto + from ..models.tariff_restriction import TariffRestriction d = src_dict.copy() tenant_id = d.pop("tenantId") @@ -258,6 +268,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_grace_period_in_minutes = d.pop("parkingGracePeriodInMinutes", UNSET) + _parking_tariff_restriction = d.pop("parkingTariffRestriction", UNSET) + parking_tariff_restriction: Union[Unset, TariffRestriction] + if isinstance(_parking_tariff_restriction, Unset): + parking_tariff_restriction = UNSET + else: + parking_tariff_restriction = TariffRestriction.from_dict(_parking_tariff_restriction) + time_tariff = d.pop("timeTariff", UNSET) time_step_size_in_minutes = d.pop("timeStepSizeInMinutes", UNSET) @@ -296,6 +313,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_tariff=parking_tariff, parking_step_size_in_minutes=parking_step_size_in_minutes, parking_grace_period_in_minutes=parking_grace_period_in_minutes, + parking_tariff_restriction=parking_tariff_restriction, time_tariff=time_tariff, time_step_size_in_minutes=time_step_size_in_minutes, time_grace_period_in_minutes=time_grace_period_in_minutes, diff --git a/longship_api_client/models/tariff_post_dto.py b/longship_api_client/models/tariff_post_dto.py index 8e81dc5..89d629f 100644 --- a/longship_api_client/models/tariff_post_dto.py +++ b/longship_api_client/models/tariff_post_dto.py @@ -7,6 +7,7 @@ if TYPE_CHECKING: from ..models.private_emp_tariff_dto import PrivateEmpTariffDto + from ..models.tariff_restriction import TariffRestriction T = TypeVar("T", bound="TariffPostDto") @@ -25,6 +26,7 @@ class TariffPostDto: parking_tariff (Union[Unset, float]): parking_step_size_in_minutes (Union[Unset, int]): parking_grace_period_in_minutes (Union[Unset, int]): + parking_tariff_restriction (Union[Unset, TariffRestriction]): time_tariff (Union[Unset, float]): time_step_size_in_minutes (Union[Unset, int]): time_grace_period_in_minutes (Union[Unset, int]): @@ -40,6 +42,7 @@ class TariffPostDto: parking_tariff: Union[Unset, float] = UNSET parking_step_size_in_minutes: Union[Unset, int] = UNSET parking_grace_period_in_minutes: Union[Unset, int] = UNSET + parking_tariff_restriction: Union[Unset, "TariffRestriction"] = UNSET time_tariff: Union[Unset, float] = UNSET time_step_size_in_minutes: Union[Unset, int] = UNSET time_grace_period_in_minutes: Union[Unset, int] = UNSET @@ -62,6 +65,10 @@ def to_dict(self) -> Dict[str, Any]: parking_tariff = self.parking_tariff parking_step_size_in_minutes = self.parking_step_size_in_minutes parking_grace_period_in_minutes = self.parking_grace_period_in_minutes + parking_tariff_restriction: Union[Unset, Dict[str, Any]] = UNSET + if not isinstance(self.parking_tariff_restriction, Unset): + parking_tariff_restriction = self.parking_tariff_restriction.to_dict() + time_tariff = self.time_tariff time_step_size_in_minutes = self.time_step_size_in_minutes time_grace_period_in_minutes = self.time_grace_period_in_minutes @@ -88,6 +95,8 @@ def to_dict(self) -> Dict[str, Any]: field_dict["parkingStepSizeInMinutes"] = parking_step_size_in_minutes if parking_grace_period_in_minutes is not UNSET: field_dict["parkingGracePeriodInMinutes"] = parking_grace_period_in_minutes + if parking_tariff_restriction is not UNSET: + field_dict["parkingTariffRestriction"] = parking_tariff_restriction if time_tariff is not UNSET: field_dict["timeTariff"] = time_tariff if time_step_size_in_minutes is not UNSET: @@ -102,6 +111,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: from ..models.private_emp_tariff_dto import PrivateEmpTariffDto + from ..models.tariff_restriction import TariffRestriction d = src_dict.copy() name = d.pop("name", UNSET) @@ -132,6 +142,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_grace_period_in_minutes = d.pop("parkingGracePeriodInMinutes", UNSET) + _parking_tariff_restriction = d.pop("parkingTariffRestriction", UNSET) + parking_tariff_restriction: Union[Unset, TariffRestriction] + if isinstance(_parking_tariff_restriction, Unset): + parking_tariff_restriction = UNSET + else: + parking_tariff_restriction = TariffRestriction.from_dict(_parking_tariff_restriction) + time_tariff = d.pop("timeTariff", UNSET) time_step_size_in_minutes = d.pop("timeStepSizeInMinutes", UNSET) @@ -150,6 +167,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_tariff=parking_tariff, parking_step_size_in_minutes=parking_step_size_in_minutes, parking_grace_period_in_minutes=parking_grace_period_in_minutes, + parking_tariff_restriction=parking_tariff_restriction, time_tariff=time_tariff, time_step_size_in_minutes=time_step_size_in_minutes, time_grace_period_in_minutes=time_grace_period_in_minutes, diff --git a/longship_api_client/models/tariff_price_dto.py b/longship_api_client/models/tariff_price_dto.py index a8cee70..db71829 100644 --- a/longship_api_client/models/tariff_price_dto.py +++ b/longship_api_client/models/tariff_price_dto.py @@ -1,5 +1,5 @@ import datetime -from typing import Any, Dict, List, Type, TypeVar, Union +from typing import TYPE_CHECKING, Any, Dict, List, Type, TypeVar, Union import attr from dateutil.parser import isoparse @@ -7,6 +7,10 @@ from ..models.tariff_price_dto_approval_status import TariffPriceDtoApprovalStatus from ..types import UNSET, Unset +if TYPE_CHECKING: + from ..models.tariff_restriction import TariffRestriction + + T = TypeVar("T", bound="TariffPriceDto") @@ -23,6 +27,7 @@ class TariffPriceDto: parking_tariff (Union[Unset, float]): parking_step_size_in_minutes (Union[Unset, int]): parking_grace_period_in_minutes (Union[Unset, int]): + parking_tariff_restriction (Union[Unset, TariffRestriction]): time_tariff (Union[Unset, float]): time_step_size_in_minutes (Union[Unset, int]): time_grace_period_in_minutes (Union[Unset, int]): @@ -38,6 +43,7 @@ class TariffPriceDto: parking_tariff: Union[Unset, float] = UNSET parking_step_size_in_minutes: Union[Unset, int] = UNSET parking_grace_period_in_minutes: Union[Unset, int] = UNSET + parking_tariff_restriction: Union[Unset, "TariffRestriction"] = UNSET time_tariff: Union[Unset, float] = UNSET time_step_size_in_minutes: Union[Unset, int] = UNSET time_grace_period_in_minutes: Union[Unset, int] = UNSET @@ -60,6 +66,10 @@ def to_dict(self) -> Dict[str, Any]: parking_tariff = self.parking_tariff parking_step_size_in_minutes = self.parking_step_size_in_minutes parking_grace_period_in_minutes = self.parking_grace_period_in_minutes + parking_tariff_restriction: Union[Unset, Dict[str, Any]] = UNSET + if not isinstance(self.parking_tariff_restriction, Unset): + parking_tariff_restriction = self.parking_tariff_restriction.to_dict() + time_tariff = self.time_tariff time_step_size_in_minutes = self.time_step_size_in_minutes time_grace_period_in_minutes = self.time_grace_period_in_minutes @@ -88,6 +98,8 @@ def to_dict(self) -> Dict[str, Any]: field_dict["parkingStepSizeInMinutes"] = parking_step_size_in_minutes if parking_grace_period_in_minutes is not UNSET: field_dict["parkingGracePeriodInMinutes"] = parking_grace_period_in_minutes + if parking_tariff_restriction is not UNSET: + field_dict["parkingTariffRestriction"] = parking_tariff_restriction if time_tariff is not UNSET: field_dict["timeTariff"] = time_tariff if time_step_size_in_minutes is not UNSET: @@ -101,6 +113,8 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: + from ..models.tariff_restriction import TariffRestriction + d = src_dict.copy() _created_timestamp = d.pop("createdTimestamp", UNSET) created_timestamp: Union[Unset, datetime.datetime] @@ -130,6 +144,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_grace_period_in_minutes = d.pop("parkingGracePeriodInMinutes", UNSET) + _parking_tariff_restriction = d.pop("parkingTariffRestriction", UNSET) + parking_tariff_restriction: Union[Unset, TariffRestriction] + if isinstance(_parking_tariff_restriction, Unset): + parking_tariff_restriction = UNSET + else: + parking_tariff_restriction = TariffRestriction.from_dict(_parking_tariff_restriction) + time_tariff = d.pop("timeTariff", UNSET) time_step_size_in_minutes = d.pop("timeStepSizeInMinutes", UNSET) @@ -153,6 +174,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_tariff=parking_tariff, parking_step_size_in_minutes=parking_step_size_in_minutes, parking_grace_period_in_minutes=parking_grace_period_in_minutes, + parking_tariff_restriction=parking_tariff_restriction, time_tariff=time_tariff, time_step_size_in_minutes=time_step_size_in_minutes, time_grace_period_in_minutes=time_grace_period_in_minutes, diff --git a/longship_api_client/models/tariff_put_dto.py b/longship_api_client/models/tariff_put_dto.py index e47ca1f..7a9de9e 100644 --- a/longship_api_client/models/tariff_put_dto.py +++ b/longship_api_client/models/tariff_put_dto.py @@ -6,6 +6,7 @@ if TYPE_CHECKING: from ..models.private_emp_tariff_dto import PrivateEmpTariffDto + from ..models.tariff_restriction import TariffRestriction T = TypeVar("T", bound="TariffPutDto") @@ -23,6 +24,7 @@ class TariffPutDto: parking_tariff (Union[Unset, float]): parking_step_size_in_minutes (Union[Unset, int]): parking_grace_period_in_minutes (Union[Unset, int]): + parking_tariff_restriction (Union[Unset, TariffRestriction]): time_tariff (Union[Unset, float]): time_step_size_in_minutes (Union[Unset, int]): time_grace_period_in_minutes (Union[Unset, int]): @@ -37,6 +39,7 @@ class TariffPutDto: parking_tariff: Union[Unset, float] = UNSET parking_step_size_in_minutes: Union[Unset, int] = UNSET parking_grace_period_in_minutes: Union[Unset, int] = UNSET + parking_tariff_restriction: Union[Unset, "TariffRestriction"] = UNSET time_tariff: Union[Unset, float] = UNSET time_step_size_in_minutes: Union[Unset, int] = UNSET time_grace_period_in_minutes: Union[Unset, int] = UNSET @@ -55,6 +58,10 @@ def to_dict(self) -> Dict[str, Any]: parking_tariff = self.parking_tariff parking_step_size_in_minutes = self.parking_step_size_in_minutes parking_grace_period_in_minutes = self.parking_grace_period_in_minutes + parking_tariff_restriction: Union[Unset, Dict[str, Any]] = UNSET + if not isinstance(self.parking_tariff_restriction, Unset): + parking_tariff_restriction = self.parking_tariff_restriction.to_dict() + time_tariff = self.time_tariff time_step_size_in_minutes = self.time_step_size_in_minutes time_grace_period_in_minutes = self.time_grace_period_in_minutes @@ -79,6 +86,8 @@ def to_dict(self) -> Dict[str, Any]: field_dict["parkingStepSizeInMinutes"] = parking_step_size_in_minutes if parking_grace_period_in_minutes is not UNSET: field_dict["parkingGracePeriodInMinutes"] = parking_grace_period_in_minutes + if parking_tariff_restriction is not UNSET: + field_dict["parkingTariffRestriction"] = parking_tariff_restriction if time_tariff is not UNSET: field_dict["timeTariff"] = time_tariff if time_step_size_in_minutes is not UNSET: @@ -93,6 +102,7 @@ def to_dict(self) -> Dict[str, Any]: @classmethod def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: from ..models.private_emp_tariff_dto import PrivateEmpTariffDto + from ..models.tariff_restriction import TariffRestriction d = src_dict.copy() name = d.pop("name", UNSET) @@ -116,6 +126,13 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_grace_period_in_minutes = d.pop("parkingGracePeriodInMinutes", UNSET) + _parking_tariff_restriction = d.pop("parkingTariffRestriction", UNSET) + parking_tariff_restriction: Union[Unset, TariffRestriction] + if isinstance(_parking_tariff_restriction, Unset): + parking_tariff_restriction = UNSET + else: + parking_tariff_restriction = TariffRestriction.from_dict(_parking_tariff_restriction) + time_tariff = d.pop("timeTariff", UNSET) time_step_size_in_minutes = d.pop("timeStepSizeInMinutes", UNSET) @@ -133,6 +150,7 @@ def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: parking_tariff=parking_tariff, parking_step_size_in_minutes=parking_step_size_in_minutes, parking_grace_period_in_minutes=parking_grace_period_in_minutes, + parking_tariff_restriction=parking_tariff_restriction, time_tariff=time_tariff, time_step_size_in_minutes=time_step_size_in_minutes, time_grace_period_in_minutes=time_grace_period_in_minutes, diff --git a/longship_api_client/models/tariff_restriction.py b/longship_api_client/models/tariff_restriction.py new file mode 100644 index 0000000..f2f942c --- /dev/null +++ b/longship_api_client/models/tariff_restriction.py @@ -0,0 +1,119 @@ +import datetime +from typing import Any, Dict, List, Type, TypeVar, Union + +import attr +from dateutil.parser import isoparse + +from ..models.tariff_restriction_day_of_week_item import TariffRestrictionDayOfWeekItem +from ..types import UNSET, Unset + +T = TypeVar("T", bound="TariffRestriction") + + +@attr.s(auto_attribs=True) +class TariffRestriction: + """ + Attributes: + start_time (Union[Unset, str]): + end_time (Union[Unset, str]): + start_date (Union[Unset, datetime.datetime]): + end_date (Union[Unset, datetime.datetime]): + day_of_week (Union[Unset, List[TariffRestrictionDayOfWeekItem]]): + """ + + start_time: Union[Unset, str] = UNSET + end_time: Union[Unset, str] = UNSET + start_date: Union[Unset, datetime.datetime] = UNSET + end_date: Union[Unset, datetime.datetime] = UNSET + day_of_week: Union[Unset, List[TariffRestrictionDayOfWeekItem]] = UNSET + additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict) + + def to_dict(self) -> Dict[str, Any]: + start_time = self.start_time + end_time = self.end_time + start_date: Union[Unset, str] = UNSET + if not isinstance(self.start_date, Unset): + start_date = self.start_date.isoformat() + + end_date: Union[Unset, str] = UNSET + if not isinstance(self.end_date, Unset): + end_date = self.end_date.isoformat() + + day_of_week: Union[Unset, List[int]] = UNSET + if not isinstance(self.day_of_week, Unset): + day_of_week = [] + for day_of_week_item_data in self.day_of_week: + day_of_week_item = day_of_week_item_data.value + + day_of_week.append(day_of_week_item) + + field_dict: Dict[str, Any] = {} + field_dict.update(self.additional_properties) + field_dict.update({}) + if start_time is not UNSET: + field_dict["start_time"] = start_time + if end_time is not UNSET: + field_dict["end_time"] = end_time + if start_date is not UNSET: + field_dict["start_date"] = start_date + if end_date is not UNSET: + field_dict["end_date"] = end_date + if day_of_week is not UNSET: + field_dict["day_of_week"] = day_of_week + + return field_dict + + @classmethod + def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T: + d = src_dict.copy() + start_time = d.pop("start_time", UNSET) + + end_time = d.pop("end_time", UNSET) + + _start_date = d.pop("start_date", UNSET) + start_date: Union[Unset, datetime.datetime] + if isinstance(_start_date, Unset): + start_date = UNSET + else: + start_date = isoparse(_start_date) + + _end_date = d.pop("end_date", UNSET) + end_date: Union[Unset, datetime.datetime] + if isinstance(_end_date, Unset): + end_date = UNSET + else: + end_date = isoparse(_end_date) + + day_of_week = [] + _day_of_week = d.pop("day_of_week", UNSET) + for day_of_week_item_data in _day_of_week or []: + day_of_week_item = TariffRestrictionDayOfWeekItem(day_of_week_item_data) + + day_of_week.append(day_of_week_item) + + tariff_restriction = cls( + start_time=start_time, + end_time=end_time, + start_date=start_date, + end_date=end_date, + day_of_week=day_of_week, + ) + + tariff_restriction.additional_properties = d + return tariff_restriction + + @property + def additional_keys(self) -> List[str]: + return list(self.additional_properties.keys()) + + def __getitem__(self, key: str) -> Any: + return self.additional_properties[key] + + def __setitem__(self, key: str, value: Any) -> None: + self.additional_properties[key] = value + + def __delitem__(self, key: str) -> None: + del self.additional_properties[key] + + def __contains__(self, key: str) -> bool: + return key in self.additional_properties diff --git a/longship_api_client/models/tariff_restriction_day_of_week_item.py b/longship_api_client/models/tariff_restriction_day_of_week_item.py new file mode 100644 index 0000000..ca7be18 --- /dev/null +++ b/longship_api_client/models/tariff_restriction_day_of_week_item.py @@ -0,0 +1,14 @@ +from enum import IntEnum + + +class TariffRestrictionDayOfWeekItem(IntEnum): + VALUE_0 = 0 + VALUE_1 = 1 + VALUE_2 = 2 + VALUE_3 = 3 + VALUE_4 = 4 + VALUE_5 = 5 + VALUE_6 = 6 + + def __str__(self) -> str: + return str(self.value) diff --git a/longship_api_client/models/webhook_get_dto_event_types_item.py b/longship_api_client/models/webhook_get_dto_event_types_item.py index ce61465..a2e5522 100644 --- a/longship_api_client/models/webhook_get_dto_event_types_item.py +++ b/longship_api_client/models/webhook_get_dto_event_types_item.py @@ -2,8 +2,12 @@ class WebhookGetDtoEventTypesItem(str, Enum): + CDR_CREATED = "CDR_CREATED" CHARGEPOINT_BOOTED = "CHARGEPOINT_BOOTED" CONNECTIVITY_STATUS = "CONNECTIVITY_STATUS" + LOCATION_CREATED = "LOCATION_CREATED" + LOCATION_UPDATED = "LOCATION_UPDATED" + MSP_INVOICE_PROPOSAL_STATUS = "MSP_INVOICE_PROPOSAL_STATUS" OPERATIONAL_STATUS = "OPERATIONAL_STATUS" PING = "PING" SESSION_START = "SESSION_START" diff --git a/longship_api_client/models/webhook_post_dto_event_types_item.py b/longship_api_client/models/webhook_post_dto_event_types_item.py index 4e64a5f..dc7fbbf 100644 --- a/longship_api_client/models/webhook_post_dto_event_types_item.py +++ b/longship_api_client/models/webhook_post_dto_event_types_item.py @@ -2,8 +2,12 @@ class WebhookPostDtoEventTypesItem(str, Enum): + CDR_CREATED = "CDR_CREATED" CHARGEPOINT_BOOTED = "CHARGEPOINT_BOOTED" CONNECTIVITY_STATUS = "CONNECTIVITY_STATUS" + LOCATION_CREATED = "LOCATION_CREATED" + LOCATION_UPDATED = "LOCATION_UPDATED" + MSP_INVOICE_PROPOSAL_STATUS = "MSP_INVOICE_PROPOSAL_STATUS" OPERATIONAL_STATUS = "OPERATIONAL_STATUS" PING = "PING" SESSION_START = "SESSION_START" diff --git a/longship_api_client/models/webhook_put_dto_event_types_item.py b/longship_api_client/models/webhook_put_dto_event_types_item.py index 0897f42..b9f8e08 100644 --- a/longship_api_client/models/webhook_put_dto_event_types_item.py +++ b/longship_api_client/models/webhook_put_dto_event_types_item.py @@ -2,8 +2,12 @@ class WebhookPutDtoEventTypesItem(str, Enum): + CDR_CREATED = "CDR_CREATED" CHARGEPOINT_BOOTED = "CHARGEPOINT_BOOTED" CONNECTIVITY_STATUS = "CONNECTIVITY_STATUS" + LOCATION_CREATED = "LOCATION_CREATED" + LOCATION_UPDATED = "LOCATION_UPDATED" + MSP_INVOICE_PROPOSAL_STATUS = "MSP_INVOICE_PROPOSAL_STATUS" OPERATIONAL_STATUS = "OPERATIONAL_STATUS" PING = "PING" SESSION_START = "SESSION_START" diff --git a/longship_api_client/models/webhook_summary_get_dto_event_types_item.py b/longship_api_client/models/webhook_summary_get_dto_event_types_item.py index e60af05..eea0b65 100644 --- a/longship_api_client/models/webhook_summary_get_dto_event_types_item.py +++ b/longship_api_client/models/webhook_summary_get_dto_event_types_item.py @@ -2,8 +2,12 @@ class WebhookSummaryGetDtoEventTypesItem(str, Enum): + CDR_CREATED = "CDR_CREATED" CHARGEPOINT_BOOTED = "CHARGEPOINT_BOOTED" CONNECTIVITY_STATUS = "CONNECTIVITY_STATUS" + LOCATION_CREATED = "LOCATION_CREATED" + LOCATION_UPDATED = "LOCATION_UPDATED" + MSP_INVOICE_PROPOSAL_STATUS = "MSP_INVOICE_PROPOSAL_STATUS" OPERATIONAL_STATUS = "OPERATIONAL_STATUS" PING = "PING" SESSION_START = "SESSION_START"