ItemList

trompace.mutations.itemlist.mutation_add_itemlist_itemlist_element(itemlist_id: str, element_id: str)

Returns a mutation for adding a ThingInterface in an ItemList object based on the identifier. (https://schema.org/itemListElement)

Parameters

  • itemlist_id – The unique identifier of the ItemList object.

  • element_id – The unique identifier of the ThingInterface object.

Returns

The string for the mutation for adding an ThingInterface in an ItemList object based on the identifier,

trompace.mutations.itemlist.mutation_add_listitem_item(listitem_id: str, item_id: str)

Returns a mutation for adding an Item to a ListItem object based on the identifier. (https://schema.org/item)

Parameters

  • listitem_id – The unique identifier of the ListItem object.

  • item_id – The unique identifier of the Item object.

Returns

The string for the mutation for adding a Item to a ListItem object

based on the identifier.

trompace.mutations.itemlist.mutation_add_listitem_nextitem(listitem_id: str, nextitem_id: str)

Returns a mutation for adding a NextItem to a ListItem object based on the identifier. (https://schema.org/nextItem)

Parameters

  • listitem_id – The unique identifier of the ListItem object.

  • nextitem_id – The unique identifier of the NextItem object.

Returns

The string for the mutation for adding a NextItem to a ListItem object

based on the identifier.

trompace.mutations.itemlist.mutation_create_itemlist(name: str, creator: str, itemlistorder: trompace.constants.ItemListOrderType = <ItemListOrderType.ItemListUnordered: 3>, description: str = None, contributor: str = None, additionaltype: List[str] = None)

Returns a mutation for creating an ItemList object. (https://schema.org/ItemList)

Parameters

  • name – The name of the ItemList object.

  • creator – The person, organization or service who created the ItemList.

  • itemlistorder – The type of ordering for the list (ascending, descending, unordered, ordered)

  • contributor (optional) – A person, an organization, or a service responsible for contributing the ItemList to the web resource. This can be either a name or a base URL.

  • description (optional) – The description of the ItemList object

  • additionaltype (optional) – A list of schema.org additionalTypes used to categorise this ItemList

Returns

The string for the mutation for creating the ItemList.

trompace.mutations.itemlist.mutation_create_listitem(creator: str, name: str = None, contributor: str = None, description: str = None, itemurl: str = None, position: Optional[int] = None)

Returns a mutation for creating a ListItem object. (https://schema.org/ListItem)

Parameters

  • name – The name of the ListItem object.

  • creator – The person, organization or service who created the ListItem.

  • contributor – A person, an organization, or a service responsible for contributing the ListItem to the web resource. This can be either a name or a base URL.

  • description – The description of the ListItem object

  • itemurl – If the item of this ListItem points to a URL outside of the CE, the item URL

  • position – the position of the ListItem

Returns

The string for the mutation for creating the ListItem.

trompace.mutations.itemlist.mutation_delete_itemlist(identifier: str)

Returns a mutation for deleting an ItemList object based on the identifier. (https://schema.org/ItemList)

Parameters

identifier – The unique identifier of the ItemList object.

Returns

The string for the mutation for deleting the ItemList object based on the identifier.

trompace.mutations.itemlist.mutation_delete_listitem(identifier: str)

Returns a mutation for deleting a ListItem object based on the identifier. (https://schema.org/ListItem)

Parameters

identifier – The unique identifier of the ListItem object.

Returns

The string for the mutation for deleting the ListItem object based on the identifier.

trompace.mutations.itemlist.mutation_remove_itemlist_itemlist_element(itemlist_id: str, element_id: str)

Returns a mutation for removing a ThingInterface from an ItemList object based on the identifier. (https://schema.org/itemListElement)

Parameters

  • itemlist_id – The unique identifier of the ItemList object.

  • element_id – The unique identifier of the ThingInterface object.

Returns

The string for the mutation for removing an ThingInterface from an ItemList object based on the identifier.

trompace.mutations.itemlist.mutation_remove_listitem_item(listitem_id: str, item_id: str)

Returns a mutation for removing a Item from a ListItem object based on the identifier. (https://schema.org/item)

Parameters

  • listitem_id – The unique identifier of the ListItem object.

  • item_id – The unique identifier of the Item object.

Returns

The string for the mutation for removing a Item from a ListItem

object based on the identifier.

trompace.mutations.itemlist.mutation_remove_listitem_nextitem(listitem_id: str, nextitem_id: str)

Returns a mutation for removing a NextItem from a ListItem object based on the identifier. (https://schema.org/nextItem)

Parameters

  • listitem_id – The unique identifier of the ListItem object.

  • nextitem_id – The unique identifier of the NextItem object.

Returns

The string for the mutation for removing a NextItem from a ListItem

object based on the identifier.

trompace.mutations.itemlist.mutation_sequence_add_itemlist_itemlist_element(itemlist_id: str, element_ids: list)

Returns a mutation for adding a sequence of ThingInterface in an ItemList object based on the identifiers. (https://schema.org/itemListElement)

Parameters

  • itemlist_id – The unique identifier of the ItemList object.

  • element_ids – The list of unique identifiers of the ThingInterface objects.

Returns

The string for the mutation for adding a sequence of ThingInterface in an ItemList object based on the identifiers.

trompace.mutations.itemlist.mutation_sequence_add_listitem_item(listitem_ids: list, item_ids: list)

Returns a mutation for adding a sequence of ThingInterface in an ListItem objects based on the identifiers. (https://schema.org/itemListElement)

Parameters

  • listitem_ids – The list of unique identifiers of the ListItem objects.

  • item_ids – The list of unique identifiers of the ThingInterface objects.

Returns

The string for the mutation for adding a sequence of ThingInterface in an

ListItem objects based on the identifiers.

trompace.mutations.itemlist.mutation_sequence_add_listitem_nextitem(listitem_ids: list)

Returns a mutation for adding a sequence of NextItem to an ListItem objects based on the identifiers. (https://schema.org/itemListElement)

Parameters

listitem_ids – The list of unique identifier of the ListItems objects.

Returns

The string for the mutation for adding a sequence of NextItem to an

ListItem objects based on the identifiers.

trompace.mutations.itemlist.mutation_sequence_create_listitem(listitems: list, contributor: str, creator: str = None, name: str = None, description: list = None)

Returns a mutation for creating a sequence of ListItem objects (https://schema.org/itemListElement)

Parameters

  • listitems – the ListItems objects to create

  • creator – The person, organization or service who created the items.

  • contributor – A person, an organization, or a service responsible for contributing the ListItem to the web resource. This can be either a name or a base URL.

  • name – The name of the ListItem object.

Returns

The string for the mutation for creating a sequence of ListItem objects

trompace.mutations.itemlist.mutation_update_itemlist(identifier: str, name: str = None, creator: str = None, itemlistorder: trompace.constants.ItemListOrderType = None, description: str = None, contributor: str = None, additionaltype: List[str] = None)

Returns a mutation for updating an ItemList object. (https://schema.org/ItemList)

Parameters

  • identifier – The identifier of the ItemList in the CE to be updated.

  • name – The name of the ItemList object.

  • creator – The person, organization or service who created the ItemList.

  • itemlistorder – The type of ordering for the list (ascending, descending, unordered, ordered)

  • contributor (optional) – A person, an organization, or a service responsible for contributing the ItemList to the web resource. This can be either a name or a base URL.

  • description (optional) – The description of the ItemList object

  • additionaltype (optional) – A list of schema.org additionalTypes used to categorise this ItemList

Returns

The string for the mutation for updating the ItemList.

trompace.mutations.itemlist.mutation_update_listitem(identifier: str, creator: str = None, name: str = None, contributor: str = None, description: str = None, itemurl: str = None, position: int = None)

Returns a mutation for updating a ListItem object. (https://schema.org/ListItem)

Parameters

  • identifier – The identifier of the ListItem in the CE to be updated.

  • name – The name of the ListItem object.

  • creator – The person, organization or service who created the ListItem.

  • contributor – A person, an organization, or a service responsible for contributing the ListItem to the web resource. This can be either a name or a base URL.

  • description – The description of the ListItem object

  • itemurl – If the item of this ListItem points to a URL outside of the CE, the item URL

  • position – the position of the ListItem

Returns

The string for the mutation for updating the ListItem.