stripe: update a few signatures (#7978)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>

stubs/stripe/stripe/__init__.pyi

@@ -4,7 +4,7 @@ from stripe.api_resources import *
 from stripe.oauth import OAuth as OAuth
 from stripe.webhook import Webhook as Webhook, WebhookSignature as WebhookSignature
 
-api_key: Any
+api_key: str | None
 client_id: Any
 api_base: str
 connect_api_base: str

stubs/stripe/stripe/api_resources/abstract/api_resource.pyi

@@ -1,3 +1,4 @@
+from _typeshed import Self
 from typing import Any
 
 from stripe import api_requestor as api_requestor, error as error
@@ -5,8 +6,8 @@ from stripe.stripe_object import StripeObject as StripeObject
 
 class APIResource(StripeObject):
     @classmethod
-    def retrieve(cls, id, api_key: Any | None = ..., **params): ...
-    def refresh(self): ...
+    def retrieve(cls: type[Self], id, api_key: Any | None = ..., **params) -> Self: ...
+    def refresh(self: Self) -> Self: ...
     @classmethod
-    def class_url(cls): ...
-    def instance_url(self): ...
+    def class_url(cls) -> str: ...
+    def instance_url(self) -> str: ...

stubs/stripe/stripe/api_resources/abstract/createable_api_resource.pyi

@@ -1,3 +1,4 @@
+from _typeshed import Self
 from typing import Any
 
 from stripe import api_requestor as api_requestor
@@ -6,10 +7,10 @@ from stripe.api_resources.abstract.api_resource import APIResource as APIResourc
 class CreateableAPIResource(APIResource):
     @classmethod
     def create(
-        cls,
+        cls: type[Self],
         api_key: Any | None = ...,
         idempotency_key: Any | None = ...,
         stripe_version: Any | None = ...,
         stripe_account: Any | None = ...,
         **params,
-    ): ...
+    ) -> Self: ...

stubs/stripe/stripe/api_resources/abstract/listable_api_resource.pyi

@@ -1,10 +1,14 @@
+from collections.abc import Iterator
 from typing import Any
 
 from stripe import api_requestor as api_requestor
 from stripe.api_resources.abstract.api_resource import APIResource as APIResource
+from stripe.api_resources.list_object import ListObject
 
 class ListableAPIResource(APIResource):
     @classmethod
-    def auto_paging_iter(cls, *args, **params): ...
+    def auto_paging_iter(cls, *args, **params) -> Iterator[Any]: ...
     @classmethod
-    def list(cls, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params): ...
+    def list(
+        cls, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
+    ) -> ListObject: ...

stubs/stripe/stripe/api_resources/abstract/updateable_api_resource.pyi

@@ -1,8 +1,8 @@
-from typing import Any
+from _typeshed import Self
 
 from stripe.api_resources.abstract.api_resource import APIResource as APIResource
 
 class UpdateableAPIResource(APIResource):
     @classmethod
-    def modify(cls, sid, **params): ...
-    def save(self, idempotency_key: Any | None = ...): ...
+    def modify(cls: type[Self], sid: str, **params) -> Self: ...
+    def save(self: Self, idempotency_key: str | None = ...) -> Self: ...

stubs/stripe/stripe/api_resources/alipay_account.pyi

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe.api_resources.abstract import (
     DeletableAPIResource as DeletableAPIResource,
@@ -14,4 +14,4 @@ class AlipayAccount(DeletableAPIResource, UpdateableAPIResource):
     @classmethod
     def retrieve(
         cls, id, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
-    ) -> None: ...
+    ) -> NoReturn: ...

stubs/stripe/stripe/api_resources/application_fee_refund.pyi

@@ -1,4 +1,5 @@
-from typing import Any
+from _typeshed import Self
+from typing import Any, NoReturn
 
 from stripe.api_resources import ApplicationFee as ApplicationFee
 from stripe.api_resources.abstract import UpdateableAPIResource as UpdateableAPIResource
@@ -6,7 +7,7 @@ from stripe.api_resources.abstract import UpdateableAPIResource as UpdateableAPI
 class ApplicationFeeRefund(UpdateableAPIResource):
     OBJECT_NAME: str
     @classmethod
-    def modify(cls, fee, sid, **params): ...
-    def instance_url(self): ...
+    def modify(cls: type[Self], fee, sid: str, **params) -> Self: ...  # type: ignore[override]
+    def instance_url(self) -> str: ...
     @classmethod
-    def retrieve(cls, id, api_key: Any | None = ..., **params) -> None: ...
+    def retrieve(cls, id, api_key: Any | None = ..., **params) -> NoReturn: ...

stubs/stripe/stripe/api_resources/bank_account.pyi

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe import error as error
 from stripe.api_resources.abstract import (
@@ -11,10 +11,10 @@ from stripe.api_resources.customer import Customer as Customer
 
 class BankAccount(DeletableAPIResource, UpdateableAPIResource, VerifyMixin):
     OBJECT_NAME: str
-    def instance_url(self): ...
+    def instance_url(self) -> str: ...
     @classmethod
-    def modify(cls, sid, **params) -> None: ...
+    def modify(cls, sid, **params) -> NoReturn: ...
     @classmethod
     def retrieve(
         cls, id, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
-    ) -> None: ...
+    ) -> NoReturn: ...

