nominal-api 0.1240.0

API bindings for the Nominal 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

use conjure_http::endpoint;
/// This internal-only service manages long lived api keys.e
#[conjure_http::conjure_client(name = "InternalApiKeyService")]
pub trait InternalApiKeyService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Get a Nominal-issued access token from a long-lived API key. Callers should verify that
    /// their api key is formatted properly (i.e. prefixed with "nominal_api_key") before calling this endpoint.
    #[endpoint(
        method = POST,
        path = "/api-key-internal/v1/access-token",
        name = "getAccessTokenFromApiKeyValue",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_access_token_from_api_key_value(
        &self,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::objects::authorization::GetAccessTokenFromApiKeyRequest,
    ) -> Result<
        super::super::super::objects::authorization::GetAccessTokenResponse,
        conjure_http::private::Error,
    >;
}
/// This internal-only service manages long lived api keys.e
#[conjure_http::conjure_client(name = "InternalApiKeyService")]
pub trait AsyncInternalApiKeyService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Get a Nominal-issued access token from a long-lived API key. Callers should verify that
    /// their api key is formatted properly (i.e. prefixed with "nominal_api_key") before calling this endpoint.
    #[endpoint(
        method = POST,
        path = "/api-key-internal/v1/access-token",
        name = "getAccessTokenFromApiKeyValue",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_access_token_from_api_key_value(
        &self,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::objects::authorization::GetAccessTokenFromApiKeyRequest,
    ) -> Result<
        super::super::super::objects::authorization::GetAccessTokenResponse,
        conjure_http::private::Error,
    >;
}
/// This internal-only service manages long lived api keys.e
#[conjure_http::conjure_client(name = "InternalApiKeyService", local)]
pub trait LocalAsyncInternalApiKeyService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Get a Nominal-issued access token from a long-lived API key. Callers should verify that
    /// their api key is formatted properly (i.e. prefixed with "nominal_api_key") before calling this endpoint.
    #[endpoint(
        method = POST,
        path = "/api-key-internal/v1/access-token",
        name = "getAccessTokenFromApiKeyValue",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_access_token_from_api_key_value(
        &self,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::objects::authorization::GetAccessTokenFromApiKeyRequest,
    ) -> Result<
        super::super::super::objects::authorization::GetAccessTokenResponse,
        conjure_http::private::Error,
    >;
}