Skip to content

Commit

Permalink
Update generated code for v1380
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe-openapi[bot] committed Nov 26, 2024
1 parent ddbc46c commit e849644
Show file tree
Hide file tree
Showing 13 changed files with 89 additions and 90 deletions.
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1378
v1380
6 changes: 3 additions & 3 deletions stripe/billing/_credit_balance_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ class RetrieveParamsFilter(TypedDict):
class RetrieveParamsFilterApplicabilityScope(TypedDict):
price_type: Literal["metered"]
"""
The price type for which credit grants can apply. We currently only support the `metered` price type.
The price type that credit grants can apply to. We currently only support the `metered` price type.
"""

balances: List[Balance]
Expand All @@ -134,7 +134,7 @@ def retrieve(
cls, **params: Unpack["CreditBalanceSummary.RetrieveParams"]
) -> "CreditBalanceSummary":
"""
Retrieves the credit balance summary for a customer
Retrieves the credit balance summary for a customer.
"""
instance = cls(None, **params)
instance.refresh()
Expand All @@ -145,7 +145,7 @@ async def retrieve_async(
cls, **params: Unpack["CreditBalanceSummary.RetrieveParams"]
) -> "CreditBalanceSummary":
"""
Retrieves the credit balance summary for a customer
Retrieves the credit balance summary for a customer.
"""
instance = cls(None, **params)
await instance.refresh_async()
Expand Down
6 changes: 3 additions & 3 deletions stripe/billing/_credit_balance_summary_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ class RetrieveParamsFilter(TypedDict):
class RetrieveParamsFilterApplicabilityScope(TypedDict):
price_type: Literal["metered"]
"""
The price type for which credit grants can apply. We currently only support the `metered` price type.
The price type that credit grants can apply to. We currently only support the `metered` price type.
"""

