updates
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from importlib import import_module
|
||||
from typing_extensions import TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from stripe.reporting._report_run import ReportRun as ReportRun
|
||||
from stripe.reporting._report_run_service import (
|
||||
ReportRunService as ReportRunService,
|
||||
)
|
||||
from stripe.reporting._report_type import ReportType as ReportType
|
||||
from stripe.reporting._report_type_service import (
|
||||
ReportTypeService as ReportTypeService,
|
||||
)
|
||||
|
||||
# name -> (import_target, is_submodule)
|
||||
_import_map = {
|
||||
"ReportRun": ("stripe.reporting._report_run", False),
|
||||
"ReportRunService": ("stripe.reporting._report_run_service", False),
|
||||
"ReportType": ("stripe.reporting._report_type", False),
|
||||
"ReportTypeService": ("stripe.reporting._report_type_service", False),
|
||||
}
|
||||
if not TYPE_CHECKING:
|
||||
|
||||
def __getattr__(name):
|
||||
try:
|
||||
target, is_submodule = _import_map[name]
|
||||
module = import_module(target)
|
||||
if is_submodule:
|
||||
return module
|
||||
|
||||
return getattr(
|
||||
module,
|
||||
name,
|
||||
)
|
||||
except KeyError:
|
||||
raise AttributeError()
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,211 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._createable_api_resource import CreateableAPIResource
|
||||
from stripe._list_object import ListObject
|
||||
from stripe._listable_api_resource import ListableAPIResource
|
||||
from stripe._stripe_object import StripeObject
|
||||
from typing import ClassVar, List, Optional, cast
|
||||
from typing_extensions import Literal, Unpack, TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from stripe._file import File
|
||||
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,
|
||||
)
|
||||
|
||||
|
||||
class ReportRun(
|
||||
CreateableAPIResource["ReportRun"],
|
||||
ListableAPIResource["ReportRun"],
|
||||
):
|
||||
"""
|
||||
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).
|
||||
"""
|
||||
|
||||
OBJECT_NAME: ClassVar[Literal["reporting.report_run"]] = (
|
||||
"reporting.report_run"
|
||||
)
|
||||
|
||||
class Parameters(StripeObject):
|
||||
columns: Optional[List[str]]
|
||||
"""
|
||||
The set of output columns requested for inclusion in the report run.
|
||||
"""
|
||||
connected_account: Optional[str]
|
||||
"""
|
||||
Connected account ID by which to filter the report run.
|
||||
"""
|
||||
currency: Optional[str]
|
||||
"""
|
||||
Currency of objects to be included in the report run.
|
||||
"""
|
||||
interval_end: Optional[int]
|
||||
"""
|
||||
Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value.
|
||||
"""
|
||||
interval_start: Optional[int]
|
||||
"""
|
||||
Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value.
|
||||
"""
|
||||
payout: Optional[str]
|
||||
"""
|
||||
Payout ID by which to filter the report run.
|
||||
"""
|
||||
reporting_category: Optional[str]
|
||||
"""
|
||||
Category of balance transactions to be included in the report run.
|
||||
"""
|
||||
timezone: Optional[str]
|
||||
"""
|
||||
Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`.
|
||||
"""
|
||||
|
||||
created: int
|
||||
"""
|
||||
Time at which the object was created. Measured in seconds since the Unix epoch.
|
||||
"""
|
||||
error: Optional[str]
|
||||
"""
|
||||
If something should go wrong during the run, a message about the failure (populated when
|
||||
`status=failed`).
|
||||
"""
|
||||
id: str
|
||||
"""
|
||||
Unique identifier for the object.
|
||||
"""
|
||||
livemode: bool
|
||||
"""
|
||||
`true` if the report is run on live mode data and `false` if it is run on test mode data.
|
||||
"""
|
||||
object: Literal["reporting.report_run"]
|
||||
"""
|
||||
String representing the object's type. Objects of the same type share the same value.
|
||||
"""
|
||||
parameters: Parameters
|
||||
report_type: str
|
||||
"""
|
||||
The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`.
|
||||
"""
|
||||
result: Optional["File"]
|
||||
"""
|
||||
The file object representing the result of the report run (populated when
|
||||
`status=succeeded`).
|
||||
"""
|
||||
status: str
|
||||
"""
|
||||
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.
|
||||
"""
|
||||
succeeded_at: Optional[int]
|
||||
"""
|
||||
Timestamp at which this run successfully finished (populated when
|
||||
`status=succeeded`). Measured in seconds since the Unix epoch.
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def create(cls, **params: Unpack["ReportRunCreateParams"]) -> "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",
|
||||
cls._static_request(
|
||||
"post",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
),
|
||||
)
|
||||
|
||||
@classmethod
|
||||
async def create_async(
|
||||
cls, **params: Unpack["ReportRunCreateParams"]
|
||||
) -> "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 cls._static_request_async(
|
||||
"post",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
),
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def list(
|
||||
cls, **params: Unpack["ReportRunListParams"]
|
||||
) -> ListObject["ReportRun"]:
|
||||
"""
|
||||
Returns a list of Report Runs, with the most recent appearing first.
|
||||
"""
|
||||
result = cls._static_request(
|
||||
"get",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
)
|
||||
if not isinstance(result, ListObject):
|
||||
raise TypeError(
|
||||
"Expected list object from API, got %s"
|
||||
% (type(result).__name__)
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
async def list_async(
|
||||
cls, **params: Unpack["ReportRunListParams"]
|
||||
) -> ListObject["ReportRun"]:
|
||||
"""
|
||||
Returns a list of Report Runs, with the most recent appearing first.
|
||||
"""
|
||||
result = await cls._static_request_async(
|
||||
"get",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
)
|
||||
if not isinstance(result, ListObject):
|
||||
raise TypeError(
|
||||
"Expected list object from API, got %s"
|
||||
% (type(result).__name__)
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
def retrieve(
|
||||
cls, id: str, **params: Unpack["ReportRunRetrieveParams"]
|
||||
) -> "ReportRun":
|
||||
"""
|
||||
Retrieves the details of an existing Report Run.
|
||||
"""
|
||||
instance = cls(id, **params)
|
||||
instance.refresh()
|
||||
return instance
|
||||
|
||||
@classmethod
|
||||
async def retrieve_async(
|
||||
cls, id: str, **params: Unpack["ReportRunRetrieveParams"]
|
||||
) -> "ReportRun":
|
||||
"""
|
||||
Retrieves the details of an existing Report Run.
|
||||
"""
|
||||
instance = cls(id, **params)
|
||||
await instance.refresh_async()
|
||||
return instance
|
||||
|
||||
_inner_class_types = {"parameters": Parameters}
|
||||
@@ -0,0 +1,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,
|
||||
),
|
||||
)
|
||||
@@ -0,0 +1,129 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# File generated from our OpenAPI spec
|
||||
from stripe._list_object import ListObject
|
||||
from stripe._listable_api_resource import ListableAPIResource
|
||||
from typing import ClassVar, List, Optional
|
||||
from typing_extensions import Literal, Unpack, TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from stripe.params.reporting._report_type_list_params import (
|
||||
ReportTypeListParams,
|
||||
)
|
||||
from stripe.params.reporting._report_type_retrieve_params import (
|
||||
ReportTypeRetrieveParams,
|
||||
)
|
||||
|
||||
|
||||
class ReportType(ListableAPIResource["ReportType"]):
|
||||
"""
|
||||
The Report Type resource corresponds to a particular type of report, such as
|
||||
the "Activity summary" or "Itemized payouts" reports. These objects are
|
||||
identified by an ID belonging to a set of enumerated values. See
|
||||
[API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)
|
||||
for those Report Type IDs, along with required and optional parameters.
|
||||
|
||||
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).
|
||||
"""
|
||||
|
||||
OBJECT_NAME: ClassVar[Literal["reporting.report_type"]] = (
|
||||
"reporting.report_type"
|
||||
)
|
||||
data_available_end: int
|
||||
"""
|
||||
Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
|
||||
"""
|
||||
data_available_start: int
|
||||
"""
|
||||
Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
|
||||
"""
|
||||
default_columns: Optional[List[str]]
|
||||
"""
|
||||
List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)
|
||||
"""
|
||||
id: str
|
||||
"""
|
||||
The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.
|
||||
"""
|
||||
livemode: bool
|
||||
"""
|
||||
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
|
||||
"""
|
||||
name: str
|
||||
"""
|
||||
Human-readable name of the Report Type
|
||||
"""
|
||||
object: Literal["reporting.report_type"]
|
||||
"""
|
||||
String representing the object's type. Objects of the same type share the same value.
|
||||
"""
|
||||
updated: int
|
||||
"""
|
||||
When this Report Type was latest updated. Measured in seconds since the Unix epoch.
|
||||
"""
|
||||
version: int
|
||||
"""
|
||||
Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def list(
|
||||
cls, **params: Unpack["ReportTypeListParams"]
|
||||
) -> ListObject["ReportType"]:
|
||||
"""
|
||||
Returns a full list of Report Types.
|
||||
"""
|
||||
result = cls._static_request(
|
||||
"get",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
)
|
||||
if not isinstance(result, ListObject):
|
||||
raise TypeError(
|
||||
"Expected list object from API, got %s"
|
||||
% (type(result).__name__)
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
async def list_async(
|
||||
cls, **params: Unpack["ReportTypeListParams"]
|
||||
) -> ListObject["ReportType"]:
|
||||
"""
|
||||
Returns a full list of Report Types.
|
||||
"""
|
||||
result = await cls._static_request_async(
|
||||
"get",
|
||||
cls.class_url(),
|
||||
params=params,
|
||||
)
|
||||
if not isinstance(result, ListObject):
|
||||
raise TypeError(
|
||||
"Expected list object from API, got %s"
|
||||
% (type(result).__name__)
|
||||
)
|
||||
|
||||
return result
|
||||
|
||||
@classmethod
|
||||
def retrieve(
|
||||
cls, id: str, **params: Unpack["ReportTypeRetrieveParams"]
|
||||
) -> "ReportType":
|
||||
"""
|
||||
Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
|
||||
"""
|
||||
instance = cls(id, **params)
|
||||
instance.refresh()
|
||||
return instance
|
||||
|
||||
@classmethod
|
||||
async def retrieve_async(
|
||||
cls, id: str, **params: Unpack["ReportTypeRetrieveParams"]
|
||||
) -> "ReportType":
|
||||
"""
|
||||
Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
|
||||
"""
|
||||
instance = cls(id, **params)
|
||||
await instance.refresh_async()
|
||||
return instance
|
||||
@@ -0,0 +1,101 @@
|
||||
# -*- 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_type_list_params import (
|
||||
ReportTypeListParams,
|
||||
)
|
||||
from stripe.params.reporting._report_type_retrieve_params import (
|
||||
ReportTypeRetrieveParams,
|
||||
)
|
||||
from stripe.reporting._report_type import ReportType
|
||||
|
||||
|
||||
class ReportTypeService(StripeService):
|
||||
def list(
|
||||
self,
|
||||
params: Optional["ReportTypeListParams"] = None,
|
||||
options: Optional["RequestOptions"] = None,
|
||||
) -> "ListObject[ReportType]":
|
||||
"""
|
||||
Returns a full list of Report Types.
|
||||
"""
|
||||
return cast(
|
||||
"ListObject[ReportType]",
|
||||
self._request(
|
||||
"get",
|
||||
"/v1/reporting/report_types",
|
||||
base_address="api",
|
||||
params=params,
|
||||
options=options,
|
||||
),
|
||||
)
|
||||
|
||||
async def list_async(
|
||||
self,
|
||||
params: Optional["ReportTypeListParams"] = None,
|
||||
options: Optional["RequestOptions"] = None,
|
||||
) -> "ListObject[ReportType]":
|
||||
"""
|
||||
Returns a full list of Report Types.
|
||||
"""
|
||||
return cast(
|
||||
"ListObject[ReportType]",
|
||||
await self._request_async(
|
||||
"get",
|
||||
"/v1/reporting/report_types",
|
||||
base_address="api",
|
||||
params=params,
|
||||
options=options,
|
||||
),
|
||||
)
|
||||
|
||||
def retrieve(
|
||||
self,
|
||||
report_type: str,
|
||||
params: Optional["ReportTypeRetrieveParams"] = None,
|
||||
options: Optional["RequestOptions"] = None,
|
||||
) -> "ReportType":
|
||||
"""
|
||||
Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
|
||||
"""
|
||||
return cast(
|
||||
"ReportType",
|
||||
self._request(
|
||||
"get",
|
||||
"/v1/reporting/report_types/{report_type}".format(
|
||||
report_type=sanitize_id(report_type),
|
||||
),
|
||||
base_address="api",
|
||||
params=params,
|
||||
options=options,
|
||||
),
|
||||
)
|
||||
|
||||
async def retrieve_async(
|
||||
self,
|
||||
report_type: str,
|
||||
params: Optional["ReportTypeRetrieveParams"] = None,
|
||||
options: Optional["RequestOptions"] = None,
|
||||
) -> "ReportType":
|
||||
"""
|
||||
Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
|
||||
"""
|
||||
return cast(
|
||||
"ReportType",
|
||||
await self._request_async(
|
||||
"get",
|
||||
"/v1/reporting/report_types/{report_type}".format(
|
||||
report_type=sanitize_id(report_type),
|
||||
),
|
||||
base_address="api",
|
||||
params=params,
|
||||
options=options,
|
||||
),
|
||||
)
|
||||
Reference in New Issue
Block a user