Skip to content

Commit f109470

Browse files
chore: add missing docstrings
1 parent 5b81cac commit f109470

File tree

904 files changed

+7112
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

904 files changed

+7112
-0
lines changed

src/cloudflare/types/abuse_reports/abuse_report_get_response.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010

1111
class MitigationSummary(BaseModel):
12+
"""A summary of the mitigations related to this report."""
13+
1214
accepted_url_count: int
1315
"""How many of the reported URLs were confirmed as abusive."""
1416

@@ -26,6 +28,8 @@ class MitigationSummary(BaseModel):
2628

2729

2830
class Submitter(BaseModel):
31+
"""Information about the submitter of the report."""
32+
2933
company: Optional[str] = None
3034

3135
email: Optional[str] = None

src/cloudflare/types/abuse_reports/abuse_report_list_response.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010

1111
class ReportMitigationSummary(BaseModel):
12+
"""A summary of the mitigations related to this report."""
13+
1214
accepted_url_count: int
1315
"""How many of the reported URLs were confirmed as abusive."""
1416

@@ -26,6 +28,8 @@ class ReportMitigationSummary(BaseModel):
2628

2729

2830
class ReportSubmitter(BaseModel):
31+
"""Information about the submitter of the report."""
32+
2933
company: Optional[str] = None
3034

3135
email: Optional[str] = None

src/cloudflare/types/accounts/account.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111

1212
class ManagedBy(BaseModel):
13+
"""Parent container details"""
14+
1315
parent_org_id: Optional[str] = None
1416
"""ID of the parent Organization, if one exists"""
1517

@@ -18,6 +20,8 @@ class ManagedBy(BaseModel):
1820

1921

2022
class Settings(BaseModel):
23+
"""Account settings"""
24+
2125
abuse_contact_email: Optional[str] = None
2226
"""Sets an abuse contact email to notify for abuse reports."""
2327

src/cloudflare/types/accounts/account_create_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,9 @@ class AccountCreateParams(TypedDict, total=False):
2222

2323

2424
class Unit(TypedDict, total=False):
25+
"""
26+
information related to the tenant unit, and optionally, an id of the unit to create the account on. see https://developers.cloudflare.com/tenant/how-to/manage-accounts/
27+
"""
28+
2529
id: str
2630
"""Tenant unit ID"""

src/cloudflare/types/accounts/account_update_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,14 @@ class AccountUpdateParams(TypedDict, total=False):
2727

2828

2929
class ManagedBy(TypedDict, total=False):
30+
"""Parent container details"""
31+
3032
pass
3133

3234

3335
class Settings(TypedDict, total=False):
36+
"""Account settings"""
37+
3438
abuse_contact_email: str
3539
"""Sets an abuse contact email to notify for abuse reports."""
3640

src/cloudflare/types/accounts/logs/audit_list_response.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212

1313

1414
class Account(BaseModel):
15+
"""Contains account related information."""
16+
1517
id: Optional[str] = None
1618
"""A unique identifier for the account."""
1719

@@ -20,6 +22,8 @@ class Account(BaseModel):
2022

2123

2224
class Action(BaseModel):
25+
"""Provides information about the action performed."""
26+
2327
description: Optional[str] = None
2428
"""A short description of the action performed."""
2529

@@ -34,6 +38,8 @@ class Action(BaseModel):
3438

3539

3640
class Actor(BaseModel):
41+
"""Provides details about the actor who performed the action."""
42+
3743
id: Optional[str] = None
3844
"""The ID of the actor who performed the action.
3945
@@ -59,6 +65,8 @@ class Actor(BaseModel):
5965

6066

6167
class Raw(BaseModel):
68+
"""Provides raw information about the request and response."""
69+
6270
cf_rayid: Optional[str] = FieldInfo(alias="cf_ray_id", default=None)
6371
"""The Cloudflare Ray ID for the request."""
6472

@@ -76,6 +84,8 @@ class Raw(BaseModel):
7684

7785

7886
class Resource(BaseModel):
87+
"""Provides details about the affected resource."""
88+
7989
id: Optional[str] = None
8090
"""The unique identifier for the affected resource."""
8191

@@ -94,6 +104,8 @@ class Resource(BaseModel):
94104

95105

96106
class Zone(BaseModel):
107+
"""Provides details about the zone affected by the action."""
108+
97109
id: Optional[str] = None
98110
"""A string that identifies the zone id."""
99111

src/cloudflare/types/accounts/member_create_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,15 @@ class IAMCreateMemberWithPolicies(TypedDict, total=False):
4444

4545

4646
class IAMCreateMemberWithPoliciesPolicyPermissionGroup(TypedDict, total=False):
47+
"""A group of permissions."""
48+
4749
id: Required[str]
4850
"""Identifier of the group."""
4951

5052

5153
class IAMCreateMemberWithPoliciesPolicyResourceGroup(TypedDict, total=False):
54+
"""A group of scoped resources."""
55+
5256
id: Required[str]
5357
"""Identifier of the group."""
5458

src/cloudflare/types/accounts/member_update_params.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,15 @@ class IAMUpdateMemberWithPolicies(TypedDict, total=False):
3434

3535

3636
class IAMUpdateMemberWithPoliciesPolicyPermissionGroup(TypedDict, total=False):
37+
"""A group of permissions."""
38+
3739
id: Required[str]
3840
"""Identifier of the group."""
3941

4042

4143
class IAMUpdateMemberWithPoliciesPolicyResourceGroup(TypedDict, total=False):
44+
"""A group of scoped resources."""
45+
4246
id: Required[str]
4347
"""Identifier of the group."""
4448

src/cloudflare/types/accounts/token_create_params.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ class TokenCreateParams(TypedDict, total=False):
4646

4747

4848
class ConditionRequestIP(_ConditionRequestIPReservedKeywords, total=False):
49+
"""Client IP restrictions."""
50+
4951
not_in: SequenceNotStr[TokenConditionCIDRList]
5052
"""List of IPv4/IPv6 CIDR addresses."""
5153

src/cloudflare/types/accounts/token_create_response.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616

1717
class ConditionRequestIP(BaseModel):
18+
"""Client IP restrictions."""
19+
1820
in_: Optional[List[TokenConditionCIDRList]] = FieldInfo(alias="in", default=None)
1921
"""List of IPv4/IPv6 CIDR addresses."""
2022

0 commit comments

Comments
 (0)