ds_api 1.0.0

Dart-DIO API Client for the Dataspeed Inc. Kinetic 360° Platform.

ds_api (EXPERIMENTAL)

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Dart package is automatically generated by the OpenAPI Generator project:

• API version: 0.8.0.post2.dev186+d91d395.shannon
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  ds_api: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  ds_api:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  ds_api:
    path: /path/to/ds_api

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ds_api/ds_api.dart';


final api = DsApi().getAtlasApi();
final MultipartFile chartJson = BINARY_DATA_HERE; // MultipartFile | 

try {
    final response = await api.addChart(chartJson);
    print(response);
} catch on DioException (e) {
    print("Exception when calling AtlasApi->addChart: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.lan

Class	Method	HTTP request	Description
AtlasApi	addChart	POST /atlas/charts	Add Chart
AtlasApi	addChart_0	POST /atlas/charts	Add Chart
AtlasApi	addPathToChart	PUT /atlas/charts/{chart_uuid}/path	Add Path To Chart
AtlasApi	addPathToChart_0	PUT /atlas/charts/{chart_uuid}/path	Add Path To Chart
AtlasApi	addTrail	POST /atlas/trails	Add Trail
AtlasApi	addTrail_0	POST /atlas/trails	Add Trail
AtlasApi	calculatePath	PUT /atlas/charts/{chart_uuid}/routes/{route_uuid}/path	Calculate Path
AtlasApi	calculatePath_0	PUT /atlas/charts/{chart_uuid}/routes/{route_uuid}/path	Calculate Path
AtlasApi	clearAtlas	DELETE /atlas	Clear Atlas
AtlasApi	clearAtlas_0	DELETE /atlas	Clear Atlas
AtlasApi	findNearestLocations	PUT /atlas/charts/{chart_uuid}/nearest	Find Nearest Locations
AtlasApi	findNearestLocations_0	PUT /atlas/charts/{chart_uuid}/nearest	Find Nearest Locations
AtlasApi	getAtlas	GET /atlas	Get Atlas
AtlasApi	getAtlas_0	GET /atlas	Get Atlas
AtlasApi	getChart	GET /atlas/charts/{chart_uuid}	Get Chart
AtlasApi	getChart_0	GET /atlas/charts/{chart_uuid}	Get Chart
AtlasApi	getCharts	GET /atlas/charts	Get Charts
AtlasApi	getCharts_0	GET /atlas/charts	Get Charts
AtlasApi	getSites	GET /atlas/sites	Get Sites
AtlasApi	getSites_0	GET /atlas/sites	Get Sites
AtlasApi	getTrail	GET /atlas/trails/{trail_uuid}	Get Trail
AtlasApi	getTrail_0	GET /atlas/trails/{trail_uuid}	Get Trail
AtlasApi	mergeAtlas	PATCH /atlas	Merge Atlas
AtlasApi	mergeAtlas_0	PATCH /atlas	Merge Atlas
AtlasApi	mergeCharts	PUT /atlas/charts/{chart_uuid}/merge	Merge Charts
AtlasApi	mergeCharts_0	PUT /atlas/charts/{chart_uuid}/merge	Merge Charts
AtlasApi	pathFromTrail	PUT /atlas/trails/{trail_uuid}/path	Path From Trail
AtlasApi	pathFromTrail_0	PUT /atlas/trails/{trail_uuid}/path	Path From Trail
AtlasApi	plotPath	PUT /atlas/charts/{chart_uuid}/plot	Plot Path
AtlasApi	plotPath_0	PUT /atlas/charts/{chart_uuid}/plot	Plot Path
AtlasApi	removeChart	DELETE /atlas/charts/{chart_uuid}	Remove Chart
AtlasApi	removeChart_0	DELETE /atlas/charts/{chart_uuid}	Remove Chart
AtlasApi	removeTrail	DELETE /atlas/trails/{trail_uuid}	Remove Trail
AtlasApi	removeTrail_0	DELETE /atlas/trails/{trail_uuid}	Remove Trail
AtlasApi	updateChart	PATCH /atlas/charts/{chart_uuid}	Update Chart
AtlasApi	updateChartInfo	PATCH /atlas/charts/{chart_uuid}/info	Update Chart Info
AtlasApi	updateChartInfo_0	PATCH /atlas/charts/{chart_uuid}/info	Update Chart Info
AtlasApi	updateChart_0	PATCH /atlas/charts/{chart_uuid}	Update Chart
CuesApi	activateCueByVehicleUuid	GET /fleet/{vehicle_uuid}/camera/cue/{cue_uuid}	Activate Cue By Vehicle Uuid
CuesApi	deleteCueByVehicleUuid	DELETE /fleet/{vehicle_uuid}/camera/cue/{cue_uuid}	Delete Cue By Vehicle Uuid
CuesApi	getCueListByVehicleUuid	GET /fleet/{vehicle_uuid}/camera/cue/list	Get Cue List By Vehicle Uuid
CuesApi	setCueByVehicleUuid	POST /fleet/{vehicle_uuid}/camera/cue/set	Set Cue By Vehicle Uuid
DiagnosticsApi	executeVehicleDiagnosticAction	PUT /fleet/{vehicle_uuid}/diagnostics/actions	Execute Vehicle Diagnostic Action
DiagnosticsApi	listVehicleDiagnosticActions	GET /fleet/{vehicle_uuid}/diagnostics/actions	List Vehicle Diagnostic Actions
DocketApi	addNote	PUT /docket/{ticket_uuid}/note	Add Note
DocketApi	closeTicket	POST /docket/{ticket_uuid}/close	Close Ticket
DocketApi	createDummyTicket	GET /docket/internal/docket/dummy	Create Dummy Ticket
DocketApi	createDummyTicket_0	GET /docket/internal/docket/dummy	Create Dummy Ticket
DocketApi	createTicket	POST /docket/create	Create Ticket
DocketApi	deleteTicket	DELETE /docket/{ticket_uuid}	Delete Ticket
DocketApi	getActiveTickets	GET /docket/tickets/open	Get Active Tickets
DocketApi	getClosedTicketUuids	GET /docket/tickets/closed	Get Closed Ticket Uuids
DocketApi	getContacts	GET /docket/sitrep/contacts	Get Contacts
DocketApi	getDocket	GET /docket	Get Docket
DocketApi	getTicket	GET /docket/{ticket_uuid}	Get Ticket
DocketApi	truncate	DELETE /docket/internal/docket	Truncate
DocketApi	truncate_0	DELETE /docket/internal/docket	Truncate
DocketApi	updateTicket	PUT /docket/{ticket_uuid}	Update Ticket
FleetApi	activateCueByVehicleUuid	GET /fleet/{vehicle_uuid}/camera/cue/{cue_uuid}	Activate Cue By Vehicle Uuid
FleetApi	addFleetUrl	POST /fleet/internal/deployments	Add Fleet Url
FleetApi	assignVehicleRoute	POST /fleet/{vehicle_uuid}/route	Assign Vehicle Route
FleetApi	assignVehicleRoute_0	POST /fleet/{vehicle_uuid}/route	Assign Vehicle Route
FleetApi	clearVehicleRoute	DELETE /fleet/{vehicle_uuid}/route	Clear Vehicle Route
FleetApi	clearVehicleRoute_0	DELETE /fleet/{vehicle_uuid}/route	Clear Vehicle Route
FleetApi	deleteCueByVehicleUuid	DELETE /fleet/{vehicle_uuid}/camera/cue/{cue_uuid}	Delete Cue By Vehicle Uuid
FleetApi	dispatchVehicle	PUT /fleet/dispatch	Dispatch Vehicle
FleetApi	dispatchVehicle_0	PUT /fleet/dispatch	Dispatch Vehicle
FleetApi	executeVehicleDiagnosticAction	PUT /fleet/{vehicle_uuid}/diagnostics/actions	Execute Vehicle Diagnostic Action
FleetApi	getCueListByVehicleUuid	GET /fleet/{vehicle_uuid}/camera/cue/list	Get Cue List By Vehicle Uuid
FleetApi	getFleetUrls	GET /fleet/internal/deployments	Get Fleet Urls
FleetApi	getVehicle	GET /fleet/{vehicle_uuid}	Get Vehicle
FleetApi	getVehicleDiagnostics	GET /fleet/{vehicle_uuid}/diagnostics	Get Vehicle Diagnostics
FleetApi	getVehicleObstacles	GET /fleet/{vehicle_uuid}/obstacles	Get Vehicle Obstacles
FleetApi	getVehicleOdometry	GET /fleet/{vehicle_uuid}/odometry	Get Vehicle Odometry
FleetApi	getVehiclePath	GET /fleet/{vehicle_uuid}/path	Get Vehicle Path
FleetApi	getVehiclePathUuid	GET /fleet/{vehicle_uuid}/path/uuid	Get Vehicle Path Uuid
FleetApi	getVehiclePathUuid_0	GET /fleet/{vehicle_uuid}/path/uuid	Get Vehicle Path Uuid
FleetApi	getVehiclePath_0	GET /fleet/{vehicle_uuid}/path	Get Vehicle Path
FleetApi	getVehiclePicture	GET /fleet/{vehicle_uuid}/image/{resolution}	Get Vehicle Picture
FleetApi	getVehicleRoute	GET /fleet/{vehicle_uuid}/route	Get Vehicle Route
FleetApi	getVehicleRoute_0	GET /fleet/{vehicle_uuid}/route	Get Vehicle Route
FleetApi	getVehicleStatus	GET /fleet/{vehicle_uuid}/status	Get Vehicle Status
FleetApi	getVehicleTopicsPublished	GET /fleet/{vehicle_uuid}/topics/published	Get Vehicle Topics Published
FleetApi	getVehicleTrajectory	GET /fleet/{vehicle_uuid}/trajectory/lookahead	Get Vehicle Trajectory
FleetApi	getVehicle_0	GET /fleet/{vehicle_uuid}	Get Vehicle
FleetApi	getVehicles	GET /fleet	Get Vehicles
FleetApi	getVehicles_0	GET /fleet	Get Vehicles
FleetApi	listVehicleDiagnosticActions	GET /fleet/{vehicle_uuid}/diagnostics/actions	List Vehicle Diagnostic Actions
FleetApi	registerVehicle	POST /fleet/register	Register Vehicle
FleetApi	removeFleetUrl	DELETE /fleet/internal/deployments	Remove Fleet Url
FleetApi	setCueByVehicleUuid	POST /fleet/{vehicle_uuid}/camera/cue/set	Set Cue By Vehicle Uuid
FleetApi	vehicleHeartbeatRecv	GET /fleet/{vehicle_uuid}/heartbeat	Vehicle Heartbeat Recv
GlossaryApi	getGlossary	GET /glossary	Get Glossary
GlossaryApi	getHealth	GET /health	Get Health
GlossaryApi	getRoot	GET /	Get Root
ImageApi	addImage	POST /image	Add Image
ImageApi	addVehicleImage	POST /image/vehicle/{vehicle_uuid}	Add Vehicle Image
ImageApi	getImage	GET /image/{image_uuid}	Get Image
ImageApi	getVehicleImage	GET /image/vehicle/{vehicle_uuid}	Get Vehicle Image
ImageApi	updateImage	PUT /image/{image_uuid}	Update Image
InternalApi	addFleetUrl	POST /fleet/internal/deployments	Add Fleet Url
InternalApi	createDummyTicket	GET /docket/internal/docket/dummy	Create Dummy Ticket
InternalApi	getFleetUrls	GET /fleet/internal/deployments	Get Fleet Urls
InternalApi	removeFleetUrl	DELETE /fleet/internal/deployments	Remove Fleet Url
InternalApi	truncate	DELETE /docket/internal/docket	Truncate
InternalApi	truncateMissions	DELETE /missions/truncate	Truncate Missions
MissionApi	cancelObjective	DELETE /missions/objectives/{objective_uuid}	Cancel Objective
MissionApi	getMission	GET /missions/{mission_id}	Get Mission
MissionApi	getMissionObjectivesStatusList	GET /missions/status	Get Mission Objectives Status List
MissionApi	getMissionProfiles	GET /missions/profiles	Get Mission Profiles
MissionApi	getMissionReceipts	GET /missions/receipts	Get Mission Receipts
MissionApi	getMissionTrackers	GET /missions	Get Mission Trackers
MissionApi	getObjectiveHindrance	GET /missions/objectives/{objective_uuid}/hindrance	Get Objective Hindrance
MissionApi	listMissionObjectiveTypes	GET /missions/objectives/types	List Mission Objective Types
MissionApi	reportAssistance	PUT /missions/objectives/{objective_uuid}/assist	Report Assistance
MissionApi	submitMissionOrder	POST /missions	Submit Mission Order
MissionApi	truncateMissions	DELETE /missions/truncate	Truncate Missions
RealTimeApi	getMissionObjectivesStatusList	GET /missions/status	Get Mission Objectives Status List
RealTimeApi	getMissionReceipts	GET /missions/receipts	Get Mission Receipts
RealTimeApi	getObjectiveHindrance	GET /missions/objectives/{objective_uuid}/hindrance	Get Objective Hindrance
RealTimeApi	getVehicleDiagnostics	GET /fleet/{vehicle_uuid}/diagnostics	Get Vehicle Diagnostics
RealTimeApi	getVehicleObstacles	GET /fleet/{vehicle_uuid}/obstacles	Get Vehicle Obstacles
RealTimeApi	getVehicleOdometry	GET /fleet/{vehicle_uuid}/odometry	Get Vehicle Odometry
RealTimeApi	getVehicleStatus	GET /fleet/{vehicle_uuid}/status	Get Vehicle Status
RealTimeApi	getVehicleTopicsPublished	GET /fleet/{vehicle_uuid}/topics/published	Get Vehicle Topics Published
RealTimeApi	getVehicleTrajectory	GET /fleet/{vehicle_uuid}/trajectory/lookahead	Get Vehicle Trajectory
RealTimeApi	reportAssistance	PUT /missions/objectives/{objective_uuid}/assist	Report Assistance
RegistrationApi	registerVehicle	POST /fleet/register	Register Vehicle
RegistrationApi	vehicleHeartbeatRecv	GET /fleet/{vehicle_uuid}/heartbeat	Vehicle Heartbeat Recv
SitRepApi	getContacts	GET /docket/sitrep/contacts	Get Contacts
VideoApi	createIngress	POST /video/ingress	Create Ingress
VideoApi	createRoom	POST /video/rooms	Create Room
VideoApi	getConnectionInfo	GET /video/connection	Get Connection Info
VideoApi	getIngress	GET /video/ingress/{room_name}/{participant_identity}	Get Ingress
VideoApi	getRooms	GET /video/rooms	Get Rooms
VideoApi	getToken	GET /video/token	Get Token

Documentation For Models

• AssistanceModel
• AssistanceResolutionEnum
• AtlasModel
• AtlasResponse
• AutonomyControlModeEnum
• AutonomyStateModel
• BodyDispatchVehicle
• BooleanListResponse
• BooleanResponse
• BoundingSphereModel
• CameraCueActivationResponse
• CameraCueListResponseModel
• ChartInfoModel
• ChartListResponse
• ChartModel
• ChartResponse
• ClassificationObjectiveModel
• CodecModel
• ContactListResponseModel
• ContactModel
• CoordinateListResponse
• CoordinateModel
• CreateIngressRequestModel
• DeploymentInfo
• DiagnosticActionListResponse
• DiagnosticActionModel
• DiagnosticActionResponse
• DiagnosticActionResult
• DiagnosticModel
• DiagnosticsResponse
• DocketModel
• DocketResponseModel
• DriveByWireCapabilityModel
• DriveTo2DObjectiveModel
• DriveToObjectiveModel
• DwellObjectiveModel
• EnvironmentInfo
• GlossaryModel
• GlossaryModelResponse
• HTTPValidationError
• HeadingModel
• HeartbeatResponseModel
• HindranceModel
• HindranceResponse
• HumanAssistedObjectiveModel
• ImageResolutionEnum
• ImageUrlModel
• IngressAudioEncodingPresetEnum
• IngressAudioOptionsModel
• IngressInfoModel
• IngressInfoResponse
• IngressInputEnum
• IngressVideoEncodingOptionsModel
• IngressVideoEncodingPresetEnum
• IngressVideoOptionsModel
• InterventionRequestEnum
• Location2DModel
• Location3DModel
• LocationInner
• ManualCameraCueModel
• MeasurementModel
• MetadataModel
• MissionListResponse
• MissionModel
• MissionObjectiveStatusUpdateListResponse
• MissionObjectiveTypeEnum
• MissionObjectiveTypeEnumListResponse
• MissionOrderModel
• MissionReceiptListResponse
• MissionReceiptModel
• MissionReceiptResponse
• MissionTrackerListResponse
• MissionTrackerModel
• MissionTrackerResponse
• MosquittoInfo
• MotionStateEnum
• NginxInfo
• NoteModel
• ObjectiveModel
• ObjectiveStateEnum
• ObjectiveStatusModel
• ObjectiveStatusUpdateModel
• ObservationModel
• ObstacleListResponse
• ObstacleModel
• OdometryModel
• OdometryModelResponse
• OrientationModel
• PathModel
• PathResponse
• PerceptionStateEnum
• Pose2DModel
• PoseModel
• PositionModel
• PowerPlantTypeEnum
• PtCoordinateModel
• PythonInfo
• QualityEnum
• QuaternionModel
• ReferenceFrameModel
• RegistrationModel
• RegistrationResponseModel
• ResponseModelListRoomModel
• RiskEnum
• RoomModel
• RosInfo
• RotationModel
• RouteModel
• RouteObjectiveModel
• RouteResponse
• SetCueModel
• SiteInfoModel
• SiteListResponse
• SiteModel
• SlewModel
• SpeedConstraintsModel
• SpeedModel
• StringListResponse
• SubsystemStatusModel
• TagModel
• TicketListResponseModel
• TicketModel
• TicketResponseModel
• TicketStatus
• TimedVersionModel
• TokenData
• TokenResponse
• TopicInfoListResponse
• TopicInfoModel
• TrackSourceEnum
• TrailModel
• TrailResponse
• TrajectoryModel
• TrajectoryResponse
• TripActionModel
• TripModel
• UuidIndexedModel
• UuidListResponse
• UuidResponse
• ValidationError
• VehicleCapabilityModel
• VehicleModel
• VehicleModelListResponse
• VehicleModelResponse
• VehicleParameters
• VehicleStatusModel
• VehicleStatusModelResponse
• VideoCodecEnum
• VideoLayerModel
• VideoQualityEnum
• WaypointEdgeModel
• WaypointLocationListResponse
• WaypointLocationModel
• WaypointModel

Documentation For Authorization

Authentication schemes defined for the API:

VideoApiOauth2Scheme

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.lan/oauth/v2/authorize
• Scopes: N/A

MissionApiOauth2Scheme

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.lan/oauth/v2/authorize
• Scopes:
• viewMission: Provides the ability to VIEW missions.
• editMission: Provides the ability to EDIT missions.
• manageMission: Provides the ability to manage missions .
• assignMission: Assign missions
• addMissions: Add missions
• cancelMission: ability to cancel missions in progress
• deleteMission: ability to delete or truncate missions

AtlasApiOauth2Scheme

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.lan/oauth/v2/authorize
• Scopes:
• addAtlasRoute: Provides the ability to ADD route objects to the atlas graph.
• deleteAtlasRoute: Provides the ability to REMOVE route objects from the atlas graph.
• editAtlasRoute: Provides the ability to EDIT route objects in the atlas graph.
• viewAtlas: Provides the ability to VIEW route objects in the atlas graph.

FleetApiOauth2Scheme

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.lan/oauth/v2/authorize
• Scopes:
• viewDiagnostics: Provides the ability to VIEW diagnostic information of fleet members.
• addFleetMember: Provides the ability to ADD vehicle/member objects to the fleet object.
• deleteFleetMember: Provides the ability to REMOVE vehicle/member objects from the fleet object.
• editFleetMember: Provides the ability to EDIT vehicle/member objects in the fleet object.
• viewFleetMember: Provides the ability to VIEW vehicle/member objects in the fleet object.
• assignMission: Provides the ability to ASSIGN a mission to a fleet member.
• viewMission: Provides the ability to VIEW a mission assigned to a fleet member.
• cancelMission: Provides the ability to CANCEL a mission assigned to a fleet member.
• manageMissions: Provides the ability to MANAGE/EDIT mission profiles.

DocketApiOauth2Scheme

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.lan/oauth/v2/authorize
• Scopes:
• viewTickets: Provides the ability to VIEW Docket tickets.
• editTickets: Provides the ability to EDIT Docket tickets.
• assignTickets: Provides the ability to ASSIGN Docket tickets.

ImageApiOauth2Scheme

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.lan/oauth/v2/authorize
• Scopes:
• addImage: Provides the ability to ADD images to the image database
• viewImage: Provides the ability to VIEW images from the image database

Author