Skip to content

docs(tem): add missing webhook service documentation #605

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
merged 1 commit into from
Jul 25, 2024
Merged

docs(tem): add missing webhook service documentation #605

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
13 changes: 13 additions & 0 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 @@ -823,6 +823,8 @@ async def list_webhooks(
domain_id: Optional[str] = None,
) -> ListWebhooksResponse:
"""
List Webhooks.
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
Expand Down Expand Up @@ -871,6 +873,8 @@ async def list_webhooks_all(
domain_id: Optional[str] = None,
) -> List[Webhook]:
"""
List Webhooks.
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
Expand Down Expand Up @@ -909,6 +913,7 @@ async def get_webhook(
) -> Webhook:
"""
Get information about a Webhook.
Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
:param webhook_id: ID of the Webhook to check.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`Webhook <Webhook>`
Expand Down Expand Up @@ -944,6 +949,8 @@ async def update_webhook(
sns_arn: Optional[str] = None,
) -> Webhook:
"""
Update a Webhook.
Update a Webhook events type, SNS ARN or name.
:param webhook_id: ID of the Webhook to update.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the Webhook to update.
Expand Down Expand Up @@ -989,6 +996,8 @@ async def delete_webhook(
region: Optional[Region] = None,
) -> None:
"""
Delete a Webhook.
You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
:param webhook_id: ID of the Webhook to delete.
:param region: Region to target. If none is passed will use default region from the config.

Expand Down Expand Up @@ -1028,6 +1037,8 @@ async def list_webhook_events(
domain_id: Optional[str] = None,
) -> ListWebhookEventsResponse:
"""
List Webhook triggered events.
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
:param webhook_id: ID of the Webhook linked to the events.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
Expand Down Expand Up @@ -1090,6 +1101,8 @@ async def list_webhook_events_all(
domain_id: Optional[str] = None,
) -> List[WebhookEvent]:
"""
List Webhook triggered events.
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
:param webhook_id: ID of the Webhook linked to the events.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
Expand Down
13 changes: 13 additions & 0 deletions scaleway/scaleway/tem/v1alpha1/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,6 +823,8 @@ def list_webhooks(
domain_id: Optional[str] = None,
) -> ListWebhooksResponse:
"""
List Webhooks.
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
Expand Down Expand Up @@ -871,6 +873,8 @@ def list_webhooks_all(
domain_id: Optional[str] = None,
) -> List[Webhook]:
"""
List Webhooks.
Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhooks corresponding to specific criteria.
:param page: (Optional) Requested page number. Value must be greater or equal to 1.
Expand Down Expand Up @@ -909,6 +913,7 @@ def get_webhook(
) -> Webhook:
"""
Get information about a Webhook.
Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters.
:param webhook_id: ID of the Webhook to check.
:param region: Region to target. If none is passed will use default region from the config.
:return: :class:`Webhook <Webhook>`
Expand Down Expand Up @@ -944,6 +949,8 @@ def update_webhook(
sns_arn: Optional[str] = None,
) -> Webhook:
"""
Update a Webhook.
Update a Webhook events type, SNS ARN or name.
:param webhook_id: ID of the Webhook to update.
:param region: Region to target. If none is passed will use default region from the config.
:param name: Name of the Webhook to update.
Expand Down Expand Up @@ -989,6 +996,8 @@ def delete_webhook(
region: Optional[Region] = None,
) -> None:
"""
Delete a Webhook.
You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone.
:param webhook_id: ID of the Webhook to delete.
:param region: Region to target. If none is passed will use default region from the config.

Expand Down Expand Up @@ -1028,6 +1037,8 @@ def list_webhook_events(
domain_id: Optional[str] = None,
) -> ListWebhookEventsResponse:
"""
List Webhook triggered events.
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
:param webhook_id: ID of the Webhook linked to the events.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
Expand Down Expand Up @@ -1090,6 +1101,8 @@ def list_webhook_events_all(
domain_id: Optional[str] = None,
) -> List[WebhookEvent]:
"""
List Webhook triggered events.
Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`.
:param webhook_id: ID of the Webhook linked to the events.
:param region: Region to target. If none is passed will use default region from the config.
:param order_by: (Optional) List Webhook events corresponding to specific criteria.
Expand Down