gestalt-sdk 0.0.1-alpha.19

Rust SDK scaffolding and generated protocol bindings for Gestalt executable providers
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
// Code generated by sdkgen. DO NOT EDIT.

//! Generated native types and clients for external_credential.proto.

use crate::codec::external_credential::{
    from_wire_exchange_external_credential_response, from_wire_external_credential,
    from_wire_list_external_credentials_response, from_wire_resolve_external_credential_response,
    to_wire_delete_external_credential_request, to_wire_exchange_external_credential_request,
    to_wire_get_external_credential_request, to_wire_list_external_credentials_request,
    to_wire_resolve_external_credential_request, to_wire_upsert_external_credential_request,
    to_wire_validate_external_credential_config_request,
};
use crate::codec::host_service::{HostServiceChannel, connect_host_service, plain_channel};
use crate::generated::v1;
use crate::rpc_support::GestaltError;

/// Native message type for `gestalt.provider.v1.DeleteExternalCredentialRequest`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct DeleteExternalCredentialRequest {
    /// The `id` field.
    pub id: String,
}

/// Native message type for `gestalt.provider.v1.ExchangeExternalCredentialRequest`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ExchangeExternalCredentialRequest {
    /// The `provider` field.
    pub provider: String,
    /// The `connection` field.
    pub connection: String,
    /// The `connection_id` field.
    pub connection_id: String,
    /// The `credential_subject_id` field.
    pub credential_subject_id: String,
    /// The `actor_subject_id` field.
    pub actor_subject_id: String,
    /// The `instance` field.
    pub instance: String,
    /// The `auth` field; None when unset.
    pub auth: Option<ExternalCredentialAuthConfig>,
    /// The `credential_json` field.
    pub credential_json: String,
    /// The `connection_params` field.
    pub connection_params: std::collections::BTreeMap<String, String>,
}

/// Native message type for `gestalt.provider.v1.ExchangeExternalCredentialResponse`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ExchangeExternalCredentialResponse {
    /// The `token_response` field; None when unset.
    pub token_response: Option<ExternalCredentialTokenResponse>,
}

/// Native message type for `gestalt.provider.v1.ExternalCredential`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ExternalCredential {
    /// The `id` field.
    pub id: String,
    /// The `subject_id` field.
    pub subject_id: String,
    /// The `instance` field.
    pub instance: String,
    /// The `access_token` field.
    pub access_token: String,
    /// The `refresh_token` field.
    pub refresh_token: String,
    /// The `scopes` field.
    pub scopes: String,
    /// The `expires_at` field; None when unset.
    pub expires_at: Option<std::time::SystemTime>,
    /// The `last_refreshed_at` field; None when unset.
    pub last_refreshed_at: Option<std::time::SystemTime>,
    /// The `refresh_error_count` field.
    pub refresh_error_count: i32,
    /// The `metadata_json` field.
    pub metadata_json: String,
    /// The `created_at` field; None when unset.
    pub created_at: Option<std::time::SystemTime>,
    /// The `updated_at` field; None when unset.
    pub updated_at: Option<std::time::SystemTime>,
    /// The `connection_id` field.
    pub connection_id: String,
}

/// Native message type for `gestalt.provider.v1.ExternalCredentialAuthConfig`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ExternalCredentialAuthConfig {
    /// The `type` field.
    pub r#type: String,
    /// The `token` field.
    pub token: String,
    /// The `token_prefix` field.
    pub token_prefix: String,
    /// The `grant_type` field.
    pub grant_type: String,
    /// The `token_url` field.
    pub token_url: String,
    /// The `client_id` field.
    pub client_id: String,
    /// The `client_secret` field.
    pub client_secret: String,
    /// The `client_auth` field.
    pub client_auth: String,
    /// The `token_exchange` field.
    pub token_exchange: String,
    /// The `scopes` field.
    pub scopes: Vec<String>,
    /// The `scope_param` field.
    pub scope_param: String,
    /// The `scope_separator` field.
    pub scope_separator: String,
    /// The `token_params` field.
    pub token_params: std::collections::BTreeMap<String, String>,
    /// The `refresh_params` field.
    pub refresh_params: std::collections::BTreeMap<String, String>,
    /// The `accept_header` field.
    pub accept_header: String,
    /// The `access_token_path` field.
    pub access_token_path: String,
    /// The `token_exchange_drivers` field.
    pub token_exchange_drivers: Vec<ExternalCredentialTokenExchangeDriver>,
    /// The `refresh_token` field.
    pub refresh_token: String,
}

