8428812894

Committed 26 Mar 2024 12:20AM UTC coverage: 97.439% (-0.003%) from 97.442%

Build # 8428812894

Build Type

Pull #1276

github

Committed by

web-flow

Commit Message

Merge 40d73d071 into cd6c5b3e2

Pull Request Pull Request #1276: Update generated code

Run Details

895 of 1350 branches covered (66.3%)

Branch coverage included in aggregate %.

61 of 64 new or added lines in 16 files covered. (95.31%)

269 existing lines in 42 files now uncovered.

56553 of 57608 relevant lines covered (98.17%)

0.98 hits per line

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

98.08

/stripe/_invoice_line_item_service.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._invoice_line_item import InvoiceLineItem
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict


class InvoiceLineItemService(StripeService):
    class ListParams(TypedDict):
        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 UpdateParams(TypedDict):
        amount: NotRequired[int]
        """
        The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
        """
        description: NotRequired[str]
        """
        An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
        """
        discountable: NotRequired[bool]
        """
        Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
        """
        discounts: NotRequired[
            "Literal['']|List[InvoiceLineItemService.UpdateParamsDiscount]"
        ]
        """
        The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        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`.
        """
        period: NotRequired["InvoiceLineItemService.UpdateParamsPeriod"]
        """
        The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
        """
        price: NotRequired[str]
        """
        The ID of the price object.
        """
        price_data: NotRequired["InvoiceLineItemService.UpdateParamsPriceData"]
        """
        Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
        """
        quantity: NotRequired[int]
        """
        Non-negative integer. The quantity of units for the line item.
        """
        tax_amounts: NotRequired[
            "Literal['']|List[InvoiceLineItemService.UpdateParamsTaxAmount]"
        ]
        """
        A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
        """
        tax_rates: NotRequired["Literal['']|List[str]"]
        """
        The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
        """

    class UpdateParamsDiscount(TypedDict):
        coupon: NotRequired[str]
        """
        ID of the coupon to create a new discount for.
        """
        discount: NotRequired[str]
        """
        ID of an existing discount on the object (or one of its ancestors) to reuse.
        """

    class UpdateParamsPeriod(TypedDict):
        end: int
        """
        The end of the period, which must be greater than or equal to the start. This value is inclusive.
        """
        start: int
        """
        The start of the period. This value is inclusive.
        """

    class UpdateParamsPriceData(TypedDict):
        currency: str
        """
        Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
        """
        product: NotRequired[str]
        """
        The ID of the product that this price will belong to. One of `product` or `product_data` is required.
        """
        product_data: NotRequired[
            "InvoiceLineItemService.UpdateParamsPriceDataProductData"
        ]
        """
        Data used to generate a new product object inline. One of `product` or `product_data` is required.
        """
        tax_behavior: NotRequired[
            Literal["exclusive", "inclusive", "unspecified"]
        ]
        """
        Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
        """
        unit_amount: NotRequired[int]
        """
        A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
        """
        unit_amount_decimal: NotRequired[str]
        """
        Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
        """

    class UpdateParamsPriceDataProductData(TypedDict):
        description: NotRequired[str]
        """
        The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
        """
        images: NotRequired[List[str]]
        """
        A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
        """
        metadata: NotRequired[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`.
        """
        name: str
        """
        The product's name, meant to be displayable to the customer.
        """
        tax_code: NotRequired[str]
        """
        A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
        """

    class UpdateParamsTaxAmount(TypedDict):
        amount: int
        """
        The amount, in cents (or local equivalent), of the tax.
        """
        tax_rate_data: "InvoiceLineItemService.UpdateParamsTaxAmountTaxRateData"
        """
        Data to find or create a TaxRate object.

        Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item's `tax_rates`, and cannot be directly added to invoices, payments, or line items.
        """
        taxable_amount: int
        """
        The amount on which tax is calculated, in cents (or local equivalent).
        """

    class UpdateParamsTaxAmountTaxRateData(TypedDict):
        country: NotRequired[str]
        """
        Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
        """
        description: NotRequired[str]
        """
        An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
        """
        display_name: str
        """
        The display name of the tax rate, which will be shown to users.
        """
        inclusive: bool
        """
        This specifies if the tax rate is inclusive or exclusive.
        """
        jurisdiction: NotRequired[str]
        """
        The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
        """
        percentage: float
        """
        The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
        """
        state: NotRequired[str]
        """
        [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
        """
        tax_type: NotRequired[
            Literal[
                "amusement_tax",
                "communications_tax",
                "gst",
                "hst",
                "igst",
                "jct",
                "lease_tax",
                "pst",
                "qst",
                "rst",
                "sales_tax",
                "vat",
                "service_tax",
            ]
        ]
        """
        The high-level tax type, such as `vat` or `sales_tax`.
        """

    def list(
        self,
        invoice: str,
        params: "InvoiceLineItemService.ListParams" = {},
        options: RequestOptions = {},
    ) -> ListObject[InvoiceLineItem]:
        """
        When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
        """
        return cast(
            ListObject[InvoiceLineItem],
            self._request(
                "get",
                "/v1/invoices/{invoice}/lines".format(
                    invoice=sanitize_id(invoice),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def update(
        self,
        invoice: str,
        line_item_id: str,
        params: "InvoiceLineItemService.UpdateParams" = {},
        options: RequestOptions = {},
    ) -> InvoiceLineItem:
        """
        Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
        so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
        item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
        Updating an invoice's line item is only possible before the invoice is finalized.
        """
        return cast(
            InvoiceLineItem,
            self._request(
                "post",
                "/v1/invoices/{invoice}/lines/{line_item_id}".format(
                    invoice=sanitize_id(invoice),
                    line_item_id=sanitize_id(line_item_id),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._invoice_line_item import InvoiceLineItem	1✔
4	from stripe._list_object import ListObject	1✔
5	from stripe._request_options import RequestOptions	1✔
6	from stripe._stripe_service import StripeService	1✔
7	from stripe._util import sanitize_id	1✔
8	from typing import Dict, List, cast	1✔
9	from typing_extensions import Literal, NotRequired, TypedDict	1✔
10
11
12	class InvoiceLineItemService(StripeService):	1✔
13	class ListParams(TypedDict):	1✔
14	ending_before: NotRequired[str]	1✔
15	"""	1✔
16	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.
17	"""
18	expand: NotRequired[List[str]]	1✔
19	"""	1✔
20	Specifies which fields in the response should be expanded.
21	"""
22	limit: NotRequired[int]	1✔
23	"""	1✔
24	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
25	"""
26	starting_after: NotRequired[str]	1✔
27	"""	1✔
28	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.
29	"""
30
31	class UpdateParams(TypedDict):	1✔
32	amount: NotRequired[int]	1✔
33	"""	1✔
34	The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
35	"""
36	description: NotRequired[str]	1✔
37	"""	1✔
38	An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
39	"""
40	discountable: NotRequired[bool]	1✔
41	"""	1✔
42	Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
43	"""
44	discounts: NotRequired[	1✔
45	"Literal['']\|List[InvoiceLineItemService.UpdateParamsDiscount]"
46	]
47	"""	1✔
48	The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
49	"""
50	expand: NotRequired[List[str]]	1✔
51	"""	1✔
52	Specifies which fields in the response should be expanded.
53	"""
54	metadata: NotRequired["Literal['']\|Dict[str, str]"]	1✔
55	"""	1✔
56	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`.
57	"""
58	period: NotRequired["InvoiceLineItemService.UpdateParamsPeriod"]	1✔
59	"""	1✔
60	The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
61	"""
62	price: NotRequired[str]	1✔
63	"""	1✔
64	The ID of the price object.
65	"""
66	price_data: NotRequired["InvoiceLineItemService.UpdateParamsPriceData"]	1✔
67	"""	1✔
68	Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
69	"""
70	quantity: NotRequired[int]	1✔
71	"""	1✔
72	Non-negative integer. The quantity of units for the line item.
73	"""
74	tax_amounts: NotRequired[	1✔
75	"Literal['']\|List[InvoiceLineItemService.UpdateParamsTaxAmount]"
76	]
77	"""	1✔
78	A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.
79	"""
80	tax_rates: NotRequired["Literal['']\|List[str]"]	1✔
81	"""	1✔
82	The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.
83	"""
84
85	class UpdateParamsDiscount(TypedDict):	1✔
86	coupon: NotRequired[str]	1✔
87	"""	1✔
88	ID of the coupon to create a new discount for.
89	"""
90	discount: NotRequired[str]	1✔
91	"""	1✔
92	ID of an existing discount on the object (or one of its ancestors) to reuse.
93	"""
94
95	class UpdateParamsPeriod(TypedDict):	1✔
96	end: int	1✔
97	"""	1✔
98	The end of the period, which must be greater than or equal to the start. This value is inclusive.
99	"""
100	start: int	1✔
101	"""	1✔
102	The start of the period. This value is inclusive.
103	"""
104
105	class UpdateParamsPriceData(TypedDict):	1✔
106	currency: str	1✔
107	"""	1✔
108	Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
109	"""
110	product: NotRequired[str]	1✔
111	"""	1✔
112	The ID of the product that this price will belong to. One of `product` or `product_data` is required.
113	"""
114	product_data: NotRequired[	1✔
115	"InvoiceLineItemService.UpdateParamsPriceDataProductData"
116	]
117	"""	1✔
118	Data used to generate a new product object inline. One of `product` or `product_data` is required.
119	"""
120	tax_behavior: NotRequired[	1✔
121	Literal["exclusive", "inclusive", "unspecified"]
122	]
123	"""	1✔
124	Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
125	"""
126	unit_amount: NotRequired[int]	1✔
127	"""	1✔
128	A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
129	"""
130	unit_amount_decimal: NotRequired[str]	1✔
131	"""	1✔
132	Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
133	"""
134
135	class UpdateParamsPriceDataProductData(TypedDict):	1✔
136	description: NotRequired[str]	1✔
137	"""	1✔
138	The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
139	"""
140	images: NotRequired[List[str]]	1✔
141	"""	1✔
142	A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
143	"""
144	metadata: NotRequired[Dict[str, str]]	1✔
145	"""	1✔
146	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`.
147	"""
148	name: str	1✔
149	"""	1✔
150	The product's name, meant to be displayable to the customer.
151	"""
152	tax_code: NotRequired[str]	1✔
153	"""	1✔
154	A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
155	"""
156
157	class UpdateParamsTaxAmount(TypedDict):	1✔
158	amount: int	1✔
159	"""	1✔
160	The amount, in cents (or local equivalent), of the tax.
161	"""
162	tax_rate_data: "InvoiceLineItemService.UpdateParamsTaxAmountTaxRateData"	1✔
163	"""	1✔
164	Data to find or create a TaxRate object.
165
166	Stripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item's `tax_rates`, and cannot be directly added to invoices, payments, or line items.
167	"""
168	taxable_amount: int	1✔
169	"""	1✔
170	The amount on which tax is calculated, in cents (or local equivalent).
171	"""
172
173	class UpdateParamsTaxAmountTaxRateData(TypedDict):	1✔
174	country: NotRequired[str]	1✔
175	"""	1✔
176	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
177	"""
178	description: NotRequired[str]	1✔
179	"""	1✔
180	An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
181	"""
182	display_name: str	1✔
183	"""	1✔
184	The display name of the tax rate, which will be shown to users.
185	"""
186	inclusive: bool	1✔
187	"""	1✔
188	This specifies if the tax rate is inclusive or exclusive.
189	"""
190	jurisdiction: NotRequired[str]	1✔
191	"""	1✔
192	The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer's invoice.
193	"""
194	percentage: float	1✔
195	"""	1✔
196	The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.
197	"""
198	state: NotRequired[str]	1✔
199	"""	1✔
200	[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
201	"""
202	tax_type: NotRequired[	1✔
203	Literal[
204	"amusement_tax",
205	"communications_tax",
206	"gst",
207	"hst",
208	"igst",
209	"jct",
210	"lease_tax",
211	"pst",
212	"qst",
213	"rst",
214	"sales_tax",
215	"vat",
216	"service_tax",
217	]
218	]
219	"""	1✔
220	The high-level tax type, such as `vat` or `sales_tax`.
221	"""
222
223	def list(	1✔
224	self,
225	invoice: str,
226	params: "InvoiceLineItemService.ListParams" = {},
227	options: RequestOptions = {},
228	) -> ListObject[InvoiceLineItem]:
229	"""
230	When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
231	"""
UNCOV 232	return cast(	×
233	ListObject[InvoiceLineItem],
234	self._request(
235	"get",
236	"/v1/invoices/{invoice}/lines".format(
237	invoice=sanitize_id(invoice),
238	),
239	api_mode="V1",
240	base_address="api",
241	params=params,
242	options=options,
243	),
244	)
245
246	def update(	1✔
247	self,
248	invoice: str,
249	line_item_id: str,
250	params: "InvoiceLineItemService.UpdateParams" = {},
251	options: RequestOptions = {},
252	) -> InvoiceLineItem:
253	"""
254	Updates an invoice's line item. Some fields, such as tax_amounts, only live on the invoice line item,
255	so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice
256	item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.
257	Updating an invoice's line item is only possible before the invoice is finalized.
258	"""
UNCOV 259	return cast(	×
260	InvoiceLineItem,
261	self._request(
262	"post",
263	"/v1/invoices/{invoice}/lines/{line_item_id}".format(
264	invoice=sanitize_id(invoice),
265	line_item_id=sanitize_id(line_item_id),
266	),
267	api_mode="V1",
268	base_address="api",
269	params=params,
270	options=options,
271	),
272	)

stripe / stripe-python / 8428812894

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