Skip to content

feat(tem): add filter to list offer subscriptions #2055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
estellesoulard merged 1 commit into from
Aug 19, 2026
Merged

feat(tem): add filter to list offer subscriptions #2055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
67 changes: 65 additions & 2 deletions scaleway-async/scaleway_async/tem/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
Region as ScwRegion,
)
from scaleway_core.utils import (
OneOfPossibility,
WaitForOptions,
resolve_one_of,
validate_path_param,
fetch_all_pages_async,
wait_for_resource_async,
Expand Down Expand Up @@ -1488,13 +1490,23 @@ async def list_offer_subscriptions(
self,
*,
region: Optional[ScwRegion] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
organization_id: Optional[str] = None,
project_id: Optional[str] = None,
offer_name: Optional[OfferName] = None,
) -> ListOfferSubscriptionsResponse:
"""
Get information about subscribed offers.
Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
:param page_size: (Optional) Requested page size. Value must be between 1 and 100.
:param organization_id: (Optional) ID of the Organization.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param project_id: (Optional) ID of the Project.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param offer_name: (Optional) Name of the offer associated with the Project.
:return: :class:`ListOfferSubscriptionsResponse <ListOfferSubscriptionsResponse>`

Usage:
Expand All @@ -1511,13 +1523,64 @@ async def list_offer_subscriptions(
"GET",
f"/transactional-email/v1alpha1/regions/{param_region}/offer-subscriptions",
params={
"project_id": project_id or self.client.default_project_id,
"offer_name": offer_name,
"page": page,
"page_size": page_size or self.client.default_page_size,
**resolve_one_of(
[
OneOfPossibility("organization_id", organization_id),
OneOfPossibility("project_id", project_id),
]
),
},
)

self._throw_on_error(res)
return unmarshal_ListOfferSubscriptionsResponse(res.json())

async def list_offer_subscriptions_all(
self,
*,
region: Optional[ScwRegion] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
organization_id: Optional[str] = None,
project_id: Optional[str] = None,
offer_name: Optional[OfferName] = None,
) -> list[OfferSubscription]:
"""
Get information about subscribed offers.
Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
:param region: Region to target. If none is passed will use default region from the config.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
:param page_size: (Optional) Requested page size. Value must be between 1 and 100.
:param organization_id: (Optional) ID of the Organization.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param project_id: (Optional) ID of the Project.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param offer_name: (Optional) Name of the offer associated with the Project.
:return: :class:`list[OfferSubscription] <list[OfferSubscription]>`

Usage:
::

result = await api.list_offer_subscriptions_all()
"""

return await fetch_all_pages_async(
type=ListOfferSubscriptionsResponse,
key="offer_subscriptions",
fetcher=self.list_offer_subscriptions,
args={
"region": region,
"page": page,
"page_size": page_size,
"offer_name": offer_name,
"organization_id": organization_id,
"project_id": project_id,
},
)

async def update_offer_subscription(
self,
*,
Expand Down
18 changes: 16 additions & 2 deletions scaleway-async/scaleway_async/tem/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1561,11 +1561,25 @@ class ListOfferSubscriptionsRequest:
Region to target. If none is passed will use default region from the config.
"""

project_id: Optional[str] = None
page: Optional[int] = 0
"""
ID of the Project.
(Optional) Requested page number. Value must be greater or equal to 1.
"""

page_size: Optional[int] = 0
"""
(Optional) Requested page size. Value must be between 1 and 100.
"""

offer_name: Optional[OfferName] = OfferName.UNKNOWN_NAME
"""
(Optional) Name of the offer associated with the Project.
"""

organization_id: Optional[str] = None

project_id: Optional[str] = None


@dataclass
class ListOfferSubscriptionsResponse:
Expand Down
67 changes: 65 additions & 2 deletions scaleway/scaleway/tem/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
Region as ScwRegion,
)
from scaleway_core.utils import (
OneOfPossibility,
WaitForOptions,
resolve_one_of,
validate_path_param,
fetch_all_pages,
wait_for_resource,
Expand Down Expand Up @@ -1488,13 +1490,23 @@ def list_offer_subscriptions(
self,
*,
region: Optional[ScwRegion] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
organization_id: Optional[str] = None,
project_id: Optional[str] = None,
offer_name: Optional[OfferName] = None,
) -> ListOfferSubscriptionsResponse:
"""
Get information about subscribed offers.
Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
:param region: Region to target. If none is passed will use default region from the config.
:param project_id: ID of the Project.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
:param page_size: (Optional) Requested page size. Value must be between 1 and 100.
:param organization_id: (Optional) ID of the Organization.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param project_id: (Optional) ID of the Project.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param offer_name: (Optional) Name of the offer associated with the Project.
:return: :class:`ListOfferSubscriptionsResponse <ListOfferSubscriptionsResponse>`

Usage:
Expand All @@ -1511,13 +1523,64 @@ def list_offer_subscriptions(
"GET",
f"/transactional-email/v1alpha1/regions/{param_region}/offer-subscriptions",
params={
"project_id": project_id or self.client.default_project_id,
"offer_name": offer_name,
"page": page,
"page_size": page_size or self.client.default_page_size,
**resolve_one_of(
[
OneOfPossibility("organization_id", organization_id),
OneOfPossibility("project_id", project_id),
]
),
},
)

self._throw_on_error(res)
return unmarshal_ListOfferSubscriptionsResponse(res.json())

def list_offer_subscriptions_all(
self,
*,
region: Optional[ScwRegion] = None,
page: Optional[int] = None,
page_size: Optional[int] = None,
organization_id: Optional[str] = None,
project_id: Optional[str] = None,
offer_name: Optional[OfferName] = None,
) -> list[OfferSubscription]:
"""
Get information about subscribed offers.
Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters.
:param region: Region to target. If none is passed will use default region from the config.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
:param page_size: (Optional) Requested page size. Value must be between 1 and 100.
:param organization_id: (Optional) ID of the Organization.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param project_id: (Optional) ID of the Project.
One-Of ('scope'): at most one of 'organization_id', 'project_id' could be set.
:param offer_name: (Optional) Name of the offer associated with the Project.
:return: :class:`list[OfferSubscription] <list[OfferSubscription]>`

Usage:
::

result = api.list_offer_subscriptions_all()
"""

return fetch_all_pages(
type=ListOfferSubscriptionsResponse,
key="offer_subscriptions",
fetcher=self.list_offer_subscriptions,
args={
"region": region,
"page": page,
"page_size": page_size,
"offer_name": offer_name,
"organization_id": organization_id,
"project_id": project_id,
},
)

def update_offer_subscription(
self,
*,
Expand Down
18 changes: 16 additions & 2 deletions scaleway/scaleway/tem/v1alpha1/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1561,11 +1561,25 @@ class ListOfferSubscriptionsRequest:
Region to target. If none is passed will use default region from the config.
"""

project_id: Optional[str] = None
page: Optional[int] = 0
"""
ID of the Project.
(Optional) Requested page number. Value must be greater or equal to 1.
"""

page_size: Optional[int] = 0
"""
(Optional) Requested page size. Value must be between 1 and 100.
"""

offer_name: Optional[OfferName] = OfferName.UNKNOWN_NAME
"""
(Optional) Name of the offer associated with the Project.
"""

organization_id: Optional[str] = None

project_id: Optional[str] = None


@dataclass
class ListOfferSubscriptionsResponse:
Expand Down
Loading