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
use serde::{Serialize, Deserialize};
use super::FinancialReportingFinanceReportRunRunParameters;
/**The Report Run object represents an instance of a report type generated with
specific run parameters. Once the object is created, Stripe begins processing the report.
When the report has finished running, it will give you a reference to a file
where you can retrieve your results. For an overview, see
[API Access to Reports](https://stripe.com/docs/reporting/statements/api).
Note that certain report types can only be run based on your live-mode data (not test-mode
data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).*/
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ReportingReportRun {
///Time at which the object was created. Measured in seconds since the Unix epoch.
pub created: i64,
/**If something should go wrong during the run, a message about the failure (populated when
`status=failed`).*/
#[serde(skip_serializing_if = "Option::is_none")]
pub error: Option<String>,
///Unique identifier for the object.
pub id: String,
///`true` if the report is run on live mode data and `false` if it is run on test mode data.
pub livemode: bool,
///String representing the object's type. Objects of the same type share the same value.
pub object: String,
///
pub parameters: FinancialReportingFinanceReportRunRunParameters,
///The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`.
pub report_type: String,
/**The file object representing the result of the report run (populated when
`status=succeeded`).*/
#[serde(skip_serializing_if = "Option::is_none")]
pub result: Option<serde_json::Value>,
/**Status of this report run. This will be `pending` when the run is initially created.
When the run finishes, this will be set to `succeeded` and the `result` field will be populated.
Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.*/
pub status: String,
/**Timestamp at which this run successfully finished (populated when
`status=succeeded`). Measured in seconds since the Unix epoch.*/
#[serde(skip_serializing_if = "Option::is_none")]
pub succeeded_at: Option<i64>,
}
impl std::fmt::Display for ReportingReportRun {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(f, "{}", serde_json::to_string(self).unwrap())
}
}