scaleway_async.tem.v1alpha1 package

Submodules

scaleway_async.tem.v1alpha1.api module

class scaleway_async.tem.v1alpha1.api.TemV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Transactional Email services.

async bulk_create_blocklists(*, domain_id: str, region: str | None = None, emails: List[str] | None = None, type_: BlocklistType | None = None, reason: str | None = None) → BulkCreateBlocklistsResponse

Bulk create blocklists. Create multiple blocklists in a specific Project or Organization using the region parameter. :param domain_id: Domain ID linked to the blocklist. :param region: Region to target. If none is passed will use default region from the config. :param emails: Email blocked by the blocklist. :param type_: Type of blocklist. :param reason: Reason to block the email. :return: BulkCreateBlocklistsResponse

Usage:

result = await api.bulk_create_blocklists(
    domain_id="example",
)

async cancel_email(*, email_id: str, region: str | None = None) → Email

Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the region and the email_id of the email you want to cancel. :param email_id: ID of the email to cancel. :param region: Region to target. If none is passed will use default region from the config. :return: Email

Usage:

result = await api.cancel_email(
    email_id="example",
)

async check_domain(*, domain_id: str, region: str | None = None) → Domain

Domain DNS check. Perform an immediate DNS check of a domain using the region and domain_id parameters. :param domain_id: ID of the domain to check. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.check_domain(
    domain_id="example",
)

async create_domain(*, domain_name: str, autoconfig: bool, region: str | None = None, project_id: str | None = None, accept_tos: bool | None = None) → Domain

Register a domain in a project. You must specify the region, project_id and domain_name to register a domain in a specific Project. :param domain_name: Fully qualified domain dame. :param autoconfig: Activate auto-configuration of the domain’s DNS zone. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project to which the domain belongs. :param accept_tos: Deprecated. Accept Scaleway’s Terms of Service. :return: Domain

Usage:

result = await api.create_domain(
    domain_name="example",
    autoconfig=False,
)

async create_email(*, from_: CreateEmailRequestAddress, subject: str, text: str, html: str, region: str | None = None, to: List[CreateEmailRequestAddress] | None = None, cc: List[CreateEmailRequestAddress] | None = None, bcc: List[CreateEmailRequestAddress] | None = None, project_id: str | None = None, attachments: List[CreateEmailRequestAttachment] | None = None, send_before: datetime | None = None, additional_headers: List[CreateEmailRequestHeader] | None = None) → CreateEmailResponse

Send an email. You must specify the region, the sender and the recipient’s information and the project_id to send an email from a checked domain. The subject of the email must contain at least 6 characters. :param from_: Sender information. Must be from a checked domain declared in the Project. :param subject: Subject of the email. :param text: Text content. :param html: HTML content. :param region: Region to target. If none is passed will use default region from the config. :param to: An array of the primary recipient’s information. :param cc: An array of the carbon copy recipient’s information. :param bcc: An array of the blind carbon copy recipient’s information. :param project_id: ID of the Project in which to create the email. :param attachments: Array of attachments. :param send_before: Maximum date to deliver the email. :param additional_headers: Array of additional headers as key-value. :return: CreateEmailResponse

Usage:

result = await api.create_email(
    from=CreateEmailRequestAddress(),
    subject="example",
    text="example",
    html="example",
)

async create_webhook(*, domain_id: str, name: str, sns_arn: str, region: str | None = None, project_id: str | None = None, event_types: List[WebhookEventType] | None = None) → Webhook

Create a Webhook. Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN. :param domain_id: ID of the Domain to watch for triggering events. :param name: Name of the Webhook. :param sns_arn: Scaleway SNS ARN topic to push the events to. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project to which the Webhook belongs. :param event_types: List of event types that will trigger an event. :return: Webhook

Usage:

result = await api.create_webhook(
    domain_id="example",
    name="example",
    sns_arn="example",
)

async delete_blocklist(*, blocklist_id: str, region: str | None = None) → None

Delete a blocklist. You must specify the blocklist you want to delete by the region and blocklist_id. :param blocklist_id: ID of the blocklist to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_blocklist(
    blocklist_id="example",
)

