client_api module

class client_api.ClientApi(key: str)

Bases: clockify.wrapper.Wrapper

create_client(client: clockify.model.client_model.Client) → clockify.model.client_model.Client

Create one client and return it as a object.

Parameters

client (Client) – Client object.

Returns

Client object.

Return type

Client

delete_client(workspace_id: str, client_id: str) → clockify.model.client_model.Client

Delete a Client, and return it as a Client object.

Parameters

• workspace_id (str) – ID of the clockify workspace.

• client_id (str) – ID of the clockify client.

Returns

Deleted Client object.

Return type

Client

get_client(workspace_id: str, client_id: str) → clockify.model.client_model.Client

Return one client Object

Parameters

• workspace_id (str) – ID of the clockify workspace

• client_id (str) – Id of the clockify client

Returns

A Client object.

Return type

Client

get_clients(workspace_id: str, params: clockify.model.client_model.ClientGetParams = ClientGetParams(archived=None, name=None, page=1, page_size=50, sort_column=None, sort_order=None)) → List[clockify.model.client_model.Client]

Return a list of clients.

Parameters

• workspace_id (str) – ID of the Clockify workspace.

• params (ClientGetParams, optional) – Path Parameters. Defaults to ClientGetParams().

Returns

List of Client objects

Return type

List[Client]

update_client(client: clockify.model.client_model.Client, params: clockify.model.client_model.ClientUpdateParams = ClientUpdateParams()) → clockify.model.client_model.Client

Update a Client and return it as a Client object.

Parameters

• client (Client) – Client object.

• params (ClientUpdateParams, optional) – Path parameters. Defaults to ClientUpdateParams().

Returns

Updated Client object.

Return type

Client