simply-dns 0.2.2

An async Rust client for the [Simply.com API](https://www.simply.com/se/docs/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
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
113
114
115
116
117
118
119
120
121
122
123

use serde::{Deserialize, Serialize};

/// Represents a DNS record as returned by the Simply.com DNS API.
///
/// Fields map directly to the API response schema. For details, refer to the official API docs.
/// See: https://www.simply.com/en/docs/api/
#[derive(Debug, serde::Deserialize)]
pub struct DnsRecord {
    /// Unique identifier for the DNS record.
    pub record_id: DnsRecordId,
    /// The DNS record name (subdomain), e.g. "hello" in "hello.example.com".
    pub name: String,
    /// Time to live (TTL) in seconds for the DNS record.
    pub ttl: u32,
    /// Data field for the DNS record (e.g., IP address for "A" record, target domain for "CNAME", etc.).
    pub data: String,
    /// Type of DNS record ("A", "CNAME", "MX", etc.).
    #[serde(rename = "type")]
    pub record_type: String,
    /// Priority value for records that require it (e.g., MX, SRV); optional.
    pub priority: Option<u32>,
    /// Optional comment or metadata for the record.
    pub comment: Option<String>,
}

impl From<DnsRecordResponse> for DnsRecord {
    fn from(value: DnsRecordResponse) -> Self {
        DnsRecord {
            record_id: DnsRecordId {
                id: value.record_id,
            },
            name: value.name,
            ttl: value.ttl,
            data: value.data,
            record_type: value.record_type,
            priority: value.priority,
            comment: value.comment,
        }
    }
}

#[derive(Debug, serde::Deserialize)]
pub(crate) struct DnsRecordResponse {
    /// Unique identifier for the DNS record.
    pub record_id: u32,
    /// The DNS record name (subdomain), e.g. "hello" in "hello.example.com".
    pub name: String,
    /// Time to live (TTL) in seconds for the DNS record.
    pub ttl: u32,
    /// Data field for the DNS record (e.g., IP address for "A" record, target domain for "CNAME", etc.).
    pub data: String,
    /// Type of DNS record ("A", "CNAME", "MX", etc.).
    #[serde(rename = "type")]
    pub record_type: String,
    /// Priority value for records that require it (e.g., MX, SRV); optional.
    pub priority: Option<u32>,
    /// Optional comment or metadata for the record.
    pub comment: Option<String>,
}

/// Response for listing DNS records from the API.
#[derive(Debug, Deserialize)]
pub(crate) struct ListDnsRecordsResponse {
    /// The list of DNS records returned for a domain.
    pub records: Vec<DnsRecordResponse>,
}

/// Request payload for creating a DNS record via the API.
#[derive(Debug, Serialize)]
pub struct CreateDnsRecordRequest {
    /// Type of DNS record to create ("A", "CNAME", "MX", etc.).
    #[serde(rename = "type")]
    pub record_type: String,
    /// The DNS record name (subdomain), e.g. "hello" in "hello.example.com".
    pub name: String,
    /// Data (e.g., IP address or target value).
    pub data: String,
    /// Priority value for records that require it.
    pub priority: Option<u32>,
    /// Time to live (TTL) for the record, in seconds.
    pub ttl: Option<u32>,
    /// Optional comment or metadata for the record.
    pub comment: Option<String>,
}

/// Response for creating a DNS record via the API.
#[derive(Debug, Deserialize)]
pub(crate) struct CreateDnsRecordResponse {
    /// List of created record IDs (if any).
    pub record: Option<Vec<DnsRecordId>>, // Record id(s) created
}

/// Structure representing the ID of a newly created DNS record.
#[derive(Debug, Deserialize)]
pub struct DnsRecordId {
    /// ID of the added DNS record.
    pub(crate) id: u32,
}

/// Request payload for updating an existing DNS record via the API.
#[derive(Debug, Serialize)]
pub struct UpdateDnsRecordRequest {
    /// Type of DNS record to update ("A", "CNAME", "MX", etc.).
    #[serde(rename = "type")]
    pub record_type: String,
    /// The DNS record name (subdomain), e.g. "hello" in "hello.example.com".
    pub name: String,
    /// New data for the record (IP, target, etc.).
    pub data: String,
    /// Priority value for records that require it.
    pub priority: Option<u32>,
    /// Time to live (TTL) for the record, in seconds.
    pub ttl: Option<u32>,
    /// Optional comment or metadata for the record.
    pub comment: Option<String>,
}

/// Response for deleting a DNS record via the API.
#[derive(Debug, Deserialize)]
pub(crate) struct GeneralResponse {
    /// Message from the API, e.g. "success" or error details.
    pub message: Option<String>,
}