async delete_webhook(*, webhook_id: str, region: str | None = 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.

Usage:

result = await api.delete_webhook(
    webhook_id="example",
)

async get_domain(*, domain_id: str, region: str | None = None) → Domain

Get information about a domain. Retrieve information about a specific domain using the region and domain_id parameters. Monitor your domain’s reputation and improve average and bad reputation statuses, using your domain’s Email activity tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain’s reputation. :param domain_id: ID of the domain. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.get_domain(
    domain_id="example",
)

async get_domain_last_status(*, domain_id: str, region: str | None = None) → DomainLastStatus

Display SPF and DKIM records status and potential errors. Display SPF and DKIM records status and potential errors, including the found records to make debugging easier. :param domain_id: ID of the domain to delete. :param region: Region to target. If none is passed will use default region from the config. :return: DomainLastStatus

Usage:

result = await api.get_domain_last_status(
    domain_id="example",
)

async get_email(*, email_id: str, region: str | None = None) → Email

Get an email. Retrieve information about a specific email using the email_id and region parameters. :param email_id: ID of the email to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Email

Usage:

result = await api.get_email(
    email_id="example",
)

async get_project_consumption(*, region: str | None = None, project_id: str | None = None) → ProjectConsumption

Get project resource consumption. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project. :return: ProjectConsumption

Usage:

result = await api.get_project_consumption()

async get_project_settings(*, region: str | None = None, project_id: str | None = None) → ProjectSettings

List project settings. Retrieve the project settings including periodic reports. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project. :return: ProjectSettings

Usage:

result = await api.get_project_settings()

Email statuses. Get information on your emails’ statuses. :param region: Region to target. If none is passed will use default region from the config. :param project_id: (Optional) Number of emails for this Project. :param domain_id: (Optional) Number of emails sent from this domain (must be coherent with the project_id and the organization_id). :param since: (Optional) Number of emails created after this date. :param until: (Optional) Number of emails created before this date. :param mail_from: (Optional) Number of emails sent with this sender’s email address. :return: Statistics

Usage:

result = await api.get_statistics()

async get_webhook(*, webhook_id: str, region: str | None = None) → 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: Webhook

Usage:

result = await api.get_webhook(
    webhook_id="example",
)

List blocklists. Retrieve the list of blocklists. :param domain_id: (Optional) Filter by a domain ID. :param region: Region to target. If none is passed will use default region from the config. :param order_by: (Optional) List blocklist corresponding to specific criteria. :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 email: (Optional) Filter by an email address. :param type_: (Optional) Filter by a blocklist type. :param custom: (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false). :return: ListBlocklistsResponse

Usage:

result = await api.list_blocklists(
    domain_id="example",
)

List blocklists. Retrieve the list of blocklists. :param domain_id: (Optional) Filter by a domain ID. :param region: Region to target. If none is passed will use default region from the config. :param order_by: (Optional) List blocklist corresponding to specific criteria. :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 email: (Optional) Filter by an email address. :param type_: (Optional) Filter by a blocklist type. :param custom: (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false). :return: List[Blocklist]

Usage:

result = await api.list_blocklists_all(
    domain_id="example",
)

List domains. Retrieve domains 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 page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: (Optional) ID of the Project in which to list the domains. :param status: (Optional) List domains under specific statuses. :param organization_id: (Optional) ID of the Organization in which to list the domains. :param name: (Optional) Names of the domains to list. :return: ListDomainsResponse

Usage:

result = await api.list_domains()

List domains. Retrieve domains 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 page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: (Optional) ID of the Project in which to list the domains. :param status: (Optional) List domains under specific statuses. :param organization_id: (Optional) ID of the Organization in which to list the domains. :param name: (Optional) Names of the domains to list. :return: List[Domain]

Usage:

result = await api.list_domains_all()

List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the region. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param project_id: (Optional) ID of the Project in which to list the emails. :param domain_id: (Optional) ID of the domain for which to list the emails. :param message_id: (Optional) ID of the message for which to list the emails. :param since: (Optional) List emails created after this date. :param until: (Optional) List emails created before this date. :param mail_from: (Optional) List emails sent with this sender’s email address. :param mail_to: Deprecated. List emails sent to this recipient’s email address. :param mail_rcpt: (Optional) List emails sent to this recipient’s email address. :param statuses: (Optional) List emails with any of these statuses. :param subject: (Optional) List emails with this subject. :param search: (Optional) List emails by searching to all fields. :param order_by: (Optional) List emails corresponding to specific criteria. :param flags: (Optional) List emails containing only specific flags. :return: ListEmailsResponse

Usage:

result = await api.list_emails()

List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the region. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param project_id: (Optional) ID of the Project in which to list the emails. :param domain_id: (Optional) ID of the domain for which to list the emails. :param message_id: (Optional) ID of the message for which to list the emails. :param since: (Optional) List emails created after this date. :param until: (Optional) List emails created before this date. :param mail_from: (Optional) List emails sent with this sender’s email address. :param mail_to: Deprecated. List emails sent to this recipient’s email address. :param mail_rcpt: (Optional) List emails sent to this recipient’s email address. :param statuses: (Optional) List emails with any of these statuses. :param subject: (Optional) List emails with this subject. :param search: (Optional) List emails by searching to all fields. :param order_by: (Optional) List emails corresponding to specific criteria. :param flags: (Optional) List emails containing only specific flags. :return: List[Email]

Usage:

result = await api.list_emails_all()

async list_offer_subscriptions(*, region: str | None = None, project_id: str | None = 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. :return: ListOfferSubscriptionsResponse

Usage:

result = await api.list_offer_subscriptions()

async list_offers(*, region: str | None = None) → ListOffersResponse

List the available offers. Retrieve the list of the available and free-of-charge offers you can subscribe to. :param region: Region to target. If none is passed will use default region from the config. :return: ListOffersResponse

Usage:

result = await api.list_offers()

async list_pools(*, region: str | None = None, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → ListPoolsResponse

Get information about a sending pool. Retrieve information about a sending pool, including its creation status and configuration parameters. :param region: Region to target. If none is passed will use default region from the config. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: ID of the Project. :return: ListPoolsResponse

Usage:

result = await api.list_pools()

async list_pools_all(*, region: str | None = None, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → List[Pool]

Get information about a sending pool. Retrieve information about a sending pool, including its creation status and configuration parameters. :param region: Region to target. If none is passed will use default region from the config. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: ID of the Project. :return: List[Pool]

Usage:

result = await api.list_pools_all()

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. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 100. :param email_id: ID of the email linked to the events. :param event_types: List of event types linked to the events. :param statuses: List of event statuses. :param project_id: ID of the webhook Project. :param organization_id: ID of the webhook Organization. :param domain_id: ID of the domain to watch for triggering events. :return: ListWebhookEventsResponse

Usage:

result = await api.list_webhook_events(
    webhook_id="example",
)

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. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 100. :param email_id: ID of the email linked to the events. :param event_types: List of event types linked to the events. :param statuses: List of event statuses. :param project_id: ID of the webhook Project. :param organization_id: ID of the webhook Organization. :param domain_id: ID of the domain to watch for triggering events. :return: List[WebhookEvent]

Usage:

result = await api.list_webhook_events_all(
    webhook_id="example",
)

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. :param page_size: (Optional) Requested page size. Value must be between 1 and 100. :param project_id: (Optional) ID of the Project for which to list the Webhooks. :param organization_id: (Optional) ID of the Organization for which to list the Webhooks. :param domain_id: (Optional) ID of the Domain for which to list the Webhooks. :return: ListWebhooksResponse

Usage:

result = await api.list_webhooks()

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. :param page_size: (Optional) Requested page size. Value must be between 1 and 100. :param project_id: (Optional) ID of the Project for which to list the Webhooks. :param organization_id: (Optional) ID of the Organization for which to list the Webhooks. :param domain_id: (Optional) ID of the Domain for which to list the Webhooks. :return: List[Webhook]

Usage:

result = await api.list_webhooks_all()

async revoke_domain(*, domain_id: str, region: str | None = None) → Domain

Delete a domain. You must specify the domain you want to delete by the region and domain_id. Deleting a domain is permanent and cannot be undone. :param domain_id: ID of the domain to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.revoke_domain(
    domain_id="example",
)

async update_domain(*, domain_id: str, region: str | None = None, autoconfig: bool | None = None) → Domain

Update a domain. Update a domain auto-configuration. :param domain_id: ID of the domain to update. :param region: Region to target. If none is passed will use default region from the config. :param autoconfig: (Optional) If set to true, activate auto-configuration of the domain’s DNS zone. :return: Domain

Usage:

result = await api.update_domain(
    domain_id="example",
)

async update_offer_subscription(*, region: str | None = None, project_id: str | None = None, name: OfferName | None = None) → OfferSubscription

Update a subscribed offer. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Project. :param name: Name of the offer-subscription. :return: OfferSubscription

Usage:

result = await api.update_offer_subscription()

async update_project_settings(*, region: str | None = None, project_id: str | None = None, periodic_report: UpdateProjectSettingsRequestUpdatePeriodicReport | None = None) → ProjectSettings

Update project settings. Update the project settings including periodic reports. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project. :param periodic_report: Periodic report update details - all fields are optional. :return: ProjectSettings

Usage:

result = await api.update_project_settings()

async update_webhook(*, webhook_id: str, region: str | None = None, name: str | None = None, event_types: List[WebhookEventType] | None = None, sns_arn: str | None = 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. :param event_types: List of event types to update. :param sns_arn: Scaleway SNS ARN topic to update. :return: Webhook

Usage:

result = await api.update_webhook(
    webhook_id="example",
)

async wait_for_domain(*, domain_id: str, region: str | None = None, options: WaitForOptions[Domain, bool | Awaitable[bool]] | None = None) → Domain

Get information about a domain. Retrieve information about a specific domain using the region and domain_id parameters. Monitor your domain’s reputation and improve average and bad reputation statuses, using your domain’s Email activity tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain’s reputation. :param domain_id: ID of the domain. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.get_domain(
    domain_id="example",
)

async wait_for_email(*, email_id: str, region: str | None = None, options: WaitForOptions[Email, bool | Awaitable[bool]] | None = None) → Email

Get an email. Retrieve information about a specific email using the email_id and region parameters. :param email_id: ID of the email to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Email

Usage:

result = await api.get_email(
    email_id="example",
)

scaleway_async.tem.v1alpha1.content module

scaleway_async.tem.v1alpha1.content.DOMAIN_TRANSIENT_STATUSES: List[DomainStatus] = [<DomainStatus.PENDING: 'pending'>, <DomainStatus.AUTOCONFIGURING: 'autoconfiguring'>]: Lists transient statutes of the enum DomainStatus.

scaleway_async.tem.v1alpha1.content.EMAIL_TRANSIENT_STATUSES: List[EmailStatus] = [<EmailStatus.NEW: 'new'>, <EmailStatus.SENDING: 'sending'>]: Lists transient statutes of the enum EmailStatus.

scaleway_async.tem.v1alpha1.marshalling module

scaleway_async.tem.v1alpha1.marshalling.marshal_BulkCreateBlocklistsRequest(request: BulkCreateBlocklistsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_CreateDomainRequest(request: CreateDomainRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_CreateEmailRequest(request: CreateEmailRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_CreateEmailRequestAddress(request: CreateEmailRequestAddress, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_CreateEmailRequestAttachment(request: CreateEmailRequestAttachment, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_CreateEmailRequestHeader(request: CreateEmailRequestHeader, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_CreateWebhookRequest(request: CreateWebhookRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_UpdateDomainRequest(request: UpdateDomainRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_UpdateOfferSubscriptionRequest(request: UpdateOfferSubscriptionRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_UpdateProjectSettingsRequest(request: UpdateProjectSettingsRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_UpdateProjectSettingsRequestUpdatePeriodicReport(request: UpdateProjectSettingsRequestUpdatePeriodicReport, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.marshal_UpdateWebhookRequest(request: UpdateWebhookRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.tem.v1alpha1.marshalling.unmarshal_Blocklist(data: Any) → Blocklist

scaleway_async.tem.v1alpha1.marshalling.unmarshal_BulkCreateBlocklistsResponse(data: Any) → BulkCreateBlocklistsResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_CreateEmailResponse(data: Any) → CreateEmailResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_Domain(data: Any) → Domain

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainLastStatus(data: Any) → DomainLastStatus

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainLastStatusAutoconfigState(data: Any) → DomainLastStatusAutoconfigState

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainLastStatusDkimRecord(data: Any) → DomainLastStatusDkimRecord

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainLastStatusDmarcRecord(data: Any) → DomainLastStatusDmarcRecord

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainLastStatusSpfRecord(data: Any) → DomainLastStatusSpfRecord

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainRecords(data: Any) → DomainRecords

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainRecordsDMARC(data: Any) → DomainRecordsDMARC

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainReputation(data: Any) → DomainReputation

scaleway_async.tem.v1alpha1.marshalling.unmarshal_DomainStatistics(data: Any) → DomainStatistics

scaleway_async.tem.v1alpha1.marshalling.unmarshal_Email(data: Any) → Email

scaleway_async.tem.v1alpha1.marshalling.unmarshal_EmailTry(data: Any) → EmailTry

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListBlocklistsResponse(data: Any) → ListBlocklistsResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListDomainsResponse(data: Any) → ListDomainsResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListEmailsResponse(data: Any) → ListEmailsResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListOfferSubscriptionsResponse(data: Any) → ListOfferSubscriptionsResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListOffersResponse(data: Any) → ListOffersResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListPoolsResponse(data: Any) → ListPoolsResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListWebhookEventsResponse(data: Any) → ListWebhookEventsResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ListWebhooksResponse(data: Any) → ListWebhooksResponse

scaleway_async.tem.v1alpha1.marshalling.unmarshal_Offer(data: Any) → Offer

scaleway_async.tem.v1alpha1.marshalling.unmarshal_OfferSubscription(data: Any) → OfferSubscription

scaleway_async.tem.v1alpha1.marshalling.unmarshal_Pool(data: Any) → Pool

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ProjectConsumption(data: Any) → ProjectConsumption

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ProjectSettings(data: Any) → ProjectSettings

scaleway_async.tem.v1alpha1.marshalling.unmarshal_ProjectSettingsPeriodicReport(data: Any) → ProjectSettingsPeriodicReport

scaleway_async.tem.v1alpha1.marshalling.unmarshal_Statistics(data: Any) → Statistics

scaleway_async.tem.v1alpha1.marshalling.unmarshal_Webhook(data: Any) → Webhook

scaleway_async.tem.v1alpha1.marshalling.unmarshal_WebhookEvent(data: Any) → WebhookEvent

scaleway_async.tem.v1alpha1.types module

class scaleway_async.tem.v1alpha1.types.Blocklist(id: 'str', domain_id: 'str', email: 'str', type_: 'BlocklistType', reason: 'str', custom: 'bool', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, ends_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Date and time of the blocklist creation.

custom: bool: True if this blocklist was created manually. False for an automatic Transactional Email blocklist.

domain_id: str: Domain ID linked to the blocklist.

email: str: Email blocked by the blocklist.

ends_at: datetime | None = None: Date and time when the blocklist ends. Empty if the blocklist has no end.

id: str: ID of the blocklist.

reason: str: Reason to block this email.

type_: BlocklistType: Type of block for this email.

updated_at: datetime | None = None: Date and time of the blocklist’s last update.

class scaleway_async.tem.v1alpha1.types.BlocklistType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

MAILBOX_FULL = 'mailbox_full'

MAILBOX_NOT_FOUND = 'mailbox_not_found'

UNKNOWN_TYPE = 'unknown_type'

class scaleway_async.tem.v1alpha1.types.BulkCreateBlocklistsRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None, emails: 'Optional[List[str]]' = <factory>, type_: 'Optional[BlocklistType]' = <BlocklistType.UNKNOWN_TYPE: 'unknown_type'>, reason: 'Optional[str]' = None)

Bases: object

domain_id: str: Domain ID linked to the blocklist.

emails: List[str] | None: Email blocked by the blocklist.

reason: str | None = None: Reason to block the email.

region: str | None = None: Region to target. If none is passed will use default region from the config.

type_: BlocklistType | None = 'unknown_type': Type of blocklist.

class scaleway_async.tem.v1alpha1.types.BulkCreateBlocklistsResponse(blocklists: 'List[Blocklist]')

Bases: object

blocklists: List[Blocklist]: List of blocklist created.

class scaleway_async.tem.v1alpha1.types.CancelEmailRequest(email_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

email_id: str: ID of the email to cancel.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.CheckDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain to check.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.CreateDomainRequest(domain_name: 'str', autoconfig: 'bool', region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, accept_tos: 'Optional[bool]' = False)

Bases: object

accept_tos: bool | None = False: Deprecated. Accept Scaleway’s Terms of Service.

autoconfig: bool: Activate auto-configuration of the domain’s DNS zone.

domain_name: str: Fully qualified domain dame.

project_id: str | None = None: ID of the project to which the domain belongs.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.CreateEmailRequest(from_: 'CreateEmailRequestAddress', subject: 'str', text: 'str', html: 'str', region: 'Optional[ScwRegion]' = None, to: 'Optional[List[CreateEmailRequestAddress]]' = <factory>, cc: 'Optional[List[CreateEmailRequestAddress]]' = <factory>, bcc: 'Optional[List[CreateEmailRequestAddress]]' = <factory>, project_id: 'Optional[str]' = None, attachments: 'Optional[List[CreateEmailRequestAttachment]]' = <factory>, send_before: 'Optional[datetime]' = None, additional_headers: 'Optional[List[CreateEmailRequestHeader]]' = <factory>)

Bases: object

additional_headers: List[CreateEmailRequestHeader] | None: Array of additional headers as key-value.

attachments: List[CreateEmailRequestAttachment] | None: Array of attachments.

bcc: List[CreateEmailRequestAddress] | None: An array of the blind carbon copy recipient’s information.

cc: List[CreateEmailRequestAddress] | None: An array of the carbon copy recipient’s information.

from_: CreateEmailRequestAddress: Sender information. Must be from a checked domain declared in the Project.

html: str: HTML content.

project_id: str | None = None: ID of the Project in which to create the email.

region: str | None = None: Region to target. If none is passed will use default region from the config.

send_before: datetime | None = None: Maximum date to deliver the email.

subject: str: Subject of the email.

text: str: Text content.

to: List[CreateEmailRequestAddress] | None: An array of the primary recipient’s information.

class scaleway_async.tem.v1alpha1.types.CreateEmailRequestAddress(email: 'str', name: 'Optional[str]' = None)

Bases: object

email: str: Email address.

name: str | None = None: (Optional) Name displayed.

class scaleway_async.tem.v1alpha1.types.CreateEmailRequestAttachment(name: 'str', type_: 'str', content: 'str')

Bases: object

content: str: Content of the attachment encoded in base64.

name: str: Filename of the attachment.

type_: str: MIME type of the attachment.

class scaleway_async.tem.v1alpha1.types.CreateEmailRequestHeader(key: 'str', value: 'str')

Bases: object

key: str: Email header key.

value: str: Email header value.

class scaleway_async.tem.v1alpha1.types.CreateEmailResponse(emails: 'List[Email]')

Bases: object

emails: List[Email]: Single page of emails matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.CreateWebhookRequest(domain_id: 'str', name: 'str', sns_arn: 'str', region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, event_types: 'Optional[List[WebhookEventType]]' = <factory>)

Bases: object

domain_id: str: ID of the Domain to watch for triggering events.

event_types: List[WebhookEventType] | None: List of event types that will trigger an event.

name: str: Name of the Webhook.

project_id: str | None = None: ID of the project to which the Webhook belongs.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_arn: str: Scaleway SNS ARN topic to push the events to.

class scaleway_async.tem.v1alpha1.types.DeleteBlocklistRequest(blocklist_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

blocklist_id: str: ID of the blocklist to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.DeleteWebhookRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

webhook_id: str: ID of the Webhook to delete.

class scaleway_async.tem.v1alpha1.types.Domain(id: 'str', organization_id: 'str', project_id: 'str', name: 'str', status: 'DomainStatus', spf_config: 'str', dkim_config: 'str', autoconfig: 'bool', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, next_check_at: 'Optional[datetime]' = None, last_valid_at: 'Optional[datetime]' = None, revoked_at: 'Optional[datetime]' = None, last_error: 'Optional[str]' = None, statistics: 'Optional[DomainStatistics]' = None, reputation: 'Optional[DomainReputation]' = None, records: 'Optional[DomainRecords]' = None)

Bases: object

autoconfig: bool: Status of auto-configuration for the domain’s DNS zone.

created_at: datetime | None = None: Date and time of domain creation.

dkim_config: str: DKIM public key to record in the DNS zone.

id: str: ID of the domain.

last_error: str | None = None: Deprecated. Error message returned if the last check failed.

last_valid_at: datetime | None = None: Date and time the domain was last valid.

name: str: Domain name (example.com).

next_check_at: datetime | None = None: Date and time of the next scheduled check.

organization_id: str: ID of the domain’s Organization.

project_id: str: ID of the domain’s Project.

records: DomainRecords | None = None: List of records to configure to validate a domain.

region: str: Region to target. If none is passed will use default region from the config.

reputation: DomainReputation | None = None: The domain’s reputation is available when your domain is checked and has sent enough emails.

revoked_at: datetime | None = None: Date and time of the domain’s deletion.

spf_config: str: Snippet of the SPF record to register in the DNS zone.

statistics: DomainStatistics | None = None: Domain’s statistics.

status: DomainStatus: Status of the domain.

class scaleway_async.tem.v1alpha1.types.DomainLastStatus(domain_id: 'str', domain_name: 'str', spf_record: 'Optional[DomainLastStatusSpfRecord]' = None, dkim_record: 'Optional[DomainLastStatusDkimRecord]' = None, dmarc_record: 'Optional[DomainLastStatusDmarcRecord]' = None, autoconfig_state: 'Optional[DomainLastStatusAutoconfigState]' = None)

Bases: object

autoconfig_state: DomainLastStatusAutoconfigState | None = None: The verification state of domain auto-configuration.

dkim_record: DomainLastStatusDkimRecord | None = None: The DKIM record verification data.

dmarc_record: DomainLastStatusDmarcRecord | None = None: The DMARC record verification data.

domain_id: str: The ID of the domain.

domain_name: str: The domain name (example.com).

spf_record: DomainLastStatusSpfRecord | None = None: The SPF record verification data.

class scaleway_async.tem.v1alpha1.types.DomainLastStatusAutoconfigState(enabled: 'bool', autoconfigurable: 'bool', reason: 'Optional[DomainLastStatusAutoconfigStateReason]' = <DomainLastStatusAutoconfigStateReason.UNKNOWN_REASON: 'unknown_reason'>)

Bases: object

autoconfigurable: bool: Whether the domain can be auto-configured or not.

enabled: bool: Enable or disable the auto-configuration of domain DNS records.

reason: DomainLastStatusAutoconfigStateReason | None = 'unknown_reason': The reason that the domain cannot be auto-configurable.

class scaleway_async.tem.v1alpha1.types.DomainLastStatusAutoconfigStateReason(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_NOT_FOUND = 'domain_not_found'

PERMISSION_DENIED = 'permission_denied'

UNKNOWN_REASON = 'unknown_reason'

class scaleway_async.tem.v1alpha1.types.DomainLastStatusDkimRecord(status: 'DomainLastStatusRecordStatus', last_valid_at: 'Optional[datetime]' = None, error: 'Optional[str]' = None)

Bases: object

error: str | None = None: An error text displays in case the record is not valid.

last_valid_at: datetime | None = None: Time and date the DKIM record was last valid.

status: DomainLastStatusRecordStatus: Status of the DKIM record’s configuration.

class scaleway_async.tem.v1alpha1.types.DomainLastStatusDmarcRecord(status: 'DomainLastStatusRecordStatus', last_valid_at: 'Optional[datetime]' = None, error: 'Optional[str]' = None)

Bases: object

error: str | None = None: An error text displays in case the record is not valid.

last_valid_at: datetime | None = None: Time and date the DMARC record was last valid.

status: DomainLastStatusRecordStatus: Status of the DMARC record’s configuration.

class scaleway_async.tem.v1alpha1.types.DomainLastStatusRecordStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

INVALID = 'invalid'

NOT_FOUND = 'not_found'

UNKNOWN_RECORD_STATUS = 'unknown_record_status'

VALID = 'valid'

class scaleway_async.tem.v1alpha1.types.DomainLastStatusSpfRecord(status: 'DomainLastStatusRecordStatus', last_valid_at: 'Optional[datetime]' = None, error: 'Optional[str]' = None)

Bases: object

error: str | None = None: An error text displays in case the record is not valid.

last_valid_at: datetime | None = None: Time and date the SPF record was last valid.

status: DomainLastStatusRecordStatus: Status of the SPF record’s configuration.

class scaleway_async.tem.v1alpha1.types.DomainRecords(dmarc: 'Optional[DomainRecordsDMARC]' = None)

Bases: object

dmarc: DomainRecordsDMARC | None = None: DMARC TXT record specification.

class scaleway_async.tem.v1alpha1.types.DomainRecordsDMARC(name: 'str', value: 'str')

Bases: object

name: str: Name of the DMARC TXT record.

value: str: Value of the DMARC TXT record.

class scaleway_async.tem.v1alpha1.types.DomainReputation(status: 'DomainReputationStatus', score: 'int', scored_at: 'Optional[datetime]' = None, previous_score: 'Optional[int]' = 0, previous_scored_at: 'Optional[datetime]' = None)

Bases: object

previous_score: int | None = 0: The previously-calculated domain’s reputation score.

previous_scored_at: datetime | None = None: Time and date the previous reputation score was calculated.

score: int: A range from 0 to 100 that determines your domain’s reputation score. A score of 0 means a bad domain reputation and a score of 100 means an excellent domain reputation.

scored_at: datetime | None = None: Time and date the score was calculated.

status: DomainReputationStatus: Status of your domain’s reputation.

class scaleway_async.tem.v1alpha1.types.DomainReputationStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

AVERAGE = 'average'

BAD = 'bad'

EXCELLENT = 'excellent'

GOOD = 'good'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.tem.v1alpha1.types.DomainStatistics(total_count: 'int', sent_count: 'int', failed_count: 'int', canceled_count: 'int')

Bases: object

canceled_count: int

failed_count: int

sent_count: int

total_count: int

class scaleway_async.tem.v1alpha1.types.DomainStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

AUTOCONFIGURING = 'autoconfiguring'

CHECKED = 'checked'

INVALID = 'invalid'

LOCKED = 'locked'

PENDING = 'pending'

REVOKED = 'revoked'

UNCHECKED = 'unchecked'

UNKNOWN = 'unknown'

class scaleway_async.tem.v1alpha1.types.Email(id: 'str', message_id: 'str', project_id: 'str', mail_from: 'str', mail_rcpt: 'str', rcpt_type: 'EmailRcptType', subject: 'str', status: 'EmailStatus', try_count: 'int', last_tries: 'List[EmailTry]', flags: 'List[EmailFlag]', rcpt_to: 'Optional[str]' = None, created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, status_details: 'Optional[str]' = None)

Bases: object

created_at: datetime | None = None: Creation date of the email object.

flags: List[EmailFlag]: Flags categorize emails. They allow you to obtain more information about recurring errors, for example.

id: str: Technical ID of the email.

last_tries: List[EmailTry]: Information about the last three attempts to send the email.

mail_from: str: Email address of the sender.

mail_rcpt: str: Email address of the recipient.

message_id: str: Message ID of the email.

project_id: str: ID of the Project to which the email belongs.

rcpt_to: str | None = None: Deprecated. Email address of the recipient.

rcpt_type: EmailRcptType: Type of recipient.

status: EmailStatus: Status of the email.

status_details: str | None = None: Additional status information.

subject: str: Subject of the email.

try_count: int: Number of attempts to send the email.

updated_at: datetime | None = None: Last update of the email object.

class scaleway_async.tem.v1alpha1.types.EmailFlag(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BLOCKLISTED = 'blocklisted'

GREYLISTED = 'greylisted'

HARD_BOUNCE = 'hard_bounce'

MAILBOX_FULL = 'mailbox_full'

MAILBOX_NOT_FOUND = 'mailbox_not_found'

SEND_BEFORE_EXPIRATION = 'send_before_expiration'

SOFT_BOUNCE = 'soft_bounce'

SPAM = 'spam'

UNKNOWN_FLAG = 'unknown_flag'

class scaleway_async.tem.v1alpha1.types.EmailRcptType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BCC = 'bcc'

CC = 'cc'

TO = 'to'

UNKNOWN_RCPT_TYPE = 'unknown_rcpt_type'

class scaleway_async.tem.v1alpha1.types.EmailStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CANCELED = 'canceled'

FAILED = 'failed'

NEW = 'new'

SENDING = 'sending'

SENT = 'sent'

UNKNOWN = 'unknown'

class scaleway_async.tem.v1alpha1.types.EmailTry(rank: 'int', code: 'int', message: 'str', tried_at: 'Optional[datetime]' = None)

Bases: object

code: int: The SMTP status code received after the attempt. 0 if the attempt did not reach an SMTP server.

message: str: The SMTP message received. If the attempt did not reach an SMTP server, the message returned explains what happened.

rank: int: Rank number of this attempt to send the email.

tried_at: datetime | None = None: Date of the attempt to send the email.

class scaleway_async.tem.v1alpha1.types.GetDomainLastStatusRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.GetDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.GetEmailRequest(email_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

email_id: str: ID of the email to retrieve.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.GetProjectConsumptionRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: ID of the project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.GetProjectSettingsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: ID of the project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.GetStatisticsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None, since: 'Optional[datetime]' = None, until: 'Optional[datetime]' = None, mail_from: 'Optional[str]' = None)

Bases: object

domain_id: str | None = None: (Optional) Number of emails sent from this domain (must be coherent with the project_id and the organization_id).

mail_from: str | None = None: (Optional) Number of emails sent with this sender’s email address.

project_id: str | None = None: (Optional) Number of emails for this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

since: datetime | None = None: (Optional) Number of emails created after this date.

until: datetime | None = None: (Optional) Number of emails created before this date.

class scaleway_async.tem.v1alpha1.types.GetWebhookRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

webhook_id: str: ID of the Webhook to check.

class scaleway_async.tem.v1alpha1.types.ListBlocklistsRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None, order_by: 'Optional[ListBlocklistsRequestOrderBy]' = <ListBlocklistsRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, email: 'Optional[str]' = None, type_: 'Optional[BlocklistType]' = <BlocklistType.UNKNOWN_TYPE: 'unknown_type'>, custom: 'Optional[bool]' = False)

Bases: object

custom: bool | None = False: (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false).

domain_id: str: (Optional) Filter by a domain ID.

email: str | None = None: (Optional) Filter by an email address.

order_by: ListBlocklistsRequestOrderBy | None = 'created_at_desc': (Optional) List blocklist corresponding to specific criteria.

page: int | None = 0: (Optional) Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: (Optional) Requested page size. Value must be between 1 and 100.

region: str | None = None: Region to target. If none is passed will use default region from the config.

type_: BlocklistType | None = 'unknown_type': (Optional) Filter by a blocklist type.

class scaleway_async.tem.v1alpha1.types.ListBlocklistsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

ENDS_AT_ASC = 'ends_at_asc'

ENDS_AT_DESC = 'ends_at_desc'

class scaleway_async.tem.v1alpha1.types.ListBlocklistsResponse(total_count: 'int', blocklists: 'List[Blocklist]')

Bases: object

blocklists: List[Blocklist]: Single page of blocklists matching the requested criteria.

total_count: int: Number of blocklists matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.ListDomainsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, status: 'Optional[List[DomainStatus]]' = <factory>, organization_id: 'Optional[str]' = None, name: 'Optional[str]' = None)

Bases: object

name: str | None = None: (Optional) Names of the domains to list.

organization_id: str | None = None: (Optional) ID of the Organization in which to list the domains.

page: int | None = 0: Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: Requested page size. Value must be between 1 and 1000.

project_id: str | None = None: (Optional) ID of the Project in which to list the domains.

region: str | None = None: Region to target. If none is passed will use default region from the config.

status: List[DomainStatus] | None: (Optional) List domains under specific statuses.

class scaleway_async.tem.v1alpha1.types.ListDomainsResponse(total_count: 'int', domains: 'List[Domain]')

Bases: object

domains: List[Domain]: Single page of domains matching the requested criteria.

total_count: int: Number of domains that match the request (without pagination).

class scaleway_async.tem.v1alpha1.types.ListEmailsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None, message_id: 'Optional[str]' = None, since: 'Optional[datetime]' = None, until: 'Optional[datetime]' = None, mail_from: 'Optional[str]' = None, mail_to: 'Optional[str]' = None, mail_rcpt: 'Optional[str]' = None, statuses: 'Optional[List[EmailStatus]]' = <factory>, subject: 'Optional[str]' = None, search: 'Optional[str]' = None, order_by: 'Optional[ListEmailsRequestOrderBy]' = <ListEmailsRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, flags: 'Optional[List[EmailFlag]]' = <factory>)

Bases: object

domain_id: str | None = None: (Optional) ID of the domain for which to list the emails.

flags: List[EmailFlag] | None: (Optional) List emails containing only specific flags.

mail_from: str | None = None: (Optional) List emails sent with this sender’s email address.

mail_rcpt: str | None = None: (Optional) List emails sent to this recipient’s email address.

mail_to: str | None = None: Deprecated. List emails sent to this recipient’s email address.

message_id: str | None = None: (Optional) ID of the message for which to list the emails.

order_by: ListEmailsRequestOrderBy | None = 'created_at_desc': (Optional) List emails corresponding to specific criteria.

page: int | None = 0

page_size: int | None = 0

project_id: str | None = None: (Optional) ID of the Project in which to list the emails.

region: str | None = None: Region to target. If none is passed will use default region from the config.

search: str | None = None: (Optional) List emails by searching to all fields.

since: datetime | None = None: (Optional) List emails created after this date.

statuses: List[EmailStatus] | None: (Optional) List emails with any of these statuses.

subject: str | None = None: (Optional) List emails with this subject.

until: datetime | None = None: (Optional) List emails created before this date.

class scaleway_async.tem.v1alpha1.types.ListEmailsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

MAIL_FROM_ASC = 'mail_from_asc'

MAIL_FROM_DESC = 'mail_from_desc'

MAIL_RCPT_ASC = 'mail_rcpt_asc'

MAIL_RCPT_DESC = 'mail_rcpt_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

SUBJECT_ASC = 'subject_asc'

SUBJECT_DESC = 'subject_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway_async.tem.v1alpha1.types.ListEmailsResponse(total_count: 'int', emails: 'List[Email]')

Bases: object

emails: List[Email]: Single page of emails matching the requested criteria.

total_count: int: Number of emails matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.ListOfferSubscriptionsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: ID of the Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.ListOfferSubscriptionsResponse(total_count: 'int', offer_subscriptions: 'List[OfferSubscription]')

Bases: object

offer_subscriptions: List[OfferSubscription]: Single page of offer-subscriptions matching the requested criteria.

total_count: int: Number of offer-subscriptions matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.ListOffersRequest(region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.ListOffersResponse(total_count: 'int', offers: 'List[Offer]')

Bases: object

offers: List[Offer]: Single page of offers matching the requested criteria.

total_count: int: Number of offers matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.ListPoolsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None)

Bases: object

page: int | None = 0: Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: Requested page size. Value must be between 1 and 1000.

project_id: str | None = None: ID of the Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.ListPoolsResponse(total_count: 'int', pools: 'List[Pool]')

Bases: object

pools: List[Pool]: Single page of pools matching the requested criteria.

total_count: int: Number of pools matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.ListWebhookEventsRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None, order_by: 'Optional[ListWebhookEventsRequestOrderBy]' = <ListWebhookEventsRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, email_id: 'Optional[str]' = None, event_types: 'Optional[List[WebhookEventType]]' = <factory>, statuses: 'Optional[List[WebhookEventStatus]]' = <factory>, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None)

Bases: object

domain_id: str | None = None: ID of the domain to watch for triggering events.

email_id: str | None = None: ID of the email linked to the events.

event_types: List[WebhookEventType] | None: List of event types linked to the events.

order_by: ListWebhookEventsRequestOrderBy | None = 'created_at_desc': (Optional) List Webhook events corresponding to specific criteria.

organization_id: str | None = None: ID of the webhook Organization.

page: int | None = 0: Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: Requested page size. Value must be between 1 and 100.

project_id: str | None = None: ID of the webhook Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

statuses: List[WebhookEventStatus] | None: List of event statuses.

webhook_id: str: ID of the Webhook linked to the events.

class scaleway_async.tem.v1alpha1.types.ListWebhookEventsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.tem.v1alpha1.types.ListWebhookEventsResponse(total_count: 'int', webhook_events: 'List[WebhookEvent]')

Bases: object

total_count: int: Number of Webhook events matching the requested criteria.

webhook_events: List[WebhookEvent]: Single page of Webhook events matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.ListWebhooksRequest(region: 'Optional[ScwRegion]' = None, order_by: 'Optional[ListWebhooksRequestOrderBy]' = <ListWebhooksRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None)

Bases: object

domain_id: str | None = None: (Optional) ID of the Domain for which to list the Webhooks.

order_by: ListWebhooksRequestOrderBy | None = 'created_at_desc': (Optional) List Webhooks corresponding to specific criteria.

organization_id: str | None = None: (Optional) ID of the Organization for which to list the Webhooks.

page: int | None = 0: (Optional) Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: (Optional) Requested page size. Value must be between 1 and 100.

project_id: str | None = None: (Optional) ID of the Project for which to list the Webhooks.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.ListWebhooksRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.tem.v1alpha1.types.ListWebhooksResponse(total_count: 'int', webhooks: 'List[Webhook]')

Bases: object

total_count: int: Number of Webhooks matching the requested criteria.

webhooks: List[Webhook]: Single page of Webhooks matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.Offer(name: 'OfferName', sla: 'float', max_domains: 'int', max_dedicated_ips: 'int', included_monthly_emails: 'int', max_webhooks_per_domain: 'int', max_custom_blocklists_per_domain: 'int', created_at: 'Optional[datetime]' = None, commitment_period: 'Optional[str]' = None)

Bases: object

commitment_period: str | None = None: Period of commitment.

created_at: datetime | None = None: Date and time of the offer creation.

included_monthly_emails: int: Number of emails included in the offer per month.

max_custom_blocklists_per_domain: int: Max number of active custom blocklists that can be associated with the offer.

max_dedicated_ips: int: Max number of dedicated IPs that can be associated with the offer.

max_domains: int: Max number of checked domains that can be associated with the offer.

max_webhooks_per_domain: int: Max number of webhooks that can be associated with the offer.

name: OfferName: Name of the offer.

sla: float: Service Level Agreement percentage of the offer.

class scaleway_async.tem.v1alpha1.types.OfferName(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ESSENTIAL = 'essential'

SCALE = 'scale'

UNKNOWN_NAME = 'unknown_name'

class scaleway_async.tem.v1alpha1.types.OfferSubscription(organization_id: 'str', project_id: 'str', offer_name: 'OfferName', sla: 'float', max_domains: 'int', max_dedicated_ips: 'int', max_webhooks_per_domain: 'int', max_custom_blocklists_per_domain: 'int', included_monthly_emails: 'int', subscribed_at: 'Optional[datetime]' = None, cancellation_available_at: 'Optional[datetime]' = None)

Bases: object

cancellation_available_at: datetime | None = None: Date and time of the end of the offer-subscription commitment.

included_monthly_emails: int: Number of emails included in the offer-subscription per month.

max_custom_blocklists_per_domain: int: Max number of custom blocklists that can be associated with the offer-subscription for a particular Project.

max_dedicated_ips: int: Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project.

max_domains: int: Max number of domains that can be associated with the offer-subscription for a particular Project.

max_webhooks_per_domain: int: Max number of webhooks that can be associated with the offer-subscription for a particular Project.

offer_name: OfferName: Name of the offer associated with the Project.

organization_id: str: ID of the offer-subscription Organization.

project_id: str: ID of the offer-subscription Project.

sla: float: Service Level Agreement percentage of the offer-subscription.

subscribed_at: datetime | None = None: Date and time of the subscription.

class scaleway_async.tem.v1alpha1.types.Pool(project_id: 'str', status: 'PoolStatus', ips: 'List[str]', details: 'Optional[str]' = None, zone: 'Optional[ScwZone]' = None, reverse: 'Optional[str]' = None)

Bases: object

details: str | None = None: Details of the pool.

ips: List[str]: IPs of the pool.

project_id: str: ID of the Project.

reverse: str | None = None: Reverse hostname of all IPs of the pool.

status: PoolStatus: Status of the pool.

zone: str | None = None: Zone of the pool.

class scaleway_async.tem.v1alpha1.types.PoolStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATING = 'creating'

DISABLED = 'disabled'

ERROR = 'error'

READY = 'ready'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.tem.v1alpha1.types.ProjectConsumption(project_id: 'str', domains_count: 'int', dedicated_ips_count: 'int', monthly_emails_count: 'int', webhooks_count: 'int', custom_blocklists_count: 'int')

Bases: object

custom_blocklists_count: int: Number of custom blocklists in the project.

dedicated_ips_count: int: Number of dedicated IP in the project.

domains_count: int: Number of domains in the project.

monthly_emails_count: int: Number of emails sent during the current month in the project.

project_id: str: ID of the project.

webhooks_count: int: Number of webhooks in the project.

class scaleway_async.tem.v1alpha1.types.ProjectSettings(periodic_report: 'Optional[ProjectSettingsPeriodicReport]' = None)

Bases: object

periodic_report: ProjectSettingsPeriodicReport | None = None: Information about your periodic report.

class scaleway_async.tem.v1alpha1.types.ProjectSettingsPeriodicReport(enabled: 'bool', frequency: 'ProjectSettingsPeriodicReportFrequency', sending_hour: 'int', sending_day: 'int')

Bases: object

enabled: bool: Enable or disable periodic report notifications.

frequency: ProjectSettingsPeriodicReportFrequency: At which frequency you receive periodic report notifications.

sending_day: int: On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).

sending_hour: int: At which hour you receive periodic report notifications.

class scaleway_async.tem.v1alpha1.types.ProjectSettingsPeriodicReportFrequency(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DAILY = 'daily'

MONTHLY = 'monthly'

UNKNOWN_FREQUENCY = 'unknown_frequency'

WEEKLY = 'weekly'

class scaleway_async.tem.v1alpha1.types.RevokeDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.Statistics(total_count: 'int', new_count: 'int', sending_count: 'int', sent_count: 'int', failed_count: 'int', canceled_count: 'int')

Bases: object

canceled_count: int: Number of emails in the final canceled state. This means emails that have been canceled upon request.

failed_count: int: Number of emails in the final failed state. This means emails that have been refused by the target mail system with a final error status.

new_count: int: Number of emails still in the new transient state. This means emails received from the API but not yet processed.

sending_count: int: Number of emails still in the sending transient state. This means emails received from the API but not yet in their final status.

sent_count: int: Number of emails in the final sent state. This means emails that have been delivered to the target mail system.

total_count: int: Total number of emails matching the requested criteria.

class scaleway_async.tem.v1alpha1.types.UpdateDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None, autoconfig: 'Optional[bool]' = False)

Bases: object

autoconfig: bool | None = False: (Optional) If set to true, activate auto-configuration of the domain’s DNS zone.

domain_id: str: ID of the domain to update.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.UpdateOfferSubscriptionRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, name: 'Optional[OfferName]' = <OfferName.UNKNOWN_NAME: 'unknown_name'>)

Bases: object

name: OfferName | None = 'unknown_name': Name of the offer-subscription.

project_id: str | None = None: ID of the Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.UpdateProjectSettingsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, periodic_report: 'Optional[UpdateProjectSettingsRequestUpdatePeriodicReport]' = None)

Bases: object

periodic_report: UpdateProjectSettingsRequestUpdatePeriodicReport | None = None: Periodic report update details - all fields are optional.

project_id: str | None = None: ID of the project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.types.UpdateProjectSettingsRequestUpdatePeriodicReport(enabled: 'Optional[bool]' = False, frequency: 'Optional[ProjectSettingsPeriodicReportFrequency]' = <ProjectSettingsPeriodicReportFrequency.UNKNOWN_FREQUENCY: 'unknown_frequency'>, sending_hour: 'Optional[int]' = 0, sending_day: 'Optional[int]' = 0)

Bases: object

enabled: bool | None = False: (Optional) Enable or disable periodic report notifications.

frequency: ProjectSettingsPeriodicReportFrequency | None = 'unknown_frequency': (Optional) Frequency at which you receive periodic report notifications.

sending_day: int | None = 0: (Optional) On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).

sending_hour: int | None = 0: (Optional) Hour at which you receive periodic report notifications.

class scaleway_async.tem.v1alpha1.types.UpdateWebhookRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, event_types: 'Optional[List[WebhookEventType]]' = <factory>, sns_arn: 'Optional[str]' = None)

Bases: object

event_types: List[WebhookEventType] | None: List of event types to update.

name: str | None = None: Name of the Webhook to update.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_arn: str | None = None: Scaleway SNS ARN topic to update.

webhook_id: str: ID of the Webhook to update.

class scaleway_async.tem.v1alpha1.types.Webhook(id: 'str', domain_id: 'str', organization_id: 'str', project_id: 'str', name: 'str', event_types: 'List[WebhookEventType]', sns_arn: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Date and time of the Webhook creation.

domain_id: str: ID of the Domain to watch for triggering events.

event_types: List[WebhookEventType]: List of event types that will trigger a Webhook Event.

id: str: ID of the Webhook.

name: str: Name of the Webhook.

organization_id: str: ID of the Webhook Organization.

project_id: str: ID of the Webhook Project.

sns_arn: str: Scaleway SNS ARN topic to push the events to.

updated_at: datetime | None = None: Date and time of last Webhook updates.

class scaleway_async.tem.v1alpha1.types.WebhookEvent(id: 'str', webhook_id: 'str', organization_id: 'str', project_id: 'str', domain_id: 'str', type_: 'WebhookEventType', status: 'WebhookEventStatus', data: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, email_id: 'Optional[str]' = None)

Bases: object

created_at: datetime | None = None: Date and time of the Webhook Event creation.

data: str: Data sent to the Webhook destination.

domain_id: str: ID of the webhook event domain.

email_id: str | None = None: Optional Email ID if the event is triggered by an Email resource.

id: str: ID of the Webhook Event.

organization_id: str: ID of the Webhook Event Organization.

project_id: str: ID of the Webhook Event Project.

status: WebhookEventStatus: Status of the Webhook Event.

type_: WebhookEventType: Type of the Webhook Event.

updated_at: datetime | None = None: Date and time of last Webhook Event updates.

webhook_id: str: ID of the Webhook that triggers the Event.

class scaleway_async.tem.v1alpha1.types.WebhookEventStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

FAILED = 'failed'

SENDING = 'sending'

SENT = 'sent'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.tem.v1alpha1.types.WebhookEventType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BLOCKLIST_CREATED = 'blocklist_created'

EMAIL_BLOCKLISTED = 'email_blocklisted'

EMAIL_DEFERRED = 'email_deferred'

EMAIL_DELIVERED = 'email_delivered'

EMAIL_DROPPED = 'email_dropped'

EMAIL_MAILBOX_NOT_FOUND = 'email_mailbox_not_found'

EMAIL_QUEUED = 'email_queued'

EMAIL_SPAM = 'email_spam'

UNKNOWN_TYPE = 'unknown_type'

Module contents

class scaleway_async.tem.v1alpha1.Blocklist(id: 'str', domain_id: 'str', email: 'str', type_: 'BlocklistType', reason: 'str', custom: 'bool', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, ends_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Date and time of the blocklist creation.

custom: bool: True if this blocklist was created manually. False for an automatic Transactional Email blocklist.

domain_id: str: Domain ID linked to the blocklist.

email: str: Email blocked by the blocklist.

ends_at: datetime | None = None: Date and time when the blocklist ends. Empty if the blocklist has no end.

id: str: ID of the blocklist.

reason: str: Reason to block this email.

type_: BlocklistType: Type of block for this email.

updated_at: datetime | None = None: Date and time of the blocklist’s last update.

class scaleway_async.tem.v1alpha1.BlocklistType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

MAILBOX_FULL = 'mailbox_full'

MAILBOX_NOT_FOUND = 'mailbox_not_found'

UNKNOWN_TYPE = 'unknown_type'

class scaleway_async.tem.v1alpha1.BulkCreateBlocklistsRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None, emails: 'Optional[List[str]]' = <factory>, type_: 'Optional[BlocklistType]' = <BlocklistType.UNKNOWN_TYPE: 'unknown_type'>, reason: 'Optional[str]' = None)

Bases: object

domain_id: str: Domain ID linked to the blocklist.

emails: List[str] | None: Email blocked by the blocklist.

reason: str | None = None: Reason to block the email.

region: str | None = None: Region to target. If none is passed will use default region from the config.

type_: BlocklistType | None = 'unknown_type': Type of blocklist.

class scaleway_async.tem.v1alpha1.BulkCreateBlocklistsResponse(blocklists: 'List[Blocklist]')

Bases: object

blocklists: List[Blocklist]: List of blocklist created.

class scaleway_async.tem.v1alpha1.CancelEmailRequest(email_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

email_id: str: ID of the email to cancel.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.CheckDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain to check.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.CreateDomainRequest(domain_name: 'str', autoconfig: 'bool', region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, accept_tos: 'Optional[bool]' = False)

Bases: object

accept_tos: bool | None = False: Deprecated. Accept Scaleway’s Terms of Service.

autoconfig: bool: Activate auto-configuration of the domain’s DNS zone.

domain_name: str: Fully qualified domain dame.

project_id: str | None = None: ID of the project to which the domain belongs.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.CreateEmailRequest(from_: 'CreateEmailRequestAddress', subject: 'str', text: 'str', html: 'str', region: 'Optional[ScwRegion]' = None, to: 'Optional[List[CreateEmailRequestAddress]]' = <factory>, cc: 'Optional[List[CreateEmailRequestAddress]]' = <factory>, bcc: 'Optional[List[CreateEmailRequestAddress]]' = <factory>, project_id: 'Optional[str]' = None, attachments: 'Optional[List[CreateEmailRequestAttachment]]' = <factory>, send_before: 'Optional[datetime]' = None, additional_headers: 'Optional[List[CreateEmailRequestHeader]]' = <factory>)

Bases: object

additional_headers: List[CreateEmailRequestHeader] | None: Array of additional headers as key-value.

attachments: List[CreateEmailRequestAttachment] | None: Array of attachments.

bcc: List[CreateEmailRequestAddress] | None: An array of the blind carbon copy recipient’s information.

cc: List[CreateEmailRequestAddress] | None: An array of the carbon copy recipient’s information.

from_: CreateEmailRequestAddress: Sender information. Must be from a checked domain declared in the Project.

html: str: HTML content.

project_id: str | None = None: ID of the Project in which to create the email.

region: str | None = None: Region to target. If none is passed will use default region from the config.

send_before: datetime | None = None: Maximum date to deliver the email.

subject: str: Subject of the email.

text: str: Text content.

to: List[CreateEmailRequestAddress] | None: An array of the primary recipient’s information.

class scaleway_async.tem.v1alpha1.CreateEmailRequestAddress(email: 'str', name: 'Optional[str]' = None)

Bases: object

email: str: Email address.

name: str | None = None: (Optional) Name displayed.

class scaleway_async.tem.v1alpha1.CreateEmailRequestAttachment(name: 'str', type_: 'str', content: 'str')

Bases: object

content: str: Content of the attachment encoded in base64.

name: str: Filename of the attachment.

type_: str: MIME type of the attachment.

class scaleway_async.tem.v1alpha1.CreateEmailRequestHeader(key: 'str', value: 'str')

Bases: object

key: str: Email header key.

value: str: Email header value.

class scaleway_async.tem.v1alpha1.CreateEmailResponse(emails: 'List[Email]')

Bases: object

emails: List[Email]: Single page of emails matching the requested criteria.

class scaleway_async.tem.v1alpha1.CreateWebhookRequest(domain_id: 'str', name: 'str', sns_arn: 'str', region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, event_types: 'Optional[List[WebhookEventType]]' = <factory>)

Bases: object

domain_id: str: ID of the Domain to watch for triggering events.

event_types: List[WebhookEventType] | None: List of event types that will trigger an event.

name: str: Name of the Webhook.

project_id: str | None = None: ID of the project to which the Webhook belongs.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_arn: str: Scaleway SNS ARN topic to push the events to.

class scaleway_async.tem.v1alpha1.DeleteBlocklistRequest(blocklist_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

blocklist_id: str: ID of the blocklist to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.DeleteWebhookRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

webhook_id: str: ID of the Webhook to delete.

class scaleway_async.tem.v1alpha1.Domain(id: 'str', organization_id: 'str', project_id: 'str', name: 'str', status: 'DomainStatus', spf_config: 'str', dkim_config: 'str', autoconfig: 'bool', region: 'ScwRegion', created_at: 'Optional[datetime]' = None, next_check_at: 'Optional[datetime]' = None, last_valid_at: 'Optional[datetime]' = None, revoked_at: 'Optional[datetime]' = None, last_error: 'Optional[str]' = None, statistics: 'Optional[DomainStatistics]' = None, reputation: 'Optional[DomainReputation]' = None, records: 'Optional[DomainRecords]' = None)

Bases: object

autoconfig: bool: Status of auto-configuration for the domain’s DNS zone.

created_at: datetime | None = None: Date and time of domain creation.

dkim_config: str: DKIM public key to record in the DNS zone.

id: str: ID of the domain.

last_error: str | None = None: Deprecated. Error message returned if the last check failed.

last_valid_at: datetime | None = None: Date and time the domain was last valid.

name: str: Domain name (example.com).

next_check_at: datetime | None = None: Date and time of the next scheduled check.

organization_id: str: ID of the domain’s Organization.

project_id: str: ID of the domain’s Project.

records: DomainRecords | None = None: List of records to configure to validate a domain.

region: str: Region to target. If none is passed will use default region from the config.

reputation: DomainReputation | None = None: The domain’s reputation is available when your domain is checked and has sent enough emails.

revoked_at: datetime | None = None: Date and time of the domain’s deletion.

spf_config: str: Snippet of the SPF record to register in the DNS zone.

statistics: DomainStatistics | None = None: Domain’s statistics.

status: DomainStatus: Status of the domain.

class scaleway_async.tem.v1alpha1.DomainLastStatus(domain_id: 'str', domain_name: 'str', spf_record: 'Optional[DomainLastStatusSpfRecord]' = None, dkim_record: 'Optional[DomainLastStatusDkimRecord]' = None, dmarc_record: 'Optional[DomainLastStatusDmarcRecord]' = None, autoconfig_state: 'Optional[DomainLastStatusAutoconfigState]' = None)

Bases: object

autoconfig_state: DomainLastStatusAutoconfigState | None = None: The verification state of domain auto-configuration.

dkim_record: DomainLastStatusDkimRecord | None = None: The DKIM record verification data.

dmarc_record: DomainLastStatusDmarcRecord | None = None: The DMARC record verification data.

domain_id: str: The ID of the domain.

domain_name: str: The domain name (example.com).

spf_record: DomainLastStatusSpfRecord | None = None: The SPF record verification data.

class scaleway_async.tem.v1alpha1.DomainLastStatusAutoconfigState(enabled: 'bool', autoconfigurable: 'bool', reason: 'Optional[DomainLastStatusAutoconfigStateReason]' = <DomainLastStatusAutoconfigStateReason.UNKNOWN_REASON: 'unknown_reason'>)

Bases: object

autoconfigurable: bool: Whether the domain can be auto-configured or not.

enabled: bool: Enable or disable the auto-configuration of domain DNS records.

reason: DomainLastStatusAutoconfigStateReason | None = 'unknown_reason': The reason that the domain cannot be auto-configurable.

class scaleway_async.tem.v1alpha1.DomainLastStatusAutoconfigStateReason(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DOMAIN_NOT_FOUND = 'domain_not_found'

PERMISSION_DENIED = 'permission_denied'

UNKNOWN_REASON = 'unknown_reason'

class scaleway_async.tem.v1alpha1.DomainLastStatusDkimRecord(status: 'DomainLastStatusRecordStatus', last_valid_at: 'Optional[datetime]' = None, error: 'Optional[str]' = None)

Bases: object

error: str | None = None: An error text displays in case the record is not valid.

last_valid_at: datetime | None = None: Time and date the DKIM record was last valid.

status: DomainLastStatusRecordStatus: Status of the DKIM record’s configuration.

class scaleway_async.tem.v1alpha1.DomainLastStatusDmarcRecord(status: 'DomainLastStatusRecordStatus', last_valid_at: 'Optional[datetime]' = None, error: 'Optional[str]' = None)

Bases: object

error: str | None = None: An error text displays in case the record is not valid.

last_valid_at: datetime | None = None: Time and date the DMARC record was last valid.

status: DomainLastStatusRecordStatus: Status of the DMARC record’s configuration.

class scaleway_async.tem.v1alpha1.DomainLastStatusRecordStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

INVALID = 'invalid'

NOT_FOUND = 'not_found'

UNKNOWN_RECORD_STATUS = 'unknown_record_status'

VALID = 'valid'

class scaleway_async.tem.v1alpha1.DomainLastStatusSpfRecord(status: 'DomainLastStatusRecordStatus', last_valid_at: 'Optional[datetime]' = None, error: 'Optional[str]' = None)

Bases: object

error: str | None = None: An error text displays in case the record is not valid.

last_valid_at: datetime | None = None: Time and date the SPF record was last valid.

status: DomainLastStatusRecordStatus: Status of the SPF record’s configuration.

class scaleway_async.tem.v1alpha1.DomainRecords(dmarc: 'Optional[DomainRecordsDMARC]' = None)

Bases: object

dmarc: DomainRecordsDMARC | None = None: DMARC TXT record specification.

class scaleway_async.tem.v1alpha1.DomainRecordsDMARC(name: 'str', value: 'str')

Bases: object

name: str: Name of the DMARC TXT record.

value: str: Value of the DMARC TXT record.

class scaleway_async.tem.v1alpha1.DomainReputation(status: 'DomainReputationStatus', score: 'int', scored_at: 'Optional[datetime]' = None, previous_score: 'Optional[int]' = 0, previous_scored_at: 'Optional[datetime]' = None)

Bases: object

previous_score: int | None = 0: The previously-calculated domain’s reputation score.

previous_scored_at: datetime | None = None: Time and date the previous reputation score was calculated.

score: int: A range from 0 to 100 that determines your domain’s reputation score. A score of 0 means a bad domain reputation and a score of 100 means an excellent domain reputation.

scored_at: datetime | None = None: Time and date the score was calculated.

status: DomainReputationStatus: Status of your domain’s reputation.

class scaleway_async.tem.v1alpha1.DomainReputationStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

AVERAGE = 'average'

BAD = 'bad'

EXCELLENT = 'excellent'

GOOD = 'good'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.tem.v1alpha1.DomainStatistics(total_count: 'int', sent_count: 'int', failed_count: 'int', canceled_count: 'int')

Bases: object

canceled_count: int

failed_count: int

sent_count: int

total_count: int

class scaleway_async.tem.v1alpha1.DomainStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

AUTOCONFIGURING = 'autoconfiguring'

CHECKED = 'checked'

INVALID = 'invalid'

LOCKED = 'locked'

PENDING = 'pending'

REVOKED = 'revoked'

UNCHECKED = 'unchecked'

UNKNOWN = 'unknown'

class scaleway_async.tem.v1alpha1.Email(id: 'str', message_id: 'str', project_id: 'str', mail_from: 'str', mail_rcpt: 'str', rcpt_type: 'EmailRcptType', subject: 'str', status: 'EmailStatus', try_count: 'int', last_tries: 'List[EmailTry]', flags: 'List[EmailFlag]', rcpt_to: 'Optional[str]' = None, created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, status_details: 'Optional[str]' = None)

Bases: object

created_at: datetime | None = None: Creation date of the email object.

flags: List[EmailFlag]: Flags categorize emails. They allow you to obtain more information about recurring errors, for example.

id: str: Technical ID of the email.

last_tries: List[EmailTry]: Information about the last three attempts to send the email.

mail_from: str: Email address of the sender.

mail_rcpt: str: Email address of the recipient.

message_id: str: Message ID of the email.

project_id: str: ID of the Project to which the email belongs.

rcpt_to: str | None = None: Deprecated. Email address of the recipient.

rcpt_type: EmailRcptType: Type of recipient.

status: EmailStatus: Status of the email.

status_details: str | None = None: Additional status information.

subject: str: Subject of the email.

try_count: int: Number of attempts to send the email.

updated_at: datetime | None = None: Last update of the email object.

class scaleway_async.tem.v1alpha1.EmailFlag(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BLOCKLISTED = 'blocklisted'

GREYLISTED = 'greylisted'

HARD_BOUNCE = 'hard_bounce'

MAILBOX_FULL = 'mailbox_full'

MAILBOX_NOT_FOUND = 'mailbox_not_found'

SEND_BEFORE_EXPIRATION = 'send_before_expiration'

SOFT_BOUNCE = 'soft_bounce'

SPAM = 'spam'

UNKNOWN_FLAG = 'unknown_flag'

class scaleway_async.tem.v1alpha1.EmailRcptType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BCC = 'bcc'

CC = 'cc'

TO = 'to'

UNKNOWN_RCPT_TYPE = 'unknown_rcpt_type'

class scaleway_async.tem.v1alpha1.EmailStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CANCELED = 'canceled'

FAILED = 'failed'

NEW = 'new'

SENDING = 'sending'

SENT = 'sent'

UNKNOWN = 'unknown'

class scaleway_async.tem.v1alpha1.EmailTry(rank: 'int', code: 'int', message: 'str', tried_at: 'Optional[datetime]' = None)

Bases: object

code: int: The SMTP status code received after the attempt. 0 if the attempt did not reach an SMTP server.

message: str: The SMTP message received. If the attempt did not reach an SMTP server, the message returned explains what happened.

rank: int: Rank number of this attempt to send the email.

tried_at: datetime | None = None: Date of the attempt to send the email.

class scaleway_async.tem.v1alpha1.GetDomainLastStatusRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.GetDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.GetEmailRequest(email_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

email_id: str: ID of the email to retrieve.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.GetProjectConsumptionRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: ID of the project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.GetProjectSettingsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: ID of the project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.GetStatisticsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None, since: 'Optional[datetime]' = None, until: 'Optional[datetime]' = None, mail_from: 'Optional[str]' = None)

Bases: object

domain_id: str | None = None: (Optional) Number of emails sent from this domain (must be coherent with the project_id and the organization_id).

mail_from: str | None = None: (Optional) Number of emails sent with this sender’s email address.

project_id: str | None = None: (Optional) Number of emails for this Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

since: datetime | None = None: (Optional) Number of emails created after this date.

until: datetime | None = None: (Optional) Number of emails created before this date.

class scaleway_async.tem.v1alpha1.GetWebhookRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

webhook_id: str: ID of the Webhook to check.

class scaleway_async.tem.v1alpha1.ListBlocklistsRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None, order_by: 'Optional[ListBlocklistsRequestOrderBy]' = <ListBlocklistsRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, email: 'Optional[str]' = None, type_: 'Optional[BlocklistType]' = <BlocklistType.UNKNOWN_TYPE: 'unknown_type'>, custom: 'Optional[bool]' = False)

Bases: object

custom: bool | None = False: (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false).

domain_id: str: (Optional) Filter by a domain ID.

email: str | None = None: (Optional) Filter by an email address.

order_by: ListBlocklistsRequestOrderBy | None = 'created_at_desc': (Optional) List blocklist corresponding to specific criteria.

page: int | None = 0: (Optional) Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: (Optional) Requested page size. Value must be between 1 and 100.

region: str | None = None: Region to target. If none is passed will use default region from the config.

type_: BlocklistType | None = 'unknown_type': (Optional) Filter by a blocklist type.

class scaleway_async.tem.v1alpha1.ListBlocklistsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

ENDS_AT_ASC = 'ends_at_asc'

ENDS_AT_DESC = 'ends_at_desc'

class scaleway_async.tem.v1alpha1.ListBlocklistsResponse(total_count: 'int', blocklists: 'List[Blocklist]')

Bases: object

blocklists: List[Blocklist]: Single page of blocklists matching the requested criteria.

total_count: int: Number of blocklists matching the requested criteria.

class scaleway_async.tem.v1alpha1.ListDomainsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, status: 'Optional[List[DomainStatus]]' = <factory>, organization_id: 'Optional[str]' = None, name: 'Optional[str]' = None)

Bases: object

name: str | None = None: (Optional) Names of the domains to list.

organization_id: str | None = None: (Optional) ID of the Organization in which to list the domains.

page: int | None = 0: Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: Requested page size. Value must be between 1 and 1000.

project_id: str | None = None: (Optional) ID of the Project in which to list the domains.

region: str | None = None: Region to target. If none is passed will use default region from the config.

status: List[DomainStatus] | None: (Optional) List domains under specific statuses.

class scaleway_async.tem.v1alpha1.ListDomainsResponse(total_count: 'int', domains: 'List[Domain]')

Bases: object

domains: List[Domain]: Single page of domains matching the requested criteria.

total_count: int: Number of domains that match the request (without pagination).

class scaleway_async.tem.v1alpha1.ListEmailsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None, message_id: 'Optional[str]' = None, since: 'Optional[datetime]' = None, until: 'Optional[datetime]' = None, mail_from: 'Optional[str]' = None, mail_to: 'Optional[str]' = None, mail_rcpt: 'Optional[str]' = None, statuses: 'Optional[List[EmailStatus]]' = <factory>, subject: 'Optional[str]' = None, search: 'Optional[str]' = None, order_by: 'Optional[ListEmailsRequestOrderBy]' = <ListEmailsRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, flags: 'Optional[List[EmailFlag]]' = <factory>)

Bases: object

domain_id: str | None = None: (Optional) ID of the domain for which to list the emails.

flags: List[EmailFlag] | None: (Optional) List emails containing only specific flags.

mail_from: str | None = None: (Optional) List emails sent with this sender’s email address.

mail_rcpt: str | None = None: (Optional) List emails sent to this recipient’s email address.

mail_to: str | None = None: Deprecated. List emails sent to this recipient’s email address.

message_id: str | None = None: (Optional) ID of the message for which to list the emails.

order_by: ListEmailsRequestOrderBy | None = 'created_at_desc': (Optional) List emails corresponding to specific criteria.

page: int | None = 0

page_size: int | None = 0

project_id: str | None = None: (Optional) ID of the Project in which to list the emails.

region: str | None = None: Region to target. If none is passed will use default region from the config.

search: str | None = None: (Optional) List emails by searching to all fields.

since: datetime | None = None: (Optional) List emails created after this date.

statuses: List[EmailStatus] | None: (Optional) List emails with any of these statuses.

subject: str | None = None: (Optional) List emails with this subject.

until: datetime | None = None: (Optional) List emails created before this date.

class scaleway_async.tem.v1alpha1.ListEmailsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

MAIL_FROM_ASC = 'mail_from_asc'

MAIL_FROM_DESC = 'mail_from_desc'

MAIL_RCPT_ASC = 'mail_rcpt_asc'

MAIL_RCPT_DESC = 'mail_rcpt_desc'

STATUS_ASC = 'status_asc'

STATUS_DESC = 'status_desc'

SUBJECT_ASC = 'subject_asc'

SUBJECT_DESC = 'subject_desc'

UPDATED_AT_ASC = 'updated_at_asc'

UPDATED_AT_DESC = 'updated_at_desc'

class scaleway_async.tem.v1alpha1.ListEmailsResponse(total_count: 'int', emails: 'List[Email]')

Bases: object

emails: List[Email]: Single page of emails matching the requested criteria.

total_count: int: Number of emails matching the requested criteria.

class scaleway_async.tem.v1alpha1.ListOfferSubscriptionsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None)

Bases: object

project_id: str | None = None: ID of the Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.ListOfferSubscriptionsResponse(total_count: 'int', offer_subscriptions: 'List[OfferSubscription]')

Bases: object

offer_subscriptions: List[OfferSubscription]: Single page of offer-subscriptions matching the requested criteria.

total_count: int: Number of offer-subscriptions matching the requested criteria.

class scaleway_async.tem.v1alpha1.ListOffersRequest(region: 'Optional[ScwRegion]' = None)

Bases: object

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.ListOffersResponse(total_count: 'int', offers: 'List[Offer]')

Bases: object

offers: List[Offer]: Single page of offers matching the requested criteria.

total_count: int: Number of offers matching the requested criteria.

class scaleway_async.tem.v1alpha1.ListPoolsRequest(region: 'Optional[ScwRegion]' = None, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None)

Bases: object

page: int | None = 0: Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: Requested page size. Value must be between 1 and 1000.

project_id: str | None = None: ID of the Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.ListPoolsResponse(total_count: 'int', pools: 'List[Pool]')

Bases: object

pools: List[Pool]: Single page of pools matching the requested criteria.

total_count: int: Number of pools matching the requested criteria.

class scaleway_async.tem.v1alpha1.ListWebhookEventsRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None, order_by: 'Optional[ListWebhookEventsRequestOrderBy]' = <ListWebhookEventsRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, email_id: 'Optional[str]' = None, event_types: 'Optional[List[WebhookEventType]]' = <factory>, statuses: 'Optional[List[WebhookEventStatus]]' = <factory>, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None)

Bases: object

domain_id: str | None = None: ID of the domain to watch for triggering events.

email_id: str | None = None: ID of the email linked to the events.

event_types: List[WebhookEventType] | None: List of event types linked to the events.

order_by: ListWebhookEventsRequestOrderBy | None = 'created_at_desc': (Optional) List Webhook events corresponding to specific criteria.

organization_id: str | None = None: ID of the webhook Organization.

page: int | None = 0: Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: Requested page size. Value must be between 1 and 100.

project_id: str | None = None: ID of the webhook Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

statuses: List[WebhookEventStatus] | None: List of event statuses.

webhook_id: str: ID of the Webhook linked to the events.

class scaleway_async.tem.v1alpha1.ListWebhookEventsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.tem.v1alpha1.ListWebhookEventsResponse(total_count: 'int', webhook_events: 'List[WebhookEvent]')

Bases: object

total_count: int: Number of Webhook events matching the requested criteria.

webhook_events: List[WebhookEvent]: Single page of Webhook events matching the requested criteria.

class scaleway_async.tem.v1alpha1.ListWebhooksRequest(region: 'Optional[ScwRegion]' = None, order_by: 'Optional[ListWebhooksRequestOrderBy]' = <ListWebhooksRequestOrderBy.CREATED_AT_DESC: 'created_at_desc'>, page: 'Optional[int]' = 0, page_size: 'Optional[int]' = 0, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, domain_id: 'Optional[str]' = None)

Bases: object

domain_id: str | None = None: (Optional) ID of the Domain for which to list the Webhooks.

order_by: ListWebhooksRequestOrderBy | None = 'created_at_desc': (Optional) List Webhooks corresponding to specific criteria.

organization_id: str | None = None: (Optional) ID of the Organization for which to list the Webhooks.

page: int | None = 0: (Optional) Requested page number. Value must be greater or equal to 1.

page_size: int | None = 0: (Optional) Requested page size. Value must be between 1 and 100.

project_id: str | None = None: (Optional) ID of the Project for which to list the Webhooks.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.ListWebhooksRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.tem.v1alpha1.ListWebhooksResponse(total_count: 'int', webhooks: 'List[Webhook]')

Bases: object

total_count: int: Number of Webhooks matching the requested criteria.

webhooks: List[Webhook]: Single page of Webhooks matching the requested criteria.

class scaleway_async.tem.v1alpha1.Offer(name: 'OfferName', sla: 'float', max_domains: 'int', max_dedicated_ips: 'int', included_monthly_emails: 'int', max_webhooks_per_domain: 'int', max_custom_blocklists_per_domain: 'int', created_at: 'Optional[datetime]' = None, commitment_period: 'Optional[str]' = None)

Bases: object

commitment_period: str | None = None: Period of commitment.

created_at: datetime | None = None: Date and time of the offer creation.

included_monthly_emails: int: Number of emails included in the offer per month.

max_custom_blocklists_per_domain: int: Max number of active custom blocklists that can be associated with the offer.

max_dedicated_ips: int: Max number of dedicated IPs that can be associated with the offer.

max_domains: int: Max number of checked domains that can be associated with the offer.

max_webhooks_per_domain: int: Max number of webhooks that can be associated with the offer.

name: OfferName: Name of the offer.

sla: float: Service Level Agreement percentage of the offer.

class scaleway_async.tem.v1alpha1.OfferName(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ESSENTIAL = 'essential'

SCALE = 'scale'

UNKNOWN_NAME = 'unknown_name'

class scaleway_async.tem.v1alpha1.OfferSubscription(organization_id: 'str', project_id: 'str', offer_name: 'OfferName', sla: 'float', max_domains: 'int', max_dedicated_ips: 'int', max_webhooks_per_domain: 'int', max_custom_blocklists_per_domain: 'int', included_monthly_emails: 'int', subscribed_at: 'Optional[datetime]' = None, cancellation_available_at: 'Optional[datetime]' = None)

Bases: object

cancellation_available_at: datetime | None = None: Date and time of the end of the offer-subscription commitment.

included_monthly_emails: int: Number of emails included in the offer-subscription per month.

max_custom_blocklists_per_domain: int: Max number of custom blocklists that can be associated with the offer-subscription for a particular Project.

max_dedicated_ips: int: Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project.

max_domains: int: Max number of domains that can be associated with the offer-subscription for a particular Project.

max_webhooks_per_domain: int: Max number of webhooks that can be associated with the offer-subscription for a particular Project.

offer_name: OfferName: Name of the offer associated with the Project.

organization_id: str: ID of the offer-subscription Organization.

project_id: str: ID of the offer-subscription Project.

sla: float: Service Level Agreement percentage of the offer-subscription.

subscribed_at: datetime | None = None: Date and time of the subscription.

class scaleway_async.tem.v1alpha1.Pool(project_id: 'str', status: 'PoolStatus', ips: 'List[str]', details: 'Optional[str]' = None, zone: 'Optional[ScwZone]' = None, reverse: 'Optional[str]' = None)

Bases: object

details: str | None = None: Details of the pool.

ips: List[str]: IPs of the pool.

project_id: str: ID of the Project.

reverse: str | None = None: Reverse hostname of all IPs of the pool.

status: PoolStatus: Status of the pool.

zone: str | None = None: Zone of the pool.

class scaleway_async.tem.v1alpha1.PoolStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATING = 'creating'

DISABLED = 'disabled'

ERROR = 'error'

READY = 'ready'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.tem.v1alpha1.ProjectConsumption(project_id: 'str', domains_count: 'int', dedicated_ips_count: 'int', monthly_emails_count: 'int', webhooks_count: 'int', custom_blocklists_count: 'int')

Bases: object

custom_blocklists_count: int: Number of custom blocklists in the project.

dedicated_ips_count: int: Number of dedicated IP in the project.

domains_count: int: Number of domains in the project.

monthly_emails_count: int: Number of emails sent during the current month in the project.

project_id: str: ID of the project.

webhooks_count: int: Number of webhooks in the project.

class scaleway_async.tem.v1alpha1.ProjectSettings(periodic_report: 'Optional[ProjectSettingsPeriodicReport]' = None)

Bases: object

periodic_report: ProjectSettingsPeriodicReport | None = None: Information about your periodic report.

class scaleway_async.tem.v1alpha1.ProjectSettingsPeriodicReport(enabled: 'bool', frequency: 'ProjectSettingsPeriodicReportFrequency', sending_hour: 'int', sending_day: 'int')

Bases: object

enabled: bool: Enable or disable periodic report notifications.

frequency: ProjectSettingsPeriodicReportFrequency: At which frequency you receive periodic report notifications.

sending_day: int: On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).

sending_hour: int: At which hour you receive periodic report notifications.

class scaleway_async.tem.v1alpha1.ProjectSettingsPeriodicReportFrequency(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

DAILY = 'daily'

MONTHLY = 'monthly'

UNKNOWN_FREQUENCY = 'unknown_frequency'

WEEKLY = 'weekly'

class scaleway_async.tem.v1alpha1.RevokeDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None)

Bases: object

domain_id: str: ID of the domain to delete.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.Statistics(total_count: 'int', new_count: 'int', sending_count: 'int', sent_count: 'int', failed_count: 'int', canceled_count: 'int')

Bases: object

canceled_count: int: Number of emails in the final canceled state. This means emails that have been canceled upon request.

failed_count: int: Number of emails in the final failed state. This means emails that have been refused by the target mail system with a final error status.

new_count: int: Number of emails still in the new transient state. This means emails received from the API but not yet processed.

sending_count: int: Number of emails still in the sending transient state. This means emails received from the API but not yet in their final status.

sent_count: int: Number of emails in the final sent state. This means emails that have been delivered to the target mail system.

total_count: int: Total number of emails matching the requested criteria.

class scaleway_async.tem.v1alpha1.TemV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your Transactional Email services.

async bulk_create_blocklists(*, domain_id: str, region: str | None = None, emails: List[str] | None = None, type_: BlocklistType | None = None, reason: str | None = None) → BulkCreateBlocklistsResponse

Bulk create blocklists. Create multiple blocklists in a specific Project or Organization using the region parameter. :param domain_id: Domain ID linked to the blocklist. :param region: Region to target. If none is passed will use default region from the config. :param emails: Email blocked by the blocklist. :param type_: Type of blocklist. :param reason: Reason to block the email. :return: BulkCreateBlocklistsResponse

Usage:

result = await api.bulk_create_blocklists(
    domain_id="example",
)

async cancel_email(*, email_id: str, region: str | None = None) → Email

Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the region and the email_id of the email you want to cancel. :param email_id: ID of the email to cancel. :param region: Region to target. If none is passed will use default region from the config. :return: Email

Usage:

result = await api.cancel_email(
    email_id="example",
)

async check_domain(*, domain_id: str, region: str | None = None) → Domain

Domain DNS check. Perform an immediate DNS check of a domain using the region and domain_id parameters. :param domain_id: ID of the domain to check. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.check_domain(
    domain_id="example",
)

async create_domain(*, domain_name: str, autoconfig: bool, region: str | None = None, project_id: str | None = None, accept_tos: bool | None = None) → Domain

Register a domain in a project. You must specify the region, project_id and domain_name to register a domain in a specific Project. :param domain_name: Fully qualified domain dame. :param autoconfig: Activate auto-configuration of the domain’s DNS zone. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project to which the domain belongs. :param accept_tos: Deprecated. Accept Scaleway’s Terms of Service. :return: Domain

Usage:

result = await api.create_domain(
    domain_name="example",
    autoconfig=False,
)

async create_email(*, from_: CreateEmailRequestAddress, subject: str, text: str, html: str, region: str | None = None, to: List[CreateEmailRequestAddress] | None = None, cc: List[CreateEmailRequestAddress] | None = None, bcc: List[CreateEmailRequestAddress] | None = None, project_id: str | None = None, attachments: List[CreateEmailRequestAttachment] | None = None, send_before: datetime | None = None, additional_headers: List[CreateEmailRequestHeader] | None = None) → CreateEmailResponse

Send an email. You must specify the region, the sender and the recipient’s information and the project_id to send an email from a checked domain. The subject of the email must contain at least 6 characters. :param from_: Sender information. Must be from a checked domain declared in the Project. :param subject: Subject of the email. :param text: Text content. :param html: HTML content. :param region: Region to target. If none is passed will use default region from the config. :param to: An array of the primary recipient’s information. :param cc: An array of the carbon copy recipient’s information. :param bcc: An array of the blind carbon copy recipient’s information. :param project_id: ID of the Project in which to create the email. :param attachments: Array of attachments. :param send_before: Maximum date to deliver the email. :param additional_headers: Array of additional headers as key-value. :return: CreateEmailResponse

Usage:

result = await api.create_email(
    from=CreateEmailRequestAddress(),
    subject="example",
    text="example",
    html="example",
)

async create_webhook(*, domain_id: str, name: str, sns_arn: str, region: str | None = None, project_id: str | None = None, event_types: List[WebhookEventType] | None = None) → Webhook

Create a Webhook. Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN. :param domain_id: ID of the Domain to watch for triggering events. :param name: Name of the Webhook. :param sns_arn: Scaleway SNS ARN topic to push the events to. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project to which the Webhook belongs. :param event_types: List of event types that will trigger an event. :return: Webhook

Usage:

result = await api.create_webhook(
    domain_id="example",
    name="example",
    sns_arn="example",
)

async delete_blocklist(*, blocklist_id: str, region: str | None = None) → None

Delete a blocklist. You must specify the blocklist you want to delete by the region and blocklist_id. :param blocklist_id: ID of the blocklist to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_blocklist(
    blocklist_id="example",
)

async delete_webhook(*, webhook_id: str, region: str | None = 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.

Usage:

result = await api.delete_webhook(
    webhook_id="example",
)

async get_domain(*, domain_id: str, region: str | None = None) → Domain

Get information about a domain. Retrieve information about a specific domain using the region and domain_id parameters. Monitor your domain’s reputation and improve average and bad reputation statuses, using your domain’s Email activity tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain’s reputation. :param domain_id: ID of the domain. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.get_domain(
    domain_id="example",
)

async get_domain_last_status(*, domain_id: str, region: str | None = None) → DomainLastStatus

Display SPF and DKIM records status and potential errors. Display SPF and DKIM records status and potential errors, including the found records to make debugging easier. :param domain_id: ID of the domain to delete. :param region: Region to target. If none is passed will use default region from the config. :return: DomainLastStatus

Usage:

result = await api.get_domain_last_status(
    domain_id="example",
)

async get_email(*, email_id: str, region: str | None = None) → Email

Get an email. Retrieve information about a specific email using the email_id and region parameters. :param email_id: ID of the email to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Email

Usage:

result = await api.get_email(
    email_id="example",
)

async get_project_consumption(*, region: str | None = None, project_id: str | None = None) → ProjectConsumption

Get project resource consumption. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project. :return: ProjectConsumption

Usage:

result = await api.get_project_consumption()

async get_project_settings(*, region: str | None = None, project_id: str | None = None) → ProjectSettings

List project settings. Retrieve the project settings including periodic reports. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project. :return: ProjectSettings

Usage:

result = await api.get_project_settings()

Email statuses. Get information on your emails’ statuses. :param region: Region to target. If none is passed will use default region from the config. :param project_id: (Optional) Number of emails for this Project. :param domain_id: (Optional) Number of emails sent from this domain (must be coherent with the project_id and the organization_id). :param since: (Optional) Number of emails created after this date. :param until: (Optional) Number of emails created before this date. :param mail_from: (Optional) Number of emails sent with this sender’s email address. :return: Statistics

Usage:

result = await api.get_statistics()

async get_webhook(*, webhook_id: str, region: str | None = None) → 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: Webhook

Usage:

result = await api.get_webhook(
    webhook_id="example",
)

List blocklists. Retrieve the list of blocklists. :param domain_id: (Optional) Filter by a domain ID. :param region: Region to target. If none is passed will use default region from the config. :param order_by: (Optional) List blocklist corresponding to specific criteria. :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 email: (Optional) Filter by an email address. :param type_: (Optional) Filter by a blocklist type. :param custom: (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false). :return: ListBlocklistsResponse

Usage:

result = await api.list_blocklists(
    domain_id="example",
)

List blocklists. Retrieve the list of blocklists. :param domain_id: (Optional) Filter by a domain ID. :param region: Region to target. If none is passed will use default region from the config. :param order_by: (Optional) List blocklist corresponding to specific criteria. :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 email: (Optional) Filter by an email address. :param type_: (Optional) Filter by a blocklist type. :param custom: (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false). :return: List[Blocklist]

Usage:

result = await api.list_blocklists_all(
    domain_id="example",
)

List domains. Retrieve domains 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 page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: (Optional) ID of the Project in which to list the domains. :param status: (Optional) List domains under specific statuses. :param organization_id: (Optional) ID of the Organization in which to list the domains. :param name: (Optional) Names of the domains to list. :return: ListDomainsResponse

Usage:

result = await api.list_domains()

List domains. Retrieve domains 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 page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: (Optional) ID of the Project in which to list the domains. :param status: (Optional) List domains under specific statuses. :param organization_id: (Optional) ID of the Organization in which to list the domains. :param name: (Optional) Names of the domains to list. :return: List[Domain]

Usage:

result = await api.list_domains_all()

List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the region. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param project_id: (Optional) ID of the Project in which to list the emails. :param domain_id: (Optional) ID of the domain for which to list the emails. :param message_id: (Optional) ID of the message for which to list the emails. :param since: (Optional) List emails created after this date. :param until: (Optional) List emails created before this date. :param mail_from: (Optional) List emails sent with this sender’s email address. :param mail_to: Deprecated. List emails sent to this recipient’s email address. :param mail_rcpt: (Optional) List emails sent to this recipient’s email address. :param statuses: (Optional) List emails with any of these statuses. :param subject: (Optional) List emails with this subject. :param search: (Optional) List emails by searching to all fields. :param order_by: (Optional) List emails corresponding to specific criteria. :param flags: (Optional) List emails containing only specific flags. :return: ListEmailsResponse

Usage:

result = await api.list_emails()

List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the region. :param region: Region to target. If none is passed will use default region from the config. :param page: :param page_size: :param project_id: (Optional) ID of the Project in which to list the emails. :param domain_id: (Optional) ID of the domain for which to list the emails. :param message_id: (Optional) ID of the message for which to list the emails. :param since: (Optional) List emails created after this date. :param until: (Optional) List emails created before this date. :param mail_from: (Optional) List emails sent with this sender’s email address. :param mail_to: Deprecated. List emails sent to this recipient’s email address. :param mail_rcpt: (Optional) List emails sent to this recipient’s email address. :param statuses: (Optional) List emails with any of these statuses. :param subject: (Optional) List emails with this subject. :param search: (Optional) List emails by searching to all fields. :param order_by: (Optional) List emails corresponding to specific criteria. :param flags: (Optional) List emails containing only specific flags. :return: List[Email]

Usage:

result = await api.list_emails_all()

async list_offer_subscriptions(*, region: str | None = None, project_id: str | None = 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. :return: ListOfferSubscriptionsResponse

Usage:

result = await api.list_offer_subscriptions()

async list_offers(*, region: str | None = None) → ListOffersResponse

List the available offers. Retrieve the list of the available and free-of-charge offers you can subscribe to. :param region: Region to target. If none is passed will use default region from the config. :return: ListOffersResponse

Usage:

result = await api.list_offers()

async list_pools(*, region: str | None = None, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → ListPoolsResponse

Get information about a sending pool. Retrieve information about a sending pool, including its creation status and configuration parameters. :param region: Region to target. If none is passed will use default region from the config. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: ID of the Project. :return: ListPoolsResponse

Usage:

result = await api.list_pools()

async list_pools_all(*, region: str | None = None, page: int | None = None, page_size: int | None = None, project_id: str | None = None) → List[Pool]

Get information about a sending pool. Retrieve information about a sending pool, including its creation status and configuration parameters. :param region: Region to target. If none is passed will use default region from the config. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 1000. :param project_id: ID of the Project. :return: List[Pool]

Usage:

result = await api.list_pools_all()

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. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 100. :param email_id: ID of the email linked to the events. :param event_types: List of event types linked to the events. :param statuses: List of event statuses. :param project_id: ID of the webhook Project. :param organization_id: ID of the webhook Organization. :param domain_id: ID of the domain to watch for triggering events. :return: ListWebhookEventsResponse

Usage:

result = await api.list_webhook_events(
    webhook_id="example",
)

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. :param page: Requested page number. Value must be greater or equal to 1. :param page_size: Requested page size. Value must be between 1 and 100. :param email_id: ID of the email linked to the events. :param event_types: List of event types linked to the events. :param statuses: List of event statuses. :param project_id: ID of the webhook Project. :param organization_id: ID of the webhook Organization. :param domain_id: ID of the domain to watch for triggering events. :return: List[WebhookEvent]

Usage:

result = await api.list_webhook_events_all(
    webhook_id="example",
)

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. :param page_size: (Optional) Requested page size. Value must be between 1 and 100. :param project_id: (Optional) ID of the Project for which to list the Webhooks. :param organization_id: (Optional) ID of the Organization for which to list the Webhooks. :param domain_id: (Optional) ID of the Domain for which to list the Webhooks. :return: ListWebhooksResponse

Usage:

result = await api.list_webhooks()

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. :param page_size: (Optional) Requested page size. Value must be between 1 and 100. :param project_id: (Optional) ID of the Project for which to list the Webhooks. :param organization_id: (Optional) ID of the Organization for which to list the Webhooks. :param domain_id: (Optional) ID of the Domain for which to list the Webhooks. :return: List[Webhook]

Usage:

result = await api.list_webhooks_all()

async revoke_domain(*, domain_id: str, region: str | None = None) → Domain

Delete a domain. You must specify the domain you want to delete by the region and domain_id. Deleting a domain is permanent and cannot be undone. :param domain_id: ID of the domain to delete. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.revoke_domain(
    domain_id="example",
)

async update_domain(*, domain_id: str, region: str | None = None, autoconfig: bool | None = None) → Domain

Update a domain. Update a domain auto-configuration. :param domain_id: ID of the domain to update. :param region: Region to target. If none is passed will use default region from the config. :param autoconfig: (Optional) If set to true, activate auto-configuration of the domain’s DNS zone. :return: Domain

Usage:

result = await api.update_domain(
    domain_id="example",
)

async update_offer_subscription(*, region: str | None = None, project_id: str | None = None, name: OfferName | None = None) → OfferSubscription

Update a subscribed offer. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the Project. :param name: Name of the offer-subscription. :return: OfferSubscription

Usage:

result = await api.update_offer_subscription()

async update_project_settings(*, region: str | None = None, project_id: str | None = None, periodic_report: UpdateProjectSettingsRequestUpdatePeriodicReport | None = None) → ProjectSettings

Update project settings. Update the project settings including periodic reports. :param region: Region to target. If none is passed will use default region from the config. :param project_id: ID of the project. :param periodic_report: Periodic report update details - all fields are optional. :return: ProjectSettings

Usage:

result = await api.update_project_settings()

async update_webhook(*, webhook_id: str, region: str | None = None, name: str | None = None, event_types: List[WebhookEventType] | None = None, sns_arn: str | None = 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. :param event_types: List of event types to update. :param sns_arn: Scaleway SNS ARN topic to update. :return: Webhook

Usage:

result = await api.update_webhook(
    webhook_id="example",
)

async wait_for_domain(*, domain_id: str, region: str | None = None, options: WaitForOptions[Domain, bool | Awaitable[bool]] | None = None) → Domain

Get information about a domain. Retrieve information about a specific domain using the region and domain_id parameters. Monitor your domain’s reputation and improve average and bad reputation statuses, using your domain’s Email activity tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain’s reputation. :param domain_id: ID of the domain. :param region: Region to target. If none is passed will use default region from the config. :return: Domain

Usage:

result = await api.get_domain(
    domain_id="example",
)

async wait_for_email(*, email_id: str, region: str | None = None, options: WaitForOptions[Email, bool | Awaitable[bool]] | None = None) → Email

Get an email. Retrieve information about a specific email using the email_id and region parameters. :param email_id: ID of the email to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Email

Usage:

result = await api.get_email(
    email_id="example",
)

class scaleway_async.tem.v1alpha1.UpdateDomainRequest(domain_id: 'str', region: 'Optional[ScwRegion]' = None, autoconfig: 'Optional[bool]' = False)

Bases: object

autoconfig: bool | None = False: (Optional) If set to true, activate auto-configuration of the domain’s DNS zone.

domain_id: str: ID of the domain to update.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.UpdateOfferSubscriptionRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, name: 'Optional[OfferName]' = <OfferName.UNKNOWN_NAME: 'unknown_name'>)

Bases: object

name: OfferName | None = 'unknown_name': Name of the offer-subscription.

project_id: str | None = None: ID of the Project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.UpdateProjectSettingsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, periodic_report: 'Optional[UpdateProjectSettingsRequestUpdatePeriodicReport]' = None)

Bases: object

periodic_report: UpdateProjectSettingsRequestUpdatePeriodicReport | None = None: Periodic report update details - all fields are optional.

project_id: str | None = None: ID of the project.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway_async.tem.v1alpha1.UpdateProjectSettingsRequestUpdatePeriodicReport(enabled: 'Optional[bool]' = False, frequency: 'Optional[ProjectSettingsPeriodicReportFrequency]' = <ProjectSettingsPeriodicReportFrequency.UNKNOWN_FREQUENCY: 'unknown_frequency'>, sending_hour: 'Optional[int]' = 0, sending_day: 'Optional[int]' = 0)

Bases: object

enabled: bool | None = False: (Optional) Enable or disable periodic report notifications.

frequency: ProjectSettingsPeriodicReportFrequency | None = 'unknown_frequency': (Optional) Frequency at which you receive periodic report notifications.

sending_day: int | None = 0: (Optional) On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly).

sending_hour: int | None = 0: (Optional) Hour at which you receive periodic report notifications.

class scaleway_async.tem.v1alpha1.UpdateWebhookRequest(webhook_id: 'str', region: 'Optional[ScwRegion]' = None, name: 'Optional[str]' = None, event_types: 'Optional[List[WebhookEventType]]' = <factory>, sns_arn: 'Optional[str]' = None)

Bases: object

event_types: List[WebhookEventType] | None: List of event types to update.

name: str | None = None: Name of the Webhook to update.

region: str | None = None: Region to target. If none is passed will use default region from the config.

sns_arn: str | None = None: Scaleway SNS ARN topic to update.

webhook_id: str: ID of the Webhook to update.

class scaleway_async.tem.v1alpha1.Webhook(id: 'str', domain_id: 'str', organization_id: 'str', project_id: 'str', name: 'str', event_types: 'List[WebhookEventType]', sns_arn: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None)

Bases: object

created_at: datetime | None = None: Date and time of the Webhook creation.

domain_id: str: ID of the Domain to watch for triggering events.

event_types: List[WebhookEventType]: List of event types that will trigger a Webhook Event.

id: str: ID of the Webhook.

name: str: Name of the Webhook.

organization_id: str: ID of the Webhook Organization.

project_id: str: ID of the Webhook Project.

sns_arn: str: Scaleway SNS ARN topic to push the events to.

updated_at: datetime | None = None: Date and time of last Webhook updates.

class scaleway_async.tem.v1alpha1.WebhookEvent(id: 'str', webhook_id: 'str', organization_id: 'str', project_id: 'str', domain_id: 'str', type_: 'WebhookEventType', status: 'WebhookEventStatus', data: 'str', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, email_id: 'Optional[str]' = None)

Bases: object

created_at: datetime | None = None: Date and time of the Webhook Event creation.

data: str: Data sent to the Webhook destination.

domain_id: str: ID of the webhook event domain.

email_id: str | None = None: Optional Email ID if the event is triggered by an Email resource.

id: str: ID of the Webhook Event.

organization_id: str: ID of the Webhook Event Organization.

project_id: str: ID of the Webhook Event Project.

status: WebhookEventStatus: Status of the Webhook Event.

type_: WebhookEventType: Type of the Webhook Event.

updated_at: datetime | None = None: Date and time of last Webhook Event updates.

webhook_id: str: ID of the Webhook that triggers the Event.

class scaleway_async.tem.v1alpha1.WebhookEventStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

FAILED = 'failed'

SENDING = 'sending'

SENT = 'sent'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.tem.v1alpha1.WebhookEventType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

BLOCKLIST_CREATED = 'blocklist_created'

EMAIL_BLOCKLISTED = 'email_blocklisted'

EMAIL_DEFERRED = 'email_deferred'

EMAIL_DELIVERED = 'email_delivered'

EMAIL_DROPPED = 'email_dropped'

EMAIL_MAILBOX_NOT_FOUND = 'email_mailbox_not_found'

EMAIL_QUEUED = 'email_queued'

EMAIL_SPAM = 'email_spam'

UNKNOWN_TYPE = 'unknown_type'