9066056882

Committed 13 May 2024 04:00PM UTC coverage: 96.425% (+0.007%) from 96.418%

Build # 9066056882

Build Type

Pull #1330

github

Committed by

web-flow

Commit Message

Merge 748820b7e into 81905cd27

Pull Request Pull Request #1330: (beta) swap from `black` to `ruff` for formatting

Run Details

1338 of 2019 branches covered (66.27%)

Branch coverage included in aggregate %.

100 of 100 new or added lines in 79 files covered. (100.0%)

190 existing lines in 96 files now uncovered.

82347 of 84769 relevant lines covered (97.14%)

0.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.31

/stripe/sigma/_scheduled_query_run.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from typing import ClassVar, List, Optional
from typing_extensions import Literal, NotRequired, Unpack, TYPE_CHECKING

if TYPE_CHECKING:
    from stripe._file import File


class ScheduledQueryRun(ListableAPIResource["ScheduledQueryRun"]):
    """
    If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
    receive a `sigma.scheduled_query_run.created` webhook each time the query
    runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
    retrieve the query results.
    """

    OBJECT_NAME: ClassVar[Literal["scheduled_query_run"]] = (
        "scheduled_query_run"
    )

    class Error(StripeObject):
        message: str
        """
        Information about the run failure.
        """

    class ListParams(RequestOptions):
        ending_before: NotRequired[str]
        """
        A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        limit: NotRequired[int]
        """
        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
        """
        starting_after: NotRequired[str]
        """
        A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
        """

    class RetrieveParams(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """

    created: int
    """
    Time at which the object was created. Measured in seconds since the Unix epoch.
    """
    data_load_time: int
    """
    When the query was run, Sigma contained a snapshot of your Stripe data at this time.
    """
    error: Optional[Error]
    file: Optional["File"]
    """
    The file object representing the results of the query.
    """
    id: str
    """
    Unique identifier for the object.
    """
    livemode: bool
    """
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
    """
    object: Literal["scheduled_query_run"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    result_available_until: int
    """
    Time at which the result expires and is no longer available for download.
    """
    sql: str
    """
    SQL for the query.
    """
    status: str
    """
    The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.
    """
    title: str
    """
    Title of the query.
    """

    @classmethod
    def list(
        cls, **params: Unpack["ScheduledQueryRun.ListParams"]
    ) -> ListObject["ScheduledQueryRun"]:
        """
        Returns a list of scheduled query runs.
        """
        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["ScheduledQueryRun.ListParams"]
    ) -> ListObject["ScheduledQueryRun"]:
        """
        Returns a list of scheduled query runs.
        """
        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["ScheduledQueryRun.RetrieveParams"]
    ) -> "ScheduledQueryRun":
        """
        Retrieves the details of an scheduled query run.
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["ScheduledQueryRun.RetrieveParams"]
    ) -> "ScheduledQueryRun":
        """
        Retrieves the details of an scheduled query run.
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

    @classmethod
    def class_url(cls):
        return "/v1/sigma/scheduled_query_runs"

    _inner_class_types = {"error": Error}

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._list_object import ListObject	1✔
4	from stripe._listable_api_resource import ListableAPIResource	1✔
5	from stripe._request_options import RequestOptions	1✔
6	from stripe._stripe_object import StripeObject	1✔
7	from typing import ClassVar, List, Optional	1✔
8	from typing_extensions import Literal, NotRequired, Unpack, TYPE_CHECKING	1✔
9
10	if TYPE_CHECKING:	1!
11	from stripe._file import File	×
12
13
14	class ScheduledQueryRun(ListableAPIResource["ScheduledQueryRun"]):	1✔
15	"""
16	If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
17	receive a `sigma.scheduled_query_run.created` webhook each time the query
18	runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
19	retrieve the query results.
20	"""
21
22	OBJECT_NAME: ClassVar[Literal["scheduled_query_run"]] = (	1✔
23	"scheduled_query_run"
24	)
25
26	class Error(StripeObject):	1✔
27	message: str	1✔
28	"""	1✔
29	Information about the run failure.
30	"""
31
32	class ListParams(RequestOptions):	1✔
33	ending_before: NotRequired[str]	1✔
34	"""	1✔
35	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
36	"""
37	expand: NotRequired[List[str]]	1✔
38	"""	1✔
39	Specifies which fields in the response should be expanded.
40	"""
41	limit: NotRequired[int]	1✔
42	"""	1✔
43	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
44	"""
45	starting_after: NotRequired[str]	1✔
46	"""	1✔
47	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
48	"""
49
50	class RetrieveParams(RequestOptions):	1✔
51	expand: NotRequired[List[str]]	1✔
52	"""	1✔
53	Specifies which fields in the response should be expanded.
54	"""
55
56	created: int	1✔
57	"""	1✔
58	Time at which the object was created. Measured in seconds since the Unix epoch.
59	"""
60	data_load_time: int	1✔
61	"""	1✔
62	When the query was run, Sigma contained a snapshot of your Stripe data at this time.
63	"""
64	error: Optional[Error]	1✔
65	file: Optional["File"]	1✔
66	"""	1✔
67	The file object representing the results of the query.
68	"""
69	id: str	1✔
70	"""	1✔
71	Unique identifier for the object.
72	"""
73	livemode: bool	1✔
74	"""	1✔
75	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
76	"""
77	object: Literal["scheduled_query_run"]	1✔
78	"""	1✔
79	String representing the object's type. Objects of the same type share the same value.
80	"""
81	result_available_until: int	1✔
82	"""	1✔
83	Time at which the result expires and is no longer available for download.
84	"""
85	sql: str	1✔
86	"""	1✔
87	SQL for the query.
88	"""
89	status: str	1✔
90	"""	1✔
91	The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.
92	"""
93	title: str	1✔
94	"""	1✔
95	Title of the query.
96	"""
97
98	@classmethod	1✔
99	def list(	1✔
100	cls, **params: Unpack["ScheduledQueryRun.ListParams"]
101	) -> ListObject["ScheduledQueryRun"]:
102	"""
103	Returns a list of scheduled query runs.
104	"""
105	result = cls._static_request(	1✔
106	"get",
107	cls.class_url(),
108	params=params,
109	)
110	if not isinstance(result, ListObject):	1!
UNCOV 111	raise TypeError(	×
112	"Expected list object from API, got %s"
113	% (type(result).__name__)
114	)
115
116	return result	1✔
117
118	@classmethod	1✔
119	async def list_async(	1✔
120	cls, **params: Unpack["ScheduledQueryRun.ListParams"]
121	) -> ListObject["ScheduledQueryRun"]:
122	"""
123	Returns a list of scheduled query runs.
124	"""
125	result = await cls._static_request_async(	1✔
126	"get",
127	cls.class_url(),
128	params=params,
129	)
130	if not isinstance(result, ListObject):	1!
UNCOV 131	raise TypeError(	×
132	"Expected list object from API, got %s"
133	% (type(result).__name__)
134	)
135
136	return result	1✔
137
138	@classmethod	1✔
139	def retrieve(	1✔
140	cls, id: str, **params: Unpack["ScheduledQueryRun.RetrieveParams"]
141	) -> "ScheduledQueryRun":
142	"""
143	Retrieves the details of an scheduled query run.
144	"""
145	instance = cls(id, **params)	1✔
146	instance.refresh()	1✔
147	return instance	1✔
148
149	@classmethod	1✔
150	async def retrieve_async(	1✔
151	cls, id: str, **params: Unpack["ScheduledQueryRun.RetrieveParams"]
152	) -> "ScheduledQueryRun":
153	"""
154	Retrieves the details of an scheduled query run.
155	"""
156	instance = cls(id, **params)	1✔
157	await instance.refresh_async()	1✔
158	return instance	1✔
159
160	@classmethod	1✔
161	def class_url(cls):	1✔
162	return "/v1/sigma/scheduled_query_runs"	1✔
163
164	_inner_class_types = {"error": Error}	1✔

stripe / stripe-python / 9066056882

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous