Skip to main content

dfns_sdk_rust/keys/
types.rs

1// Code generated by rust-sdk-generator. DO NOT EDIT.
2
3#![allow(clippy::all)]
4
5/// List Keys
6#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
7pub struct ListKeysResponse {
8    #[serde(rename = "items")]
9    pub items: Vec<crate::types::Key>,
10    #[serde(
11        rename = "nextPageToken",
12        default,
13        skip_serializing_if = "Option::is_none"
14    )]
15    pub next_page_token: Option<String>,
16}
17
18/// Query parameters for the ListKeysQuery operation.
19#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
20pub struct ListKeysQuery {
21    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
22    pub limit: Option<i64>,
23    #[serde(
24        rename = "paginationToken",
25        default,
26        skip_serializing_if = "Option::is_none"
27    )]
28    pub pagination_token: Option<String>,
29    #[serde(rename = "owner", default, skip_serializing_if = "Option::is_none")]
30    pub owner: Option<String>,
31}
32
33/// Create Key
34#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
35pub struct CreateKeyRequest {
36    #[serde(rename = "scheme")]
37    pub scheme: crate::types::KeyScheme,
38    #[serde(rename = "curve")]
39    pub curve: crate::types::KeyCurve,
40    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
41    pub name: Option<String>,
42    #[serde(rename = "masterKey", default, skip_serializing_if = "Option::is_none")]
43    pub master_key: Option<bool>,
44    #[serde(
45        rename = "deriveFrom",
46        default,
47        skip_serializing_if = "Option::is_none"
48    )]
49    pub derive_from: Option<serde_json::Value>,
50    #[serde(rename = "storeId", default, skip_serializing_if = "Option::is_none")]
51    pub store_id: Option<String>,
52    #[serde(
53        rename = "delegateTo",
54        default,
55        skip_serializing_if = "Option::is_none"
56    )]
57    pub delegate_to: Option<String>,
58    #[serde(
59        rename = "delayDelegation",
60        default,
61        skip_serializing_if = "Option::is_none"
62    )]
63    pub delay_delegation: Option<bool>,
64}
65
66/// Create Key
67#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
68pub struct CreateKeyResponse {
69    #[serde(rename = "id")]
70    pub id: String,
71    #[serde(rename = "scheme")]
72    pub scheme: crate::types::KeyScheme,
73    #[serde(rename = "curve")]
74    pub curve: crate::types::KeyCurve,
75    #[serde(rename = "publicKey")]
76    pub public_key: String,
77    #[serde(rename = "masterKey", default, skip_serializing_if = "Option::is_none")]
78    pub master_key: Option<bool>,
79    #[serde(
80        rename = "derivedFrom",
81        default,
82        skip_serializing_if = "Option::is_none"
83    )]
84    pub derived_from: Option<serde_json::Value>,
85    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
86    pub name: Option<String>,
87    #[serde(rename = "status")]
88    pub status: String,
89    #[serde(rename = "custodial")]
90    pub custodial: bool,
91    #[serde(rename = "dateCreated")]
92    pub date_created: String,
93    #[serde(rename = "imported", default, skip_serializing_if = "Option::is_none")]
94    pub imported: Option<bool>,
95    #[serde(rename = "exported", default, skip_serializing_if = "Option::is_none")]
96    pub exported: Option<bool>,
97    #[serde(
98        rename = "dateExported",
99        default,
100        skip_serializing_if = "Option::is_none"
101    )]
102    pub date_exported: Option<String>,
103    #[serde(
104        rename = "dateDeleted",
105        default,
106        skip_serializing_if = "Option::is_none"
107    )]
108    pub date_deleted: Option<String>,
109}
110
111/// Delegate Key
112#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
113pub struct DelegateKeyRequest {
114    #[serde(rename = "delegateTo")]
115    pub delegate_to: String,
116}
117
118/// Delegate Key
119#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
120pub struct DelegateKeyResponse {
121    #[serde(rename = "keyId")]
122    pub key_id: String,
123    #[serde(rename = "status")]
124    pub status: String,
125}
126
127/// Get Key
128#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
129pub struct GetKeyResponse {
130    #[serde(rename = "id")]
131    pub id: String,
132    #[serde(rename = "scheme")]
133    pub scheme: crate::types::KeyScheme,
134    #[serde(rename = "curve")]
135    pub curve: crate::types::KeyCurve,
136    #[serde(rename = "publicKey")]
137    pub public_key: String,
138    #[serde(rename = "masterKey", default, skip_serializing_if = "Option::is_none")]
139    pub master_key: Option<bool>,
140    #[serde(
141        rename = "derivedFrom",
142        default,
143        skip_serializing_if = "Option::is_none"
144    )]
145    pub derived_from: Option<serde_json::Value>,
146    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
147    pub name: Option<String>,
148    #[serde(rename = "status")]
149    pub status: String,
150    #[serde(rename = "custodial")]
151    pub custodial: bool,
152    #[serde(rename = "dateCreated")]
153    pub date_created: String,
154    #[serde(rename = "imported", default, skip_serializing_if = "Option::is_none")]
155    pub imported: Option<bool>,
156    #[serde(rename = "exported", default, skip_serializing_if = "Option::is_none")]
157    pub exported: Option<bool>,
158    #[serde(
159        rename = "dateExported",
160        default,
161        skip_serializing_if = "Option::is_none"
162    )]
163    pub date_exported: Option<String>,
164    #[serde(
165        rename = "dateDeleted",
166        default,
167        skip_serializing_if = "Option::is_none"
168    )]
169    pub date_deleted: Option<String>,
170    #[serde(rename = "wallets")]
171    pub wallets: Vec<serde_json::Value>,
172    #[serde(rename = "store")]
173    pub store: serde_json::Value,
174}
175
176/// Update Key
177#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
178pub struct UpdateKeyRequest {
179    #[serde(rename = "name")]
180    pub name: serde_json::Value,
181}
182
183/// Update Key
184#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
185pub struct UpdateKeyResponse {
186    #[serde(rename = "id")]
187    pub id: String,
188    #[serde(rename = "scheme")]
189    pub scheme: crate::types::KeyScheme,
190    #[serde(rename = "curve")]
191    pub curve: crate::types::KeyCurve,
192    #[serde(rename = "publicKey")]
193    pub public_key: String,
194    #[serde(rename = "masterKey", default, skip_serializing_if = "Option::is_none")]
195    pub master_key: Option<bool>,
196    #[serde(
197        rename = "derivedFrom",
198        default,
199        skip_serializing_if = "Option::is_none"
200    )]
201    pub derived_from: Option<serde_json::Value>,
202    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
203    pub name: Option<String>,
204    #[serde(rename = "status")]
205    pub status: String,
206    #[serde(rename = "custodial")]
207    pub custodial: bool,
208    #[serde(rename = "dateCreated")]
209    pub date_created: String,
210    #[serde(rename = "imported", default, skip_serializing_if = "Option::is_none")]
211    pub imported: Option<bool>,
212    #[serde(rename = "exported", default, skip_serializing_if = "Option::is_none")]
213    pub exported: Option<bool>,
214    #[serde(
215        rename = "dateExported",
216        default,
217        skip_serializing_if = "Option::is_none"
218    )]
219    pub date_exported: Option<String>,
220    #[serde(
221        rename = "dateDeleted",
222        default,
223        skip_serializing_if = "Option::is_none"
224    )]
225    pub date_deleted: Option<String>,
226}
227
228/// Delete Key
229#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
230pub struct DeleteKeyResponse {
231    #[serde(rename = "id")]
232    pub id: String,
233    #[serde(rename = "scheme")]
234    pub scheme: crate::types::KeyScheme,
235    #[serde(rename = "curve")]
236    pub curve: crate::types::KeyCurve,
237    #[serde(rename = "publicKey")]
238    pub public_key: String,
239    #[serde(rename = "masterKey", default, skip_serializing_if = "Option::is_none")]
240    pub master_key: Option<bool>,
241    #[serde(
242        rename = "derivedFrom",
243        default,
244        skip_serializing_if = "Option::is_none"
245    )]
246    pub derived_from: Option<serde_json::Value>,
247    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
248    pub name: Option<String>,
249    #[serde(rename = "status")]
250    pub status: String,
251    #[serde(rename = "custodial")]
252    pub custodial: bool,
253    #[serde(rename = "dateCreated")]
254    pub date_created: String,
255    #[serde(rename = "imported", default, skip_serializing_if = "Option::is_none")]
256    pub imported: Option<bool>,
257    #[serde(rename = "exported", default, skip_serializing_if = "Option::is_none")]
258    pub exported: Option<bool>,
259    #[serde(
260        rename = "dateExported",
261        default,
262        skip_serializing_if = "Option::is_none"
263    )]
264    pub date_exported: Option<String>,
265    #[serde(
266        rename = "dateDeleted",
267        default,
268        skip_serializing_if = "Option::is_none"
269    )]
270    pub date_deleted: Option<String>,
271}
272
273/// Derive Key
274#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
275pub struct DeriveKeyRequest {
276    #[serde(rename = "domain")]
277    pub domain: String,
278    #[serde(rename = "seed")]
279    pub seed: String,
280}
281
282/// Derive Key
283#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
284pub struct DeriveKeyResponse {
285    #[serde(rename = "output")]
286    pub output: String,
287}
288
289/// Export Key
290#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
291pub struct ExportKeyRequest {
292    #[serde(rename = "encryptionKey")]
293    pub encryption_key: String,
294    #[serde(rename = "supportedSchemes")]
295    pub supported_schemes: Vec<serde_json::Value>,
296}
297
298/// Export Key
299#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
300pub struct ExportKeyResponse {
301    #[serde(rename = "publicKey")]
302    pub public_key: String,
303    #[serde(rename = "protocol")]
304    pub protocol: serde_json::Value,
305    #[serde(rename = "curve")]
306    pub curve: String,
307    #[serde(rename = "minSigners")]
308    pub min_signers: f64,
309    #[serde(rename = "encryptedKeyShares")]
310    pub encrypted_key_shares: Vec<serde_json::Value>,
311}
312
313/// List Signatures
314#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
315pub struct ListSignaturesResponse {
316    #[serde(rename = "items")]
317    pub items: Vec<crate::types::SignatureRequest>,
318    #[serde(
319        rename = "nextPageToken",
320        default,
321        skip_serializing_if = "Option::is_none"
322    )]
323    pub next_page_token: Option<String>,
324    #[serde(rename = "keyId")]
325    pub key_id: String,
326}
327
328/// Query parameters for the ListSignaturesQuery operation.
329#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
330pub struct ListSignaturesQuery {
331    #[serde(rename = "limit", default, skip_serializing_if = "Option::is_none")]
332    pub limit: Option<i64>,
333    #[serde(
334        rename = "paginationToken",
335        default,
336        skip_serializing_if = "Option::is_none"
337    )]
338    pub pagination_token: Option<String>,
339}
340
341/// Request body for the generateSignature operation.
342pub type GenerateSignatureRequest = serde_json::Value;
343
344/// Generate Signature
345#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
346pub struct GenerateSignatureResponse {
347    #[serde(rename = "id")]
348    pub id: String,
349    #[serde(rename = "keyId")]
350    pub key_id: String,
351    #[serde(rename = "requester")]
352    pub requester: crate::types::Requester,
353    #[serde(rename = "requestBody")]
354    pub request_body: serde_json::Value,
355    #[serde(rename = "status")]
356    pub status: String,
357    #[serde(rename = "reason", default, skip_serializing_if = "Option::is_none")]
358    pub reason: Option<String>,
359    #[serde(rename = "signature", default, skip_serializing_if = "Option::is_none")]
360    pub signature: Option<serde_json::Value>,
361    #[serde(
362        rename = "signatures",
363        default,
364        skip_serializing_if = "Option::is_none"
365    )]
366    pub signatures: Option<Vec<serde_json::Value>>,
367    #[serde(
368        rename = "signedData",
369        default,
370        skip_serializing_if = "Option::is_none"
371    )]
372    pub signed_data: Option<String>,
373    #[serde(rename = "network", default, skip_serializing_if = "Option::is_none")]
374    pub network: Option<crate::types::Network>,
375    #[serde(rename = "txHash", default, skip_serializing_if = "Option::is_none")]
376    pub tx_hash: Option<String>,
377    #[serde(rename = "fee", default, skip_serializing_if = "Option::is_none")]
378    pub fee: Option<String>,
379    #[serde(
380        rename = "approvalId",
381        default,
382        skip_serializing_if = "Option::is_none"
383    )]
384    pub approval_id: Option<String>,
385    #[serde(rename = "dateRequested")]
386    pub date_requested: String,
387    #[serde(
388        rename = "datePolicyResolved",
389        default,
390        skip_serializing_if = "Option::is_none"
391    )]
392    pub date_policy_resolved: Option<String>,
393    #[serde(
394        rename = "dateSigned",
395        default,
396        skip_serializing_if = "Option::is_none"
397    )]
398    pub date_signed: Option<String>,
399    #[serde(
400        rename = "dateConfirmed",
401        default,
402        skip_serializing_if = "Option::is_none"
403    )]
404    pub date_confirmed: Option<String>,
405    #[serde(
406        rename = "externalId",
407        default,
408        skip_serializing_if = "Option::is_none"
409    )]
410    pub external_id: Option<String>,
411    #[serde(rename = "details", default, skip_serializing_if = "Option::is_none")]
412    pub details: Option<
413        std::collections::HashMap<String, std::collections::HashMap<String, serde_json::Value>>,
414    >,
415}
416
417/// Get Signature
418#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
419pub struct GetSignatureResponse {
420    #[serde(rename = "id")]
421    pub id: String,
422    #[serde(rename = "keyId")]
423    pub key_id: String,
424    #[serde(rename = "requester")]
425    pub requester: crate::types::Requester,
426    #[serde(rename = "requestBody")]
427    pub request_body: serde_json::Value,
428    #[serde(rename = "status")]
429    pub status: String,
430    #[serde(rename = "reason", default, skip_serializing_if = "Option::is_none")]
431    pub reason: Option<String>,
432    #[serde(rename = "signature", default, skip_serializing_if = "Option::is_none")]
433    pub signature: Option<serde_json::Value>,
434    #[serde(
435        rename = "signatures",
436        default,
437        skip_serializing_if = "Option::is_none"
438    )]
439    pub signatures: Option<Vec<serde_json::Value>>,
440    #[serde(
441        rename = "signedData",
442        default,
443        skip_serializing_if = "Option::is_none"
444    )]
445    pub signed_data: Option<String>,
446    #[serde(rename = "network", default, skip_serializing_if = "Option::is_none")]
447    pub network: Option<crate::types::Network>,
448    #[serde(rename = "txHash", default, skip_serializing_if = "Option::is_none")]
449    pub tx_hash: Option<String>,
450    #[serde(rename = "fee", default, skip_serializing_if = "Option::is_none")]
451    pub fee: Option<String>,
452    #[serde(
453        rename = "approvalId",
454        default,
455        skip_serializing_if = "Option::is_none"
456    )]
457    pub approval_id: Option<String>,
458    #[serde(rename = "dateRequested")]
459    pub date_requested: String,
460    #[serde(
461        rename = "datePolicyResolved",
462        default,
463        skip_serializing_if = "Option::is_none"
464    )]
465    pub date_policy_resolved: Option<String>,
466    #[serde(
467        rename = "dateSigned",
468        default,
469        skip_serializing_if = "Option::is_none"
470    )]
471    pub date_signed: Option<String>,
472    #[serde(
473        rename = "dateConfirmed",
474        default,
475        skip_serializing_if = "Option::is_none"
476    )]
477    pub date_confirmed: Option<String>,
478    #[serde(
479        rename = "externalId",
480        default,
481        skip_serializing_if = "Option::is_none"
482    )]
483    pub external_id: Option<String>,
484    #[serde(rename = "details", default, skip_serializing_if = "Option::is_none")]
485    pub details: Option<
486        std::collections::HashMap<String, std::collections::HashMap<String, serde_json::Value>>,
487    >,
488}
489
490/// Import Key
491#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
492pub struct ImportKeyRequest {
493    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
494    pub name: Option<String>,
495    #[serde(rename = "curve")]
496    pub curve: String,
497    #[serde(rename = "protocol")]
498    pub protocol: serde_json::Value,
499    #[serde(rename = "minSigners")]
500    pub min_signers: i64,
501    #[serde(rename = "encryptedKeyShares")]
502    pub encrypted_key_shares: Vec<serde_json::Value>,
503    #[serde(rename = "masterKey", default, skip_serializing_if = "Option::is_none")]
504    pub master_key: Option<bool>,
505}
506
507/// Import Key
508#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
509pub struct ImportKeyResponse {
510    #[serde(rename = "id")]
511    pub id: String,
512    #[serde(rename = "scheme")]
513    pub scheme: crate::types::KeyScheme,
514    #[serde(rename = "curve")]
515    pub curve: crate::types::KeyCurve,
516    #[serde(rename = "publicKey")]
517    pub public_key: String,
518    #[serde(rename = "masterKey", default, skip_serializing_if = "Option::is_none")]
519    pub master_key: Option<bool>,
520    #[serde(
521        rename = "derivedFrom",
522        default,
523        skip_serializing_if = "Option::is_none"
524    )]
525    pub derived_from: Option<serde_json::Value>,
526    #[serde(rename = "name", default, skip_serializing_if = "Option::is_none")]
527    pub name: Option<String>,
528    #[serde(rename = "status")]
529    pub status: String,
530    #[serde(rename = "custodial")]
531    pub custodial: bool,
532    #[serde(rename = "dateCreated")]
533    pub date_created: String,
534    #[serde(rename = "imported", default, skip_serializing_if = "Option::is_none")]
535    pub imported: Option<bool>,
536    #[serde(rename = "exported", default, skip_serializing_if = "Option::is_none")]
537    pub exported: Option<bool>,
538    #[serde(
539        rename = "dateExported",
540        default,
541        skip_serializing_if = "Option::is_none"
542    )]
543    pub date_exported: Option<String>,
544    #[serde(
545        rename = "dateDeleted",
546        default,
547        skip_serializing_if = "Option::is_none"
548    )]
549    pub date_deleted: Option<String>,
550}