10800377629

Committed 10 Sep 2024 08:49PM UTC coverage: 96.335% (-0.05%) from 96.382%

Build # 10800377629

Build Type

Pull #1389

github

Committed by

web-flow

Commit Message

Merge 995063f32 into 63489ea91

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

Run Details

1352 of 2055 branches covered (65.79%)

Branch coverage included in aggregate %.

336 of 393 new or added lines in 31 files covered. (85.5%)

1 existing line in 1 file now uncovered.

85237 of 87828 relevant lines covered (97.05%)

0.97 hits per line

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

73.91

/stripe/issuing/_dispute_settlement_detail.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from typing import ClassVar, List, Optional
from typing_extensions import Literal, NotRequired, Unpack


class DisputeSettlementDetail(ListableAPIResource["DisputeSettlementDetail"]):
    """
    Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
    """

    OBJECT_NAME: ClassVar[Literal["issuing.dispute_settlement_detail"]] = (
        "issuing.dispute_settlement_detail"
    )

    class ListParams(RequestOptions):
        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.
        """
        settlement: NotRequired[str]
        """
        Select the Issuing dispute settlement details for the given settlement.
        """
        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.
        """

    amount: int
    """
    Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
    """
    card: str
    """
    The card used to make the original transaction.
    """
    created: int
    """
    Time at which the object was created. Measured in seconds since the Unix epoch.
    """
    currency: str
    """
    The currency the original transaction was made in. 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).
    """
    dispute: str
    """
    The ID of the linked dispute.
    """
    event_type: Literal["filing", "loss", "representment", "win"]
    """
    The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
    """
    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.
    """
    network: Literal["maestro", "mastercard", "visa"]
    """
    The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
    """
    object: Literal["issuing.dispute_settlement_detail"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    settlement: Optional[str]
    """
    The ID of the linked card network settlement.
    """

    @classmethod
    def list(
        cls, **params: Unpack["DisputeSettlementDetail.ListParams"]
    ) -> ListObject["DisputeSettlementDetail"]:
        """
        Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
        """
        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["DisputeSettlementDetail.ListParams"]
    ) -> ListObject["DisputeSettlementDetail"]:
        """
        Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
        """
        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["DisputeSettlementDetail.RetrieveParams"],
    ) -> "DisputeSettlementDetail":
        """
        Retrieves an Issuing DisputeSettlementDetail object.
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls,
        id: str,
        **params: Unpack["DisputeSettlementDetail.RetrieveParams"],
    ) -> "DisputeSettlementDetail":
        """
        Retrieves an Issuing DisputeSettlementDetail object.
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._list_object import ListObject	1✔
4	from stripe._listable_api_resource import ListableAPIResource	1✔
5	from stripe._request_options import RequestOptions	1✔
6	from typing import ClassVar, List, Optional	1✔
7	from typing_extensions import Literal, NotRequired, Unpack	1✔
8
9
10	class DisputeSettlementDetail(ListableAPIResource["DisputeSettlementDetail"]):	1✔
11	"""
12	Represents a record from the card network of a money movement or change in state for an Issuing dispute. These records are included in the settlement reports that we receive from networks and expose to users as Settlement objects.
13	"""
14
15	OBJECT_NAME: ClassVar[Literal["issuing.dispute_settlement_detail"]] = (	1✔
16	"issuing.dispute_settlement_detail"
17	)
18
19	class ListParams(RequestOptions):	1✔
20	ending_before: NotRequired[str]	1✔
21	"""	1✔
22	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.
23	"""
24	expand: NotRequired[List[str]]	1✔
25	"""	1✔
26	Specifies which fields in the response should be expanded.
27	"""
28	limit: NotRequired[int]	1✔
29	"""	1✔
30	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
31	"""
32	settlement: NotRequired[str]	1✔
33	"""	1✔
34	Select the Issuing dispute settlement details for the given settlement.
35	"""
36	starting_after: NotRequired[str]	1✔
37	"""	1✔
38	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.
39	"""
40
41	class RetrieveParams(RequestOptions):	1✔
42	expand: NotRequired[List[str]]	1✔
43	"""	1✔
44	Specifies which fields in the response should be expanded.
45	"""
46
47	amount: int	1✔
48	"""	1✔
49	Disputed amount in the card's currency and in the smallest currency unit. Usually the amount of the transaction, but can differ (usually because of currency fluctuation).
50	"""
51	card: str	1✔
52	"""	1✔
53	The card used to make the original transaction.
54	"""
55	created: int	1✔
56	"""	1✔
57	Time at which the object was created. Measured in seconds since the Unix epoch.
58	"""
59	currency: str	1✔
60	"""	1✔
61	The currency the original transaction was made in. 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).
62	"""
63	dispute: str	1✔
64	"""	1✔
65	The ID of the linked dispute.
66	"""
67	event_type: Literal["filing", "loss", "representment", "win"]	1✔
68	"""	1✔
69	The type of event corresponding to this dispute settlement detail, representing the stage in the dispute network lifecycle.
70	"""
71	id: str	1✔
72	"""	1✔
73	Unique identifier for the object.
74	"""
75	livemode: bool	1✔
76	"""	1✔
77	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
78	"""
79	network: Literal["maestro", "mastercard", "visa"]	1✔
80	"""	1✔
81	The card network for this dispute settlement detail. One of ["visa", "mastercard", "maestro"]
82	"""
83	object: Literal["issuing.dispute_settlement_detail"]	1✔
84	"""	1✔
85	String representing the object's type. Objects of the same type share the same value.
86	"""
87	settlement: Optional[str]	1✔
88	"""	1✔
89	The ID of the linked card network settlement.
90	"""
91
92	@classmethod	1✔
93	def list(	1✔
94	cls, **params: Unpack["DisputeSettlementDetail.ListParams"]
95	) -> ListObject["DisputeSettlementDetail"]:
96	"""
97	Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
98	"""
NEW 99	result = cls._static_request(	×
100	"get",
101	cls.class_url(),
102	params=params,
103	)
NEW 104	if not isinstance(result, ListObject):	×
NEW 105	raise TypeError(	×
106	"Expected list object from API, got %s"
107	% (type(result).__name__)
108	)
109
NEW 110	return result	×
111
112	@classmethod	1✔
113	async def list_async(	1✔
114	cls, **params: Unpack["DisputeSettlementDetail.ListParams"]
115	) -> ListObject["DisputeSettlementDetail"]:
116	"""
117	Returns a list of Issuing DisputeSettlementDetail objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
118	"""
NEW 119	result = await cls._static_request_async(	×
120	"get",
121	cls.class_url(),
122	params=params,
123	)
NEW 124	if not isinstance(result, ListObject):	×
NEW 125	raise TypeError(	×
126	"Expected list object from API, got %s"
127	% (type(result).__name__)
128	)
129
NEW 130	return result	×
131
132	@classmethod	1✔
133	def retrieve(	1✔
134	cls,
135	id: str,
136	**params: Unpack["DisputeSettlementDetail.RetrieveParams"],
137	) -> "DisputeSettlementDetail":
138	"""
139	Retrieves an Issuing DisputeSettlementDetail object.
140	"""
NEW 141	instance = cls(id, **params)	×
NEW 142	instance.refresh()	×
NEW 143	return instance	×
144
145	@classmethod	1✔
146	async def retrieve_async(	1✔
147	cls,
148	id: str,
149	**params: Unpack["DisputeSettlementDetail.RetrieveParams"],
150	) -> "DisputeSettlementDetail":
151	"""
152	Retrieves an Issuing DisputeSettlementDetail object.
153	"""
NEW 154	instance = cls(id, **params)	×
NEW 155	await instance.refresh_async()	×
NEW 156	return instance	×

stripe / stripe-python / 10800377629

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