Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 9 additions & 20 deletions api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@ from cloudflare.types import (
ErrorData,
Identifier,
LoadBalancerPreview,
Member,
PaginationInfo,
Permission,
PermissionGrant,
RatePlan,
ResponseInfo,
Result,
Role,
SortDirection,
Subscription,
SubscriptionComponent,
Expand Down Expand Up @@ -44,36 +46,23 @@ Methods:
Types:

```python
from cloudflare.types.accounts import (
Status,
MemberCreateResponse,
MemberUpdateResponse,
MemberListResponse,
MemberDeleteResponse,
MemberGetResponse,
)
from cloudflare.types.accounts import Status, MemberDeleteResponse
```

Methods:

- <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">create</a>(\*, account_id, \*\*<a href="src/cloudflare/types/accounts/member_create_params.py">params</a>) -> <a href="./src/cloudflare/types/accounts/member_create_response.py">Optional</a></code>
- <code title="put /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">update</a>(member_id, \*, account_id, \*\*<a href="src/cloudflare/types/accounts/member_update_params.py">params</a>) -> <a href="./src/cloudflare/types/accounts/member_update_response.py">Optional</a></code>
- <code title="get /accounts/{account_id}/members">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">list</a>(\*, account_id, \*\*<a href="src/cloudflare/types/accounts/member_list_params.py">params</a>) -> <a href="./src/cloudflare/types/accounts/member_list_response.py">SyncV4PagePaginationArray[MemberListResponse]</a></code>
- <code title="post /accounts/{account_id}/members">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">create</a>(\*, account_id, \*\*<a href="src/cloudflare/types/accounts/member_create_params.py">params</a>) -> <a href="./src/cloudflare/types/shared/member.py">Optional</a></code>
- <code title="put /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">update</a>(member_id, \*, account_id, \*\*<a href="src/cloudflare/types/accounts/member_update_params.py">params</a>) -> <a href="./src/cloudflare/types/shared/member.py">Optional</a></code>
- <code title="get /accounts/{account_id}/members">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">list</a>(\*, account_id, \*\*<a href="src/cloudflare/types/accounts/member_list_params.py">params</a>) -> <a href="./src/cloudflare/types/shared/member.py">SyncV4PagePaginationArray[Member]</a></code>
- <code title="delete /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">delete</a>(member_id, \*, account_id) -> <a href="./src/cloudflare/types/accounts/member_delete_response.py">Optional</a></code>
- <code title="get /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">get</a>(member_id, \*, account_id) -> <a href="./src/cloudflare/types/accounts/member_get_response.py">Optional</a></code>
- <code title="get /accounts/{account_id}/members/{member_id}">client.accounts.members.<a href="./src/cloudflare/resources/accounts/members.py">get</a>(member_id, \*, account_id) -> <a href="./src/cloudflare/types/shared/member.py">Optional</a></code>

## Roles

Types:

```python
from cloudflare.types.accounts import RoleListResponse, RoleGetResponse
```

Methods:

- <code title="get /accounts/{account_id}/roles">client.accounts.roles.<a href="./src/cloudflare/resources/accounts/roles.py">list</a>(\*, account_id) -> <a href="./src/cloudflare/types/accounts/role_list_response.py">SyncSinglePage[RoleListResponse]</a></code>
- <code title="get /accounts/{account_id}/roles/{role_id}">client.accounts.roles.<a href="./src/cloudflare/resources/accounts/roles.py">get</a>(role_id, \*, account_id) -> <a href="./src/cloudflare/types/accounts/role_get_response.py">Optional</a></code>
- <code title="get /accounts/{account_id}/roles">client.accounts.roles.<a href="./src/cloudflare/resources/accounts/roles.py">list</a>(\*, account_id) -> <a href="./src/cloudflare/types/shared/role.py">SyncSinglePage[Role]</a></code>
- <code title="get /accounts/{account_id}/roles/{role_id}">client.accounts.roles.<a href="./src/cloudflare/resources/accounts/roles.py">get</a>(role_id, \*, account_id) -> <a href="./src/cloudflare/types/shared/role.py">Optional</a></code>

## Subscriptions

Expand Down
78 changes: 38 additions & 40 deletions src/cloudflare/resources/accounts/members.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,9 @@
from ...pagination import SyncV4PagePaginationArray, AsyncV4PagePaginationArray
from ..._base_client import AsyncPaginator, make_request_options
from ...types.accounts import member_list_params, member_create_params, member_update_params
from ...types.accounts.member_get_response import MemberGetResponse
from ...types.accounts.member_list_response import MemberListResponse
from ...types.accounts.member_create_response import MemberCreateResponse
from ...types.shared.member import Member
from ...types.shared_params.role import Role
from ...types.accounts.member_delete_response import MemberDeleteResponse
from ...types.accounts.member_update_response import MemberUpdateResponse

__all__ = ["MembersResource", "AsyncMembersResource"]

Expand Down Expand Up @@ -68,7 +66,7 @@ def create(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberCreateResponse]:
) -> Optional[Member]:
"""
Add a user to the list of members for this account.

Expand Down Expand Up @@ -103,7 +101,7 @@ def create(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberCreateResponse]:
) -> Optional[Member]:
"""
Add a user to the list of members for this account.