stubs/stripe/stripe/api_resources/capability.pyi

@@ -1,12 +1,12 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe.api_resources.abstract import UpdateableAPIResource as UpdateableAPIResource
 from stripe.api_resources.account import Account as Account
 
 class Capability(UpdateableAPIResource):
     OBJECT_NAME: str
-    def instance_url(self): ...
+    def instance_url(self) -> str: ...
     @classmethod
-    def modify(cls, sid, **params) -> None: ...
+    def modify(cls, sid, **params) -> NoReturn: ...
     @classmethod
-    def retrieve(cls, id, api_key: Any | None = ..., **params) -> None: ...
+    def retrieve(cls, id, api_key: Any | None = ..., **params) -> NoReturn: ...

stubs/stripe/stripe/api_resources/card.pyi

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe import error as error
 from stripe.api_resources.abstract import (
@@ -11,10 +11,10 @@ from stripe.api_resources.recipient import Recipient as Recipient
 
 class Card(DeletableAPIResource, UpdateableAPIResource):
     OBJECT_NAME: str
-    def instance_url(self): ...
+    def instance_url(self) -> str: ...
     @classmethod
-    def modify(cls, sid, **params) -> None: ...
+    def modify(cls, sid, **params) -> NoReturn: ...
     @classmethod
     def retrieve(
         cls, id, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
-    ) -> None: ...
+    ) -> NoReturn: ...

stubs/stripe/stripe/api_resources/customer_balance_transaction.pyi

@@ -1,10 +1,10 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe.api_resources.abstract import APIResource as APIResource
 from stripe.api_resources.customer import Customer as Customer
 
 class CustomerBalanceTransaction(APIResource):
     OBJECT_NAME: str
-    def instance_url(self): ...
+    def instance_url(self) -> str: ...
     @classmethod
-    def retrieve(cls, id, api_key: Any | None = ..., **params) -> None: ...
+    def retrieve(cls, id, api_key: Any | None = ..., **params) -> NoReturn: ...

stubs/stripe/stripe/api_resources/invoice.pyi

@@ -1,3 +1,4 @@
+from _typeshed import Self
 from typing import Any
 
 from stripe import api_requestor as api_requestor
@@ -11,12 +12,12 @@ from stripe.api_resources.abstract import (
 
 class Invoice(CreateableAPIResource, DeletableAPIResource, ListableAPIResource, UpdateableAPIResource):
     OBJECT_NAME: str
-    def finalize_invoice(self, idempotency_key: Any | None = ..., **params): ...
-    def mark_uncollectible(self, idempotency_key: Any | None = ..., **params): ...
-    def pay(self, idempotency_key: Any | None = ..., **params): ...
-    def send_invoice(self, idempotency_key: Any | None = ..., **params): ...
-    def void_invoice(self, idempotency_key: Any | None = ..., **params): ...
+    def finalize_invoice(self: Self, idempotency_key: str | None = ..., **params) -> Self: ...
+    def mark_uncollectible(self: Self, idempotency_key: str | None = ..., **params) -> Self: ...
+    def pay(self: Self, idempotency_key: str | None = ..., **params) -> Self: ...
+    def send_invoice(self: Self, idempotency_key: str | None = ..., **params) -> Self: ...
+    def void_invoice(self: Self, idempotency_key: str | None = ..., **params) -> Self: ...
     @classmethod
     def upcoming(
         cls, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
-    ): ...
+    ) -> Invoice: ...

stubs/stripe/stripe/api_resources/list_object.pyi

@@ -1,4 +1,4 @@
-from collections.abc import Generator
+from collections.abc import Iterator
 from typing import Any
 
 from stripe import api_requestor as api_requestor
@@ -6,7 +6,9 @@ from stripe.stripe_object import StripeObject as StripeObject
 
 class ListObject(StripeObject):
     OBJECT_NAME: str
-    def list(self, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params): ...
+    def list(
+        self, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
+    ) -> ListObject: ...
     def create(
         self,
         api_key: Any | None = ...,
@@ -20,16 +22,18 @@ class ListObject(StripeObject):
     ): ...
     def __getitem__(self, k): ...
     def __iter__(self): ...
-    def __len__(self): ...
+    def __len__(self) -> int: ...
     def __reversed__(self): ...
-    def auto_paging_iter(self) -> Generator[Any, None, None]: ...
+    def auto_paging_iter(self) -> Iterator[Any]: ...
     @classmethod
-    def empty_list(cls, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ...): ...
+    def empty_list(
+        cls, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ...
+    ) -> ListObject: ...
     @property
