project_model module

class project_model.Estimate(*, estimate: str = None, type: str = None)

Bases: clockify.model.base_model.BaseModel

class Config

Bases: object

fields = {'estimate': 'estimate', 'type': 'type'}
estimate: Optional[str]
type: Optional[str]
class project_model.HourlyRate(*, amount: str = None, currency: str = None)

Bases: clockify.model.base_model.BaseModel

class Config

Bases: object

fields = {'ammount': 'amount', 'amount': 'amount'}
amount: Optional[str]
currency: Optional[str]
class project_model.MemberShip(*, userId: str = None, hourlyRate: str = None, costRate: str = None, targetId: str = None, membershipType: str = None, membershipStatus: str = None)

Bases: clockify.model.base_model.BaseModel

class Config

Bases: object

fields = {'cost_rate': 'costRate', 'hourly_rate': 'hourlyRate', 'membership_Status': 'membershipStatus', 'membership_Type': 'membershipType', 'target_Id': 'targetId', 'user_Id': 'userId'}
cost_rate: Optional[str]
hourly_rate: Optional[str]
membership_Status: Optional[str]
membership_Type: Optional[str]
target_Id: Optional[str]
user_Id: Optional[str]
class project_model.Project(*, name: str, workspaceId: str, id: str = None, hourlyRate: project_model.HourlyRate = None, clientId: str = None, billable: bool = None, memberships: List[project_model.MemberShip] = None, color: str = None, estimate: project_model.Estimate = None, archived: bool = None, duration: str = None, clientName: str = None, note: str = None, costRate: str = None, timeEstimate: project_model.TimeEstimate = None, budgetEstimate: str = None, template: bool = None, public: bool = None)

Bases: clockify.model.base_model.BaseModel

class Config

Bases: object

fields = {'archived': 'archived', 'billable': 'billable', 'budget_estimate': 'budgetEstimate', 'client_id': 'clientId', 'client_name': 'clientName', 'color': 'color', 'cost_rate': 'costRate', 'duration': 'duration', 'estimate': 'estimate', 'hourly_rate': 'hourlyRate', 'id_': 'id', 'memberships': 'memberships', 'name': 'name', 'note': 'note', 'public_': 'public', 'template': 'template', 'time_estimate': 'timeEstimate', 'workspace_id': 'workspaceId'}
archived: Optional[bool]
billable: Optional[bool]
budget_estimate: Optional[str]
client_id: Optional[str]
client_name: Optional[str]
color: Optional[str]
cost_rate: Optional[str]
duration: Optional[str]
estimate: Optional[project_model.Estimate]
hourly_rate: Optional[project_model.HourlyRate]
id_: Optional[str]
memberships: Optional[List[project_model.MemberShip]]
name: str
note: Optional[str]
public_: Optional[bool]
template: Optional[bool]
time_estimate: Optional[project_model.TimeEstimate]
workspace_id: str
class project_model.ProjectGetParams(*, hydrated: bool = None, archived: bool = None, name: str = None, page: int = 1, page_size: int = 50, billable: bool = None, clients: List[str] = None, contains_client: bool = None, client_status: Literal['ACTIVE', 'ARCHIVED'] = None, users: List[str] = None, contains_users: bool = None, user_status: Literal['ACTIVE', 'ARCHIVED'] = None, is_template: bool = None, sort_column: Literal['NAME', 'CLIENT_NAME', 'DURATION'] = None, sort_order: Literal['ASCENDING', 'DESCENDING'] = None)

Bases: clockify.model.base_model.BaseModel

class Config

Bases: object

fields = {'client_status': 'client-status', 'contains_client': 'contains-client', 'contains_users': 'contains-users', 'is_template': 'is-template', 'page_size': 'page-size', 'sort_column': 'sort-column', 'sort_order': 'sort-order', 'user_status': 'user-status'}
archived: Optional[bool]
billable: Optional[bool]
client_status: Optional[Literal['ACTIVE', 'ARCHIVED']]
clients: Optional[List[str]]
contains_client: Optional[bool]
contains_users: Optional[bool]
hydrated: Optional[bool]
is_template: Optional[bool]
name: Optional[str]
page: int
page_size: int
sort_column: Optional[Literal['NAME', 'CLIENT_NAME', 'DURATION']]
sort_order: Optional[Literal['ASCENDING', 'DESCENDING']]
user_status: Optional[Literal['ACTIVE', 'ARCHIVED']]
users: Optional[List[str]]
class project_model.TimeEstimate(*, estimate: str = None, type: str = None, resetOption: str = None, active: bool = None, includeNonBillable: bool = None)

Bases: clockify.model.base_model.BaseModel

class Config

Bases: object

fields = {'active': 'active', 'estimate': 'estimate', 'include_non_billable': 'includeNonBillable', 'reset_option': 'resetOption', 'type': 'type'}
active: Optional[bool]
estimate: Optional[str]
include_non_billable: Optional[bool]
reset_option: Optional[str]
type: Optional[str]