11732212718

Committed 07 Nov 2024 10:14PM UTC coverage: 96.254% (-0.009%) from 96.263%

Build # 11732212718

Build Type

Pull #1422

github

Committed by

web-flow

Commit Message

Merge b0ba17859 into db9a7b0e2

Pull Request Pull Request #1422: Update generated code for beta

Run Details

1384 of 2119 branches covered (65.31%)

Branch coverage included in aggregate %.

41 of 51 new or added lines in 2 files covered. (80.39%)

43 existing lines in 5 files now uncovered.

90122 of 92948 relevant lines covered (96.96%)

0.97 hits per line

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

94.74

/stripe/_file.py

# -*- 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._request_options import RequestOptions
from typing import Any, ClassVar, Dict, List, Optional, cast
from typing_extensions import (
    Literal,
    NotRequired,
    TypedDict,
    Unpack,
    TYPE_CHECKING,
)

if TYPE_CHECKING:
    from stripe._file_link import FileLink


class File(CreateableAPIResource["File"], ListableAPIResource["File"]):
    """
    This object represents files hosted on Stripe's servers. You can upload
    files with the [create file](https://stripe.com/docs/api#create_file) request
    (for example, when uploading dispute evidence). Stripe also
    creates files independently (for example, the results of a [Sigma scheduled
    query](https://stripe.com/docs/api#scheduled_queries)).

    Related guide: [File upload guide](https://stripe.com/docs/file-upload)
    """

    OBJECT_NAME: ClassVar[Literal["file"]] = "file"

    class CreateParams(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        file: Any
        """
        A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
        """
        file_link_data: NotRequired["File.CreateParamsFileLinkData"]
        """
        Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
        """
        purpose: Literal[
            "account_requirement",
            "additional_verification",
            "business_icon",
            "business_logo",
            "customer_signature",
            "dispute_evidence",
            "identity_document",
            "issuing_regulatory_reporting",
            "pci_document",
            "tax_document_user_upload",
            "terminal_reader_splashscreen",
        ]
        """
        The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
        """

    class CreateParamsFileLinkData(TypedDict):
        create: bool
        """
        Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
        """
        expires_at: NotRequired[int]
        """
        The link isn't available after this future timestamp.
        """
        metadata: NotRequired["Literal['']|Dict[str, str]"]
        """
        Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        """

    class ListParams(RequestOptions):
        created: NotRequired["File.ListParamsCreated|int"]
        """
        Only return files that were created during the given date interval.
        """
        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.
        """
        purpose: NotRequired[
            Literal[
                "account_requirement",
                "additional_verification",
                "business_icon",
                "business_logo",
                "customer_signature",
                "dispute_evidence",
                "document_provider_identity_document",
                "finance_report_run",
                "identity_document",
                "identity_document_downloadable",
                "issuing_regulatory_reporting",
                "pci_document",
                "selfie",
                "sigma_scheduled_query",
                "tax_document_user_upload",
                "terminal_reader_splashscreen",
            ]
        ]
        """
        Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
        """
        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 ListParamsCreated(TypedDict):
        gt: NotRequired[int]
        """
        Minimum value to filter by (exclusive)
        """
        gte: NotRequired[int]
        """
        Minimum value to filter by (inclusive)
        """
        lt: NotRequired[int]
        """
        Maximum value to filter by (exclusive)
        """
        lte: NotRequired[int]
        """
        Maximum value to filter by (inclusive)
        """

    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.
    """
    expires_at: Optional[int]
    """
    The file expires and isn't available at this time in epoch seconds.
    """
    filename: Optional[str]
    """
    The suitable name for saving the file to a filesystem.
    """
    id: str
    """
    Unique identifier for the object.
    """
    links: Optional[ListObject["FileLink"]]
    """
    A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
    """
    object: Literal["file"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    purpose: Literal[
        "account_requirement",
        "additional_verification",
        "business_icon",
        "business_logo",
        "customer_signature",
        "dispute_evidence",
        "document_provider_identity_document",
        "finance_report_run",
        "identity_document",
        "identity_document_downloadable",
        "issuing_regulatory_reporting",
        "pci_document",
        "selfie",
        "sigma_scheduled_query",
        "tax_document_user_upload",
        "terminal_reader_splashscreen",
    ]
    """
    The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
    """
    size: int
    """
    The size of the file object in bytes.
    """
    title: Optional[str]
    """
    A suitable title for the document.
    """
    type: Optional[str]
    """
    The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
    """
    url: Optional[str]
    """
    Use your live secret API key to download the file from this URL.
    """

    @classmethod
    def create(cls, **params: Unpack["File.CreateParams"]) -> "File":
        """
        To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

        All of Stripe's officially supported Client libraries support sending multipart/form-data.
        """
        params["content_type"] = "multipart/form-data"

        return cast(
            "File",
            cls._static_request(
                "post",
                cls.class_url(),
                params=params,
                base_address="files",
            ),
        )

    @classmethod
    async def create_async(
        cls, **params: Unpack["File.CreateParams"]
    ) -> "File":
        """
        To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

        All of Stripe's officially supported Client libraries support sending multipart/form-data.
        """
        params["content_type"] = "multipart/form-data"

        return cast(
            "File",
            await cls._static_request_async(
                "post",
                cls.class_url(),
                params=params,
                base_address="files",
            ),
        )

    @classmethod
    def list(cls, **params: Unpack["File.ListParams"]) -> ListObject["File"]:
        """
        Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
        """
        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["File.ListParams"]
    ) -> ListObject["File"]:
        """
        Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
        """
        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["File.RetrieveParams"]
    ) -> "File":
        """
        Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["File.RetrieveParams"]
    ) -> "File":
        """
        Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

    # This resource can have two different object names. In latter API
    # versions, only `file` is used, but since stripe-python may be used with
    # any API version, we need to support deserializing the older
    # `file_upload` object into the same class.
    OBJECT_NAME_ALT = "file_upload"

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


