Templates

TagmeClientAdvanced.add_images_to_template(template_id: str, files_paths: List[str], organization_id: str | None = None, ) → UploadFilesResult

Add images to a template.

Parameters

* template_id ( str) – The ID of the template to add images to.

* files_paths ( List [ str ]) – The list containing the images to add.

* organization_id – optional organization identifier. Defaults to None.

Returns

The result of adding the images to the template.

Return type

UploadFilesResult

TagmeClientAdvanced.apply_template_to_project(template_id: str, project_id: str, organization_id: str | None = None, ) → None

Apply a template to a project.

Parameters

* template_id ( str) – The ID of the template to apply.

* project_id ( str) – The ID of the project to apply the template to.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.archive_template(template_id: str, organization_id: str | None = None, ) → None

Archive a template.

Parameters

* template_id ( str) – The ID of the template to archive.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.check_template(template_id: str, organization_id: str | None = None, ) → CheckTemplateResult

Check a template.

Parameters

* template_id ( str) – The ID of the template to check.

* organization_id – optional organization identifier. Defaults to None.

Returns

The result of the check.

Return type

CheckTemplateResult

TagmeClientAdvanced.create_template(name: str, description: str | None = None, documentation: str | None = None, contacts: str | None = None, categories: List[str] | None = None, from_method_id: str | None = None, organization_id: str | None = None, access: str | None = None, acl: List[str] | None = None, ) → Template

Create a new template.

Parameters

* name ( str) – The name of the template.

* description ( Optional [ str ]) – The description of the template.

* documentation ( Optional [ str ]) – The documentation of the template.

* contacts ( Optional [ str ]) – The contacts of the template.

* categories ( Optional [ List [ str ] ]) – The categories of the template.

* from_method_id ( Optional [ str ]) – The ID of the method to create the template from.

* organization_id – optional organization identifier. Defaults to None.

* access – (Optional[str]): The access level of the template.

* acl – (Optional[List[str]]): The ACL of the template.

Returns

The created template.

Return type

Template

TagmeClientAdvanced.delete_template_preview(template_id: str, organization_id: str | None = None, ) → None

Delete the preview for a template.

Parameters

* template_id ( str) – The ID of the template to delete the preview for.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.get_published_templates_list(query: str | None = None, categories: List[str] | None = None, size: int | None = None, page: int | None = None, organization_id: str | None = None, ) → List[Template]

Get a list of published templates.

Parameters

* query ( Optional [ str ]) – The query to search for.

* categories ( Optional [ List [ str ] ]) – The categories to filter by.

* size ( Optional [ int ]) – Page size for pagination. Defaults to None.

* page ( Optional [ int ]) – The page number to return.

* organization_id – optional organization identifier. Defaults to None.

Returns

A list of templates.

Return type

List[Template]

TagmeClientAdvanced.get_template(template_id: str, organization_id: str | None = None, ) → Template

Get a template by ID.

Parameters

* template_id ( str) – The ID of the template to get.

* organization_id – optional organization identifier. Defaults to None.

Returns

The template with the specified ID.

Return type

Template

TagmeClientAdvanced.get_template_images_list(template_id: str, organization_id: str | None = None, ) → SimpleImagesListResult

Get a list of images for a template.

Parameters

* template_id ( str) – The ID of the template to get images for.

* organization_id – optional organization identifier. Defaults to None.

Returns

A list of images for the template.

Return type

SimpleImagesListResult

TagmeClientAdvanced.get_templates_list(query: str | None = None, categories: List[str] | None = None, size: int | None = None, page: int | None = None, organization_id: str | None = None, ) → List[Template]

Get a list of templates.

Parameters

* query ( Optional [ str ]) – The query to search for.

* categories ( Optional [ List [ str ] ]) – The categories to filter by.

* size ( Optional [ int ]) – Page size for pagination. Defaults to None.

* page ( Optional [ int ]) – The page number to return.

* organization_id – optional organization identifier. Defaults to None.

Returns

A list of templates.

Return type

List[Template]

TagmeClientAdvanced.publish_template(template_id: str, organization_id: str | None = None, ) → None

Publish a template.

Parameters

* template_id ( str) – The ID of the template to publish.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.unpublish_template(template_id: str, organization_id: str | None = None, ) → None

Unpublish a template.

Parameters

* template_id ( str) – The ID of the template to unpublish.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.update_template(template_id: str, name: str, description: str | None = None, documentation: str | None = None, contacts: str | None = None, categories: List[str] | None = None, organization_id: str | None = None, access: str | None = None, acl: List[str] | None = None, ) → Template

Update a template.

Parameters

* template_id ( str) – The ID of the template to update.

* name ( str) – The new name of the template.

* description ( Optional [ str ]) – The new description of the template.

* documentation ( Optional [ str ]) – The new documentation of the template.

* contacts ( Optional [ str ]) – The new contacts of the template.

* categories ( Optional [ List [ str ] ]) – The new categories of the template.

* organization_id – optional organization identifier. Defaults to None.

* access – (Optional[str]): The access level of the template.

* acl – (Optional[List[str]]): The ACL of the template.

Returns

The updated template.

Return type

Template

TagmeClientAdvanced.upload_template_preview(template_id: str, files_paths: List[str], organization_id: str | None = None, ) → PreviewFileResult

Upload a preview for a template.

Parameters

* template_id ( str) – The ID of the template to upload the preview for.

* files_paths ( List [ str ]) – The list containing the preview to upload.

* organization_id – optional organization identifier. Defaults to None.

Returns

The result of uploading the preview.

Return type

PreviewFileResult