lago-types 0.1.25

Types definitions for Lago API
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

use serde::{Deserialize, Serialize};

use crate::models::{Event, PaginationMeta};

/// Response for listing events.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ListEventsResponse {
    /// The list of events.
    pub events: Vec<Event>,
    /// Pagination metadata.
    pub meta: PaginationMeta,
}

/// Response for retrieving a single event.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GetEventResponse {
    pub event: Event,
}

/// Response for creating an event.
///
/// Note: The create event endpoint returns a minimal response with just the
/// event wrapper, as events are processed asynchronously.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateEventResponse {
    pub event: EventCreated,
}

/// The created event acknowledgment.
///
/// When an event is created, Lago returns a minimal response containing
/// the transaction_id, external_customer_id, and code to confirm receipt.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EventCreated {
    /// The transaction ID of the created event
    pub transaction_id: String,
    /// The external customer ID (if provided)
    pub external_customer_id: Option<String>,
    /// The external subscription ID (if provided)
    pub external_subscription_id: Option<String>,
    /// The billable metric code
    pub code: String,
}