def retrieve(
Expand All @@ -50,7 +50,7 @@ def retrieve(
options: RequestOptions = {},
) -> CreditBalanceSummary:
"""
Retrieves the credit balance summary for a customer
Retrieves the credit balance summary for a customer.
"""
return cast(
CreditBalanceSummary,
Expand All @@ -69,7 +69,7 @@ async def retrieve_async(
options: RequestOptions = {},
) -> CreditBalanceSummary:
"""
Retrieves the credit balance summary for a customer
Retrieves the credit balance summary for a customer.
"""
return cast(
CreditBalanceSummary,
Expand Down
8 changes: 4 additions & 4 deletions stripe/billing/_credit_balance_transaction.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ def list(
cls, **params: Unpack["CreditBalanceTransaction.ListParams"]
) -> ListObject["CreditBalanceTransaction"]:
"""
Retrieve a list of credit balance transactions
Retrieve a list of credit balance transactions.
"""
result = cls._static_request(
"get",
Expand All @@ -198,7 +198,7 @@ async def list_async(
cls, **params: Unpack["CreditBalanceTransaction.ListParams"]
) -> ListObject["CreditBalanceTransaction"]:
"""
Retrieve a list of credit balance transactions
Retrieve a list of credit balance transactions.
"""
result = await cls._static_request_async(
"get",
Expand All @@ -220,7 +220,7 @@ def retrieve(
**params: Unpack["CreditBalanceTransaction.RetrieveParams"],
) -> "CreditBalanceTransaction":
"""
Retrieves a credit balance transaction
Retrieves a credit balance transaction.
"""
instance = cls(id, **params)
instance.refresh()
Expand All @@ -233,7 +233,7 @@ async def retrieve_async(
**params: Unpack["CreditBalanceTransaction.RetrieveParams"],
) -> "CreditBalanceTransaction":
"""
Retrieves a credit balance transaction
Retrieves a credit balance transaction.
"""
instance = cls(id, **params)
await instance.refresh_async()
Expand Down
8 changes: 4 additions & 4 deletions stripe/billing/_credit_balance_transaction_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def list(
options: RequestOptions = {},
) -> ListObject[CreditBalanceTransaction]:
"""
Retrieve a list of credit balance transactions
Retrieve a list of credit balance transactions.
"""
return cast(
ListObject[CreditBalanceTransaction],
Expand All @@ -67,7 +67,7 @@ async def list_async(
options: RequestOptions = {},
) -> ListObject[CreditBalanceTransaction]:
"""
Retrieve a list of credit balance transactions
Retrieve a list of credit balance transactions.
"""
return cast(
ListObject[CreditBalanceTransaction],
Expand All @@ -87,7 +87,7 @@ def retrieve(
options: RequestOptions = {},
) -> CreditBalanceTransaction:
"""
Retrieves a credit balance transaction
Retrieves a credit balance transaction.
"""
return cast(
CreditBalanceTransaction,
Expand All @@ -109,7 +109,7 @@ async def retrieve_async(
options: RequestOptions = {},
) -> CreditBalanceTransaction:
"""
Retrieves a credit balance transaction
Retrieves a credit balance transaction.
"""
return cast(
CreditBalanceTransaction,
Expand Down
26 changes: 13 additions & 13 deletions stripe/billing/_credit_grant.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ class ApplicabilityConfig(StripeObject):
class Scope(StripeObject):
price_type: Literal["metered"]
"""
The price type for which credit grants can apply. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
"""

scope: Scope
Expand All @@ -87,19 +87,19 @@ class CreateParams(RequestOptions):
"""
effective_at: NotRequired[int]
"""
The time when the billing credits become effectivewhen they're eligible for use. Defaults to the current timestamp if not specified.
The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
expires_at: NotRequired[int]
"""
The time when the billing credits will expire. If not specified, the billing credits don't expire.
The time when the billing credits expire. If not specified, the billing credits don't expire.
"""
metadata: NotRequired[Dict[str, str]]
"""
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
"""
name: NotRequired[str]
"""
Expand Down Expand Up @@ -135,7 +135,7 @@ class CreateParamsApplicabilityConfig(TypedDict):
class CreateParamsApplicabilityConfigScope(TypedDict):
price_type: Literal["metered"]
"""
The price type for which credit grants can apply. We currently only support the `metered` price type.
The price type that credit grants can apply to. We currently only support the `metered` price type.
"""

class ExpireParams(RequestOptions):
Expand Down Expand Up @@ -177,7 +177,7 @@ class ModifyParams(RequestOptions):
"""
metadata: NotRequired[Dict[str, str]]
"""
Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
"""

class RetrieveParams(RequestOptions):
Expand Down Expand Up @@ -208,7 +208,7 @@ class VoidGrantParams(RequestOptions):
"""
effective_at: Optional[int]
"""
The time when the billing credits become effectivewhen they're eligible for use.
The time when the billing credits become effective-when they're eligible for use.
"""
expires_at: Optional[int]
"""
Expand Down Expand Up @@ -252,7 +252,7 @@ def create(
cls, **params: Unpack["CreditGrant.CreateParams"]
) -> "CreditGrant":
"""
Creates a credit grant
Creates a credit grant.
"""
return cast(
"CreditGrant",
Expand All @@ -268,7 +268,7 @@ async def create_async(
cls, **params: Unpack["CreditGrant.CreateParams"]
) -> "CreditGrant":
"""
Creates a credit grant
Creates a credit grant.
"""
return cast(
"CreditGrant",
Expand Down Expand Up @@ -434,7 +434,7 @@ def modify(
cls, id: str, **params: Unpack["CreditGrant.ModifyParams"]
) -> "CreditGrant":
"""
Updates a credit grant
Updates a credit grant.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
Expand All @@ -451,7 +451,7 @@ async def modify_async(
cls, id: str, **params: Unpack["CreditGrant.ModifyParams"]
) -> "CreditGrant":
"""
Updates a credit grant
Updates a credit grant.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
Expand All @@ -468,7 +468,7 @@ def retrieve(
cls, id: str, **params: Unpack["CreditGrant.RetrieveParams"]
) -> "CreditGrant":
"""
Retrieves a credit grant
Retrieves a credit grant.
"""
instance = cls(id, **params)
instance.refresh()
Expand All @@ -479,7 +479,7 @@ async def retrieve_async(
cls, id: str, **params: Unpack["CreditGrant.RetrieveParams"]
) -> "CreditGrant":
"""
Retrieves a credit grant
Retrieves a credit grant.
"""
instance = cls(id, **params)
await instance.refresh_async()
Expand Down
22 changes: 11 additions & 11 deletions stripe/billing/_credit_grant_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,19 @@ class CreateParams(TypedDict):
"""
effective_at: NotRequired[int]
"""
The time when the billing credits become effectivewhen they're eligible for use. Defaults to the current timestamp if not specified.
The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
expires_at: NotRequired[int]
"""
The time when the billing credits will expire. If not specified, the billing credits don't expire.
The time when the billing credits expire. If not specified, the billing credits don't expire.
"""
metadata: NotRequired[Dict[str, str]]
"""
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
Set of key-value pairs that you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
"""
name: NotRequired[str]
"""
Expand Down Expand Up @@ -79,7 +79,7 @@ class CreateParamsApplicabilityConfig(TypedDict):
class CreateParamsApplicabilityConfigScope(TypedDict):
price_type: Literal["metered"]
"""
The price type for which credit grants can apply. We currently only support the `metered` price type.
The price type that credit grants can apply to. We currently only support the `metered` price type.
"""

class ExpireParams(TypedDict):
Expand Down Expand Up @@ -127,7 +127,7 @@ class UpdateParams(TypedDict):
"""
metadata: NotRequired[Dict[str, str]]
"""
Set of key-value pairs you can attach to an object. This can be useful for storing additional information about the object (for example, cost basis) in a structured format.
Set of key-value pairs you can attach to an object. You can use this to store additional information about the object (for example, cost basis) in a structured format.
"""

class VoidGrantParams(TypedDict):
Expand Down Expand Up @@ -180,7 +180,7 @@ def create(
options: RequestOptions = {},
) -> CreditGrant:
"""
Creates a credit grant
Creates a credit grant.
"""
return cast(
CreditGrant,
Expand All @@ -199,7 +199,7 @@ async def create_async(
options: RequestOptions = {},
) -> CreditGrant:
"""
Creates a credit grant
Creates a credit grant.
"""
return cast(
CreditGrant,
Expand All @@ -219,7 +219,7 @@ def retrieve(
options: RequestOptions = {},
) -> CreditGrant:
"""
Retrieves a credit grant
Retrieves a credit grant.
"""
return cast(
CreditGrant,
Expand All @@ -239,7 +239,7 @@ async def retrieve_async(
options: RequestOptions = {},
) -> CreditGrant:
"""
Retrieves a credit grant
Retrieves a credit grant.
"""
return cast(
CreditGrant,
Expand All @@ -259,7 +259,7 @@ def update(
options: RequestOptions = {},
) -> CreditGrant:
"""
Updates a credit grant
Updates a credit grant.
"""
return cast(
CreditGrant,
Expand All @@ -279,7 +279,7 @@ async def update_async(
options: RequestOptions = {},
) -> CreditGrant:
"""
Updates a credit grant
Updates a credit grant.
"""
return cast(
CreditGrant,
Expand Down
Loading

0 comments on commit e849644

Please sign in to comment.