stadar 0.1.25

Rust SDK for the stadar.net esports data API.
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
/*
 * Stadar Esports Data API
 *
 * Read-only esports data across all major competitive titles. Flat-tier pricing (no per-game gates), monthly subscriptions, sandbox keys for evaluation. See https://stadar.net for tier pricing. All endpoints under `/v1/...`. The version in `info.version` matches the URL prefix; non-breaking field additions ship in `/v1`, breaking changes get a `/v2`. We commit to 24 months of `/v1` support after `/v2` ships. Times are UTC end-to-end (RFC 3339). Localization is the client's problem. Cursors are opaque base64 strings; treat them as such. 
 *
 * The version of the OpenAPI document: v1
 * Contact: api@stadar.net
 * Generated by: https://openapi-generator.tech
 */


use reqwest;
use serde::{Deserialize, Serialize, de::Error as _};
use crate::{apis::ResponseContent, models};
use super::{Error, configuration, ContentType};

/// struct for passing parameters to the method [`matches_get`]
#[derive(Clone, Debug)]
pub struct MatchesGetParams {
    /// Either a public ID (`match_<ulid>`, case-insensitive) or a match slug. Slugs require the `?game=` query param to scope the lookup; passing a slug without `?game=` 400s. 
    pub id: String,
    /// Required when `id` is a slug. Ignored when `id` is a `match_<ulid>`.
    pub game: Option<String>
}

/// struct for passing parameters to the method [`matches_list`]
#[derive(Clone, Debug)]
pub struct MatchesListParams {
    /// Opaque pagination cursor. Hand back the value from `meta.paging.cursor` to fetch the next page; stop when `meta.paging.has_more` is false. Cursors are valid for at least 24 hours and signed against a per-deployment secret — treat them as opaque strings. The wire format may change in a backwards-compatible way (a future cursor will still satisfy the regex above). 
    pub cursor: Option<String>,
    /// Items per page. 1-200, default 50. (Pro+ on `/v1/matches` may request up to 10k via `?bulk=true`.)
    pub limit: Option<i32>,
    /// Pro+ only. Returns up to 10k matches per page instead of the cursor-default 50. Free/Hobbyist callers get 402. 
    pub bulk: Option<bool>,
    pub game: Option<String>,
    pub status: Option<String>,
    pub league_id: Option<i64>,
    pub series_id: Option<i64>,
    pub tournament_id: Option<i64>,
    pub from: Option<chrono::NaiveDate>,
    pub to: Option<chrono::NaiveDate>,
    /// Order results by soonest scheduled start (`scheduled_at` ascending, then id). Omitted, results follow insertion order. 
    pub sort: Option<String>
}

/// struct for passing parameters to the method [`matches_live`]
#[derive(Clone, Debug)]
pub struct MatchesLiveParams {
    /// Either a `match_<ulid>` public id or a match slug. Slug requires `?game=`.
    pub id: String,
    /// Required when `id` is a slug.
    pub game: Option<String>
}

/// struct for passing parameters to the method [`matches_preview`]
#[derive(Clone, Debug)]
pub struct MatchesPreviewParams {
    /// Either a `match_<ulid>` public id or a match slug. Slug requires `?game=`.
    pub id: String,
    /// Required when `id` is a slug.
    pub game: Option<String>
}

/// struct for passing parameters to the method [`matches_rounds`]
#[derive(Clone, Debug)]
pub struct MatchesRoundsParams {
    /// Either a `match_<ulid>` public id or a match slug. Slug requires `?game=`.
    pub id: String,
    /// Required when `id` is a slug.
    pub game: Option<String>
}

/// struct for passing parameters to the method [`matches_scoreboard`]
#[derive(Clone, Debug)]
pub struct MatchesScoreboardParams {
    /// Either a `match_<ulid>` public id or a match slug. Slug requires `?game=`.
    pub id: String,
    /// Required when `id` is a slug.
    pub game: Option<String>
}


