collections_create_collection_version

Create a new immutable version of an existing collection

Functions

async pydelfini.delfini_core.api.collections.collections_create_collection_version.asyncio(collection_id, *, client, body)[source]

Create a new immutable version of an existing collection

This method is used to create an immutable version of a collection. The resulting collection version will be a read-only copy of the provided collection ID.

Optionally, in the request body, a list of itemIds can be specified which will cause the new version to only include the items listed, which must be drawn from the set of items already present in the collection.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[Collection]

Return type:

Collection

async pydelfini.delfini_core.api.collections.collections_create_collection_version.asyncio_detailed(collection_id, *, client, body)[source]

Create a new immutable version of an existing collection

This method is used to create an immutable version of a collection. The resulting collection version will be a read-only copy of the provided collection ID.

Optionally, in the request body, a list of itemIds can be specified which will cause the new version to only include the items listed, which must be drawn from the set of items already present in the collection.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[Collection, ServerError]]

Return type:

Response[Collection | ServerError]

pydelfini.delfini_core.api.collections.collections_create_collection_version.sync(collection_id, *, client, body)[source]

Create a new immutable version of an existing collection

This method is used to create an immutable version of a collection. The resulting collection version will be a read-only copy of the provided collection ID.

Optionally, in the request body, a list of itemIds can be specified which will cause the new version to only include the items listed, which must be drawn from the set of items already present in the collection.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns a status code greater than or equal to 300.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Union[Collection]

Return type:

Collection

pydelfini.delfini_core.api.collections.collections_create_collection_version.sync_detailed(collection_id, *, client, body)[source]

Create a new immutable version of an existing collection

This method is used to create an immutable version of a collection. The resulting collection version will be a read-only copy of the provided collection ID.

Optionally, in the request body, a list of itemIds can be specified which will cause the new version to only include the items listed, which must be drawn from the set of items already present in the collection.

Parameters:
Raises:

  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[Union[Collection, ServerError]]

Return type:

Response[Collection | ServerError]