API Reference

`io_beep_boop.api`

This module defines the models used by the IO App API, and defines a client to interact with the API in a (kind of) Pythonic way.

`io_beep_boop.api.client`

class io_beep_boop.api.client.IOServiceClient(token: str, base_url: str = 'https://api.io.italia.it/api/v1', user_agent: str | None = None)

Simplified wrapper for the IO App API.

send_legal_message(fiscal_code: str, content: MessageContent, legal_mail: str, time_to_live: int = 3600, default_addresses: DefaultAddresses | None = None): Send a message to the user with the given fiscal_code on behalf of the service identified by the PEC given in legal_mail.

See also

https://developer.io.italia.it/openapi.html#operation/submitLegalMessageforUserWithFiscalCodeInBodyOnBehalfOfService

send_message(fiscal_code: str, content: MessageContent, time_to_live: int = 3600, default_addresses: DefaultAddresses | None = None): Send a message to the user with the given fiscal_code.

See also

https://developer.io.italia.it/openapi.html#operation/submitMessageforUser

get_message(fiscal_code: str, message_id: str): Get the message with the given message_id addressed to the user with the given fiscal_code.

See also

https://developer.io.italia.it/openapi.html#operation/getMessage

get_profile(fiscal_code: str): Get the profile of the user with the given fiscal_code.

See also

https://developer.io.italia.it/openapi.html#operation/getProfile

get_subscriptions_on_day(date: date): Get a list of hashed fiscal codes which subscribed and unsubscribed from the service on the given date.

Warning

Requires special authorization.

See also

https://developer.io.italia.it/openapi.html#operation/getSubscriptionsFeedForDate

`io_beep_boop.api.models`

class io_beep_boop.api.models.Payee(*, fiscal_code: str)

fiscal_code: str

class io_beep_boop.api.models.PaymentData(*, amount: int, notice_number: str, invalid_after_due_date: bool, payee: Payee)

amount: int

notice_number: str

invalid_after_due_date: bool

payee: Payee

class io_beep_boop.api.models.PrescriptionData(*, nre: str, iup: str, prescriber_fiscal_code: str)

nre: str

iup: str

prescriber_fiscal_code: str

class io_beep_boop.api.models.LegalData(*, sender_email_from: str, has_attachment: bool, message_unique_id: str, original_message_url: str, pec_server_service_id: str)

sender_email_from: str

has_attachment: bool

message_unique_id: str

original_message_url: str

pec_server_service_id: str

class io_beep_boop.api.models.EuCovidCert(*, auth_code: str)

auth_code: str

class io_beep_boop.api.models.MessageContent(*, subject: str, markdown: str, payment_data: PaymentData | None = None, prescription_data: PrescriptionData | None = None, legal_data: LegalData | None = None, eu_covid_cert: EuCovidCert | None = None, due_date: datetime)