annoworkapi.wrapper module

class annoworkapi.wrapper.Wrapper(api: AnnoworkApi)

AnnoworkApiのラッパー.

パラメータ:

api -- AnnoworkApi Instance

get_actual_working_times_by_workspace_member_daily(workspace_id: str, workspace_member_id: str, *, term_start_date: str | None = None, term_end_date: str | None = None, tzinfo: tzinfo | None = None) → Any

ワークスペースメンバーに対する実績時間を一括取得します。実績時間は日、ジョブ、メンバ単位で集計されています。

パラメータ:

• workspace_id (str) -- ワークスペースID (required)

• workspace_member_id (str) -- ワークスペースメンバーID (required)

• term_start_date (str) -- 検索範囲の開始日（YYYY-MM-DD）

• term_end_date (str) -- 検索範囲の終了日（YYYY-MM-DD）

• tzinfo -- 日付を決めるためのタイムゾーン。未指定の場合はシステムのタイムゾーンを参照します。

戻り値:

日付、ジョブ、メンバ単位で集計した実績時間のlistを返します。listの要素はdictで以下のキーを持ちます。 * date * job_id * workspace_member_id * actual_working_hours

get_actual_working_times_daily(workspace_id: str, *, job_id: str | None = None, term_start_date: str | None = None, term_end_date: str | None = None, tzinfo: tzinfo | None = None) → list[dict[str, Any]]

ワークスペース全体の実績時間を一括取得します。実績時間は日、ジョブ、メンバ単位で集計されています。

パラメータ:

• workspace_id (str) -- ワークスペースID (required)

• job_id (str) -- ジョブIDで絞り込みます。

• term_start_date (str) -- 検索範囲の開始日（YYYY-MM-DD）

• term_end_date (str) -- 検索範囲の終了日（YYYY-MM-DD）

• tzinfo -- 日付を決めるためのタイムゾーン。未指定の場合はシステムのタイムゾーンを参照します。

戻り値:

日付、ジョブ、メンバ単位で集計した実績時間のlistを返します。listの要素はdictで以下のキーを持ちます。 * date * job_id * workspace_member_id * actual_working_hours

get_schedules_daily(workspace_id: str, *, term_start: str | None = None, term_end: str | None = None, job_id: str | None = None) → list[dict[str, Any]]

日、ジョブ、メンバ単位のアサイン時間を取得します。

メモ

内部で api.get_expected_working_times を実行します。

パラメータ:

• workspace_id -- ワークスペースID

• term_start_date (str) -- 検索範囲の開始日（YYYY-MM-DD）

• term_end_date (str) -- 検索範囲の終了日（YYYY-MM-DD）

• job_id (str) -- 検索対象のジョブID

戻り値:

日、ジョブ、メンバ単位のアサイン時間のlist。listの要素は以下のキーを持ちます。 * date * job_id * workspace_member_id * assigned_working_hours