oadr3 - v1.0.0

oadr3/schema

Types

Anon25ddbf1f

</> 
pub type Anon25ddbf1f {
  Anon25ddbf1f(url: String)
}

Constructors 

  • Anon25ddbf1f(url: String)

Anon818bb683

</> 
pub type Anon818bb683 {
  Anon818bb683(
    interval_period: option.Option(IntervalPeriod),
    intervals: List(Interval),
    resource_name: String,
  )
}

Constructors

Anon85c77f13

</> 
pub type Anon85c77f13 {
  Anon85c77f13(
    bearer_token: option.Option(String),
    callback_url: String,
    objects: List(String),
    operations: List(String),
  )
}

Constructors 

  • Anon85c77f13(
  bearer_token: option.Option(String),
  callback_url: String,
  objects: List(String),
  operations: List(String),
)

Anon97535fea

</> 
pub type Anon97535fea {
  Anon97535fea(client_id: String)
}

Constructors 

  • Anon97535fea(client_id: String)

AuthError

</> 
pub type AuthError {
  AuthError(
    error: String,
    error_description: option.Option(String),
    error_uri: option.Option(String),
  )
}

Constructors

AuthServerInfo

</> 
pub type AuthServerInfo {
  AuthServerInfo(token_url: String)
}

Constructors 

  • AuthServerInfo(token_url: String)

BlResourceRequest

</> 
pub type BlResourceRequest {
  BlResourceRequest(
    attributes: option.Option(List(ValuesMap)),
    client_id: String,
    object_type: String,
    resource_name: String,
    targets: option.Option(List(String)),
    ven_id: String,
  )
}

Constructors 

  • BlResourceRequest(
  attributes: option.Option(List(ValuesMap)),
  client_id: String,
  object_type: String,
  resource_name: String,
  targets: option.Option(List(String)),
  ven_id: String,
)

BlVenRequest

</> 
pub type BlVenRequest {
  BlVenRequest(
    attributes: option.Option(List(ValuesMap)),
    client_id: String,
    object_type: String,
    targets: option.Option(List(String)),
    ven_name: String,
  )
}

Constructors

ClientCredentialRequest

</> 
pub type ClientCredentialRequest {
  ClientCredentialRequest(
    client_id: String,
    client_secret: String,
    grant_type: String,
    scope: option.Option(String),
  )
}

Constructors 

  • ClientCredentialRequest(
  client_id: String,
  client_secret: String,
  grant_type: String,
  scope: option.Option(String),
)

ClientCredentialResponse

</> 
pub type ClientCredentialResponse {
  ClientCredentialResponse(
    access_token: String,
    expires_in: option.Option(Int),
    refresh_token: option.Option(String),
    scope: option.Option(String),
    token_type: String,
  )
}

Constructors

ClientId

</> 
pub type ClientId =
  String

ClientName

</> 
pub type ClientName =
  String

DateTime

</> 
pub type DateTime =
  String

Duration

</> 
pub type Duration =
  String

Event

</> 
pub type Event =
  #(ObjectMetadata, EventRequest)

EventPayloadDescriptor

</> 
pub type EventPayloadDescriptor {
  EventPayloadDescriptor(
    currency: option.Option(String),
    object_type: String,
    payload_type: String,
    units: option.Option(String),
  )
}

Constructors 

  • EventPayloadDescriptor(
  currency: option.Option(String),
  object_type: String,
  payload_type: String,
  units: option.Option(String),
)

EventRequest

</> 
pub type EventRequest {
  EventRequest(
    duration: option.Option(String),
    event_name: option.Option(String),
    interval_period: option.Option(IntervalPeriod),
    intervals: option.Option(List(Interval)),
    payload_descriptors: option.Option(
      List(EventPayloadDescriptor),
    ),
    priority: option.Option(Int),
    program_id: String,
    report_descriptors: option.Option(List(ReportDescriptor)),
    targets: option.Option(List(String)),
  )
}

Constructors

Interval

