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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.params.reporting._report_run_create_params import (
ReportRunCreateParams,
)
from stripe.params.reporting._report_run_list_params import (
ReportRunListParams,
)
from stripe.params.reporting._report_run_retrieve_params import (
ReportRunRetrieveParams,
)
from stripe.reporting._report_run import ReportRun
class ReportRunService(StripeService):
def list(
self,
params: Optional["ReportRunListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[ReportRun]":
"""
Returns a list of Report Runs, with the most recent appearing first.
"""
return cast(
"ListObject[ReportRun]",
self._request(
"get",
"/v1/reporting/report_runs",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["ReportRunListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[ReportRun]":
"""
Returns a list of Report Runs, with the most recent appearing first.
"""
return cast(
"ListObject[ReportRun]",
await self._request_async(
"get",
"/v1/reporting/report_runs",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "ReportRunCreateParams",
options: Optional["RequestOptions"] = None,
) -> "ReportRun":
"""
Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
"""
return cast(
"ReportRun",
self._request(
"post",
"/v1/reporting/report_runs",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "ReportRunCreateParams",
options: Optional["RequestOptions"] = None,
) -> "ReportRun":
"""
Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
"""
return cast(
"ReportRun",
await self._request_async(
"post",
"/v1/reporting/report_runs",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
report_run: str,
params: Optional["ReportRunRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ReportRun":
"""
Retrieves the details of an existing Report Run.
"""
return cast(
"ReportRun",
self._request(
"get",
"/v1/reporting/report_runs/{report_run}".format(
report_run=sanitize_id(report_run),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
report_run: str,
params: Optional["ReportRunRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ReportRun":
"""
Retrieves the details of an existing Report Run.
"""
return cast(
"ReportRun",
await self._request_async(
"get",
"/v1/reporting/report_runs/{report_run}".format(
report_run=sanitize_id(report_run),
),
base_address="api",
params=params,
options=options,
),
)
|