Expand Down Expand Up @@ -139,7 +137,7 @@ def create(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberCreateResponse]:
) -> Optional[Member]:
if not account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._post(
Expand All @@ -158,9 +156,9 @@ def create(
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[MemberCreateResponse]]._unwrapper,
post_parser=ResultWrapper[Optional[Member]]._unwrapper,
),
cast_to=cast(Type[Optional[MemberCreateResponse]], ResultWrapper[MemberCreateResponse]),
cast_to=cast(Type[Optional[Member]], ResultWrapper[Member]),
)

@overload
Expand All @@ -169,14 +167,14 @@ def update(
member_id: str,
*,
account_id: str,
roles: Iterable[member_update_params.IAMUpdateMemberWithRolesRole] | NotGiven = NOT_GIVEN,
roles: Iterable[Role] | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberUpdateResponse]:
) -> Optional[Member]:
"""
Modify an account member.

Expand Down Expand Up @@ -210,7 +208,7 @@ def update(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberUpdateResponse]:
) -> Optional[Member]:
"""
Modify an account member.

Expand All @@ -237,15 +235,15 @@ def update(
member_id: str,
*,
account_id: str,
roles: Iterable[member_update_params.IAMUpdateMemberWithRolesRole] | NotGiven = NOT_GIVEN,
roles: Iterable[Role] | NotGiven = NOT_GIVEN,
policies: Iterable[member_update_params.IAMUpdateMemberWithPoliciesPolicy] | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberUpdateResponse]:
) -> Optional[Member]:
if not account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not member_id:
Expand All @@ -264,9 +262,9 @@ def update(
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[MemberUpdateResponse]]._unwrapper,
post_parser=ResultWrapper[Optional[Member]]._unwrapper,
),
cast_to=cast(Type[Optional[MemberUpdateResponse]], ResultWrapper[MemberUpdateResponse]),
cast_to=cast(Type[Optional[Member]], ResultWrapper[Member]),
)

def list(
Expand All @@ -284,7 +282,7 @@ def list(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> SyncV4PagePaginationArray[MemberListResponse]:
) -> SyncV4PagePaginationArray[Member]:
"""
List all members of an account.

Expand Down Expand Up @@ -313,7 +311,7 @@ def list(
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._get_api_list(
f"/accounts/{account_id}/members",
page=SyncV4PagePaginationArray[MemberListResponse],
page=SyncV4PagePaginationArray[Member],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
Expand All @@ -330,7 +328,7 @@ def list(
member_list_params.MemberListParams,
),
),
model=MemberListResponse,
model=Member,
)

def delete(
Expand Down Expand Up @@ -388,7 +386,7 @@ def get(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberGetResponse]:
) -> Optional[Member]:
"""
Get information about a specific member of an account.

Expand Down Expand Up @@ -416,9 +414,9 @@ def get(
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[MemberGetResponse]]._unwrapper,
post_parser=ResultWrapper[Optional[Member]]._unwrapper,
),
cast_to=cast(Type[Optional[MemberGetResponse]], ResultWrapper[MemberGetResponse]),
cast_to=cast(Type[Optional[Member]], ResultWrapper[Member]),
)