</> 
pub type Interval {
  Interval(
    id: Int,
    interval_period: option.Option(IntervalPeriod),
    payloads: List(ValuesMap),
  )
}

Constructors

IntervalPeriod

</> 
pub type IntervalPeriod {
  IntervalPeriod(
    duration: option.Option(String),
    randomize_start: option.Option(String),
    start: option.Option(String),
  )
}

Constructors

MqttNotifierAuthenticationAnonymous

</> 
pub type MqttNotifierAuthenticationAnonymous {
  MqttNotifierAuthenticationAnonymous(method_: String)
}

Constructors 

  • MqttNotifierAuthenticationAnonymous(method_: String)

MqttNotifierAuthenticationCertificate

</> 
pub type MqttNotifierAuthenticationCertificate {
  MqttNotifierAuthenticationCertificate(
    ca_cert: String,
    client_cert: String,
    client_key: String,
    method_: String,
  )
}

Constructors 

  • MqttNotifierAuthenticationCertificate(
  ca_cert: String,
  client_cert: String,
  client_key: String,
  method_: String,
)

MqttNotifierAuthenticationOauth2BearerToken

</> 
pub type MqttNotifierAuthenticationOauth2BearerToken {
  MqttNotifierAuthenticationOauth2BearerToken(
    method_: String,
    username: String,
  )
}

Constructors 

  • MqttNotifierAuthenticationOauth2BearerToken(
  method_: String,
  username: String,
)

MqttNotifierBindingObject

</> 
pub type MqttNotifierBindingObject {
  MqttNotifierBindingObject(
    uris: List(String),
    authentication: utils.Any,
    serialization: String,
  )
}

Constructors 

  • MqttNotifierBindingObject(
  uris: List(String),
  authentication: utils.Any,
  serialization: String,
)

Notification

</> 
pub type Notification {
  Notification(
    object: Nil,
    object_type: String,
    operation: String,
    targets: option.Option(List(String)),
  )
}

Constructors 

  • Notification(
  object: Nil,
  object_type: String,
  operation: String,
  targets: option.Option(List(String)),
)

NotifierOperationsTopics

</> 
pub type NotifierOperationsTopics {
  NotifierOperationsTopics(
    all: option.Option(String),
    create: option.Option(String),
    delete: String,
    update: String,
  )
}

Constructors

NotifierTopicsResponse

</> 
pub type NotifierTopicsResponse {
  NotifierTopicsResponse(topics: NotifierOperationsTopics)
}

Constructors

NotifiersResponse

</> 
pub type NotifiersResponse {
  NotifiersResponse(
    mqtt: option.Option(MqttNotifierBindingObject),
    webhook: Bool,
  )
}

Constructors

ObjectId

</> 
pub type ObjectId =
  String

ObjectMetadata

</> 
pub type ObjectMetadata {
  ObjectMetadata(
    created_date_time: String,
    id: String,
    modification_date_time: String,
    object_type: String,
  )
}

Constructors 

  • ObjectMetadata(
  created_date_time: String,
  id: String,
  modification_date_time: String,
  object_type: String,
)

ObjectTypes

</> 
pub type ObjectTypes =
  String

Point

</> 
pub type Point {
  Point(x: Float, y: Float)
}

Constructors 

  • Point(x: Float, y: Float)

Problem

</> 
pub type Problem {
  Problem(
    detail: option.Option(String),
    instance: option.Option(String),
    status: option.Option(Int),
    title: option.Option(String),
    type_: option.Option(String),
  )
}

Constructors

Program

</> 
pub type Program =
  #(ObjectMetadata, ProgramRequest)

ProgramRequest

</> 
pub type ProgramRequest {
  ProgramRequest(
    attributes: option.Option(List(ValuesMap)),
    interval_period: option.Option(IntervalPeriod),
    payload_descriptors: option.Option(List(utils.Any)),
    program_descriptions: option.Option(List(Anon25ddbf1f)),
    program_name: String,
    targets: option.Option(List(String)),
  )
}

