lightcone 0.5.2

Rust SDK for the Lightcone Protocol — unified native + WASM client
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

# Referrals

Beta access status and referral code management.

[← Overview](../../../README.md)

## Table of Contents

- [Types](#types)
- [Client Methods](#client-methods)
- [Examples](#examples)

## Types

### `ReferralStatus`

Current referral and beta access status for the authenticated user.

| Field | Type | Description |
|-------|------|-------------|
| `is_beta` | `bool` | Whether the user has beta access |
| `source` | `Option<String>` | How the user gained access (e.g., referral code, whitelist) |
| `referral_codes` | `Vec<ReferralCodeInfo>` | Referral codes the user can share |

### `ReferralCodeInfo`

A single referral code owned by the user.

| Field | Type | Description |
|-------|------|-------------|
| `code` | `String` | The referral code string |
| `max_uses` | `i32` | Maximum number of redemptions |
| `use_count` | `i64` | Current number of redemptions |

### `RedeemResult`

Result of redeeming a referral code.

| Field | Type | Description |
|-------|------|-------------|
| `success` | `bool` | Whether the redemption succeeded |
| `is_beta` | `bool` | Whether the user now has beta access |

## Client Methods

Access via `client.referrals()`. All methods require an authenticated session.

### `get_status`

```rust
async fn get_status(&self) -> Result<ReferralStatus, SdkError>
```

Get the current user's referral status, including their beta access state and any referral codes they own.

### `redeem`

```rust
async fn redeem(&self, code: &str) -> Result<RedeemResult, SdkError>
```

Redeem a referral code to gain beta access. Returns an error if the code is invalid, expired, or already at max uses.

## Examples

### Check referral status and share codes

```rust
use lightcone::prelude::*;

async fn check_referral(client: &LightconeClient) -> Result<(), SdkError> {
    let status = client.referrals().get_status().await?;

    if status.is_beta {
        println!("Beta access: active");
        for code in &status.referral_codes {
            println!("  Code: {} ({}/{} uses)", code.code, code.use_count, code.max_uses);
        }
    } else {
        println!("No beta access yet. Redeem a code to get started.");
    }

    Ok(())
}
```

### Redeem a referral code

```rust
use lightcone::prelude::*;

async fn redeem_code(client: &LightconeClient, code: &str) -> Result<(), SdkError> {
    let result = client.referrals().redeem(code).await?;
    if result.success {
        println!("Referral code redeemed. Beta access: {}", result.is_beta);
    }
    Ok(())
}
```

---

[← Overview](../../../README.md)