onspring-api-sdk-rust 0.0.1

Rust SDK for the Onspring API
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

use std::collections::HashMap;

use serde::{Deserialize, Serialize};

use super::enums::{DataFormat, ValueType};

/// Represents a record in an Onspring application.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Record {
  pub app_id: i32,
  pub record_id: i32,
  pub field_data: Option<Vec<RecordFieldValue>>,
}

/// Represents a single field value within a record.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RecordFieldValue {
  #[serde(rename = "type")]
  pub value_type: ValueType,
  pub field_id: i32,
  pub value: serde_json::Value,
}

/// Request to create or update a record.
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SaveRecordRequest {
  pub app_id: i32,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub record_id: Option<i32>,
  pub fields: HashMap<String, serde_json::Value>,
}

/// Response from saving a record.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SaveRecordResponse {
  pub id: i32,
  pub warnings: Option<Vec<String>>,
}

/// Request to query records with a filter.
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct QueryRecordsRequest {
  pub app_id: i32,
  pub filter: String,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub field_ids: Option<Vec<i32>>,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub data_format: Option<DataFormat>,
}

/// Request to get a batch of records.
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct BatchGetRecordsRequest {
  pub app_id: i32,
  pub record_ids: Vec<i32>,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub field_ids: Option<Vec<i32>>,
  #[serde(skip_serializing_if = "Option::is_none")]
  pub data_format: Option<DataFormat>,
}

/// Request to delete a batch of records.
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct BatchDeleteRecordsRequest {
  pub app_id: i32,
  pub record_ids: Vec<i32>,
}