272 lines
7.8 KiB
Python
272 lines
7.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
# File generated from our OpenAPI spec
|
|
from stripe._createable_api_resource import CreateableAPIResource
|
|
from stripe._deletable_api_resource import DeletableAPIResource
|
|
from stripe._list_object import ListObject
|
|
from stripe._listable_api_resource import ListableAPIResource
|
|
from stripe._request_options import RequestOptions
|
|
from stripe._util import class_method_variant, sanitize_id
|
|
from typing import ClassVar, List, Optional, cast, overload
|
|
from typing_extensions import Literal, NotRequired, Unpack
|
|
|
|
|
|
class ApplePayDomain(
|
|
CreateableAPIResource["ApplePayDomain"],
|
|
DeletableAPIResource["ApplePayDomain"],
|
|
ListableAPIResource["ApplePayDomain"],
|
|
):
|
|
OBJECT_NAME: ClassVar[Literal["apple_pay_domain"]] = "apple_pay_domain"
|
|
|
|
class CreateParams(RequestOptions):
|
|
domain_name: str
|
|
expand: NotRequired[List[str]]
|
|
"""
|
|
Specifies which fields in the response should be expanded.
|
|
"""
|
|
|
|
class DeleteParams(RequestOptions):
|
|
pass
|
|
|
|
class ListParams(RequestOptions):
|
|
domain_name: NotRequired[str]
|
|
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.
|
|
"""
|
|
deleted: Optional[Literal[True]]
|
|
"""
|
|
Always true for a deleted object
|
|
"""
|
|
domain_name: str
|
|
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["apple_pay_domain"]
|
|
"""
|
|
String representing the object's type. Objects of the same type share the same value.
|
|
"""
|
|
|
|
@classmethod
|
|
def create(
|
|
cls, **params: Unpack["ApplePayDomain.CreateParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Create an apple pay domain.
|
|
"""
|
|
return cast(
|
|
"ApplePayDomain",
|
|
cls._static_request(
|
|
"post",
|
|
cls.class_url(),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
async def create_async(
|
|
cls, **params: Unpack["ApplePayDomain.CreateParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Create an apple pay domain.
|
|
"""
|
|
return cast(
|
|
"ApplePayDomain",
|
|
await cls._static_request_async(
|
|
"post",
|
|
cls.class_url(),
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@classmethod
|
|
def _cls_delete(
|
|
cls, sid: str, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
|
|
return cast(
|
|
"ApplePayDomain",
|
|
cls._static_request(
|
|
"delete",
|
|
url,
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@overload
|
|
@staticmethod
|
|
def delete(
|
|
sid: str, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
...
|
|
|
|
@overload
|
|
def delete(
|
|
self, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
...
|
|
|
|
@class_method_variant("_cls_delete")
|
|
def delete( # pyright: ignore[reportGeneralTypeIssues]
|
|
self, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
return self._request_and_refresh(
|
|
"delete",
|
|
self.instance_url(),
|
|
params=params,
|
|
)
|
|
|
|
@classmethod
|
|
async def _cls_delete_async(
|
|
cls, sid: str, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
|
|
return cast(
|
|
"ApplePayDomain",
|
|
await cls._static_request_async(
|
|
"delete",
|
|
url,
|
|
params=params,
|
|
),
|
|
)
|
|
|
|
@overload
|
|
@staticmethod
|
|
async def delete_async(
|
|
sid: str, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
...
|
|
|
|
@overload
|
|
async def delete_async(
|
|
self, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
...
|
|
|
|
@class_method_variant("_cls_delete_async")
|
|
async def delete_async( # pyright: ignore[reportGeneralTypeIssues]
|
|
self, **params: Unpack["ApplePayDomain.DeleteParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Delete an apple pay domain.
|
|
"""
|
|
return await self._request_and_refresh_async(
|
|
"delete",
|
|
self.instance_url(),
|
|
params=params,
|
|
)
|
|
|
|
@classmethod
|
|
def list(
|
|
cls, **params: Unpack["ApplePayDomain.ListParams"]
|
|
) -> ListObject["ApplePayDomain"]:
|
|
"""
|
|
List apple pay domains.
|
|
"""
|
|
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["ApplePayDomain.ListParams"]
|
|
) -> ListObject["ApplePayDomain"]:
|
|
"""
|
|
List apple pay domains.
|
|
"""
|
|
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["ApplePayDomain.RetrieveParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Retrieve an apple pay domain.
|
|
"""
|
|
instance = cls(id, **params)
|
|
instance.refresh()
|
|
return instance
|
|
|
|
@classmethod
|
|
async def retrieve_async(
|
|
cls, id: str, **params: Unpack["ApplePayDomain.RetrieveParams"]
|
|
) -> "ApplePayDomain":
|
|
"""
|
|
Retrieve an apple pay domain.
|
|
"""
|
|
instance = cls(id, **params)
|
|
await instance.refresh_async()
|
|
return instance
|
|
|
|
@classmethod
|
|
def class_url(cls):
|
|
return "/v1/apple_pay/domains"
|