/// Native message type for `gestalt.provider.v1.ExternalCredentialLookup`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ExternalCredentialLookup {
    /// The `subject_id` field.
    pub subject_id: String,
    /// The `instance` field.
    pub instance: String,
    /// The `connection_id` field.
    pub connection_id: String,
}

/// Native message type for `gestalt.provider.v1.ExternalCredentialTokenExchangeDriver`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ExternalCredentialTokenExchangeDriver {
    /// The `type` field.
    pub r#type: String,
    /// The `target_principal` field.
    pub target_principal: String,
    /// The `scopes` field.
    pub scopes: Vec<String>,
    /// The `lifetime_seconds` field.
    pub lifetime_seconds: i32,
    /// The `endpoint` field.
    pub endpoint: String,
    /// The `params` field.
    pub params: std::collections::BTreeMap<String, String>,
}

/// Native message type for `gestalt.provider.v1.ExternalCredentialTokenResponse`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ExternalCredentialTokenResponse {
    /// The `access_token` field.
    pub access_token: String,
    /// The `refresh_token` field.
    pub refresh_token: String,
    /// The `expires_in` field.
    pub expires_in: i32,
    /// The `token_type` field.
    pub token_type: String,
    /// The `extra_json` field.
    pub extra_json: String,
    /// The `refresh_source` field.
    pub refresh_source: String,
}

/// Native message type for `gestalt.provider.v1.GetExternalCredentialRequest`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct GetExternalCredentialRequest {
    /// The `lookup` field; None when unset.
    pub lookup: Option<ExternalCredentialLookup>,
}

/// Native message type for `gestalt.provider.v1.ListExternalCredentialsRequest`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ListExternalCredentialsRequest {
    /// The `subject_id` field.
    pub subject_id: String,
    /// The `instance` field.
    pub instance: String,
    /// The `connection_id` field.
    pub connection_id: String,
}

/// Native message type for `gestalt.provider.v1.ListExternalCredentialsResponse`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ListExternalCredentialsResponse {
    /// The `credentials` field.
    pub credentials: Vec<ExternalCredential>,
}

/// Native message type for `gestalt.provider.v1.ResolveExternalCredentialRequest`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ResolveExternalCredentialRequest {
    /// The `provider` field.
    pub provider: String,
    /// The `connection` field.
    pub connection: String,
    /// The `connection_id` field.
    pub connection_id: String,
    /// The `mode` field.
    pub mode: String,
    /// The `credential_subject_id` field.
    pub credential_subject_id: String,
    /// The `actor_subject_id` field.
    pub actor_subject_id: String,
    /// The `instance` field.
    pub instance: String,
    /// The `auth` field; None when unset.
    pub auth: Option<ExternalCredentialAuthConfig>,
    /// The `connection_params` field.
    pub connection_params: std::collections::BTreeMap<String, String>,
}

/// Native message type for `gestalt.provider.v1.ResolveExternalCredentialResponse`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ResolveExternalCredentialResponse {
    /// The `token` field.
    pub token: String,
    /// The `expires_at` field; None when unset.
    pub expires_at: Option<std::time::SystemTime>,
    /// The `metadata_json` field.
    pub metadata_json: String,
    /// The `params` field.
    pub params: std::collections::BTreeMap<String, String>,
    /// The `credential` field; None when unset.
    pub credential: Option<ExternalCredential>,
}

/// Native message type for `gestalt.provider.v1.UpsertExternalCredentialRequest`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct UpsertExternalCredentialRequest {
    /// The `credential` field; None when unset.
    pub credential: Option<ExternalCredential>,
    /// The `preserve_timestamps` field.
    pub preserve_timestamps: bool,
}

/// Native message type for `gestalt.provider.v1.ValidateExternalCredentialConfigRequest`.
#[derive(Clone, Debug, Default, PartialEq)]
pub struct ValidateExternalCredentialConfigRequest {
    /// The `provider` field.
    pub provider: String,
    /// The `connection` field.
    pub connection: String,
    /// The `connection_id` field.
    pub connection_id: String,
    /// The `mode` field.
    pub mode: String,
    /// The `auth` field; None when unset.
    pub auth: Option<ExternalCredentialAuthConfig>,
    /// The `connection_params` field.
    pub connection_params: std::collections::BTreeMap<String, String>,
}