# For backwards compatibility, the `File` class is aliased to `FileUpload`.
FileUpload = File

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._createable_api_resource import CreateableAPIResource	1✔
4	from stripe._list_object import ListObject	1✔
5	from stripe._listable_api_resource import ListableAPIResource	1✔
6	from stripe._request_options import RequestOptions	1✔
7	from typing import Any, ClassVar, Dict, List, Optional, cast	1✔
8	from typing_extensions import (	1✔
9	Literal,
10	NotRequired,
11	TypedDict,
12	Unpack,
13	TYPE_CHECKING,
14	)
15
16	if TYPE_CHECKING:	1!
17	from stripe._file_link import FileLink	×
18
19
20	class File(CreateableAPIResource["File"], ListableAPIResource["File"]):	1✔
21	"""
22	This object represents files hosted on Stripe's servers. You can upload
23	files with the [create file](https://stripe.com/docs/api#create_file) request
24	(for example, when uploading dispute evidence). Stripe also
25	creates files independently (for example, the results of a [Sigma scheduled
26	query](https://stripe.com/docs/api#scheduled_queries)).
27
28	Related guide: [File upload guide](https://stripe.com/docs/file-upload)
29	"""
30
31	OBJECT_NAME: ClassVar[Literal["file"]] = "file"	1✔
32
33	class CreateParams(RequestOptions):	1✔
34	expand: NotRequired[List[str]]	1✔
35	"""	1✔
36	Specifies which fields in the response should be expanded.
37	"""
38	file: Any	1✔
39	"""	1✔
40	A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
41	"""
42	file_link_data: NotRequired["File.CreateParamsFileLinkData"]	1✔
43	"""	1✔
44	Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
45	"""
46	purpose: Literal[	1✔
47	"account_requirement",
48	"additional_verification",
49	"business_icon",
50	"business_logo",
51	"customer_signature",
52	"dispute_evidence",
53	"identity_document",
54	"issuing_regulatory_reporting",
55	"pci_document",
56	"tax_document_user_upload",
57	"terminal_reader_splashscreen",
58	]
59	"""	1✔
60	The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
61	"""
62
63	class CreateParamsFileLinkData(TypedDict):	1✔
64	create: bool	1✔
65	"""	1✔
66	Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
67	"""
68	expires_at: NotRequired[int]	1✔
69	"""	1✔
70	The link isn't available after this future timestamp.
71	"""
72	metadata: NotRequired["Literal['']\|Dict[str, str]"]	1✔
73	"""	1✔
74	Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
75	"""
76
77	class ListParams(RequestOptions):	1✔
78	created: NotRequired["File.ListParamsCreated\|int"]	1✔
79	"""	1✔
80	Only return files that were created during the given date interval.
81	"""
82	ending_before: NotRequired[str]	1✔
83	"""	1✔
84	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.
85	"""
86	expand: NotRequired[List[str]]	1✔
87	"""	1✔
88	Specifies which fields in the response should be expanded.
89	"""
90	limit: NotRequired[int]	1✔
91	"""	1✔
92	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
93	"""
94	purpose: NotRequired[	1✔
95	Literal[
96	"account_requirement",
97	"additional_verification",
98	"business_icon",
99	"business_logo",
100	"customer_signature",
101	"dispute_evidence",
102	"document_provider_identity_document",
103	"finance_report_run",
104	"identity_document",
105	"identity_document_downloadable",
106	"issuing_regulatory_reporting",
107	"pci_document",
108	"selfie",
109	"sigma_scheduled_query",
110	"tax_document_user_upload",
111	"terminal_reader_splashscreen",
112	]
113	]
114	"""	1✔
115	Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
116	"""
117	starting_after: NotRequired[str]	1✔
118	"""	1✔
119	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.
120	"""
121
122	class ListParamsCreated(TypedDict):	1✔
123	gt: NotRequired[int]	1✔
124	"""	1✔
125	Minimum value to filter by (exclusive)
126	"""
127	gte: NotRequired[int]	1✔
128	"""	1✔
129	Minimum value to filter by (inclusive)
130	"""
131	lt: NotRequired[int]	1✔
132	"""	1✔
133	Maximum value to filter by (exclusive)
134	"""
135	lte: NotRequired[int]	1✔
136	"""	1✔
137	Maximum value to filter by (inclusive)
138	"""
139
140	class RetrieveParams(RequestOptions):	1✔
141	expand: NotRequired[List[str]]	1✔
142	"""	1✔
143	Specifies which fields in the response should be expanded.
144	"""
145
146	created: int	1✔
147	"""	1✔
148	Time at which the object was created. Measured in seconds since the Unix epoch.
149	"""
150	expires_at: Optional[int]	1✔
151	"""	1✔
152	The file expires and isn't available at this time in epoch seconds.
153	"""
154	filename: Optional[str]	1✔
155	"""	1✔
156	The suitable name for saving the file to a filesystem.
157	"""
158	id: str	1✔
159	"""	1✔
160	Unique identifier for the object.
161	"""
162	links: Optional[ListObject["FileLink"]]	1✔
163	"""	1✔
164	A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
165	"""
166	object: Literal["file"]	1✔
167	"""	1✔
168	String representing the object's type. Objects of the same type share the same value.
169	"""
170	purpose: Literal[	1✔
171	"account_requirement",
172	"additional_verification",
173	"business_icon",
174	"business_logo",
175	"customer_signature",
176	"dispute_evidence",
177	"document_provider_identity_document",
178	"finance_report_run",
179	"identity_document",
180	"identity_document_downloadable",
181	"issuing_regulatory_reporting",
182	"pci_document",
183	"selfie",
184	"sigma_scheduled_query",
185	"tax_document_user_upload",
186	"terminal_reader_splashscreen",
187	]
188	"""	1✔
189	The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
190	"""
191	size: int	1✔
192	"""	1✔
193	The size of the file object in bytes.
194	"""
195	title: Optional[str]	1✔
196	"""	1✔
197	A suitable title for the document.
198	"""
199	type: Optional[str]	1✔
200	"""	1✔
201	The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
202	"""
203	url: Optional[str]	1✔
204	"""	1✔
205	Use your live secret API key to download the file from this URL.
206	"""
207
208	@classmethod	1✔
209	def create(cls, **params: Unpack["File.CreateParams"]) -> "File":	1✔
210	"""
211	To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
212
213	All of Stripe's officially supported Client libraries support sending multipart/form-data.
214	"""
215	params["content_type"] = "multipart/form-data"	1✔
216
217	return cast(	1✔
218	"File",
219	cls._static_request(
220	"post",
221	cls.class_url(),
222	params=params,
223	base_address="files",
224	),
225	)
226
227	@classmethod	1✔
228	async def create_async(	1✔
229	cls, **params: Unpack["File.CreateParams"]
230	) -> "File":
231	"""
232	To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
233
234	All of Stripe's officially supported Client libraries support sending multipart/form-data.
235	"""
236	params["content_type"] = "multipart/form-data"	1✔
237
238	return cast(	1✔
239	"File",
240	await cls._static_request_async(
241	"post",
242	cls.class_url(),
243	params=params,
244	base_address="files",
245	),
246	)
247
248	@classmethod	1✔
249	def list(cls, **params: Unpack["File.ListParams"]) -> ListObject["File"]:	1✔
250	"""
251	Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
252	"""
253	result = cls._static_request(	1✔
254	"get",
255	cls.class_url(),
256	params=params,
257	)
258	if not isinstance(result, ListObject):	1!
UNCOV 259	raise TypeError(	×
260	"Expected list object from API, got %s"
261	% (type(result).__name__)
262	)
263
264	return result	1✔
265
266	@classmethod	1✔
267	async def list_async(	1✔
268	cls, **params: Unpack["File.ListParams"]
269	) -> ListObject["File"]:
270	"""
271	Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
272	"""
273	result = await cls._static_request_async(	1✔
274	"get",
275	cls.class_url(),
276	params=params,
277	)
278	if not isinstance(result, ListObject):	1!
UNCOV 279	raise TypeError(	×
280	"Expected list object from API, got %s"
281	% (type(result).__name__)
282	)
283
284	return result	1✔
285
286	@classmethod	1✔
287	def retrieve(	1✔
288	cls, id: str, **params: Unpack["File.RetrieveParams"]
289	) -> "File":
290	"""
291	Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
292	"""
293	instance = cls(id, **params)	1✔
294	instance.refresh()	1✔
295	return instance	1✔
296
297	@classmethod	1✔
298	async def retrieve_async(	1✔
299	cls, id: str, **params: Unpack["File.RetrieveParams"]
300	) -> "File":
301	"""
302	Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to [access file contents](https://stripe.com/docs/file-upload#download-file-contents).
303	"""
304	instance = cls(id, **params)	1✔
305	await instance.refresh_async()	1✔
306	return instance	1✔
307
308	# This resource can have two different object names. In latter API
309	# versions, only `file` is used, but since stripe-python may be used with
310	# any API version, we need to support deserializing the older
311	# `file_upload` object into the same class.
312	OBJECT_NAME_ALT = "file_upload"	1✔
313
314	@classmethod	1✔
315	def class_url(cls):	1✔
316	return "/v1/files"	1✔
317
318
319	# For backwards compatibility, the `File` class is aliased to `FileUpload`.
320	FileUpload = File	1✔

stripe / stripe-python / 11732212718

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