Skip to content

chore: Regenerate models from the published OpenAPI spec #1007

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
apify-service-account wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: Regenerate models from the published OpenAPI spec #1007

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions src/apify_client/_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,12 @@ class CreateTaskRequest(BaseModel):
input: TaskInput | None = None
title: str | None = None
actor_standby: ActorStandby | None = None
public_config: TaskPublicConfig | None = None
"""
Configuration that controls how the published task appears on its public landing page.
Editing this object requires write permission to the Actor that the task belongs to.

"""


@docs_group('Models')
Expand Down Expand Up @@ -3496,6 +3502,12 @@ class Task(BaseModel):
title: str | None = None
actor_standby: ActorStandby | None = None
standby_url: AnyUrl | None = None
is_public: Annotated[bool | None, Field(examples=[False])] = None
"""
Whether the task is published. Based on the `publicConfig.publishedAt` field.

"""
public_config: TaskPublicConfig | None = None


@docs_group('Models')
Expand Down Expand Up @@ -3527,6 +3539,57 @@ class TaskOptions(BaseModel):
restart_on_error: Annotated[bool | None, Field(examples=[False])] = None


@docs_group('Models')
class TaskPublicConfig(BaseModel):
"""Public-facing configuration of a published task, used by the task's public landing page.
The task's publication state is determined by `publishedAt` - a task is published when
`publishedAt` is set and unpublished when it is `null`.

"""

model_config = ConfigDict(
extra='allow',
populate_by_name=True,
alias_generator=to_camel,
)
published_at: Annotated[AwareDatetime | None, Field(examples=['2025-06-16T09:20:45.777Z'])] = None
"""
Time when the task was published, or `null` if the task isn't published.
This field is server-controlled. To publish or unpublish a task, use the
[Update task](https://docs.apify.com/api/v2/actor-task-put) endpoint and set `isPublic`.

"""
seo_title: Annotated[str | None, Field(examples=['Scrape data from a website'], max_length=60)] = None
"""
Name of the Actor task to display by search engines such as Google. Defaults to the task
title. At most 60 characters.

"""
seo_description: Annotated[str | None, Field(max_length=160)] = None
"""
Description of the Actor task to display by search engines such as Google. Defaults to the
task description. At most 160 characters.

"""
input_schema_fields: list[str] | None = None
"""
Names of the task input fields displayed on the public task page.
"""
dataset_name: str | None = None
"""
Name of the dataset from the Actor's dataset schema whose results are displayed. When
`null`, the Actor's default dataset is used. That is, the only dataset the Actor declares,
or the one named `default` when it declares several.

"""
dataset_view: str | None = None
"""
Key of the dataset view from the Actor's dataset schema used to display results. Must be
one of the views declared on the resolved dataset. You can't publish a task without it.

"""


@docs_group('Models')
class TaskResponse(BaseModel):
"""Response containing Actor task data."""
Expand Down Expand Up @@ -3802,6 +3865,22 @@ class UpdateTaskRequest(BaseModel):
input: TaskInput | None = None
title: str | None = None
actor_standby: ActorStandby | None = None
public_config: TaskPublicConfig | None = None
"""
Configuration that controls how the published task appears on its public landing page.
Editing this object requires write permission to the Actor that the task belongs to.

The fields you send are merged into the stored configuration, so you only need to include
the ones you're changing. To clear a field, set it to `null`. Sending `publicConfig: null`
is rejected, so the object as a whole can't be cleared.

"""
is_public: Annotated[bool | None, Field(examples=[True])] = None
"""
Set to `true` to publish the task on its public landing page, or `false` to unpublish it.
Sending the value the task already has does nothing.

"""


@docs_group('Models')
Expand Down
Loading