Projects endpoint¶
Fetch all projects¶
-
projects
([params=None])¶ Parameters: params (dict) – (optional) pagination options Returns: Collection of projects
Example:
client.projects({"page": 2, "limit": 10})
Fetch a single project¶
-
project
(project_id)¶ Parameters: project_id (str) – ID of the project to fetch Returns: Project model
Example:
project = client.project('123.abc')
project.project_type # => "localization_files"
project.name # => "Sample Project"
Create project¶
-
create_project
(params)¶ Parameters: params (dict) – Project parameters Returns: Project model
Example:
client.create_project({
"name": "Python sample project",
"description": "Project created by Python client",
"languages": [
{
"lang_iso": "en",
"custom_iso": "en-us"
},
{
"lang_iso": "en_GB",
"custom_iso": "en-gb"
}
],
"base_lang_iso": "en-us"
})
Update project¶
-
update_project
(project_id, params)¶ Parameters: - project_id (str) – ID of the project to update
- params (dict) – Project parameters
Returns: Project model
Example:
client.update_project('123.abc', {
"name": "Updated Python proj",
"description": "Proj updated by Python"
})