/// struct for typed errors of method [`matches_get`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MatchesGetError {
    Status400(models::ErrorEnvelope),
    Status401(models::ErrorEnvelope),
    Status404(models::ErrorEnvelope),
    Status429(models::ErrorEnvelope),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`matches_list`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MatchesListError {
    Status400(models::ErrorEnvelope),
    Status401(models::ErrorEnvelope),
    Status402(models::ErrorEnvelope),
    Status429(models::ErrorEnvelope),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`matches_live`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MatchesLiveError {
    Status400(models::ErrorEnvelope),
    Status401(models::ErrorEnvelope),
    Status402(models::ErrorEnvelope),
    Status404(models::ErrorEnvelope),
    Status429(models::ErrorEnvelope),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`matches_preview`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MatchesPreviewError {
    Status400(models::ErrorEnvelope),
    Status401(models::ErrorEnvelope),
    Status402(models::ErrorEnvelope),
    Status404(models::ErrorEnvelope),
    Status429(models::ErrorEnvelope),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`matches_rounds`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MatchesRoundsError {
    Status400(models::ErrorEnvelope),
    Status401(models::ErrorEnvelope),
    Status402(models::ErrorEnvelope),
    Status404(models::ErrorEnvelope),
    Status429(models::ErrorEnvelope),
    UnknownValue(serde_json::Value),
}

/// struct for typed errors of method [`matches_scoreboard`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum MatchesScoreboardError {
    Status400(models::ErrorEnvelope),
    Status401(models::ErrorEnvelope),
    Status402(models::ErrorEnvelope),
    Status404(models::ErrorEnvelope),
    Status429(models::ErrorEnvelope),
    UnknownValue(serde_json::Value),
}


pub async fn matches_get(configuration: &configuration::Configuration, params: MatchesGetParams) -> Result<models::MatchEnvelope, Error<MatchesGetError>> {

    let uri_str = format!("{}/v1/matches/{id}", configuration.base_path, id=crate::apis::urlencode(params.id));
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    if let Some(ref param_value) = params.game {
        req_builder = req_builder.query(&[("game", &param_value.to_string())]);
    }
    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(ref token) = configuration.bearer_access_token {
        req_builder = req_builder.bearer_auth(token.to_owned());
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::MatchEnvelope`"))),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::MatchEnvelope`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<MatchesGetError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}

/// Returns matches with denormalized league/series/tournament summaries. Stats (per-player KDA / per-map team aggregates) are gated to Hobbyist+ via the `match_stats` capability — Free-tier sees scores + status only. Bulk export (`?bulk=true`) is Pro+ via `bulk_export` capability and allows up to 10k matches per page. 
pub async fn matches_list(configuration: &configuration::Configuration, params: MatchesListParams) -> Result<models::MatchesListResponse, Error<MatchesListError>> {

    let uri_str = format!("{}/v1/matches", configuration.base_path);
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    if let Some(ref param_value) = params.cursor {
        req_builder = req_builder.query(&[("cursor", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.limit {
        req_builder = req_builder.query(&[("limit", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.bulk {
        req_builder = req_builder.query(&[("bulk", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.game {
        req_builder = req_builder.query(&[("game", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.status {
        req_builder = req_builder.query(&[("status", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.league_id {
        req_builder = req_builder.query(&[("league_id", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.series_id {
        req_builder = req_builder.query(&[("series_id", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.tournament_id {
        req_builder = req_builder.query(&[("tournament_id", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.from {
        req_builder = req_builder.query(&[("from", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.to {
        req_builder = req_builder.query(&[("to", &param_value.to_string())]);
    }
    if let Some(ref param_value) = params.sort {
        req_builder = req_builder.query(&[("sort", &param_value.to_string())]);
    }
    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(ref token) = configuration.bearer_access_token {
        req_builder = req_builder.bearer_auth(token.to_owned());
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::MatchesListResponse`"))),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::MatchesListResponse`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<MatchesListError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}

/// Polling-friendly projection of the per-game / per-map state for a single match. Surfaces the current in-progress game, per-team kill counts, the series score, and a freshness timestamp so clients can back off polling on stale series. Matches without an upstream live-state counterpart return 200 with an empty `games` array and `live_data_source: \"liquipedia\"` — clients should not poll these matches. Scale+ via the `live` capability. Responses ship `Cache-Control: max-age=15` so polling at 1 Hz still hits the cache about 14 times out of 15. 
pub async fn matches_live(configuration: &configuration::Configuration, params: MatchesLiveParams) -> Result<models::MatchLiveEnvelope, Error<MatchesLiveError>> {

    let uri_str = format!("{}/v1/matches/{id}/live", configuration.base_path, id=crate::apis::urlencode(params.id));
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    if let Some(ref param_value) = params.game {
        req_builder = req_builder.query(&[("game", &param_value.to_string())]);
    }
    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(ref token) = configuration.bearer_access_token {
        req_builder = req_builder.bearer_auth(token.to_owned());
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::MatchLiveEnvelope`"))),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::MatchLiveEnvelope`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<MatchesLiveError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}

/// Pre-match form (last-N results, 30-day wins/losses), head-to-head record, and last-5 matches per team. CS2 matches additionally carry `cs2_specific` with map veto history when the upstream carried structured veto data. Pro+ via `match_preview` capability. Derived from completed matches in our match-history corpus — attribution is included in `meta.sources` when applicable. Responses ship `Cache-Control: max-age=120`. 
pub async fn matches_preview(configuration: &configuration::Configuration, params: MatchesPreviewParams) -> Result<models::MatchPreviewEnvelope, Error<MatchesPreviewError>> {

    let uri_str = format!("{}/v1/matches/{id}/preview", configuration.base_path, id=crate::apis::urlencode(params.id));
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    if let Some(ref param_value) = params.game {
        req_builder = req_builder.query(&[("game", &param_value.to_string())]);
    }
    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(ref token) = configuration.bearer_access_token {
        req_builder = req_builder.bearer_auth(token.to_owned());
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::MatchPreviewEnvelope`"))),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::MatchPreviewEnvelope`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<MatchesPreviewError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}

/// Round-by-round breakdown for a CS2 match — per round: the winning side, the round-end condition (`win_type`), and the T/CT side each team played. Sourced from the GRID Live Data Feed. Available only for matches linked to a GRID counterpart; others return 200 with an empty `rounds` array. Hobbyist+ via the `match_stats` capability. Responses ship `Cache-Control: max-age=15`. 
pub async fn matches_rounds(configuration: &configuration::Configuration, params: MatchesRoundsParams) -> Result<models::MatchRoundsEnvelope, Error<MatchesRoundsError>> {

    let uri_str = format!("{}/v1/matches/{id}/rounds", configuration.base_path, id=crate::apis::urlencode(params.id));
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    if let Some(ref param_value) = params.game {
        req_builder = req_builder.query(&[("game", &param_value.to_string())]);
    }
    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(ref token) = configuration.bearer_access_token {
        req_builder = req_builder.bearer_auth(token.to_owned());
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::MatchRoundsEnvelope`"))),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::MatchRoundsEnvelope`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<MatchesRoundsError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}

/// Per-map per-player scoreboard for a CS2 match — kills, deaths, assists, headshots, damage, and end-of-map economy (money, loadout value, net worth). Sourced from the GRID Live Data Feed. Available only for matches linked to a GRID counterpart; others return 200 with an empty `players` array. Hobbyist+ via the `match_stats` capability. Responses ship `Cache-Control: max-age=15`. 
pub async fn matches_scoreboard(configuration: &configuration::Configuration, params: MatchesScoreboardParams) -> Result<models::MatchScoreboardEnvelope, Error<MatchesScoreboardError>> {

    let uri_str = format!("{}/v1/matches/{id}/scoreboard", configuration.base_path, id=crate::apis::urlencode(params.id));
    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);

    if let Some(ref param_value) = params.game {
        req_builder = req_builder.query(&[("game", &param_value.to_string())]);
    }
    if let Some(ref user_agent) = configuration.user_agent {
        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
    }
    if let Some(ref token) = configuration.bearer_access_token {
        req_builder = req_builder.bearer_auth(token.to_owned());
    };

    let req = req_builder.build()?;
    let resp = configuration.client.execute(req).await?;

    let status = resp.status();
    let content_type = resp
        .headers()
        .get("content-type")
        .and_then(|v| v.to_str().ok())
        .unwrap_or("application/octet-stream");
    let content_type = super::ContentType::from(content_type);

    if !status.is_client_error() && !status.is_server_error() {
        let content = resp.text().await?;
        match content_type {
            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::MatchScoreboardEnvelope`"))),
            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::MatchScoreboardEnvelope`")))),
        }
    } else {
        let content = resp.text().await?;
        let entity: Option<MatchesScoreboardError> = serde_json::from_str(&content).ok();
        Err(Error::ResponseError(ResponseContent { status, content, entity }))
    }
}