/// Client for the `gestalt.provider.v1.ExternalCredentials` service.
pub struct ExternalCredentials {
    inner: v1::external_credentials_client::ExternalCredentialsClient<HostServiceChannel>,
    timeout: Option<std::time::Duration>,
}

impl ExternalCredentials {
    /// Creates a client over an established channel.
    pub fn new(channel: tonic::transport::Channel) -> Self {
        Self {
            inner: v1::external_credentials_client::ExternalCredentialsClient::new(plain_channel(
                channel,
            )),
            timeout: None,
        }
    }

    /// Sets a deadline applied to every unary call; calls that run past it
    /// fail with DEADLINE_EXCEEDED. Streaming calls are unaffected.
    pub fn with_timeout(mut self, timeout: std::time::Duration) -> Self {
        self.timeout = Some(timeout);
        self
    }

    /// Connects to the `external_credentials` host service described by the environment.
    pub async fn connect() -> Result<Self, GestaltError> {
        Self::connect_named("").await
    }

    /// Connects to the named `external_credentials` host-service binding.
    pub async fn connect_named(name: &str) -> Result<Self, GestaltError> {
        Ok(Self {
            inner: v1::external_credentials_client::ExternalCredentialsClient::new(
                connect_host_service("external_credentials", name).await?,
            ),
            timeout: None,
        })
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.UpsertCredential`.
    pub async fn upsert_credential(
        &mut self,
        preserve_timestamps: bool,
        credential: Option<ExternalCredential>,
    ) -> Result<ExternalCredential, GestaltError> {
        let request = UpsertExternalCredentialRequest {
            preserve_timestamps,
            credential,
        };
        let mut tonic_request =
            tonic::Request::new(to_wire_upsert_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.upsert_credential(tonic_request).await?;
        Ok(from_wire_external_credential(response.into_inner()))
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.UpsertCredential` with the full request and response messages.
    pub async fn upsert_credential_raw(
        &mut self,
        request: UpsertExternalCredentialRequest,
    ) -> Result<ExternalCredential, GestaltError> {
        let mut tonic_request =
            tonic::Request::new(to_wire_upsert_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.upsert_credential(tonic_request).await?;
        Ok(from_wire_external_credential(response.into_inner()))
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.GetCredential`.
    pub async fn get_credential(
        &mut self,
        lookup: Option<ExternalCredentialLookup>,
    ) -> Result<ExternalCredential, GestaltError> {
        let request = GetExternalCredentialRequest { lookup };
        let mut tonic_request =
            tonic::Request::new(to_wire_get_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.get_credential(tonic_request).await?;
        Ok(from_wire_external_credential(response.into_inner()))
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.GetCredential` with the full request and response messages.
    pub async fn get_credential_raw(
        &mut self,
        request: GetExternalCredentialRequest,
    ) -> Result<ExternalCredential, GestaltError> {
        let mut tonic_request =
            tonic::Request::new(to_wire_get_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.get_credential(tonic_request).await?;
        Ok(from_wire_external_credential(response.into_inner()))
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ListCredentials`.
    pub async fn list_credentials(
        &mut self,
        subject_id: String,
        instance: String,
        connection_id: String,
    ) -> Result<Vec<ExternalCredential>, GestaltError> {
        let request = ListExternalCredentialsRequest {
            subject_id,
            instance,
            connection_id,
        };
        let mut tonic_request =
            tonic::Request::new(to_wire_list_external_credentials_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = from_wire_list_external_credentials_response(
            self.inner
                .list_credentials(tonic_request)
                .await?
                .into_inner(),
        );
        Ok(response.credentials)
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ListCredentials` with the full request and response messages.
    pub async fn list_credentials_raw(
        &mut self,
        request: ListExternalCredentialsRequest,
    ) -> Result<ListExternalCredentialsResponse, GestaltError> {
        let mut tonic_request =
            tonic::Request::new(to_wire_list_external_credentials_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.list_credentials(tonic_request).await?;
        Ok(from_wire_list_external_credentials_response(
            response.into_inner(),
        ))
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.DeleteCredential`.
    pub async fn delete_credential(&mut self, id: String) -> Result<(), GestaltError> {
        let request = DeleteExternalCredentialRequest { id };
        let mut tonic_request =
            tonic::Request::new(to_wire_delete_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        self.inner.delete_credential(tonic_request).await?;
        Ok(())
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.DeleteCredential` with the full request and response messages.
    pub async fn delete_credential_raw(
        &mut self,
        request: DeleteExternalCredentialRequest,
    ) -> Result<(), GestaltError> {
        let mut tonic_request =
            tonic::Request::new(to_wire_delete_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        self.inner.delete_credential(tonic_request).await?;
        Ok(())
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ValidateCredentialConfig`.
    pub async fn validate_credential_config(
        &mut self,
        provider: String,
        connection: String,
        connection_id: String,
        mode: String,
        auth: Option<ExternalCredentialAuthConfig>,
    ) -> Result<(), GestaltError> {
        let request = ValidateExternalCredentialConfigRequest {
            provider,
            connection,
            connection_id,
            mode,
            auth,
            ..Default::default()
        };
        let mut tonic_request =
            tonic::Request::new(to_wire_validate_external_credential_config_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        self.inner.validate_credential_config(tonic_request).await?;
        Ok(())
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ValidateCredentialConfig` with the full request and response messages.
    pub async fn validate_credential_config_raw(
        &mut self,
        request: ValidateExternalCredentialConfigRequest,
    ) -> Result<(), GestaltError> {
        let mut tonic_request =
            tonic::Request::new(to_wire_validate_external_credential_config_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        self.inner.validate_credential_config(tonic_request).await?;
        Ok(())
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ResolveCredential`.
    #[allow(clippy::too_many_arguments)]
    pub async fn resolve_credential(
        &mut self,
        provider: String,
        connection: String,
        connection_id: String,
        mode: String,
        credential_subject_id: String,
        actor_subject_id: String,
        instance: String,
        auth: Option<ExternalCredentialAuthConfig>,
    ) -> Result<ResolveExternalCredentialResponse, GestaltError> {
        let request = ResolveExternalCredentialRequest {
            provider,
            connection,
            connection_id,
            mode,
            credential_subject_id,
            actor_subject_id,
            instance,
            auth,
            ..Default::default()
        };
        let mut tonic_request =
            tonic::Request::new(to_wire_resolve_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.resolve_credential(tonic_request).await?;
        Ok(from_wire_resolve_external_credential_response(
            response.into_inner(),
        ))
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ResolveCredential` with the full request and response messages.
    pub async fn resolve_credential_raw(
        &mut self,
        request: ResolveExternalCredentialRequest,
    ) -> Result<ResolveExternalCredentialResponse, GestaltError> {
        let mut tonic_request =
            tonic::Request::new(to_wire_resolve_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.resolve_credential(tonic_request).await?;
        Ok(from_wire_resolve_external_credential_response(
            response.into_inner(),
        ))
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ExchangeCredential`.
    #[allow(clippy::too_many_arguments)]
    pub async fn exchange_credential(
        &mut self,
        provider: String,
        connection: String,
        connection_id: String,
        credential_subject_id: String,
        actor_subject_id: String,
        instance: String,
        credential_json: String,
        auth: Option<ExternalCredentialAuthConfig>,
    ) -> Result<Option<ExternalCredentialTokenResponse>, GestaltError> {
        let request = ExchangeExternalCredentialRequest {
            provider,
            connection,
            connection_id,
            credential_subject_id,
            actor_subject_id,
            instance,
            credential_json,
            auth,
            ..Default::default()
        };
        let mut tonic_request =
            tonic::Request::new(to_wire_exchange_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = from_wire_exchange_external_credential_response(
            self.inner
                .exchange_credential(tonic_request)
                .await?
                .into_inner(),
        );
        Ok(response.token_response)
    }

    /// Calls `gestalt.provider.v1.ExternalCredentials.ExchangeCredential` with the full request and response messages.
    pub async fn exchange_credential_raw(
        &mut self,
        request: ExchangeExternalCredentialRequest,
    ) -> Result<ExchangeExternalCredentialResponse, GestaltError> {
        let mut tonic_request =
            tonic::Request::new(to_wire_exchange_external_credential_request(request));
        if let Some(timeout) = self.timeout {
            tonic_request.set_timeout(timeout);
        }
        let response = self.inner.exchange_credential(tonic_request).await?;
        Ok(from_wire_exchange_external_credential_response(
            response.into_inner(),
        ))
    }
}