Constructors

ReadingType

</> 
pub type ReadingType =
  String

Report

</> 
pub type Report =
  #(ObjectMetadata, ReportRequest, Anon97535fea)

ReportDescriptor

</> 
pub type ReportDescriptor {
  ReportDescriptor(
    aggregate: option.Option(Bool),
    frequency: option.Option(Int),
    historical: option.Option(Bool),
    num_intervals: option.Option(Int),
    payload_type: String,
    reading_type: option.Option(String),
    repeat: option.Option(Int),
    report_intervals: option.Option(String),
    start_interval: option.Option(Int),
    targets: option.Option(List(String)),
    units: option.Option(String),
  )
}

Constructors

ReportPayloadDescriptor

</> 
pub type ReportPayloadDescriptor {
  ReportPayloadDescriptor(
    accuracy: option.Option(Float),
    confidence: option.Option(Int),
    object_type: String,
    payload_type: String,
    reading_type: option.Option(String),
    units: option.Option(String),
  )
}

Constructors

ReportRequest

</> 
pub type ReportRequest {
  ReportRequest(
    client_name: String,
    event_id: String,
    payload_descriptors: option.Option(
      List(ReportPayloadDescriptor),
    ),
    report_name: option.Option(String),
    resources: List(Anon818bb683),
  )
}

Constructors

Resource

</> 
pub type Resource =
  #(ObjectMetadata, BlResourceRequest)

ResourceName

</> 
pub type ResourceName =
  String

ResourceRequest

</> 
pub type ResourceRequest =
  utils.Any

Subscription

</> 
pub type Subscription =
  #(ObjectMetadata, SubscriptionRequest, Anon97535fea)

SubscriptionRequest

</> 
pub type SubscriptionRequest {
  SubscriptionRequest(
    client_name: String,
    object_operations: List(Anon85c77f13),
    program_id: option.Option(String),
    targets: option.Option(List(String)),
  )
}

Constructors

Target

</> 
pub type Target =
  String

Units

</> 
pub type Units =
  String

ValuesMap

</> 
pub type ValuesMap {
  ValuesMap(type_: String, values: List(utils.Any))
}

Constructors 

  • ValuesMap(type_: String, values: List(utils.Any))

Ven

</> 
pub type Ven =
  #(ObjectMetadata, BlVenRequest)

VenName

</> 
pub type VenName =
  String

VenRequest

</> 
pub type VenRequest =
  utils.Any

VenResourceRequest

</> 
pub type VenResourceRequest {
  VenResourceRequest(
    attributes: option.Option(List(ValuesMap)),
    object_type: String,
    resource_name: String,
    ven_id: String,
  )
}

Constructors 

  • VenResourceRequest(
  attributes: option.Option(List(ValuesMap)),
  object_type: String,
  resource_name: String,
  ven_id: String,
)

VenVenRequest

</> 
pub type VenVenRequest {
  VenVenRequest(
    attributes: option.Option(List(ValuesMap)),
    object_type: String,
    ven_name: String,
  )
}

Constructors

Values

anon_25ddbf1f_decoder

</> 
pub fn anon_25ddbf1f_decoder() -> decode.Decoder(Anon25ddbf1f)

anon_25ddbf1f_encode

</> 
pub fn anon_25ddbf1f_encode(data: Anon25ddbf1f) -> json.Json

anon_818bb683_decoder

</> 
pub fn anon_818bb683_decoder() -> decode.Decoder(Anon818bb683)

anon_818bb683_encode

</> 
pub fn anon_818bb683_encode(data: Anon818bb683) -> json.Json

anon_85c77f13_decoder

</> 
pub fn anon_85c77f13_decoder() -> decode.Decoder(Anon85c77f13)

anon_85c77f13_encode

</> 
pub fn anon_85c77f13_encode(data: Anon85c77f13) -> json.Json

anon_97535fea_decoder

</> 
pub fn anon_97535fea_decoder() -> decode.Decoder(Anon97535fea)

