scm-sdk 0.2.2

Native async Strata Cloud Manager SDK, beginning with Prisma AIRS
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

use super::{PaginationOptions, models::*, next_offset, optional_items, tenant};
use crate::{
    Client, RawRequest, RequestOptions, Result,
    engine::AuthKind,
    pagination::{CollectOptions, CollectionResult, Page, Pages},
};
use http::Method;
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct ApiKeyListAllOptions {
    pub limit: u32,
    pub collect: CollectOptions,
}
impl Default for ApiKeyListAllOptions {
    fn default() -> Self {
        Self {
            limit: 100,
            collect: CollectOptions::default(),
        }
    }
}
#[derive(Clone, Debug)]
pub struct ApiKeysClient {
    pub(super) client: Client,
}
impl ApiKeysClient {
    pub fn new(client: Client) -> Result<Self> {
        client.require_auth(AuthKind::OAuth)?;
        Ok(Self { client })
    }
    pub async fn list_for_token(
        &self,
        page: PaginationOptions,
        options: Option<&RequestOptions>,
    ) -> Result<ApiKeyListResponse> {
        self.client
            .send_contract(
                RawRequest::read("/v1/mgmt/apikeys")
                    .named("airs.management.api_keys.list_for_token")
                    .query(page.query(false)?),
                "ApiKeyListResponseSchema",
                options,
            )
            .await
    }
    pub async fn create(
        &self,
        body: &ApiKeyCreateRequest,
        options: Option<&RequestOptions>,
    ) -> Result<ApiKey> {
        self.client
            .send_model(
                RawRequest::new(Method::POST, "/v1/mgmt/apikey")
                    .named("airs.management.api_keys.create"),
                body,
                "ApiKeyCreateRequestSchema",
                "ApiKeySchema",
                options,
            )
            .await
    }
    pub async fn list(
        &self,
        page: PaginationOptions,
        options: Option<&RequestOptions>,
    ) -> Result<ApiKeyListResponse> {
        self.client
            .send_contract(
                RawRequest::read("/v1/mgmt/apikeys/tsg")
                    .segment(tenant(&self.client)?)?
                    .named("airs.management.api_keys.list")
                    .query(page.query(false)?),
                "ApiKeyListResponseSchema",
                options,
            )
            .await
    }
    pub fn pages(
        &self,
        page: PaginationOptions,
        max_pages: usize,
        options: Option<&RequestOptions>,
    ) -> Result<Pages<'static, ApiKey, u64>> {
        page.query(false)?;
        let client = self.clone();
        Pages::new(
            page.offset,
            self.client.operation_options(options)?,
            self.client.session(),
            max_pages,
            move |offset, options| {
                let client = client.clone();
                async move {
                    let response = client
                        .list(PaginationOptions { offset, ..page }, Some(&options))
                        .await?;
                    Ok(Page {
                        items: optional_items(response.api_keys),
                        next: next_offset(response.next_offset)?,
                    })
                }
            },
        )
    }
    pub async fn list_all(
        &self,
        all: ApiKeyListAllOptions,
        options: Option<&RequestOptions>,
    ) -> CollectionResult<ApiKey, u64> {
        self.pages(
            PaginationOptions {
                limit: all.limit,
                ..PaginationOptions::default()
            },
            all.collect.max_pages,
            options,
        )?
        .collect(all.collect)
        .await
    }
    pub async fn delete(
        &self,
        name: &str,
        updated_by: &str,
        options: Option<&RequestOptions>,
    ) -> Result<ApiKeyDeleteResponse> {
        self.client
            .send_contract(
                RawRequest::new(Method::DELETE, "/v1/mgmt/apikey/delete")
                    .segment(name)?
                    .named("airs.management.api_keys.delete")
                    .query([("updated_by".into(), updated_by.into())]),
                "ApiKeyDeleteResponseSchema",
                options,
            )
            .await
    }
    pub async fn regenerate(
        &self,
        id: &str,
        body: &ApiKeyRegenerateRequest,
        options: Option<&RequestOptions>,
    ) -> Result<ApiKey> {
        self.client
            .send_model(
                RawRequest::new(Method::POST, "/v1/mgmt/apikey/regenerate")
                    .segment(id)?
                    .named("airs.management.api_keys.regenerate"),
                body,
                "ApiKeyRegenerateRequestSchema",
                "ApiKeySchema",
                options,
            )
            .await
    }
}