afinsp-rs 0.1.1

AFINSP Billing SDK for Rust
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

// this file is @generated
#[allow(unused_imports)]
use crate::{error::Result, models::*, Configuration};

#[derive(Default)]
pub struct CustomPropertiesListDefinitionsOptions {
    /// Filter to a single entity type.
    pub entity_type: Option<CustomPropertyEntityType>,

    /// Include archived (soft-deleted) definitions. Defaults to false.
    pub include_archived: Option<bool>,

    /// Page number (0-indexed)
    pub page: Option<i32>,

    /// Number of items per page
    pub per_page: Option<i32>,
}

pub struct CustomProperties<'a> {
    cfg: &'a Configuration,
}

impl<'a> CustomProperties<'a> {
    pub(super) fn new(cfg: &'a Configuration) -> Self {
        Self { cfg }
    }

    pub async fn list_definitions(
        &self,
        options: Option<CustomPropertiesListDefinitionsOptions>,
    ) -> Result<crate::models::CustomPropertyDefinitionListResponse> {
        let CustomPropertiesListDefinitionsOptions {
            entity_type,
            include_archived,
            page,
            per_page,
        } = options.unwrap_or_default();

        crate::request::Request::new(http1::Method::GET, "/api/v1/custom-property-definitions")
            .with_optional_query_param("entity_type", entity_type)
            .with_optional_query_param("include_archived", include_archived)
            .with_optional_query_param("page", page)
            .with_optional_query_param("per_page", per_page)
            .execute(self.cfg)
            .await
    }

    pub async fn create_definition(
        &self,
        custom_property_definition_create_request: crate::models::CustomPropertyDefinitionCreateRequest,
    ) -> Result<crate::models::CustomPropertyDefinition> {
        crate::request::Request::new(http1::Method::POST, "/api/v1/custom-property-definitions")
            .with_body_param(custom_property_definition_create_request)
            .execute(self.cfg)
            .await
    }

    pub async fn get_definition(
        &self,
        id: String,
    ) -> Result<crate::models::CustomPropertyDefinition> {
        crate::request::Request::new(
            http1::Method::GET,
            "/api/v1/custom-property-definitions/{id}",
        )
        .with_path_param("id", id)
        .execute(self.cfg)
        .await
    }

    pub async fn update_definition(
        &self,
        id: String,
        custom_property_definition_update_request: crate::models::CustomPropertyDefinitionUpdateRequest,
    ) -> Result<crate::models::CustomPropertyDefinition> {
        crate::request::Request::new(
            http1::Method::PUT,
            "/api/v1/custom-property-definitions/{id}",
        )
        .with_path_param("id", id)
        .with_body_param(custom_property_definition_update_request)
        .execute(self.cfg)
        .await
    }

    /// Soft-deletes the definition. Existing property values on entities are preserved; the definition
    /// simply stops being enforced on new writes.
    pub async fn archive_definition(
        &self,
        id: String,
    ) -> Result<crate::models::CustomPropertyDefinition> {
        crate::request::Request::new(
            http1::Method::DELETE,
            "/api/v1/custom-property-definitions/{id}",
        )
        .with_path_param("id", id)
        .execute(self.cfg)
        .await
    }
}