9023192124

Committed 09 May 2024 08:32PM UTC coverage: 96.375% (-0.02%) from 96.394%

Build # 9023192124

Build Type

Pull #1326

github

Committed by

web-flow

Commit Message

Merge 40d231476 into aea13b317

Pull Request Pull Request #1326: Add lint rule to ensure `async` functions are named `X_async`

Run Details

1076 of 1668 branches covered (64.51%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

159 existing lines in 12 files now uncovered.

64212 of 66076 relevant lines covered (97.18%)

0.97 hits per line

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

98.02

/stripe/_capability.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._account import Account
from stripe._expandable_field import ExpandableField
from stripe._stripe_object import StripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import sanitize_id
from typing import ClassVar, List, Optional
from typing_extensions import Literal


class Capability(UpdateableAPIResource["Capability"]):
    """
    This is an object representing a capability for a Stripe account.

    Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
    """

    OBJECT_NAME: ClassVar[Literal["capability"]] = "capability"

    class FutureRequirements(StripeObject):
        class Alternative(StripeObject):
            alternative_fields_due: List[str]
            """
            Fields that can be provided to satisfy all fields in `original_fields_due`.
            """
            original_fields_due: List[str]
            """
            Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
            """

        class Error(StripeObject):
            code: Literal[
                "invalid_address_city_state_postal_code",
                "invalid_address_highway_contract_box",
                "invalid_address_private_mailbox",
                "invalid_business_profile_name",
                "invalid_business_profile_name_denylisted",
                "invalid_company_name_denylisted",
                "invalid_dob_age_over_maximum",
                "invalid_dob_age_under_18",
                "invalid_dob_age_under_minimum",
                "invalid_product_description_length",
                "invalid_product_description_url_match",
                "invalid_representative_country",
                "invalid_statement_descriptor_business_mismatch",
                "invalid_statement_descriptor_denylisted",
                "invalid_statement_descriptor_length",
                "invalid_statement_descriptor_prefix_denylisted",
                "invalid_statement_descriptor_prefix_mismatch",
                "invalid_street_address",
                "invalid_tax_id",
                "invalid_tax_id_format",
                "invalid_tos_acceptance",
                "invalid_url_denylisted",
                "invalid_url_format",
                "invalid_url_length",
                "invalid_url_web_presence_detected",
                "invalid_url_website_business_information_mismatch",
                "invalid_url_website_empty",
                "invalid_url_website_inaccessible",
                "invalid_url_website_inaccessible_geoblocked",
                "invalid_url_website_inaccessible_password_protected",
                "invalid_url_website_incomplete",
                "invalid_url_website_incomplete_cancellation_policy",
                "invalid_url_website_incomplete_customer_service_details",
                "invalid_url_website_incomplete_legal_restrictions",
                "invalid_url_website_incomplete_refund_policy",
                "invalid_url_website_incomplete_return_policy",
                "invalid_url_website_incomplete_terms_and_conditions",
                "invalid_url_website_incomplete_under_construction",
                "invalid_url_website_other",
                "invalid_value_other",
                "verification_directors_mismatch",
                "verification_document_address_mismatch",
                "verification_document_address_missing",
                "verification_document_corrupt",
                "verification_document_country_not_supported",
                "verification_document_directors_mismatch",
                "verification_document_dob_mismatch",
                "verification_document_duplicate_type",
                "verification_document_expired",
                "verification_document_failed_copy",
                "verification_document_failed_greyscale",
                "verification_document_failed_other",
                "verification_document_failed_test_mode",
                "verification_document_fraudulent",
                "verification_document_id_number_mismatch",
                "verification_document_id_number_missing",
                "verification_document_incomplete",
                "verification_document_invalid",
                "verification_document_issue_or_expiry_date_missing",
                "verification_document_manipulated",
                "verification_document_missing_back",
                "verification_document_missing_front",
                "verification_document_name_mismatch",
                "verification_document_name_missing",
                "verification_document_nationality_mismatch",
                "verification_document_not_readable",
                "verification_document_not_signed",
                "verification_document_not_uploaded",
                "verification_document_photo_mismatch",
                "verification_document_too_large",
                "verification_document_type_not_supported",
                "verification_extraneous_directors",
                "verification_failed_address_match",
                "verification_failed_business_iec_number",
                "verification_failed_document_match",
                "verification_failed_id_number_match",
                "verification_failed_keyed_identity",
                "verification_failed_keyed_match",
                "verification_failed_name_match",
                "verification_failed_other",
                "verification_failed_representative_authority",
                "verification_failed_residential_address",
                "verification_failed_tax_id_match",
                "verification_failed_tax_id_not_issued",
                "verification_missing_directors",
                "verification_missing_executives",
                "verification_missing_owners",
                "verification_requires_additional_memorandum_of_associations",
            ]
            """
            The code for the type of error.
            """
            reason: str
            """
            An informative message that indicates the error type and provides additional details about the error.
            """
            requirement: str
            """
            The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
            """

        alternatives: Optional[List[Alternative]]
        """
        Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
        """
        current_deadline: Optional[int]
        """
        Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
        """
        currently_due: List[str]
        """
        Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
        """
        disabled_reason: Optional[str]
        """
        This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account.
        """
        errors: List[Error]
        """
        Fields that are `currently_due` and need to be collected again because validation or verification failed.
        """
        eventually_due: List[str]
        """
        Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well.
        """
        past_due: List[str]
        """
        Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
        """
        pending_verification: List[str]
        """
        Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
        """
        _inner_class_types = {"alternatives": Alternative, "errors": Error}

    class Requirements(StripeObject):
        class Alternative(StripeObject):
            alternative_fields_due: List[str]
            """
            Fields that can be provided to satisfy all fields in `original_fields_due`.
            """
            original_fields_due: List[str]
            """
            Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
            """

        class Error(StripeObject):
            code: Literal[
                "invalid_address_city_state_postal_code",
                "invalid_address_highway_contract_box",
                "invalid_address_private_mailbox",
                "invalid_business_profile_name",
                "invalid_business_profile_name_denylisted",
                "invalid_company_name_denylisted",
                "invalid_dob_age_over_maximum",
                "invalid_dob_age_under_18",
                "invalid_dob_age_under_minimum",
                "invalid_product_description_length",
                "invalid_product_description_url_match",
                "invalid_representative_country",
                "invalid_statement_descriptor_business_mismatch",
                "invalid_statement_descriptor_denylisted",
                "invalid_statement_descriptor_length",
                "invalid_statement_descriptor_prefix_denylisted",
                "invalid_statement_descriptor_prefix_mismatch",
                "invalid_street_address",
                "invalid_tax_id",
                "invalid_tax_id_format",
                "invalid_tos_acceptance",
                "invalid_url_denylisted",
                "invalid_url_format",
                "invalid_url_length",
                "invalid_url_web_presence_detected",
                "invalid_url_website_business_information_mismatch",
                "invalid_url_website_empty",
                "invalid_url_website_inaccessible",
                "invalid_url_website_inaccessible_geoblocked",
                "invalid_url_website_inaccessible_password_protected",
                "invalid_url_website_incomplete",
                "invalid_url_website_incomplete_cancellation_policy",
                "invalid_url_website_incomplete_customer_service_details",
                "invalid_url_website_incomplete_legal_restrictions",
                "invalid_url_website_incomplete_refund_policy",
                "invalid_url_website_incomplete_return_policy",
                "invalid_url_website_incomplete_terms_and_conditions",
                "invalid_url_website_incomplete_under_construction",
                "invalid_url_website_other",
                "invalid_value_other",
                "verification_directors_mismatch",
                "verification_document_address_mismatch",
                "verification_document_address_missing",
                "verification_document_corrupt",
                "verification_document_country_not_supported",
                "verification_document_directors_mismatch",
                "verification_document_dob_mismatch",
                "verification_document_duplicate_type",
                "verification_document_expired",
                "verification_document_failed_copy",
                "verification_document_failed_greyscale",
                "verification_document_failed_other",
                "verification_document_failed_test_mode",
                "verification_document_fraudulent",
                "verification_document_id_number_mismatch",
                "verification_document_id_number_missing",
                "verification_document_incomplete",
                "verification_document_invalid",
                "verification_document_issue_or_expiry_date_missing",
                "verification_document_manipulated",
                "verification_document_missing_back",
                "verification_document_missing_front",
                "verification_document_name_mismatch",
                "verification_document_name_missing",
                "verification_document_nationality_mismatch",
                "verification_document_not_readable",
                "verification_document_not_signed",
                "verification_document_not_uploaded",
                "verification_document_photo_mismatch",
                "verification_document_too_large",
                "verification_document_type_not_supported",
                "verification_extraneous_directors",
                "verification_failed_address_match",
                "verification_failed_business_iec_number",
                "verification_failed_document_match",
                "verification_failed_id_number_match",
                "verification_failed_keyed_identity",
                "verification_failed_keyed_match",
                "verification_failed_name_match",
                "verification_failed_other",
                "verification_failed_representative_authority",
                "verification_failed_residential_address",
                "verification_failed_tax_id_match",
                "verification_failed_tax_id_not_issued",
                "verification_missing_directors",
                "verification_missing_executives",
                "verification_missing_owners",
                "verification_requires_additional_memorandum_of_associations",
            ]
            """
            The code for the type of error.
            """
            reason: str
            """
            An informative message that indicates the error type and provides additional details about the error.
            """
            requirement: str
            """
            The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
            """

        alternatives: Optional[List[Alternative]]
        """
        Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
        """
        current_deadline: Optional[int]
        """
        Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.
        """
        currently_due: List[str]
        """
        Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
        """
        disabled_reason: Optional[str]
        """
        If the capability is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `requirements.fields_needed`, `pending.onboarding`, `pending.review`, `rejected.other`, `platform_paused`, `rejected.inactivty`, or `rejected.unsupported_business`.

        `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service, such as in [Afterpay Clearpay's terms of service](https://stripe.com/afterpay-clearpay/legal#restricted-businesses).

        `rejected.inactivity` means that the capability has been paused for inactivity. This disabled reason currently only applies to the Issuing capability. See [Issuing: Managing Inactive Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) for more details.
        """
        errors: List[Error]
        """
        Fields that are `currently_due` and need to be collected again because validation or verification failed.
        """
        eventually_due: List[str]
        """
        Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
        """
        past_due: List[str]
        """
        Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
        """
        pending_verification: List[str]
        """
        Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
        """
        _inner_class_types = {"alternatives": Alternative, "errors": Error}

    account: ExpandableField["Account"]
    """
    The account for which the capability enables functionality.
    """
    future_requirements: Optional[FutureRequirements]
    id: str
    """
    The identifier for the capability.
    """
    object: Literal["capability"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    requested: bool
    """
    Whether the capability has been requested.
    """
    requested_at: Optional[int]
    """
    Time at which the capability was requested. Measured in seconds since the Unix epoch.
    """
    requirements: Optional[Requirements]
    status: Literal["active", "disabled", "inactive", "pending", "unrequested"]
    """
    The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`.
    """

    def instance_url(self):
        token = self.id
        account = self.account
        base = Account.class_url()
        if isinstance(account, Account):
            account = account.id
        acct_extn = sanitize_id(account)
        extn = sanitize_id(token)
        return "%s/%s/capabilities/%s" % (base, acct_extn, extn)

    @classmethod
    def modify(cls, sid, **params):
        raise NotImplementedError(
            "Can't update a capability without an account ID. Update a capability using "
            "account.modify_capability('acct_123', 'acap_123', params)"
        )

    @classmethod
    def retrieve(cls, id, **params):
        raise NotImplementedError(
            "Can't retrieve a capability without an account ID. Retrieve a capability using "
            "account.retrieve_capability('acct_123', 'acap_123')"
        )

    _inner_class_types = {
        "future_requirements": FutureRequirements,
        "requirements": Requirements,
    }

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._account import Account	1✔
4	from stripe._expandable_field import ExpandableField	1✔
5	from stripe._stripe_object import StripeObject	1✔
6	from stripe._updateable_api_resource import UpdateableAPIResource	1✔
7	from stripe._util import sanitize_id	1✔
8	from typing import ClassVar, List, Optional	1✔
9	from typing_extensions import Literal	1✔
10
11
12	class Capability(UpdateableAPIResource["Capability"]):	1✔
13	"""
14	This is an object representing a capability for a Stripe account.
15
16	Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
17	"""
18
19	OBJECT_NAME: ClassVar[Literal["capability"]] = "capability"	1✔
20
21	class FutureRequirements(StripeObject):	1✔
22	class Alternative(StripeObject):	1✔
23	alternative_fields_due: List[str]	1✔
24	"""	1✔
25	Fields that can be provided to satisfy all fields in `original_fields_due`.
26	"""
27	original_fields_due: List[str]	1✔
28	"""	1✔
29	Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
30	"""
31
32	class Error(StripeObject):	1✔
33	code: Literal[	1✔
34	"invalid_address_city_state_postal_code",
35	"invalid_address_highway_contract_box",
36	"invalid_address_private_mailbox",
37	"invalid_business_profile_name",
38	"invalid_business_profile_name_denylisted",
39	"invalid_company_name_denylisted",
40	"invalid_dob_age_over_maximum",
41	"invalid_dob_age_under_18",
42	"invalid_dob_age_under_minimum",
43	"invalid_product_description_length",
44	"invalid_product_description_url_match",
45	"invalid_representative_country",
46	"invalid_statement_descriptor_business_mismatch",
47	"invalid_statement_descriptor_denylisted",
48	"invalid_statement_descriptor_length",
49	"invalid_statement_descriptor_prefix_denylisted",
50	"invalid_statement_descriptor_prefix_mismatch",
51	"invalid_street_address",
52	"invalid_tax_id",
53	"invalid_tax_id_format",
54	"invalid_tos_acceptance",
55	"invalid_url_denylisted",
56	"invalid_url_format",
57	"invalid_url_length",
58	"invalid_url_web_presence_detected",
59	"invalid_url_website_business_information_mismatch",
60	"invalid_url_website_empty",
61	"invalid_url_website_inaccessible",
62	"invalid_url_website_inaccessible_geoblocked",
63	"invalid_url_website_inaccessible_password_protected",
64	"invalid_url_website_incomplete",
65	"invalid_url_website_incomplete_cancellation_policy",
66	"invalid_url_website_incomplete_customer_service_details",
67	"invalid_url_website_incomplete_legal_restrictions",
68	"invalid_url_website_incomplete_refund_policy",
69	"invalid_url_website_incomplete_return_policy",
70	"invalid_url_website_incomplete_terms_and_conditions",
71	"invalid_url_website_incomplete_under_construction",
72	"invalid_url_website_other",
73	"invalid_value_other",
74	"verification_directors_mismatch",
75	"verification_document_address_mismatch",
76	"verification_document_address_missing",
77	"verification_document_corrupt",
78	"verification_document_country_not_supported",
79	"verification_document_directors_mismatch",
80	"verification_document_dob_mismatch",
81	"verification_document_duplicate_type",
82	"verification_document_expired",
83	"verification_document_failed_copy",
84	"verification_document_failed_greyscale",
85	"verification_document_failed_other",
86	"verification_document_failed_test_mode",
87	"verification_document_fraudulent",
88	"verification_document_id_number_mismatch",
89	"verification_document_id_number_missing",
90	"verification_document_incomplete",
91	"verification_document_invalid",
92	"verification_document_issue_or_expiry_date_missing",
93	"verification_document_manipulated",
94	"verification_document_missing_back",
95	"verification_document_missing_front",
96	"verification_document_name_mismatch",
97	"verification_document_name_missing",
98	"verification_document_nationality_mismatch",
99	"verification_document_not_readable",
100	"verification_document_not_signed",
101	"verification_document_not_uploaded",
102	"verification_document_photo_mismatch",
103	"verification_document_too_large",
104	"verification_document_type_not_supported",
105	"verification_extraneous_directors",
106	"verification_failed_address_match",
107	"verification_failed_business_iec_number",
108	"verification_failed_document_match",
109	"verification_failed_id_number_match",
110	"verification_failed_keyed_identity",
111	"verification_failed_keyed_match",
112	"verification_failed_name_match",
113	"verification_failed_other",
114	"verification_failed_representative_authority",
115	"verification_failed_residential_address",
116	"verification_failed_tax_id_match",
117	"verification_failed_tax_id_not_issued",
118	"verification_missing_directors",
119	"verification_missing_executives",
120	"verification_missing_owners",
121	"verification_requires_additional_memorandum_of_associations",
122	]
123	"""	1✔
124	The code for the type of error.
125	"""
126	reason: str	1✔
127	"""	1✔
128	An informative message that indicates the error type and provides additional details about the error.
129	"""
130	requirement: str	1✔
131	"""	1✔
132	The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
133	"""
134
135	alternatives: Optional[List[Alternative]]	1✔
136	"""	1✔
137	Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
138	"""
139	current_deadline: Optional[int]	1✔
140	"""	1✔
141	Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
142	"""
143	currently_due: List[str]	1✔
144	"""	1✔
145	Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
146	"""
147	disabled_reason: Optional[str]	1✔
148	"""	1✔
149	This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account.
150	"""
151	errors: List[Error]	1✔
152	"""	1✔
153	Fields that are `currently_due` and need to be collected again because validation or verification failed.
154	"""
155	eventually_due: List[str]	1✔
156	"""	1✔
157	Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well.
158	"""
159	past_due: List[str]	1✔
160	"""	1✔
161	Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
162	"""
163	pending_verification: List[str]	1✔
164	"""	1✔
165	Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
166	"""
167	_inner_class_types = {"alternatives": Alternative, "errors": Error}	1✔
168
169	class Requirements(StripeObject):	1✔
170	class Alternative(StripeObject):	1✔
171	alternative_fields_due: List[str]	1✔
172	"""	1✔
173	Fields that can be provided to satisfy all fields in `original_fields_due`.
174	"""
175	original_fields_due: List[str]	1✔
176	"""	1✔
177	Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
178	"""
179
180	class Error(StripeObject):	1✔
181	code: Literal[	1✔
182	"invalid_address_city_state_postal_code",
183	"invalid_address_highway_contract_box",
184	"invalid_address_private_mailbox",
185	"invalid_business_profile_name",
186	"invalid_business_profile_name_denylisted",
187	"invalid_company_name_denylisted",
188	"invalid_dob_age_over_maximum",
189	"invalid_dob_age_under_18",
190	"invalid_dob_age_under_minimum",
191	"invalid_product_description_length",
192	"invalid_product_description_url_match",
193	"invalid_representative_country",
194	"invalid_statement_descriptor_business_mismatch",
195	"invalid_statement_descriptor_denylisted",
196	"invalid_statement_descriptor_length",
197	"invalid_statement_descriptor_prefix_denylisted",
198	"invalid_statement_descriptor_prefix_mismatch",
199	"invalid_street_address",
200	"invalid_tax_id",
201	"invalid_tax_id_format",
202	"invalid_tos_acceptance",
203	"invalid_url_denylisted",
204	"invalid_url_format",
205	"invalid_url_length",
206	"invalid_url_web_presence_detected",
207	"invalid_url_website_business_information_mismatch",
208	"invalid_url_website_empty",
209	"invalid_url_website_inaccessible",
210	"invalid_url_website_inaccessible_geoblocked",
211	"invalid_url_website_inaccessible_password_protected",
212	"invalid_url_website_incomplete",
213	"invalid_url_website_incomplete_cancellation_policy",
214	"invalid_url_website_incomplete_customer_service_details",
215	"invalid_url_website_incomplete_legal_restrictions",
216	"invalid_url_website_incomplete_refund_policy",
217	"invalid_url_website_incomplete_return_policy",
218	"invalid_url_website_incomplete_terms_and_conditions",
219	"invalid_url_website_incomplete_under_construction",
220	"invalid_url_website_other",
221	"invalid_value_other",
222	"verification_directors_mismatch",
223	"verification_document_address_mismatch",
224	"verification_document_address_missing",
225	"verification_document_corrupt",
226	"verification_document_country_not_supported",
227	"verification_document_directors_mismatch",
228	"verification_document_dob_mismatch",
229	"verification_document_duplicate_type",
230	"verification_document_expired",
231	"verification_document_failed_copy",
232	"verification_document_failed_greyscale",
233	"verification_document_failed_other",
234	"verification_document_failed_test_mode",
235	"verification_document_fraudulent",
236	"verification_document_id_number_mismatch",
237	"verification_document_id_number_missing",
238	"verification_document_incomplete",
239	"verification_document_invalid",
240	"verification_document_issue_or_expiry_date_missing",
241	"verification_document_manipulated",
242	"verification_document_missing_back",
243	"verification_document_missing_front",
244	"verification_document_name_mismatch",
245	"verification_document_name_missing",
246	"verification_document_nationality_mismatch",
247	"verification_document_not_readable",
248	"verification_document_not_signed",
249	"verification_document_not_uploaded",
250	"verification_document_photo_mismatch",
251	"verification_document_too_large",
252	"verification_document_type_not_supported",
253	"verification_extraneous_directors",
254	"verification_failed_address_match",
255	"verification_failed_business_iec_number",
256	"verification_failed_document_match",
257	"verification_failed_id_number_match",
258	"verification_failed_keyed_identity",
259	"verification_failed_keyed_match",
260	"verification_failed_name_match",
261	"verification_failed_other",
262	"verification_failed_representative_authority",
263	"verification_failed_residential_address",
264	"verification_failed_tax_id_match",
265	"verification_failed_tax_id_not_issued",
266	"verification_missing_directors",
267	"verification_missing_executives",
268	"verification_missing_owners",
269	"verification_requires_additional_memorandum_of_associations",
270	]
271	"""	1✔
272	The code for the type of error.
273	"""
274	reason: str	1✔
275	"""	1✔
276	An informative message that indicates the error type and provides additional details about the error.
277	"""
278	requirement: str	1✔
279	"""	1✔
280	The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
281	"""
282
283	alternatives: Optional[List[Alternative]]	1✔
284	"""	1✔
285	Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
286	"""
287	current_deadline: Optional[int]	1✔
288	"""	1✔
289	Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected.
290	"""
291	currently_due: List[str]	1✔
292	"""	1✔
293	Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
294	"""
295	disabled_reason: Optional[str]	1✔
296	"""	1✔
297	If the capability is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `requirements.fields_needed`, `pending.onboarding`, `pending.review`, `rejected.other`, `platform_paused`, `rejected.inactivty`, or `rejected.unsupported_business`.
298
299	`rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service, such as in [Afterpay Clearpay's terms of service](https://stripe.com/afterpay-clearpay/legal#restricted-businesses).
300
301	`rejected.inactivity` means that the capability has been paused for inactivity. This disabled reason currently only applies to the Issuing capability. See [Issuing: Managing Inactive Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) for more details.
302	"""
303	errors: List[Error]	1✔
304	"""	1✔
305	Fields that are `currently_due` and need to be collected again because validation or verification failed.
306	"""
307	eventually_due: List[str]	1✔
308	"""	1✔
309	Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
310	"""
311	past_due: List[str]	1✔
312	"""	1✔
313	Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
314	"""
315	pending_verification: List[str]	1✔
316	"""	1✔
317	Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
318	"""
319	_inner_class_types = {"alternatives": Alternative, "errors": Error}	1✔
320
321	account: ExpandableField["Account"]	1✔
322	"""	1✔
323	The account for which the capability enables functionality.
324	"""
325	future_requirements: Optional[FutureRequirements]	1✔
326	id: str	1✔
327	"""	1✔
328	The identifier for the capability.
329	"""
330	object: Literal["capability"]	1✔
331	"""	1✔
332	String representing the object's type. Objects of the same type share the same value.
333	"""
334	requested: bool	1✔
335	"""	1✔
336	Whether the capability has been requested.
337	"""
338	requested_at: Optional[int]	1✔
339	"""	1✔
340	Time at which the capability was requested. Measured in seconds since the Unix epoch.
341	"""
342	requirements: Optional[Requirements]	1✔
343	status: Literal["active", "disabled", "inactive", "pending", "unrequested"]	1✔
344	"""	1✔
345	The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`.
346	"""
347
348	def instance_url(self):	1✔
349	token = self.id	1✔
350	account = self.account	1✔
351	base = Account.class_url()	1✔
352	if isinstance(account, Account):	1!
UNCOV 353	account = account.id	×
354	acct_extn = sanitize_id(account)	1✔
355	extn = sanitize_id(token)	1✔
356	return "%s/%s/capabilities/%s" % (base, acct_extn, extn)	1✔
357
358	@classmethod	1✔
359	def modify(cls, sid, **params):	1✔
360	raise NotImplementedError(	1✔
361	"Can't update a capability without an account ID. Update a capability using "
362	"account.modify_capability('acct_123', 'acap_123', params)"
363	)
364
365	@classmethod	1✔
366	def retrieve(cls, id, **params):	1✔
367	raise NotImplementedError(	1✔
368	"Can't retrieve a capability without an account ID. Retrieve a capability using "
369	"account.retrieve_capability('acct_123', 'acap_123')"
370	)
371
372	_inner_class_types = {	1✔
373	"future_requirements": FutureRequirements,
374	"requirements": Requirements,
375	}

stripe / stripe-python / 9023192124

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