boreholeio 0.1.0

A library for interacting with borehole.io, a subsurface data management, delivery and visualisation platform
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use serde::Serialize;

use crate::{
    client::{internal_client::HttpRequestType, BoreholeIoClient, Result},
    schema::{
        Borehole, DateTime, Device, JsonValue, Location, LoggingEquipment, LoggingRun, Project,
        Tag, Uuid,
    },
};

pub async fn list(client: &BoreholeIoClient) -> Result<Vec<LoggingRun>> {
    client
        .web_client
        .send_request_with_data::<(), Vec<LoggingRun>>(
            (format!("{}/logging-runs/", client.base_url())).as_str(),
            HttpRequestType::Get,
            (),
        )
        .await
}

#[derive(Default, Serialize)]
pub struct UpdateTagsParameters {
    add: Vec<Tag>,
    remove: Vec<Tag>,
}

#[serde_with::skip_serializing_none]
#[derive(Default, serde::Serialize)]
pub struct BulkUpdateParameters {
    pub ids: Option<Vec<Uuid>>,
    pub borehole: Option<Borehole>,
    pub project: Option<Project>,
    pub location: Option<Location>,
    pub tags: Option<UpdateTagsParameters>,
}

pub async fn bulk_update(
    client: &BoreholeIoClient,
    parameters: BulkUpdateParameters,
) -> Result<()> {
    client
        .web_client
        .send_request_no_data::<BulkUpdateParameters>(
            (format!("{}/logging-runs/", client.base_url())).as_str(),
            HttpRequestType::Post,
            parameters,
        )
        .await
}

#[serde_with::skip_serializing_none]
#[derive(Default, serde::Serialize)]
pub struct CreateParameters {
    pub id: Option<Uuid>,
    pub borehole: Option<Borehole>,
    pub project: Option<Project>,
    pub tags: Option<Vec<Tag>>,
    pub metadata: Option<JsonValue>,
    pub notes: Option<String>,
    pub device: Option<Device>,
    pub location: Option<Location>,
    pub starting_depth: Option<f64>,
    pub started_at: Option<DateTime>,
    pub logging_equipment: Option<LoggingEquipment>,
}

pub async fn create(client: &BoreholeIoClient, parameters: CreateParameters) -> Result<LoggingRun> {
    client
        .web_client
        .send_request_with_data::<_, LoggingRun>(
            (format!("{}/logging-runs/", client.base_url())).as_str(),
            HttpRequestType::Post,
            parameters,
        )
        .await
}

pub async fn find(client: &BoreholeIoClient, id: Uuid) -> Result<LoggingRun> {
    client
        .web_client
        .send_request_with_data::<_, LoggingRun>(
            (format!("{}/logging-runs/{}", client.base_url(), id)).as_str(),
            HttpRequestType::Get,
            (),
        )
        .await
}

#[serde_with::skip_serializing_none]
#[derive(Default, serde::Serialize)]
pub struct UpdateParameters {
    pub borehole: Option<Borehole>,
    pub project: Option<Project>,
    pub location: Option<Location>,
    pub tags: Option<UpdateTagsParameters>,
}

pub async fn update(
    client: &BoreholeIoClient,
    id: Uuid,
    parameters: UpdateParameters,
) -> Result<LoggingRun> {
    client
        .web_client
        .send_request_with_data::<_, LoggingRun>(
            (format!("{}/logging-runs/{}", client.base_url(), id)).as_str(),
            HttpRequestType::Patch,
            parameters,
        )
        .await
}