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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use strum_macros::EnumString;
use uuid::Uuid;

/// Represents a customer in the Lago billing system.
///
/// This struct contains all the information about a customer, including
/// their identification, contact details, billing configuration, and
/// associated metadata.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Customer {
    pub lago_id: Option<Uuid>,
    pub sequential_id: Option<i32>,
    pub slug: Option<String>,
    pub external_id: Option<String>,
    pub applicable_timezone: String,
    pub created_at: DateTime<Utc>,
    pub billing_entity_code: String,
    pub address_line1: Option<String>,
    pub address_line2: Option<String>,
    pub city: Option<String>,
    pub country: Option<String>,
    pub currency: Option<String>,
    pub email: Option<String>,
    pub legal_name: Option<String>,
    pub legal_number: Option<String>,
    pub logo_url: Option<String>,
    pub name: Option<String>,
    pub firstname: Option<String>,
    pub lastname: Option<String>,
    pub account_type: CustomerAccountType,
    pub customer_type: Option<CustomerType>,
    pub phone: Option<String>,
    pub state: Option<String>,
    pub tax_identification_number: Option<String>,
    pub timezone: Option<String>,
    pub url: Option<String>,
    pub zipcode: Option<String>,
    pub net_payment_term: Option<i32>,
    pub updated_at: DateTime<Utc>,
    pub finalize_zero_amount_invoice: CustomerFinalizeZeroAmountInvoice,
    pub skip_invoice_custom_sections: bool,
    pub billing_configuration: CustomerBillingConfiguration,
    pub shipping_address: CustomerShippingAddress,
    pub metadata: Vec<CustomerMetadata>,
    pub integration_customers: Vec<CustomerIntegration>,
}

/// Defines the type of customer account.
#[derive(Debug, Clone, Serialize, Deserialize, EnumString)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum CustomerAccountType {
    Customer,
    Partner,
}

/// Defines the type of customer entity.
#[derive(Debug, Clone, Serialize, Deserialize, EnumString)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum CustomerType {
    Company,
    Individual,
}

/// Configuration for handling zero-amount invoices.
#[derive(Debug, Clone, Serialize, Deserialize, EnumString)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum CustomerFinalizeZeroAmountInvoice {
    Inherit,
    Finalize,
    Skip,
}

/// Billing configuration settings for a customer.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomerBillingConfiguration {
    pub invoice_grace_period: Option<i32>,
    pub payment_provider: Option<CustomerPaymentProvider>,
    pub payment_provider_code: Option<String>,
    pub provider_customer_id: Option<String>,
    pub sync: Option<bool>,
    pub sync_with_provider: Option<bool>,
    pub document_locale: Option<String>,
    pub provider_payment_methods: Option<Vec<String>>,
}

/// Supported payment providers.
#[derive(Debug, Clone, Serialize, Deserialize, EnumString)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum CustomerPaymentProvider {
    Stripe,
    Adyen,
    Gocardless,
}

/// Shipping address information for a customer.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomerShippingAddress {
    pub address_line1: Option<String>,
    pub address_line2: Option<String>,
    pub city: Option<String>,
    pub country: Option<String>,
    pub state: Option<String>,
    pub zipcode: Option<String>,
}

/// Custom metadata associated with a customer.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomerMetadata {
    pub lago_id: Uuid,
    pub key: String,
    pub value: String,
    pub display_in_invoice: bool,
    pub created_at: DateTime<Utc>,
}

/// Integration configuration for connecting with third-party systems.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomerIntegration {
    pub lago_id: Uuid,
    #[serde(alias = "type")]
    pub integration_type: CustomerIntegrationType,
    pub integration_code: Option<String>,
    pub external_customer_id: Option<String>,
    pub sync_with_provider: bool,
    pub subsidiary_id: Option<String>,
}

/// Supported integration types.
#[derive(Debug, Clone, Serialize, Deserialize, EnumString)]
#[serde(rename_all = "snake_case")]
#[strum(serialize_all = "snake_case")]
pub enum CustomerIntegrationType {
    Netsuite,
    Anrok,
}