-    def is_empty(self): ...
+    def is_empty(self) -> bool: ...
     def next_page(
         self, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
-    ): ...
+    ) -> ListObject: ...
     def previous_page(
         self, api_key: Any | None = ..., stripe_version: Any | None = ..., stripe_account: Any | None = ..., **params
-    ): ...
+    ) -> ListObject: ...

stubs/stripe/stripe/api_resources/payment_method.pyi

@@ -1,4 +1,4 @@
-from typing import Any
+from _typeshed import Self
 
 from stripe.api_resources.abstract import (
     CreateableAPIResource as CreateableAPIResource,
@@ -9,5 +9,5 @@ from stripe.api_resources.abstract import (
 
 class PaymentMethod(CreateableAPIResource, ListableAPIResource, UpdateableAPIResource):
     OBJECT_NAME: str
-    def attach(self, idempotency_key: Any | None = ..., **params): ...
-    def detach(self, idempotency_key: Any | None = ..., **params): ...
+    def attach(self: Self, idempotency_key: str | None = ..., **params) -> Self: ...
+    def detach(self: Self, idempotency_key: str | None = ..., **params) -> Self: ...

stubs/stripe/stripe/api_resources/person.pyi

@@ -1,12 +1,12 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe.api_resources.abstract import UpdateableAPIResource as UpdateableAPIResource
 from stripe.api_resources.account import Account as Account
 
 class Person(UpdateableAPIResource):
     OBJECT_NAME: str
-    def instance_url(self): ...
+    def instance_url(self) -> str: ...
     @classmethod
-    def modify(cls, sid, **params) -> None: ...
+    def modify(cls, sid, **params) -> NoReturn: ...
     @classmethod
-    def retrieve(cls, id, api_key: Any | None = ..., **params) -> None: ...
+    def retrieve(cls, id, api_key: Any | None = ..., **params) -> NoReturn: ...

stubs/stripe/stripe/api_resources/reversal.pyi

@@ -1,12 +1,12 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe.api_resources.abstract import UpdateableAPIResource as UpdateableAPIResource
 from stripe.api_resources.transfer import Transfer as Transfer
 
 class Reversal(UpdateableAPIResource):
     OBJECT_NAME: str
-    def instance_url(self): ...
+    def instance_url(self) -> str: ...
     @classmethod
-    def modify(cls, sid, **params) -> None: ...
+    def modify(cls, sid, **params) -> NoReturn: ...
     @classmethod
-    def retrieve(cls, id, api_key: Any | None = ..., **params) -> None: ...
+    def retrieve(cls, id, api_key: Any | None = ..., **params) -> NoReturn: ...

stubs/stripe/stripe/api_resources/tax_id.pyi

@@ -1,10 +1,10 @@
-from typing import Any
+from typing import Any, NoReturn
 
 from stripe.api_resources.abstract import APIResource as APIResource
 from stripe.api_resources.customer import Customer as Customer
 
 class TaxId(APIResource):
     OBJECT_NAME: str
-    def instance_url(self): ...
+    def instance_url(self) -> str: ...
     @classmethod
-    def retrieve(cls, id, api_key: Any | None = ..., **params) -> None: ...
+    def retrieve(cls, id, api_key: Any | None = ..., **params) -> NoReturn: ...

stubs/stripe/stripe/stripe_object.pyi

@@ -1,4 +1,5 @@
 import json
+from _typeshed import Self
 from typing import Any
 
 from stripe import api_requestor as api_requestor
@@ -28,14 +29,19 @@ class StripeObject(dict[Any, Any]):
     def __reduce__(self): ...
     @classmethod
     def construct_from(
-        cls, values, key, stripe_version: Any | None = ..., stripe_account: Any | None = ..., last_response: Any | None = ...
-    ): ...
+        cls: type[Self],
+        values: Any,
+        key: str | None,
+        stripe_version: Any | None = ...,
+        stripe_account: Any | None = ...,
+        last_response: Any | None = ...,
+    ) -> Self: ...
     api_key: Any
     stripe_version: Any
     stripe_account: Any
     def refresh_from(
         self,
-        values,
+        values: Any,
         api_key: Any | None = ...,
         partial: bool = ...,
         stripe_version: Any | None = ...,

stubs/stripe/stripe/webhook.pyi

@@ -1,13 +1,17 @@
-from typing import Any
+from typing_extensions import Literal
 
-from stripe import error as error
+from stripe import Event, error as error
 
 class Webhook:
     DEFAULT_TOLERANCE: int
     @staticmethod
-    def construct_event(payload, sig_header, secret, tolerance=..., api_key: Any | None = ...): ...
+    def construct_event(
+        payload: bytes | str, sig_header: str, secret: str, tolerance: int = ..., api_key: str | None = ...
+    ) -> Event: ...
 
 class WebhookSignature:
     EXPECTED_SCHEME: str
     @classmethod
-    def verify_header(cls, payload, header, secret, tolerance: Any | None = ...): ...
+    def verify_header(cls, payload: bytes | str, header: str, secret: str, tolerance: int | None = ...) -> Literal[True]: ...
+    @staticmethod
+    def _compute_signature(payload: str, secret: str) -> str: ...