anon_97535fea_encode

</> 
pub fn anon_97535fea_encode(data: Anon97535fea) -> json.Json

auth_error_decoder

</> 
pub fn auth_error_decoder() -> decode.Decoder(AuthError)

auth_error_encode

</> 
pub fn auth_error_encode(data: AuthError) -> json.Json

auth_server_info_decoder

</> 
pub fn auth_server_info_decoder() -> decode.Decoder(
  AuthServerInfo,
)

auth_server_info_encode

</> 
pub fn auth_server_info_encode(data: AuthServerInfo) -> json.Json

bl_resource_request_decoder

</> 
pub fn bl_resource_request_decoder() -> decode.Decoder(
  BlResourceRequest,
)

bl_resource_request_encode

</> 
pub fn bl_resource_request_encode(
  data: BlResourceRequest,
) -> json.Json

bl_ven_request_decoder

</> 
pub fn bl_ven_request_decoder() -> decode.Decoder(BlVenRequest)

bl_ven_request_encode

</> 
pub fn bl_ven_request_encode(data: BlVenRequest) -> json.Json

client_credential_request_decoder

</> 
pub fn client_credential_request_decoder() -> decode.Decoder(
  ClientCredentialRequest,
)

client_credential_request_encode

</> 
pub fn client_credential_request_encode(
  data: ClientCredentialRequest,
) -> json.Json

client_credential_response_decoder

</> 
pub fn client_credential_response_decoder() -> decode.Decoder(
  ClientCredentialResponse,
)

client_credential_response_encode

</> 
pub fn client_credential_response_encode(
  data: ClientCredentialResponse,
) -> json.Json

client_id_decoder

</> 
pub fn client_id_decoder() -> decode.Decoder(String)

client_id_encode

</> 
pub fn client_id_encode(data: String) -> json.Json

client_name_decoder

</> 
pub fn client_name_decoder() -> decode.Decoder(String)

client_name_encode

</> 
pub fn client_name_encode(data: String) -> json.Json

date_time_decoder

</> 
pub fn date_time_decoder() -> decode.Decoder(String)

date_time_encode

</> 
pub fn date_time_encode(data: String) -> json.Json

duration_decoder

</> 
pub fn duration_decoder() -> decode.Decoder(String)

duration_encode

</> 
pub fn duration_encode(data: String) -> json.Json

event_decoder

</> 
pub fn event_decoder() -> decode.Decoder(
  #(ObjectMetadata, EventRequest),
)

event_encode

</> 
pub fn event_encode(
  data: #(ObjectMetadata, EventRequest),
) -> json.Json

event_payload_descriptor_decoder

</> 
pub fn event_payload_descriptor_decoder() -> decode.Decoder(
  EventPayloadDescriptor,
)

event_payload_descriptor_encode

</> 
pub fn event_payload_descriptor_encode(
  data: EventPayloadDescriptor,
) -> json.Json

event_request_decoder

</> 
pub fn event_request_decoder() -> decode.Decoder(EventRequest)

event_request_encode

</> 
pub fn event_request_encode(data: EventRequest) -> json.Json

interval_decoder

</> 
pub fn interval_decoder() -> decode.Decoder(Interval)

interval_encode

</> 
pub fn interval_encode(data: Interval) -> json.Json

interval_period_decoder

</> 
pub fn interval_period_decoder() -> decode.Decoder(IntervalPeriod)

interval_period_encode

</> 
pub fn interval_period_encode(data: IntervalPeriod) -> json.Json

mqtt_notifier_authentication_anonymous_decoder

</> 
pub fn mqtt_notifier_authentication_anonymous_decoder() -> decode.Decoder(
  MqttNotifierAuthenticationAnonymous,
)

mqtt_notifier_authentication_anonymous_encode

</> 
pub fn mqtt_notifier_authentication_anonymous_encode(
  data: MqttNotifierAuthenticationAnonymous,
) -> json.Json