Expand Down Expand Up @@ -456,7 +454,7 @@ async def create(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberCreateResponse]:
) -> Optional[Member]:
"""
Add a user to the list of members for this account.

Expand Down Expand Up @@ -491,7 +489,7 @@ async def create(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberCreateResponse]:
) -> Optional[Member]:
"""
Add a user to the list of members for this account.

Expand Down Expand Up @@ -527,7 +525,7 @@ async def create(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberCreateResponse]:
) -> Optional[Member]:
if not account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return await self._post(
Expand All @@ -546,9 +544,9 @@ async def create(
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[MemberCreateResponse]]._unwrapper,
post_parser=ResultWrapper[Optional[Member]]._unwrapper,
),
cast_to=cast(Type[Optional[MemberCreateResponse]], ResultWrapper[MemberCreateResponse]),
cast_to=cast(Type[Optional[Member]], ResultWrapper[Member]),
)

@overload
Expand All @@ -557,14 +555,14 @@ async def update(
member_id: str,
*,
account_id: str,
roles: Iterable[member_update_params.IAMUpdateMemberWithRolesRole] | NotGiven = NOT_GIVEN,
roles: Iterable[Role] | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberUpdateResponse]:
) -> Optional[Member]:
"""
Modify an account member.

Expand Down Expand Up @@ -598,7 +596,7 @@ async def update(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberUpdateResponse]:
) -> Optional[Member]:
"""
Modify an account member.

Expand All @@ -625,15 +623,15 @@ async def update(
member_id: str,
*,
account_id: str,
roles: Iterable[member_update_params.IAMUpdateMemberWithRolesRole] | NotGiven = NOT_GIVEN,
roles: Iterable[Role] | NotGiven = NOT_GIVEN,
policies: Iterable[member_update_params.IAMUpdateMemberWithPoliciesPolicy] | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberUpdateResponse]:
) -> Optional[Member]:
if not account_id:
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
if not member_id:
Expand All @@ -652,9 +650,9 @@ async def update(
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[MemberUpdateResponse]]._unwrapper,
post_parser=ResultWrapper[Optional[Member]]._unwrapper,
),
cast_to=cast(Type[Optional[MemberUpdateResponse]], ResultWrapper[MemberUpdateResponse]),
cast_to=cast(Type[Optional[Member]], ResultWrapper[Member]),
)

def list(
Expand All @@ -672,7 +670,7 @@ def list(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> AsyncPaginator[MemberListResponse, AsyncV4PagePaginationArray[MemberListResponse]]:
) -> AsyncPaginator[Member, AsyncV4PagePaginationArray[Member]]:
"""
List all members of an account.

Expand Down Expand Up @@ -701,7 +699,7 @@ def list(
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
return self._get_api_list(
f"/accounts/{account_id}/members",
page=AsyncV4PagePaginationArray[MemberListResponse],
page=AsyncV4PagePaginationArray[Member],
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
Expand All @@ -718,7 +716,7 @@ def list(
member_list_params.MemberListParams,
),
),
model=MemberListResponse,
model=Member,
)

async def delete(
Expand Down Expand Up @@ -776,7 +774,7 @@ async def get(
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Optional[MemberGetResponse]:
) -> Optional[Member]:
"""
Get information about a specific member of an account.

Expand Down Expand Up @@ -804,9 +802,9 @@ async def get(
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
post_parser=ResultWrapper[Optional[MemberGetResponse]]._unwrapper,
post_parser=ResultWrapper[Optional[Member]]._unwrapper,
),
cast_to=cast(Type[Optional[MemberGetResponse]], ResultWrapper[MemberGetResponse]),
cast_to=cast(Type[Optional[Member]], ResultWrapper[Member]),
)


Expand Down
Loading