roboto.domain.collections.operations

Module Contents

class roboto.domain.collections.operations.CreateCollectionRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to create a collection

Parameters:

data (Any)

custom_fields: dict[str, Any] | None = None

Initial values for Ready custom fields on this collection.

Each key must be the name of a CustomField that is Ready for the caller’s org and the Collection entity type; each value must satisfy the field’s declared type. Names that are undefined or not Ready, and values that don’t match the field’s type, are rejected with a structured error.

description: str | None = None

name: str | None = None

resource_type: roboto.domain.collections.record.CollectionResourceType

resources: list[roboto.domain.collections.record.CollectionResourceRef] | None = None

tags: list[str] | None = None

class roboto.domain.collections.operations.UpdateCollectionRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to update a collection

Parameters:

data (Any)

add_resources: list[roboto.domain.collections.record.CollectionResourceRef] | roboto.sentinels.NotSetType

add_tags: list[str] | roboto.sentinels.NotSetType

custom_fields_changeset: roboto.updates.CustomFieldChangeset | None = None

Changes to apply to Ready custom-field values on this collection.

Each referenced field name must be a Ready custom field for this collection’s org and the Collection entity type; each set_fields value must satisfy the field’s declared type. Names that are undefined or not Ready are rejected with a structured error. Field names not mentioned by the changeset are left unchanged.

description: roboto.sentinels.NotSetType | str | None

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: roboto.sentinels.NotSetType | str | None

remove_resources: list[roboto.domain.collections.record.CollectionResourceRef] | roboto.sentinels.NotSetType

remove_tags: list[str] | roboto.sentinels.NotSetType