mqtt_notifier_authentication_certificate_decoder

</> 
pub fn mqtt_notifier_authentication_certificate_decoder() -> decode.Decoder(
  MqttNotifierAuthenticationCertificate,
)

mqtt_notifier_authentication_certificate_encode

</> 
pub fn mqtt_notifier_authentication_certificate_encode(
  data: MqttNotifierAuthenticationCertificate,
) -> json.Json

mqtt_notifier_authentication_oauth2_bearer_token_decoder

</> 
pub fn mqtt_notifier_authentication_oauth2_bearer_token_decoder() -> decode.Decoder(
  MqttNotifierAuthenticationOauth2BearerToken,
)

mqtt_notifier_authentication_oauth2_bearer_token_encode

</> 
pub fn mqtt_notifier_authentication_oauth2_bearer_token_encode(
  data: MqttNotifierAuthenticationOauth2BearerToken,
) -> json.Json

mqtt_notifier_binding_object_decoder

</> 
pub fn mqtt_notifier_binding_object_decoder() -> decode.Decoder(
  MqttNotifierBindingObject,
)

mqtt_notifier_binding_object_encode

</> 
pub fn mqtt_notifier_binding_object_encode(
  data: MqttNotifierBindingObject,
) -> json.Json

notification_decoder

</> 
pub fn notification_decoder() -> decode.Decoder(Notification)

notification_encode

</> 
pub fn notification_encode(data: Notification) -> json.Json

notifier_operations_topics_decoder

</> 
pub fn notifier_operations_topics_decoder() -> decode.Decoder(
  NotifierOperationsTopics,
)

notifier_operations_topics_encode

</> 
pub fn notifier_operations_topics_encode(
  data: NotifierOperationsTopics,
) -> json.Json

notifier_topics_response_decoder

</> 
pub fn notifier_topics_response_decoder() -> decode.Decoder(
  NotifierTopicsResponse,
)

notifier_topics_response_encode

</> 
pub fn notifier_topics_response_encode(
  data: NotifierTopicsResponse,
) -> json.Json

notifiers_response_decoder

</> 
pub fn notifiers_response_decoder() -> decode.Decoder(
  NotifiersResponse,
)

notifiers_response_encode

</> 
pub fn notifiers_response_encode(
  data: NotifiersResponse,
) -> json.Json

object_id_decoder

</> 
pub fn object_id_decoder() -> decode.Decoder(String)

object_id_encode

</> 
pub fn object_id_encode(data: String) -> json.Json

object_metadata_decoder

</> 
pub fn object_metadata_decoder() -> decode.Decoder(ObjectMetadata)

object_metadata_encode

</> 
pub fn object_metadata_encode(data: ObjectMetadata) -> json.Json

object_types_decoder

</> 
pub fn object_types_decoder() -> decode.Decoder(String)

object_types_encode

</> 
pub fn object_types_encode(data: String) -> json.Json

point_decoder

</> 
pub fn point_decoder() -> decode.Decoder(Point)

point_encode

</> 
pub fn point_encode(data: Point) -> json.Json

problem_decoder

</> 
pub fn problem_decoder() -> decode.Decoder(Problem)

problem_encode

</> 
pub fn problem_encode(data: Problem) -> json.Json

program_decoder

</> 
pub fn program_decoder() -> decode.Decoder(
  #(ObjectMetadata, ProgramRequest),
)

program_encode

</> 
pub fn program_encode(
  data: #(ObjectMetadata, ProgramRequest),
) -> json.Json

program_request_decoder

</> 
pub fn program_request_decoder() -> decode.Decoder(ProgramRequest)

program_request_encode

</> 
pub fn program_request_encode(data: ProgramRequest) -> json.Json

reading_type_decoder

</> 
pub fn reading_type_decoder() -> decode.Decoder(String)

reading_type_encode

</> 
pub fn reading_type_encode(data: String) -> json.Json

report_decoder

</> 
pub fn report_decoder() -> decode.Decoder(
  #(ObjectMetadata, ReportRequest, Anon97535fea),
)

