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
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

use conjure_http::endpoint;
#[conjure_http::conjure_client(name = "WebhookTemplateService")]
pub trait WebhookTemplateService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Validates a Handlebars webhook template and returns the evaluated payload.
    /// Checks for template syntax errors and validates that the result is valid JSON.
    #[endpoint(
        method = POST,
        path = "/scout/v1/webhook-templates/validate",
        name = "validateTemplate",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn validate_template(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::webhook::template::api::ValidateTemplateRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::webhook::template::api::ValidationResult,
        conjure_http::private::Error,
    >;
    /// Sends a test webhook using the specified integration and template.
    /// This allows users to verify their webhook configuration before using it in procedures.
    #[endpoint(
        method = POST,
        path = "/scout/v1/webhook-templates/test",
        name = "testWebhook",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn test_webhook(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookResponse,
        conjure_http::private::Error,
    >;
}
#[conjure_http::conjure_client(name = "WebhookTemplateService")]
pub trait AsyncWebhookTemplateService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Validates a Handlebars webhook template and returns the evaluated payload.
    /// Checks for template syntax errors and validates that the result is valid JSON.
    #[endpoint(
        method = POST,
        path = "/scout/v1/webhook-templates/validate",
        name = "validateTemplate",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn validate_template(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::webhook::template::api::ValidateTemplateRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::webhook::template::api::ValidationResult,
        conjure_http::private::Error,
    >;
    /// Sends a test webhook using the specified integration and template.
    /// This allows users to verify their webhook configuration before using it in procedures.
    #[endpoint(
        method = POST,
        path = "/scout/v1/webhook-templates/test",
        name = "testWebhook",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn test_webhook(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookResponse,
        conjure_http::private::Error,
    >;
}
#[conjure_http::conjure_client(name = "WebhookTemplateService", local)]
pub trait LocalAsyncWebhookTemplateService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Validates a Handlebars webhook template and returns the evaluated payload.
    /// Checks for template syntax errors and validates that the result is valid JSON.
    #[endpoint(
        method = POST,
        path = "/scout/v1/webhook-templates/validate",
        name = "validateTemplate",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn validate_template(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::webhook::template::api::ValidateTemplateRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::webhook::template::api::ValidationResult,
        conjure_http::private::Error,
    >;
    /// Sends a test webhook using the specified integration and template.
    /// This allows users to verify their webhook configuration before using it in procedures.
    #[endpoint(
        method = POST,
        path = "/scout/v1/webhook-templates/test",
        name = "testWebhook",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn test_webhook(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::webhook::template::api::TestWebhookResponse,
        conjure_http::private::Error,
    >;
}