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

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

#[derive(Default)]
pub struct SubscriptionsListSubscriptionsOptions {
    /// Filter by customer ID or alias
    pub customer_id: Option<String>,

    pub plan_id: Option<PlanId>,

    pub statuses: Option<Vec<SubscriptionStatusEnum>>,

    /// Sort order. Format: `column.direction`. Allowed columns: `customer_name`, `plan_name`, `mrr_cents`, `billing_start_date`, `end_date`, `status`, `created_at`. Direction: `asc` or `desc`. Default: `created_at.desc`.
    pub order_by: Option<String>,

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

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

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

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

    /// List subscriptions with optional filtering by customer or plan.
    pub async fn list_subscriptions(
        &self,
        options: Option<SubscriptionsListSubscriptionsOptions>,
    ) -> Result<crate::models::SubscriptionListResponse> {
        let SubscriptionsListSubscriptionsOptions {
            customer_id,
            plan_id,
            statuses,
            order_by,
            page,
            per_page,
        } = options.unwrap_or_default();

        crate::request::Request::new(http1::Method::GET, "/api/v1/subscriptions")
            .with_optional_query_param("customer_id", customer_id)
            .with_optional_query_param("plan_id", plan_id)
            .with_optional_exploded_query_param("statuses", statuses)
            .with_optional_query_param("order_by", order_by)
            .with_optional_query_param("page", page)
            .with_optional_query_param("per_page", per_page)
            .execute(self.cfg)
            .await
    }

    /// Create a new subscription for a customer with a specific plan.
    pub async fn create_subscription(
        &self,
        subscription_create_request: crate::models::SubscriptionCreateRequest,
    ) -> Result<crate::models::SubscriptionDetails> {
        crate::request::Request::new(http1::Method::POST, "/api/v1/subscriptions")
            .with_body_param(subscription_create_request)
            .execute(self.cfg)
            .await
    }

    /// Retrieve detailed information about a subscription including price components and schedules.
    pub async fn subscription_details(
        &self,
        subscription_id: String,
    ) -> Result<crate::models::SubscriptionDetails> {
        crate::request::Request::new(
            http1::Method::GET,
            "/api/v1/subscriptions/{subscription_id}",
        )
        .with_path_param("subscription_id", subscription_id)
        .execute(self.cfg)
        .await
    }

    /// Update subscription settings like payment configuration, billing options, etc.
    pub async fn update_subscription(
        &self,
        subscription_id: String,
        subscription_update_request: crate::models::SubscriptionUpdateRequest,
    ) -> Result<crate::models::SubscriptionUpdateResponse> {
        crate::request::Request::new(
            http1::Method::PATCH,
            "/api/v1/subscriptions/{subscription_id}",
        )
        .with_path_param("subscription_id", subscription_id)
        .with_body_param(subscription_update_request)
        .execute(self.cfg)
        .await
    }

    /// Cancel a subscription either immediately or at the end of the billing period.
    pub async fn cancel_subscription(
        &self,
        subscription_id: String,
        cancel_subscription_request: crate::models::CancelSubscriptionRequest,
    ) -> Result<crate::models::CancelSubscriptionResponse> {
        crate::request::Request::new(
            http1::Method::POST,
            "/api/v1/subscriptions/{subscription_id}/cancel",
        )
        .with_path_param("subscription_id", subscription_id)
        .with_body_param(cancel_subscription_request)
        .execute(self.cfg)
        .await
    }

    pub async fn list_subscription_entitlements(
        &self,
        subscription_id: String,
    ) -> Result<crate::models::EffectiveEntitlementListResponse> {
        crate::request::Request::new(
            http1::Method::GET,
            "/api/v1/subscriptions/{subscription_id}/entitlements",
        )
        .with_path_param("subscription_id", subscription_id)
        .execute(self.cfg)
        .await
    }
}