report_descriptor_decoder

</> 
pub fn report_descriptor_decoder() -> decode.Decoder(
  ReportDescriptor,
)

report_descriptor_encode

</> 
pub fn report_descriptor_encode(
  data: ReportDescriptor,
) -> json.Json

report_encode

</> 
pub fn report_encode(
  data: #(ObjectMetadata, ReportRequest, Anon97535fea),
) -> json.Json

report_payload_descriptor_decoder

</> 
pub fn report_payload_descriptor_decoder() -> decode.Decoder(
  ReportPayloadDescriptor,
)

report_payload_descriptor_encode

</> 
pub fn report_payload_descriptor_encode(
  data: ReportPayloadDescriptor,
) -> json.Json

report_request_decoder

</> 
pub fn report_request_decoder() -> decode.Decoder(ReportRequest)

report_request_encode

</> 
pub fn report_request_encode(data: ReportRequest) -> json.Json

resource_decoder

</> 
pub fn resource_decoder() -> decode.Decoder(
  #(ObjectMetadata, BlResourceRequest),
)

resource_encode

</> 
pub fn resource_encode(
  data: #(ObjectMetadata, BlResourceRequest),
) -> json.Json

resource_name_decoder

</> 
pub fn resource_name_decoder() -> decode.Decoder(String)

resource_name_encode

</> 
pub fn resource_name_encode(data: String) -> json.Json

resource_request_decoder

</> 
pub fn resource_request_decoder() -> decode.Decoder(utils.Any)

resource_request_encode

</> 
pub fn resource_request_encode(data: utils.Any) -> json.Json

subscription_decoder

</> 
pub fn subscription_decoder() -> decode.Decoder(
  #(ObjectMetadata, SubscriptionRequest, Anon97535fea),
)

subscription_encode

</> 
pub fn subscription_encode(
  data: #(ObjectMetadata, SubscriptionRequest, Anon97535fea),
) -> json.Json

subscription_request_decoder

</> 
pub fn subscription_request_decoder() -> decode.Decoder(
  SubscriptionRequest,
)

subscription_request_encode

</> 
pub fn subscription_request_encode(
  data: SubscriptionRequest,
) -> json.Json

target_decoder

</> 
pub fn target_decoder() -> decode.Decoder(String)

target_encode

</> 
pub fn target_encode(data: String) -> json.Json

units_decoder

</> 
pub fn units_decoder() -> decode.Decoder(String)

units_encode

</> 
pub fn units_encode(data: String) -> json.Json

values_map_decoder

</> 
pub fn values_map_decoder() -> decode.Decoder(ValuesMap)

values_map_encode

</> 
pub fn values_map_encode(data: ValuesMap) -> json.Json

ven_decoder

</> 
pub fn ven_decoder() -> decode.Decoder(
  #(ObjectMetadata, BlVenRequest),
)

ven_encode

</> 
pub fn ven_encode(
  data: #(ObjectMetadata, BlVenRequest),
) -> json.Json

ven_name_decoder

</> 
pub fn ven_name_decoder() -> decode.Decoder(String)

ven_name_encode

</> 
pub fn ven_name_encode(data: String) -> json.Json

ven_request_decoder

</> 
pub fn ven_request_decoder() -> decode.Decoder(utils.Any)

ven_request_encode

</> 
pub fn ven_request_encode(data: utils.Any) -> json.Json

ven_resource_request_decoder

</> 
pub fn ven_resource_request_decoder() -> decode.Decoder(
  VenResourceRequest,
)

ven_resource_request_encode

</> 
pub fn ven_resource_request_encode(
  data: VenResourceRequest,
) -> json.Json

ven_ven_request_decoder

</> 
pub fn ven_ven_request_decoder() -> decode.Decoder(VenVenRequest)

ven_ven_request_encode

</> 
pub fn ven_ven_request_encode(data: VenVenRequest) -> json.Json
✨ Search Document