nominal-api 0.1240.0

use conjure_http::endpoint;
/// [INTERNAL]
/// Series metadata represents the constant information about data in a series - specifically, the name, units, a
/// description, and the tags. Series metadata can be used to query points from specific series depending on the tag
/// value selections.
#[conjure_http::conjure_client(name = "SeriesMetadataService")]
pub trait SeriesMetadataService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Batch get series metadata by DataSourceRid.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-get",
        name = "batchGet",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Create new series metadata.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype",
        name = "create",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Idempotently creates series metadata.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-create",
        name = "batchCreate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn batch_create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Upserts series metadata. Creates new series metadata if it does not exist for the given channel and data
    /// source. If it already exists, updates the locator and any provided unit and description fields while
    /// preserving existing values for fields not supplied.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/create-or-update",
        name = "createOrUpdate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn create_or_update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Batch version of createOrUpdate.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-create-or-update",
        name = "batchCreateOrUpdate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn batch_create_or_update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Get series metadata from its series metadata rid.
    #[endpoint(
        method = GET,
        path = "/timeseries/archetype/v1/series-archetype/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::SeriesMetadataRid,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
        conjure_http::private::Error,
    >;
    /// Update existing series metadata.
    /// Throws SeriesMetadataNotFound if the series metadata does not exist.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/{rid}/metadata",
        name = "updateMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn update_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::SeriesMetadataRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::UpdateSeriesMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
        conjure_http::private::Error,
    >;
    /// Batch creates series metadata for video channels if they don't exist.
    /// Idempotent - returns existing SeriesMetadataRid if already exists.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/video-channel",
        name = "batchCreateVideoSeries",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_create_video_series(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesResponse,
        conjure_http::private::Error,
    >;
}
/// [INTERNAL]
/// Series metadata represents the constant information about data in a series - specifically, the name, units, a
/// description, and the tags. Series metadata can be used to query points from specific series depending on the tag
/// value selections.
#[conjure_http::conjure_client(name = "SeriesMetadataService")]
pub trait AsyncSeriesMetadataService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Batch get series metadata by DataSourceRid.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-get",
        name = "batchGet",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Create new series metadata.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype",
        name = "create",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Idempotently creates series metadata.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-create",
        name = "batchCreate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Upserts series metadata. Creates new series metadata if it does not exist for the given channel and data
    /// source. If it already exists, updates the locator and any provided unit and description fields while
    /// preserving existing values for fields not supplied.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/create-or-update",
        name = "createOrUpdate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn create_or_update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Batch version of createOrUpdate.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-create-or-update",
        name = "batchCreateOrUpdate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_create_or_update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Get series metadata from its series metadata rid.
    #[endpoint(
        method = GET,
        path = "/timeseries/archetype/v1/series-archetype/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::SeriesMetadataRid,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
        conjure_http::private::Error,
    >;
    /// Update existing series metadata.
    /// Throws SeriesMetadataNotFound if the series metadata does not exist.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/{rid}/metadata",
        name = "updateMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::SeriesMetadataRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::UpdateSeriesMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
        conjure_http::private::Error,
    >;
    /// Batch creates series metadata for video channels if they don't exist.
    /// Idempotent - returns existing SeriesMetadataRid if already exists.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/video-channel",
        name = "batchCreateVideoSeries",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_create_video_series(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesResponse,
        conjure_http::private::Error,
    >;
}
/// [INTERNAL]
/// Series metadata represents the constant information about data in a series - specifically, the name, units, a
/// description, and the tags. Series metadata can be used to query points from specific series depending on the tag
/// value selections.
#[conjure_http::conjure_client(name = "SeriesMetadataService", local)]
pub trait LocalAsyncSeriesMetadataService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Batch get series metadata by DataSourceRid.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-get",
        name = "batchGet",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::BatchGetSeriesMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Create new series metadata.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype",
        name = "create",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Idempotently creates series metadata.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-create",
        name = "batchCreate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Upserts series metadata. Creates new series metadata if it does not exist for the given channel and data
    /// source. If it already exists, updates the locator and any provided unit and description fields while
    /// preserving existing values for fields not supplied.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/create-or-update",
        name = "createOrUpdate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn create_or_update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::CreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Batch version of createOrUpdate.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/batch-create-or-update",
        name = "batchCreateOrUpdate",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_create_or_update(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateSeriesMetadataRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Get series metadata from its series metadata rid.
    #[endpoint(
        method = GET,
        path = "/timeseries/archetype/v1/series-archetype/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::SeriesMetadataRid,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
        conjure_http::private::Error,
    >;
    /// Update existing series metadata.
    /// Throws SeriesMetadataNotFound if the series metadata does not exist.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/{rid}/metadata",
        name = "updateMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::objects::api::SeriesMetadataRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::UpdateSeriesMetadataRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::SeriesMetadata,
        conjure_http::private::Error,
    >;
    /// Batch creates series metadata for video channels if they don't exist.
    /// Idempotent - returns existing SeriesMetadataRid if already exists.
    #[endpoint(
        method = POST,
        path = "/timeseries/archetype/v1/series-archetype/video-channel",
        name = "batchCreateVideoSeries",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_create_video_series(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesRequest,
    ) -> Result<
        super::super::super::super::objects::timeseries::metadata::api::BatchCreateVideoSeriesResponse,
        conjure_http::private::Error,
    >;
}