2616 lines
77 KiB
TypeScript
2616 lines
77 KiB
TypeScript
/**
|
|
* This file was auto-generated by openapi-typescript.
|
|
* Do not make direct changes to the file.
|
|
*/
|
|
|
|
export interface paths {
|
|
"/api/sample/v1/context": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Context */
|
|
get: operations["context_api_sample_v1_context_get"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/demo-data": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Demo Data */
|
|
get: operations["demo_data_api_sample_v1_demo_data_get"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/monitoring/alerts": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Alerts */
|
|
get: operations["alerts_api_sample_v1_monitoring_alerts_get"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/monitoring/observations": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Observations */
|
|
get: operations["observations_api_sample_v1_monitoring_observations_get"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/monitoring/points": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Points */
|
|
get: operations["points_api_sample_v1_monitoring_points_get"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/requests/{request_id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Receipt */
|
|
get: operations["receipt_api_sample_v1_requests__request_id__get"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/scenario": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Scenario */
|
|
get: operations["scenario_api_sample_v1_scenario_get"];
|
|
put?: never;
|
|
/** Configure Scenario */
|
|
post: operations["configure_scenario_api_sample_v1_scenario_post"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/test-data": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Test Data */
|
|
get: operations["test_data_api_sample_v1_test_data_get"];
|
|
put?: never;
|
|
/** Create Test Data */
|
|
post: operations["create_test_data_api_sample_v1_test_data_post"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/test-data/{record_id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Test Data Record */
|
|
get: operations["test_data_record_api_sample_v1_test_data__record_id__get"];
|
|
put?: never;
|
|
post?: never;
|
|
/** Delete Test Data */
|
|
delete: operations["delete_test_data_api_sample_v1_test_data__record_id__delete"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Update Test Data */
|
|
patch: operations["update_test_data_api_sample_v1_test_data__record_id__patch"];
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/work-orders": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Work Orders */
|
|
get: operations["work_orders_api_sample_v1_work_orders_get"];
|
|
put?: never;
|
|
/** Create Work Order */
|
|
post: operations["create_work_order_api_sample_v1_work_orders_post"];
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
"/api/sample/v1/work-orders/{work_order_id}": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Work Order */
|
|
get: operations["work_order_api_sample_v1_work_orders__work_order_id__get"];
|
|
put?: never;
|
|
post?: never;
|
|
/** Delete Work Order */
|
|
delete: operations["delete_work_order_api_sample_v1_work_orders__work_order_id__delete"];
|
|
options?: never;
|
|
head?: never;
|
|
/** Update Work Order */
|
|
patch: operations["update_work_order_api_sample_v1_work_orders__work_order_id__patch"];
|
|
trace?: never;
|
|
};
|
|
"/health": {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
/** Health */
|
|
get: operations["health_health_get"];
|
|
put?: never;
|
|
post?: never;
|
|
delete?: never;
|
|
options?: never;
|
|
head?: never;
|
|
patch?: never;
|
|
trace?: never;
|
|
};
|
|
}
|
|
export type webhooks = Record<string, never>;
|
|
export interface components {
|
|
schemas: {
|
|
/** Alert */
|
|
Alert: {
|
|
/** Alert Id */
|
|
alert_id: string;
|
|
/** Message */
|
|
message: string;
|
|
/**
|
|
* Occurred At
|
|
* Format: date-time
|
|
*/
|
|
occurred_at: string;
|
|
/**
|
|
* Origin
|
|
* @enum {string}
|
|
*/
|
|
origin: "historical_replay" | "synthetic";
|
|
/** Point Id */
|
|
point_id: string;
|
|
};
|
|
/** AlertPage */
|
|
AlertPage: {
|
|
/**
|
|
* Availability
|
|
* @enum {string}
|
|
*/
|
|
availability: "available" | "not_configured";
|
|
/** Items */
|
|
items: components["schemas"]["Alert"][];
|
|
/**
|
|
* Origin
|
|
* @enum {string}
|
|
*/
|
|
origin: "historical_replay" | "synthetic";
|
|
/** Reason */
|
|
reason: string | null;
|
|
/** Source Id */
|
|
source_id: string;
|
|
};
|
|
/** Context */
|
|
Context: {
|
|
/** Can Write */
|
|
can_write: boolean;
|
|
managed_resources: components["schemas"]["ManagedResourceCapabilities"];
|
|
/**
|
|
* Origin
|
|
* @constant
|
|
*/
|
|
origin: "synthetic";
|
|
/**
|
|
* Project Id
|
|
* Format: uuid
|
|
*/
|
|
project_id: string;
|
|
/**
|
|
* Protocol Version
|
|
* @constant
|
|
*/
|
|
protocol_version: "tjwater-peripheral-sample@1";
|
|
/** Scenarios */
|
|
scenarios: ("normal" | "missing_data" | "unavailable" | "response_lost" | "duplicate_feedback" | "conflicting_feedback" | "late_state")[];
|
|
/** State Transitions */
|
|
state_transitions: {
|
|
[key: string]: string[];
|
|
};
|
|
/**
|
|
* User Id
|
|
* Format: uuid
|
|
*/
|
|
user_id: string;
|
|
};
|
|
/** CreateTestDataRecord */
|
|
CreateTestDataRecord: {
|
|
/** Label */
|
|
label: string;
|
|
/**
|
|
* Notes
|
|
* @default
|
|
*/
|
|
notes: string;
|
|
/**
|
|
* Observed At
|
|
* Format: date-time
|
|
*/
|
|
observed_at: string;
|
|
/** Point Id */
|
|
point_id: string;
|
|
/**
|
|
* Quality
|
|
* @default valid
|
|
* @enum {string}
|
|
*/
|
|
quality: "valid" | "unknown" | "missing";
|
|
/**
|
|
* Request Id
|
|
* Format: uuid
|
|
*/
|
|
request_id: string;
|
|
/** Unit */
|
|
unit: string;
|
|
/** Value */
|
|
value: number | null;
|
|
};
|
|
/** CreateWorkOrder */
|
|
CreateWorkOrder: {
|
|
/** Assignee */
|
|
assignee?: string | null;
|
|
/** Feedback Requirements */
|
|
feedback_requirements?: string[];
|
|
/** Location */
|
|
location?: string | null;
|
|
/**
|
|
* Priority
|
|
* @default normal
|
|
* @enum {string}
|
|
*/
|
|
priority: "low" | "normal" | "high" | "urgent";
|
|
/**
|
|
* Request Id
|
|
* Format: uuid
|
|
*/
|
|
request_id: string;
|
|
/** Scenario Code */
|
|
scenario_code?: string | null;
|
|
/** Scheduled At */
|
|
scheduled_at?: string | null;
|
|
/**
|
|
* Status
|
|
* @default draft
|
|
* @enum {string}
|
|
*/
|
|
status: "draft" | "open" | "in_progress" | "awaiting_reply" | "completed" | "cancelled";
|
|
/** Summary */
|
|
summary: string;
|
|
/** Title */
|
|
title: string;
|
|
/**
|
|
* Work Order Type
|
|
* @default general
|
|
* @enum {string}
|
|
*/
|
|
work_order_type: "general" | "water_quality_complaint" | "burst_report";
|
|
};
|
|
/** DeleteResource */
|
|
DeleteResource: {
|
|
/** Expected Revision */
|
|
expected_revision: number;
|
|
/**
|
|
* Request Id
|
|
* Format: uuid
|
|
*/
|
|
request_id: string;
|
|
};
|
|
/** DeletedResource */
|
|
DeletedResource: {
|
|
/**
|
|
* Deleted
|
|
* @constant
|
|
*/
|
|
deleted: true;
|
|
/**
|
|
* Resource Id
|
|
* Format: uuid
|
|
*/
|
|
resource_id: string;
|
|
/**
|
|
* Resource Type
|
|
* @enum {string}
|
|
*/
|
|
resource_type: "work_order" | "test_data_record";
|
|
/** Revision */
|
|
revision: number;
|
|
};
|
|
/** DemoAlert */
|
|
DemoAlert: {
|
|
/**
|
|
* Alert Id
|
|
* Format: uuid
|
|
*/
|
|
alert_id: string;
|
|
/** Asset Id */
|
|
asset_id: string;
|
|
/** Cleared At */
|
|
cleared_at: string | null;
|
|
/**
|
|
* Code
|
|
* @enum {string}
|
|
*/
|
|
code: "communication_lost" | "low_level";
|
|
/** Message */
|
|
message: string;
|
|
/**
|
|
* Occurred At
|
|
* Format: date-time
|
|
*/
|
|
occurred_at: string;
|
|
};
|
|
/** DemoDataset */
|
|
DemoDataset: {
|
|
/** Alerts */
|
|
alerts: components["schemas"]["DemoAlert"][];
|
|
/** Device States */
|
|
device_states: components["schemas"]["DemoDeviceState"][];
|
|
/**
|
|
* Generator Version
|
|
* @constant
|
|
*/
|
|
generator_version: "water-demo@2";
|
|
/** Observations */
|
|
observations: components["schemas"]["Observation"][];
|
|
/** Operations */
|
|
operations: components["schemas"]["DemoOperation"][];
|
|
/**
|
|
* Origin
|
|
* @constant
|
|
*/
|
|
origin: "synthetic";
|
|
/** Points */
|
|
points: components["schemas"]["Point"][];
|
|
/**
|
|
* Project Id
|
|
* Format: uuid
|
|
*/
|
|
project_id: string;
|
|
/** Seed */
|
|
seed: string;
|
|
/** Source Id */
|
|
source_id: string;
|
|
/** Source Revision */
|
|
source_revision: string;
|
|
window: components["schemas"]["TimeRange"];
|
|
};
|
|
/** DemoDeviceState */
|
|
DemoDeviceState: {
|
|
/** Asset Id */
|
|
asset_id: string;
|
|
/**
|
|
* Asset Type
|
|
* @enum {string}
|
|
*/
|
|
asset_type: "pressure_sensor" | "pump" | "valve";
|
|
/**
|
|
* Observed At
|
|
* Format: date-time
|
|
*/
|
|
observed_at: string;
|
|
/**
|
|
* Record Id
|
|
* Format: uuid
|
|
*/
|
|
record_id: string;
|
|
/**
|
|
* State
|
|
* @enum {string}
|
|
*/
|
|
state: "online" | "offline" | "running" | "stopped" | "open" | "closed";
|
|
};
|
|
/** DemoOperation */
|
|
DemoOperation: {
|
|
/**
|
|
* Actor
|
|
* @constant
|
|
*/
|
|
actor: "synthetic-generator";
|
|
/** Asset Id */
|
|
asset_id: string;
|
|
/** Note */
|
|
note: string;
|
|
/**
|
|
* Occurred At
|
|
* Format: date-time
|
|
*/
|
|
occurred_at: string;
|
|
/**
|
|
* Operation
|
|
* @enum {string}
|
|
*/
|
|
operation: "pump_start" | "pump_stop" | "valve_open" | "valve_close";
|
|
/**
|
|
* Record Id
|
|
* Format: uuid
|
|
*/
|
|
record_id: string;
|
|
};
|
|
/** Feedback */
|
|
Feedback: {
|
|
applicable_time: components["schemas"]["TimeRange"];
|
|
/** Asset Ids */
|
|
asset_ids: string[];
|
|
/** Attachment Refs */
|
|
attachment_refs: string[];
|
|
/**
|
|
* Feedback Id
|
|
* Format: uuid
|
|
*/
|
|
feedback_id: string;
|
|
/**
|
|
* Finding
|
|
* @enum {string}
|
|
*/
|
|
finding: "instrument_fault" | "no_instrument_fault" | "uncertain";
|
|
/** Notes */
|
|
notes: string;
|
|
/**
|
|
* Occurred At
|
|
* Format: date-time
|
|
*/
|
|
occurred_at: string;
|
|
/**
|
|
* Origin
|
|
* @constant
|
|
*/
|
|
origin: "synthetic";
|
|
/**
|
|
* Recorded At
|
|
* Format: date-time
|
|
*/
|
|
recorded_at: string;
|
|
/** Recorded By */
|
|
recorded_by: string;
|
|
/**
|
|
* Task Id
|
|
* Format: uuid
|
|
*/
|
|
task_id: string;
|
|
};
|
|
/** HistoryEntry */
|
|
HistoryEntry: {
|
|
/** Actor */
|
|
actor: string;
|
|
/**
|
|
* At
|
|
* Format: date-time
|
|
*/
|
|
at: string;
|
|
/** From Status */
|
|
from_status: ("pending" | "processing" | "pending_review" | "completed") | null;
|
|
/** Reason */
|
|
reason: string;
|
|
/** Sequence */
|
|
sequence: number;
|
|
/**
|
|
* To Status
|
|
* @enum {string}
|
|
*/
|
|
to_status: "pending" | "processing" | "pending_review" | "completed";
|
|
};
|
|
/** ManagedResourceCapabilities */
|
|
ManagedResourceCapabilities: {
|
|
/**
|
|
* Test Data
|
|
* @enum {string}
|
|
*/
|
|
test_data: "available" | "not_configured";
|
|
/**
|
|
* Work Orders
|
|
* @enum {string}
|
|
*/
|
|
work_orders: "available" | "not_configured";
|
|
};
|
|
/** ObjectRef */
|
|
ObjectRef: {
|
|
/**
|
|
* Object Id
|
|
* Format: uuid
|
|
*/
|
|
object_id: string;
|
|
/**
|
|
* Object Type
|
|
* @enum {string}
|
|
*/
|
|
object_type: "analysis_task" | "goal" | "state_snapshot" | "action_contract" | "validation" | "run" | "outcome" | "evidence" | "artifact" | "operation";
|
|
/** Revision */
|
|
revision: number;
|
|
};
|
|
/** Observation */
|
|
Observation: {
|
|
/**
|
|
* Observed At
|
|
* Format: date-time
|
|
*/
|
|
observed_at: string;
|
|
/** Point Id */
|
|
point_id: string;
|
|
/**
|
|
* Quality
|
|
* @enum {string}
|
|
*/
|
|
quality: "valid" | "unknown" | "missing";
|
|
/** Record Id */
|
|
record_id: string;
|
|
/** Unit */
|
|
unit: string;
|
|
/** Value */
|
|
value: number | null;
|
|
};
|
|
/** Observations */
|
|
Observations: {
|
|
/** Items */
|
|
items: components["schemas"]["Observation"][];
|
|
/**
|
|
* Origin
|
|
* @enum {string}
|
|
*/
|
|
origin: "historical_replay" | "synthetic";
|
|
/** Source Id */
|
|
source_id: string;
|
|
/** Source Revision */
|
|
source_revision: string;
|
|
/** Truncated */
|
|
truncated: boolean;
|
|
};
|
|
/** Point */
|
|
Point: {
|
|
/** Label */
|
|
label: string;
|
|
/**
|
|
* Origin
|
|
* @enum {string}
|
|
*/
|
|
origin: "historical_replay" | "synthetic";
|
|
/** Point Id */
|
|
point_id: string;
|
|
/** Status */
|
|
status: string;
|
|
/** Unit */
|
|
unit: string;
|
|
};
|
|
/** PointPage */
|
|
PointPage: {
|
|
/** Items */
|
|
items: components["schemas"]["Point"][];
|
|
/** Next Cursor */
|
|
next_cursor: string | null;
|
|
/**
|
|
* Origin
|
|
* @enum {string}
|
|
*/
|
|
origin: "historical_replay" | "synthetic";
|
|
/** Source Id */
|
|
source_id: string;
|
|
};
|
|
/** Receipt */
|
|
Receipt: {
|
|
/**
|
|
* Request Id
|
|
* Format: uuid
|
|
*/
|
|
request_id: string;
|
|
/** Result */
|
|
result: components["schemas"]["Task"] | components["schemas"]["ScenarioState"] | components["schemas"]["WorkOrder"] | components["schemas"]["TestDataRecord"] | components["schemas"]["DeletedResource"];
|
|
/** Task Id */
|
|
task_id: string | null;
|
|
};
|
|
/** SampleError */
|
|
SampleError: {
|
|
/** Code */
|
|
code: string;
|
|
/**
|
|
* Effect
|
|
* @enum {string}
|
|
*/
|
|
effect: "none" | "unknown";
|
|
/** Message */
|
|
message: string;
|
|
/** Request Id */
|
|
request_id: string | null;
|
|
};
|
|
/** ScenarioCommand */
|
|
ScenarioCommand: {
|
|
/**
|
|
* Request Id
|
|
* Format: uuid
|
|
*/
|
|
request_id: string;
|
|
/**
|
|
* Scenario
|
|
* @enum {string}
|
|
*/
|
|
scenario: "normal" | "missing_data" | "unavailable" | "response_lost" | "duplicate_feedback" | "conflicting_feedback" | "late_state";
|
|
};
|
|
/** ScenarioState */
|
|
ScenarioState: {
|
|
/** Revision */
|
|
revision: number;
|
|
/**
|
|
* Scenario
|
|
* @enum {string}
|
|
*/
|
|
scenario: "normal" | "missing_data" | "unavailable" | "response_lost" | "duplicate_feedback" | "conflicting_feedback" | "late_state";
|
|
};
|
|
/** SourceLink */
|
|
SourceLink: {
|
|
/**
|
|
* Object Id
|
|
* Format: uuid
|
|
*/
|
|
object_id: string;
|
|
/**
|
|
* Object Type
|
|
* @enum {string}
|
|
*/
|
|
object_type: "validation" | "artifact";
|
|
/** Revision */
|
|
revision: number;
|
|
/**
|
|
* System
|
|
* @constant
|
|
*/
|
|
system: "next";
|
|
/**
|
|
* Task Id
|
|
* Format: uuid
|
|
*/
|
|
task_id: string;
|
|
};
|
|
/** Task */
|
|
Task: {
|
|
analysis_window: components["schemas"]["TimeRange"];
|
|
/** Asset Ids */
|
|
asset_ids: string[];
|
|
/**
|
|
* Created At
|
|
* Format: date-time
|
|
*/
|
|
created_at: string;
|
|
/** Created By */
|
|
created_by: string;
|
|
/** Evidence Refs */
|
|
evidence_refs: components["schemas"]["ObjectRef"][];
|
|
/** Feedback */
|
|
feedback: components["schemas"]["Feedback"][];
|
|
/** History */
|
|
history: components["schemas"]["HistoryEntry"][];
|
|
/**
|
|
* Origin
|
|
* @constant
|
|
*/
|
|
origin: "synthetic";
|
|
/**
|
|
* Project Id
|
|
* Format: uuid
|
|
*/
|
|
project_id: string;
|
|
/** Requested Check */
|
|
requested_check: string;
|
|
/** Revision */
|
|
revision: number;
|
|
source: components["schemas"]["SourceLink"];
|
|
/**
|
|
* Status
|
|
* @enum {string}
|
|
*/
|
|
status: "pending" | "processing" | "pending_review" | "completed";
|
|
/** Summary */
|
|
summary: string;
|
|
/**
|
|
* Task Id
|
|
* Format: uuid
|
|
*/
|
|
task_id: string;
|
|
/** Title */
|
|
title: string;
|
|
/**
|
|
* Updated At
|
|
* Format: date-time
|
|
*/
|
|
updated_at: string;
|
|
};
|
|
/** TestDataRecord */
|
|
TestDataRecord: {
|
|
/**
|
|
* Created At
|
|
* Format: date-time
|
|
*/
|
|
created_at: string;
|
|
/** Created By */
|
|
created_by: string;
|
|
/** Label */
|
|
label: string;
|
|
/** Notes */
|
|
notes: string;
|
|
/**
|
|
* Observed At
|
|
* Format: date-time
|
|
*/
|
|
observed_at: string;
|
|
/**
|
|
* Origin
|
|
* @constant
|
|
*/
|
|
origin: "synthetic";
|
|
/** Point Id */
|
|
point_id: string;
|
|
/**
|
|
* Project Id
|
|
* Format: uuid
|
|
*/
|
|
project_id: string;
|
|
/**
|
|
* Quality
|
|
* @enum {string}
|
|
*/
|
|
quality: "valid" | "unknown" | "missing";
|
|
/**
|
|
* Record Id
|
|
* Format: uuid
|
|
*/
|
|
record_id: string;
|
|
/** Revision */
|
|
revision: number;
|
|
/** Unit */
|
|
unit: string;
|
|
/**
|
|
* Updated At
|
|
* Format: date-time
|
|
*/
|
|
updated_at: string;
|
|
/** Updated By */
|
|
updated_by: string;
|
|
/** Value */
|
|
value: number | null;
|
|
};
|
|
/** TestDataRecordPage */
|
|
TestDataRecordPage: {
|
|
/** Items */
|
|
items: components["schemas"]["TestDataRecord"][];
|
|
/** Next Cursor */
|
|
next_cursor: string | null;
|
|
};
|
|
/** TimeRange */
|
|
TimeRange: {
|
|
/**
|
|
* End
|
|
* Format: date-time
|
|
*/
|
|
end: string;
|
|
/**
|
|
* Start
|
|
* Format: date-time
|
|
*/
|
|
start: string;
|
|
};
|
|
/** UpdateTestDataRecord */
|
|
UpdateTestDataRecord: {
|
|
/**
|
|
* Clear Value
|
|
* @default false
|
|
*/
|
|
clear_value: boolean;
|
|
/** Expected Revision */
|
|
expected_revision: number;
|
|
/** Label */
|
|
label?: string | null;
|
|
/** Notes */
|
|
notes?: string | null;
|
|
/** Observed At */
|
|
observed_at?: string | null;
|
|
/** Point Id */
|
|
point_id?: string | null;
|
|
/** Quality */
|
|
quality?: ("valid" | "unknown" | "missing") | null;
|
|
/**
|
|
* Request Id
|
|
* Format: uuid
|
|
*/
|
|
request_id: string;
|
|
/** Unit */
|
|
unit?: string | null;
|
|
/** Value */
|
|
value?: number | null;
|
|
};
|
|
/** UpdateWorkOrder */
|
|
UpdateWorkOrder: {
|
|
/** Assignee */
|
|
assignee?: string | null;
|
|
/**
|
|
* Clear Assignee
|
|
* @default false
|
|
*/
|
|
clear_assignee: boolean;
|
|
/**
|
|
* Clear Location
|
|
* @default false
|
|
*/
|
|
clear_location: boolean;
|
|
/**
|
|
* Clear Scenario Code
|
|
* @default false
|
|
*/
|
|
clear_scenario_code: boolean;
|
|
/**
|
|
* Clear Scheduled At
|
|
* @default false
|
|
*/
|
|
clear_scheduled_at: boolean;
|
|
/** Expected Revision */
|
|
expected_revision: number;
|
|
/** Feedback Requirements */
|
|
feedback_requirements?: string[] | null;
|
|
/** Location */
|
|
location?: string | null;
|
|
/** Priority */
|
|
priority?: ("low" | "normal" | "high" | "urgent") | null;
|
|
/** Progress Note */
|
|
progress_note?: string | null;
|
|
/**
|
|
* Request Id
|
|
* Format: uuid
|
|
*/
|
|
request_id: string;
|
|
/** Scenario Code */
|
|
scenario_code?: string | null;
|
|
/** Scheduled At */
|
|
scheduled_at?: string | null;
|
|
/** Status */
|
|
status?: ("draft" | "open" | "in_progress" | "awaiting_reply" | "completed" | "cancelled") | null;
|
|
/** Summary */
|
|
summary?: string | null;
|
|
/** Title */
|
|
title?: string | null;
|
|
};
|
|
/** WorkOrder */
|
|
WorkOrder: {
|
|
/** Activity */
|
|
activity?: components["schemas"]["WorkOrderActivity"][];
|
|
/** Assignee */
|
|
assignee: string | null;
|
|
/**
|
|
* Created At
|
|
* Format: date-time
|
|
*/
|
|
created_at: string;
|
|
/** Created By */
|
|
created_by: string;
|
|
/** Feedback Requirements */
|
|
feedback_requirements?: string[];
|
|
/** Location */
|
|
location?: string | null;
|
|
/**
|
|
* Origin
|
|
* @constant
|
|
*/
|
|
origin: "synthetic";
|
|
/**
|
|
* Priority
|
|
* @enum {string}
|
|
*/
|
|
priority: "low" | "normal" | "high" | "urgent";
|
|
/**
|
|
* Project Id
|
|
* Format: uuid
|
|
*/
|
|
project_id: string;
|
|
/** Revision */
|
|
revision: number;
|
|
/** Scenario Code */
|
|
scenario_code?: string | null;
|
|
/** Scheduled At */
|
|
scheduled_at: string | null;
|
|
/**
|
|
* Status
|
|
* @enum {string}
|
|
*/
|
|
status: "draft" | "open" | "in_progress" | "awaiting_reply" | "completed" | "cancelled";
|
|
/** Summary */
|
|
summary: string;
|
|
/** Title */
|
|
title: string;
|
|
/**
|
|
* Updated At
|
|
* Format: date-time
|
|
*/
|
|
updated_at: string;
|
|
/** Updated By */
|
|
updated_by: string;
|
|
/**
|
|
* Work Order Id
|
|
* Format: uuid
|
|
*/
|
|
work_order_id: string;
|
|
/**
|
|
* Work Order Type
|
|
* @default general
|
|
* @enum {string}
|
|
*/
|
|
work_order_type: "general" | "water_quality_complaint" | "burst_report";
|
|
};
|
|
/** WorkOrderActivity */
|
|
WorkOrderActivity: {
|
|
/** Actor */
|
|
actor: string;
|
|
/** Detail */
|
|
detail: string;
|
|
/**
|
|
* Kind
|
|
* @enum {string}
|
|
*/
|
|
kind: "created" | "updated" | "feedback";
|
|
/**
|
|
* Occurred At
|
|
* Format: date-time
|
|
*/
|
|
occurred_at: string;
|
|
/** Sequence */
|
|
sequence: number;
|
|
/** Title */
|
|
title: string;
|
|
};
|
|
/** WorkOrderPage */
|
|
WorkOrderPage: {
|
|
/** Items */
|
|
items: components["schemas"]["WorkOrder"][];
|
|
/** Next Cursor */
|
|
next_cursor: string | null;
|
|
};
|
|
};
|
|
responses: never;
|
|
parameters: never;
|
|
requestBodies: never;
|
|
headers: never;
|
|
pathItems: never;
|
|
}
|
|
export type $defs = Record<string, never>;
|
|
export interface operations {
|
|
context_api_sample_v1_context_get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["Context"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
demo_data_api_sample_v1_demo_data_get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["DemoDataset"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
alerts_api_sample_v1_monitoring_alerts_get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["AlertPage"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
observations_api_sample_v1_monitoring_observations_get: {
|
|
parameters: {
|
|
query: {
|
|
point_id: string;
|
|
start: string;
|
|
end: string;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["Observations"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
points_api_sample_v1_monitoring_points_get: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
cursor?: string | null;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["PointPage"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
receipt_api_sample_v1_requests__request_id__get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
request_id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["Receipt"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
scenario_api_sample_v1_scenario_get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ScenarioState"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
configure_scenario_api_sample_v1_scenario_post: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["ScenarioCommand"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["ScenarioState"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
test_data_api_sample_v1_test_data_get: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
cursor?: string | null;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["TestDataRecordPage"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
create_test_data_api_sample_v1_test_data_post: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateTestDataRecord"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Successful Response */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["TestDataRecord"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
test_data_record_api_sample_v1_test_data__record_id__get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
record_id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["TestDataRecord"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
delete_test_data_api_sample_v1_test_data__record_id__delete: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
record_id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["DeleteResource"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["DeletedResource"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
update_test_data_api_sample_v1_test_data__record_id__patch: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
record_id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateTestDataRecord"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["TestDataRecord"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
work_orders_api_sample_v1_work_orders_get: {
|
|
parameters: {
|
|
query?: {
|
|
limit?: number;
|
|
cursor?: string | null;
|
|
};
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WorkOrderPage"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
create_work_order_api_sample_v1_work_orders_post: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["CreateWorkOrder"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Successful Response */
|
|
201: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WorkOrder"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
work_order_api_sample_v1_work_orders__work_order_id__get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
work_order_id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WorkOrder"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
delete_work_order_api_sample_v1_work_orders__work_order_id__delete: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
work_order_id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["DeleteResource"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["DeletedResource"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
update_work_order_api_sample_v1_work_orders__work_order_id__patch: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path: {
|
|
work_order_id: string;
|
|
};
|
|
cookie?: never;
|
|
};
|
|
requestBody: {
|
|
content: {
|
|
"application/json": components["schemas"]["UpdateWorkOrder"];
|
|
};
|
|
};
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["WorkOrder"];
|
|
};
|
|
};
|
|
/** @description Unauthorized */
|
|
401: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Forbidden */
|
|
403: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Not Found */
|
|
404: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Conflict */
|
|
409: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Unprocessable Entity */
|
|
422: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Bad Gateway */
|
|
502: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
/** @description Service Unavailable */
|
|
503: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": components["schemas"]["SampleError"];
|
|
};
|
|
};
|
|
};
|
|
};
|
|
health_health_get: {
|
|
parameters: {
|
|
query?: never;
|
|
header?: never;
|
|
path?: never;
|
|
cookie?: never;
|
|
};
|
|
requestBody?: never;
|
|
responses: {
|
|
/** @description Successful Response */
|
|
200: {
|
|
headers: {
|
|
[name: string]: unknown;
|
|
};
|
|
content: {
|
|
"application/json": unknown;
|
|
};
|
|
};
|
|
};
|
|
};
|
|
}
|