api.md

Blocks

Types:

from unlayer.types import BlockRetrieveResponse

Methods:

• client.blocks.retrieve(**params) -> BlockRetrieveResponse

Domains

Types:

from unlayer.types import (
    DomainCreateResponse,
    DomainRetrieveResponse,
    DomainListResponse,
    DomainDeleteResponse,
)

Methods:

• client.domains.create(**params) -> DomainCreateResponse
• client.domains.retrieve(id) -> DomainRetrieveResponse
• client.domains.list() -> DomainListResponse
• client.domains.delete(id) -> DomainDeleteResponse

Verify

Types:

from unlayer.types.domains import VerifyCreateResponse

Methods:

• client.domains.verify.create(id) -> VerifyCreateResponse

EditorSessions

Types:

from unlayer.types import EditorSessionCreateResponse

Methods:

• client.editor_sessions.create(**params) -> EditorSessionCreateResponse

Emails

Types:

from unlayer.types import EmailCreateResponse, EmailRetrieveResponse, EmailListResponse

Methods:

• client.emails.create(**params) -> EmailCreateResponse
• client.emails.retrieve(id) -> EmailRetrieveResponse
• client.emails.list(**params) -> EmailListResponse

Events

Types:

from unlayer.types.emails import EventRetrieveResponse

Methods:

• client.emails.events.retrieve(id) -> EventRetrieveResponse

Render

Types:

from unlayer.types.emails import RenderCreateResponse

Methods:

• client.emails.render.create(**params) -> RenderCreateResponse

Settings

Types:

from unlayer.types.emails import SettingRetrieveResponse, SettingUpdateResponse

Methods:

• client.emails.settings.retrieve() -> SettingRetrieveResponse
• client.emails.settings.update(**params) -> SettingUpdateResponse

Stats

Types:

from unlayer.types.emails import StatRetrieveResponse

Methods:

• client.emails.stats.retrieve(**params) -> StatRetrieveResponse

Suppressions

Types:

from unlayer.types.emails import (
    SuppressionCreateResponse,
    SuppressionRetrieveResponse,
    SuppressionDeleteResponse,
)

Methods:

• client.emails.suppressions.create(**params) -> SuppressionCreateResponse
• client.emails.suppressions.retrieve(**params) -> SuppressionRetrieveResponse
• client.emails.suppressions.delete(**params) -> SuppressionDeleteResponse

SuppressionsCheck

Types:

from unlayer.types.emails import SuppressionsCheckRetrieveResponse

Methods:

• client.emails.suppressions_check.retrieve(**params) -> SuppressionsCheckRetrieveResponse

Template

Types:

from unlayer.types.emails import TemplateCreateResponse

Methods:

• client.emails.template.create(**params) -> TemplateCreateResponse

Me

Subscription

Types:

from unlayer.types.me import SubscriptionRetrieveResponse

Methods:

• client.me.subscription.retrieve(**params) -> SubscriptionRetrieveResponse

Projects

Types:

from unlayer.types import ProjectRetrieveResponse

Methods:

• client.projects.retrieve(id) -> ProjectRetrieveResponse

AICredits

Types:

from unlayer.types.projects import AICreditRetrieveResponse

Methods:

• client.projects.ai_credits.retrieve(id) -> AICreditRetrieveResponse

AICreditsSettings

Types:

from unlayer.types.projects import AICreditsSettingRetrieveResponse, AICreditsSettingUpdateResponse

Methods:

• client.projects.ai_credits_settings.retrieve(id) -> AICreditsSettingRetrieveResponse
• client.projects.ai_credits_settings.update(id, **params) -> AICreditsSettingUpdateResponse

AICreditsSettingsRotateSecret

Types:

from unlayer.types.projects import AICreditsSettingsRotateSecretCreateResponse

Methods:

• client.projects.ai_credits_settings_rotate_secret.create(id) -> AICreditsSettingsRotateSecretCreateResponse

AICreditsUsage

Types:

from unlayer.types.projects import AICreditsUsageRetrieveResponse

Methods:

• client.projects.ai_credits_usage.retrieve(id, **params) -> AICreditsUsageRetrieveResponse

AICreditsWebhooksDeliveries

Types:

from unlayer.types.projects import AICreditsWebhooksDeliveryRetrieveResponse

Methods:

• client.projects.ai_credits_webhooks_deliveries.retrieve(id, **params) -> AICreditsWebhooksDeliveryRetrieveResponse

AICreditsWebhooksDeliveriesattempts

Types:

from unlayer.types.projects import AICreditsWebhooksDeliveriesattemptRetrieveResponse

Methods:

• client.projects.ai_credits_webhooks_deliveriesattempts.retrieve(delivery_id, *, id, **params) -> AICreditsWebhooksDeliveriesattemptRetrieveResponse

AICreditsWebhooksDeliveriesretry

Types:

from unlayer.types.projects import AICreditsWebhooksDeliveriesretryCreateResponse

Methods:

• client.projects.ai_credits_webhooks_deliveriesretry.create(delivery_id, *, id) -> AICreditsWebhooksDeliveriesretryCreateResponse

Templates

Types:

from unlayer.types import TemplateRetrieveResponse, TemplateListResponse

Methods:

• client.templates.retrieve(id, **params) -> TemplateRetrieveResponse
• client.templates.list(**params) -> SyncCursorPage[TemplateListResponse]

ConvertFullToSimple

Types:

from unlayer.types.templates import ConvertFullToSimpleCreateResponse

Methods:

• client.templates.convert_full_to_simple.create(**params) -> ConvertFullToSimpleCreateResponse

ConvertSimpleToFull

Types:

from unlayer.types.templates import ConvertSimpleToFullCreateResponse

Methods:

• client.templates.convert_simple_to_full.create(**params) -> ConvertSimpleToFullCreateResponse

ExportHTML

Types:

from unlayer.types.templates import ExportHTMLCreateResponse

Methods:

• client.templates.export_html.create(**params) -> ExportHTMLCreateResponse

ExportImage

Types:

from unlayer.types.templates import ExportImageCreateResponse

Methods:

• client.templates.export_image.create(**params) -> ExportImageCreateResponse

ExportPdf

Types:

from unlayer.types.templates import ExportPdfCreateResponse

Methods:

• client.templates.export_pdf.create(**params) -> ExportPdfCreateResponse

ExportZip

Types:

from unlayer.types.templates import ExportZipCreateResponse

Methods:

• client.templates.export_zip.create(**params) -> ExportZipCreateResponse

Generate

Types:

from unlayer.types.templates import GenerateCreateResponse

Methods:

• client.templates.generate.create(**params) -> GenerateCreateResponse
• client.templates.generate.retrieve() -> None

Import

Types:

from unlayer.types.templates import ImportCreateResponse

Methods:

• client.templates.import*.create(**params) -> ImportCreateResponse

Schema

Methods:

• client.templates.schema.retrieve(**params) -> None

Validate

Types:

from unlayer.types.templates import ValidateCreateResponse

Methods:

• client.templates.validate.create(**params) -> ValidateCreateResponse

Webhooks

Types:

from unlayer.types import (
    WebhookCreateResponse,
    WebhookRetrieveResponse,
    WebhookUpdateResponse,
    WebhookListResponse,
    WebhookDeleteResponse,
)

Methods:

• client.webhooks.create(**params) -> WebhookCreateResponse
• client.webhooks.retrieve(id) -> WebhookRetrieveResponse
• client.webhooks.update(id, **params) -> WebhookUpdateResponse
• client.webhooks.list() -> WebhookListResponse
• client.webhooks.delete(id) -> WebhookDeleteResponse

RotateSecret

Types:

from unlayer.types.webhooks import RotateSecretCreateResponse

Methods:

• client.webhooks.rotate_secret.create(id) -> RotateSecretCreateResponse

Workspaces

Types:

from unlayer.types import WorkspaceRetrieveResponse, WorkspaceListResponse

Methods:

• client.workspaces.retrieve(workspace_id) -> WorkspaceRetrieveResponse
• client.workspaces.list() -> WorkspaceListResponse