mirror of
https://github.com/solidtime-io/solidtime.git
synced 2026-10-17 18:23:19 +01:00
Compare commits
1 Commits
feautre/im
...
ded56c0798
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ded56c0798 |
@@ -88,8 +88,6 @@ class InvitationController extends Controller
|
|||||||
/**
|
/**
|
||||||
* Remove a pending invitation
|
* Remove a pending invitation
|
||||||
*
|
*
|
||||||
* This revokes the invitation: the link in the invitation email stops working. Find the invitation ID with `GET /organizations/{organization}/invitations`.
|
|
||||||
*
|
|
||||||
* @throws AuthorizationException
|
* @throws AuthorizationException
|
||||||
*
|
*
|
||||||
* @operationId removeInvitation
|
* @operationId removeInvitation
|
||||||
|
|||||||
@@ -145,9 +145,6 @@ class MemberController extends Controller
|
|||||||
/**
|
/**
|
||||||
* Merge one member into another
|
* Merge one member into another
|
||||||
*
|
*
|
||||||
* Only placeholder members (for example people created by an import) can be merged. All time entries and other data of the placeholder
|
|
||||||
* are reassigned to the member given in `member_id`, and the placeholder is removed. Find both member IDs with `GET /organizations/{organization}/members`.
|
|
||||||
*
|
|
||||||
* @throws AuthorizationException
|
* @throws AuthorizationException
|
||||||
* @throws OnlyPlaceholdersCanBeMergedIntoAnotherMember
|
* @throws OnlyPlaceholdersCanBeMergedIntoAnotherMember
|
||||||
* @throws Throwable
|
* @throws Throwable
|
||||||
|
|||||||
@@ -71,8 +71,6 @@ class ReportController extends Controller
|
|||||||
/**
|
/**
|
||||||
* Create report
|
* Create report
|
||||||
*
|
*
|
||||||
* A report is a saved set of filters. Set `is_public` to `true` to share it: the response then contains the `shareable_link` that can be opened without logging in.
|
|
||||||
*
|
|
||||||
* @throws AuthorizationException
|
* @throws AuthorizationException
|
||||||
*
|
*
|
||||||
* @operationId createReport
|
* @operationId createReport
|
||||||
|
|||||||
@@ -109,14 +109,9 @@ class TimeEntryController extends Controller
|
|||||||
/**
|
/**
|
||||||
* Get time entries in organization
|
* Get time entries in organization
|
||||||
*
|
*
|
||||||
* Without a member filter this returns the time entries of all members of the organization (for users who may view all time entries, such as owners and admins), not only your own.
|
* If you only need time entries for a specific user, you can filter by `member_id`.
|
||||||
* To get only your own time entries, pass your member ID as `member_id`. Your member ID is the `id` returned for this organization by `GET /v1/users/me/memberships`; it is not your user ID.
|
|
||||||
* Users with the permission `time-entries:view:own` can only use this endpoint with their own member ID in the member_id filter.
|
* Users with the permission `time-entries:view:own` can only use this endpoint with their own member ID in the member_id filter.
|
||||||
*
|
*
|
||||||
* The `start` and `end` filters both apply to the start time of an entry, in UTC. Convert the user's local day boundaries to UTC first.
|
|
||||||
* Results are paginated with `limit` (default 100, max 500) and `offset`; check `meta.total` and fetch further pages when needed.
|
|
||||||
* To find the running timer, use `active=true` (or `GET /v1/users/me/time-entries/active`).
|
|
||||||
*
|
|
||||||
* @return TimeEntryCollection<TimeEntryResource>
|
* @return TimeEntryCollection<TimeEntryResource>
|
||||||
*
|
*
|
||||||
* @throws AuthorizationException
|
* @throws AuthorizationException
|
||||||
@@ -356,11 +351,6 @@ class TimeEntryController extends Controller
|
|||||||
* The parameters `group` and `sub_group` allow you to group the time entries by different criteria.
|
* The parameters `group` and `sub_group` allow you to group the time entries by different criteria.
|
||||||
* If the group parameters are all set to `null` or are all missing, the endpoint will aggregate all filtered time entries.
|
* If the group parameters are all set to `null` or are all missing, the endpoint will aggregate all filtered time entries.
|
||||||
*
|
*
|
||||||
* Durations are returned in `seconds` (divide by 3600 for hours) and amounts in `cost` as cents in the organization's currency (divide by 100 for money).
|
|
||||||
* Filter by member with `member_id`. Your member ID is the `id` returned for this organization by `GET /v1/users/me/memberships`; it is not your user ID.
|
|
||||||
* Array filters use the query format `client_ids[]=<id>`.
|
|
||||||
* Example: billable hours per client for a period: `group=client&billable=true&start=...&end=...`.
|
|
||||||
*
|
|
||||||
* @operationId getAggregatedTimeEntries
|
* @operationId getAggregatedTimeEntries
|
||||||
*
|
*
|
||||||
* @return array{
|
* @return array{
|
||||||
@@ -594,12 +584,6 @@ class TimeEntryController extends Controller
|
|||||||
/**
|
/**
|
||||||
* Create time entry
|
* Create time entry
|
||||||
*
|
*
|
||||||
* `billable` is not taken from the project. To match the web app, set it to the project's `is_billable` value (or `false` without a project).
|
|
||||||
*
|
|
||||||
* A member can only have one running time entry (an entry with `end` set to `null`). Creating a running entry while another one runs fails with `time_entry_still_running`.
|
|
||||||
* To start a new timer, first stop the running entry by updating its `end` to the current time, then create the new entry.
|
|
||||||
* To log past work, send both `start` and `end` (UTC). Create one entry per block of work.
|
|
||||||
*
|
|
||||||
* @throws AuthorizationException
|
* @throws AuthorizationException
|
||||||
* @throws TimeEntryStillRunningApiException
|
* @throws TimeEntryStillRunningApiException
|
||||||
*
|
*
|
||||||
@@ -650,8 +634,6 @@ class TimeEntryController extends Controller
|
|||||||
/**
|
/**
|
||||||
* Update time entry
|
* Update time entry
|
||||||
*
|
*
|
||||||
* To stop a running timer, set `end` to the stop time (UTC). Times the user gives in their own timezone must be converted to UTC first.
|
|
||||||
*
|
|
||||||
* @throws AuthorizationException|TimeEntryCanNotBeRestartedApiException
|
* @throws AuthorizationException|TimeEntryCanNotBeRestartedApiException
|
||||||
*
|
*
|
||||||
* @operationId updateTimeEntry
|
* @operationId updateTimeEntry
|
||||||
@@ -720,10 +702,6 @@ class TimeEntryController extends Controller
|
|||||||
/**
|
/**
|
||||||
* Update multiple time entries
|
* Update multiple time entries
|
||||||
*
|
*
|
||||||
* Applies the same `changes` to every entry in `ids`. To find the IDs, list entries with `GET /organizations/{organization}/time-entries`
|
|
||||||
* (filtered by `member_id`, the project and the other criteria), then send their IDs here.
|
|
||||||
* When `changes.project_id` moves entries to another project, also set `changes.task_id` to a task of the new project or to `null`, because tasks belong to a project.
|
|
||||||
*
|
|
||||||
* @operationId updateMultipleTimeEntries
|
* @operationId updateMultipleTimeEntries
|
||||||
*
|
*
|
||||||
* @throws AuthorizationException
|
* @throws AuthorizationException
|
||||||
|
|||||||
@@ -27,7 +27,6 @@ class MemberUpdateRequest extends BaseFormRequest
|
|||||||
'string',
|
'string',
|
||||||
Rule::enum(Role::class),
|
Rule::enum(Role::class),
|
||||||
],
|
],
|
||||||
// Billable rate in cents per hour (example: 8000 means 80.00 in the organization's currency)
|
|
||||||
'billable_rate' => array_merge(
|
'billable_rate' => array_merge(
|
||||||
[
|
[
|
||||||
'nullable',
|
'nullable',
|
||||||
|
|||||||
@@ -36,7 +36,6 @@ class OrganizationUpdateRequest extends BaseFormRequest
|
|||||||
'string',
|
'string',
|
||||||
new CurrencyRule,
|
new CurrencyRule,
|
||||||
],
|
],
|
||||||
// Billable rate in cents per hour (example: 8000 means 80.00 in the organization's currency)
|
|
||||||
'billable_rate' => array_merge(
|
'billable_rate' => array_merge(
|
||||||
[
|
[
|
||||||
'nullable',
|
'nullable',
|
||||||
|
|||||||
@@ -55,7 +55,6 @@ class ProjectStoreRequest extends BaseFormRequest
|
|||||||
'required',
|
'required',
|
||||||
'boolean',
|
'boolean',
|
||||||
],
|
],
|
||||||
// Billable rate in cents per hour (example: 8000 means 80.00 in the organization's currency)
|
|
||||||
'billable_rate' => array_merge(
|
'billable_rate' => array_merge(
|
||||||
[
|
[
|
||||||
'nullable',
|
'nullable',
|
||||||
|
|||||||
@@ -68,7 +68,6 @@ class ProjectUpdateRequest extends BaseFormRequest
|
|||||||
return $builder->whereBelongsTo($this->organization, 'organization');
|
return $builder->whereBelongsTo($this->organization, 'organization');
|
||||||
})->uuid(),
|
})->uuid(),
|
||||||
],
|
],
|
||||||
// Billable rate in cents per hour (example: 8000 means 80.00 in the organization's currency)
|
|
||||||
'billable_rate' => array_merge([
|
'billable_rate' => array_merge([
|
||||||
'nullable',
|
'nullable',
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -31,7 +31,6 @@ class ProjectMemberStoreRequest extends BaseFormRequest
|
|||||||
return $builder->whereBelongsTo($this->organization, 'organization');
|
return $builder->whereBelongsTo($this->organization, 'organization');
|
||||||
})->uuid(),
|
})->uuid(),
|
||||||
],
|
],
|
||||||
// Billable rate in cents per hour (example: 8000 means 80.00 in the organization's currency)
|
|
||||||
'billable_rate' => array_merge(
|
'billable_rate' => array_merge(
|
||||||
[
|
[
|
||||||
'nullable',
|
'nullable',
|
||||||
|
|||||||
@@ -21,7 +21,6 @@ class ProjectMemberUpdateRequest extends BaseFormRequest
|
|||||||
public function rules(): array
|
public function rules(): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
// Billable rate in cents per hour (example: 8000 means 80.00 in the organization's currency)
|
|
||||||
'billable_rate' => array_merge(
|
'billable_rate' => array_merge(
|
||||||
[
|
[
|
||||||
'nullable',
|
'nullable',
|
||||||
|
|||||||
@@ -35,7 +35,7 @@ class TimeEntryIndexRequest extends BaseFormRequest
|
|||||||
public function rules(): array
|
public function rules(): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
// Filter by member ID. Without it, users who may view all time entries (owners, admins) get the entries of every member; pass your own member ID (from GET /v1/users/me/memberships) to get only yours
|
// Filter by member ID
|
||||||
'member_id' => [
|
'member_id' => [
|
||||||
'string',
|
'string',
|
||||||
ExistsEloquent::make(Member::class, null, function (Builder $builder): Builder {
|
ExistsEloquent::make(Member::class, null, function (Builder $builder): Builder {
|
||||||
@@ -155,7 +155,7 @@ class TimeEntryIndexRequest extends BaseFormRequest
|
|||||||
'string',
|
'string',
|
||||||
Rule::enum(TimeEntryType::class),
|
Rule::enum(TimeEntryType::class),
|
||||||
],
|
],
|
||||||
// Limit the number of returned time entries (default: 100)
|
// Limit the number of returned time entries (default: 150)
|
||||||
'limit' => [
|
'limit' => [
|
||||||
'integer',
|
'integer',
|
||||||
'min:1',
|
'min:1',
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ class TimeEntryStoreRequest extends BaseFormRequest
|
|||||||
public function rules(): array
|
public function rules(): array
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
// ID of the organization member that the time entry should belong to (a member ID from GET /v1/users/me/memberships or the members list, not a user ID)
|
// ID of the organization member that the time entry should belong to
|
||||||
'member_id' => [
|
'member_id' => [
|
||||||
'required',
|
'required',
|
||||||
'string',
|
'string',
|
||||||
@@ -86,7 +86,7 @@ class TimeEntryStoreRequest extends BaseFormRequest
|
|||||||
'date_format:Y-m-d\TH:i:s\Z',
|
'date_format:Y-m-d\TH:i:s\Z',
|
||||||
'after_or_equal:start',
|
'after_or_equal:start',
|
||||||
],
|
],
|
||||||
// Whether time entry is billable. Not derived from the project: set it to the project's is_billable value to match the web app
|
// Whether time entry is billable
|
||||||
'billable' => [
|
'billable' => [
|
||||||
'required',
|
'required',
|
||||||
'boolean',
|
'boolean',
|
||||||
|
|||||||
@@ -117,13 +117,13 @@ class ReportPropertiesDto implements Castable
|
|||||||
$dto->end = $data->end !== null ? Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $data->end) : null;
|
$dto->end = $data->end !== null ? Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $data->end) : null;
|
||||||
$dto->start = $data->start !== null ? Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $data->start) : null;
|
$dto->start = $data->start !== null ? Carbon::createFromFormat('Y-m-d\TH:i:s\Z', $data->start) : null;
|
||||||
$dto->active = $data->active;
|
$dto->active = $data->active;
|
||||||
$dto->memberIds = $data->memberIds !== null ? ReportPropertiesDto::idArrayToCollection($data->memberIds) : null;
|
$dto->setMemberIds($data->memberIds !== null ? (array) $data->memberIds : null);
|
||||||
$dto->billable = $data->billable;
|
$dto->billable = $data->billable;
|
||||||
$dto->clientIds = $data->clientIds !== null ? ReportPropertiesDto::idArrayToCollection($data->clientIds) : null;
|
$dto->setClientIds($data->clientIds !== null ? (array) $data->clientIds : null);
|
||||||
$dto->projectIds = $data->projectIds !== null ? ReportPropertiesDto::idArrayToCollection($data->projectIds) : null;
|
$dto->setProjectIds($data->projectIds !== null ? (array) $data->projectIds : null);
|
||||||
$dto->tagIds = $data->tagIds !== null ? ReportPropertiesDto::idArrayToCollection($data->tagIds) : null;
|
$dto->setTagIds($data->tagIds !== null ? (array) $data->tagIds : null);
|
||||||
$dto->tagMatchType = isset($data->tagMatchType) ? TagMatchType::from($data->tagMatchType) : null;
|
$dto->tagMatchType = isset($data->tagMatchType) ? TagMatchType::from($data->tagMatchType) : null;
|
||||||
$dto->taskIds = $data->taskIds ? ReportPropertiesDto::idArrayToCollection($data->taskIds) : null;
|
$dto->setTaskIds($data->taskIds !== null ? (array) $data->taskIds : null);
|
||||||
$dto->group = TimeEntryAggregationType::from($data->group);
|
$dto->group = TimeEntryAggregationType::from($data->group);
|
||||||
$dto->subGroup = TimeEntryAggregationType::from($data->subGroup);
|
$dto->subGroup = TimeEntryAggregationType::from($data->subGroup);
|
||||||
$dto->historyGroup = TimeEntryAggregationTypeInterval::from($data->historyGroup);
|
$dto->historyGroup = TimeEntryAggregationTypeInterval::from($data->historyGroup);
|
||||||
@@ -205,7 +205,7 @@ class ReportPropertiesDto implements Castable
|
|||||||
*/
|
*/
|
||||||
public function setMemberIds(?array $memberIds): void
|
public function setMemberIds(?array $memberIds): void
|
||||||
{
|
{
|
||||||
$this->memberIds = $memberIds !== null ? ReportPropertiesDto::idArrayToCollection($memberIds) : null;
|
$this->memberIds = $memberIds !== null && count($memberIds) > 0 ? ReportPropertiesDto::idArrayToCollection($memberIds) : null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -213,7 +213,7 @@ class ReportPropertiesDto implements Castable
|
|||||||
*/
|
*/
|
||||||
public function setClientIds(?array $clientIds): void
|
public function setClientIds(?array $clientIds): void
|
||||||
{
|
{
|
||||||
$this->clientIds = $clientIds !== null ? ReportPropertiesDto::idArrayToCollection($clientIds) : null;
|
$this->clientIds = $clientIds !== null && count($clientIds) > 0 ? ReportPropertiesDto::idArrayToCollection($clientIds) : null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -221,7 +221,7 @@ class ReportPropertiesDto implements Castable
|
|||||||
*/
|
*/
|
||||||
public function setProjectIds(?array $projectIds): void
|
public function setProjectIds(?array $projectIds): void
|
||||||
{
|
{
|
||||||
$this->projectIds = $projectIds !== null ? ReportPropertiesDto::idArrayToCollection($projectIds) : null;
|
$this->projectIds = $projectIds !== null && count($projectIds) > 0 ? ReportPropertiesDto::idArrayToCollection($projectIds) : null;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -229,7 +229,7 @@ class ReportPropertiesDto implements Castable
|
|||||||
*/
|
*/
|
||||||
public function setTagIds(?array $tagIds): void
|
public function setTagIds(?array $tagIds): void
|
||||||
{
|
{
|
||||||
$this->tagIds = $tagIds !== null ? ReportPropertiesDto::idArrayToCollection($tagIds) : null;
|
$this->tagIds = $tagIds !== null && count($tagIds) > 0 ? ReportPropertiesDto::idArrayToCollection($tagIds) : null;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function setTagMatchType(?TagMatchType $tagMatchType): void
|
public function setTagMatchType(?TagMatchType $tagMatchType): void
|
||||||
@@ -242,6 +242,6 @@ class ReportPropertiesDto implements Castable
|
|||||||
*/
|
*/
|
||||||
public function setTaskIds(?array $taskIds): void
|
public function setTaskIds(?array $taskIds): void
|
||||||
{
|
{
|
||||||
$this->taskIds = $taskIds !== null ? ReportPropertiesDto::idArrayToCollection($taskIds) : null;
|
$this->taskIds = $taskIds !== null && count($taskIds) > 0 ? ReportPropertiesDto::idArrayToCollection($taskIds) : null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -111,7 +111,8 @@ class TimeEntryFilter
|
|||||||
*/
|
*/
|
||||||
public function addMemberIdsFilter(?array $memberIds): self
|
public function addMemberIdsFilter(?array $memberIds): self
|
||||||
{
|
{
|
||||||
if ($memberIds === null) {
|
// An empty selection is no constraint, the same as null
|
||||||
|
if ($memberIds === null || count($memberIds) === 0) {
|
||||||
return $this;
|
return $this;
|
||||||
}
|
}
|
||||||
$this->builder->whereIn('member_id', $memberIds);
|
$this->builder->whereIn('member_id', $memberIds);
|
||||||
@@ -181,6 +182,10 @@ class TimeEntryFilter
|
|||||||
}
|
}
|
||||||
$includeNone = in_array(self::NONE_VALUE, $clientIds, true);
|
$includeNone = in_array(self::NONE_VALUE, $clientIds, true);
|
||||||
$clientIds = array_values(array_filter($clientIds, fn (string $id): bool => $id !== self::NONE_VALUE));
|
$clientIds = array_values(array_filter($clientIds, fn (string $id): bool => $id !== self::NONE_VALUE));
|
||||||
|
// An empty selection (no client IDs and not filtering for "none") is no constraint, so apply nothing
|
||||||
|
if (count($clientIds) === 0 && ! $includeNone) {
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
$this->builder->where(function (Builder $builder) use ($clientIds, $includeNone): void {
|
$this->builder->where(function (Builder $builder) use ($clientIds, $includeNone): void {
|
||||||
if (count($clientIds) > 0) {
|
if (count($clientIds) > 0) {
|
||||||
@@ -204,6 +209,10 @@ class TimeEntryFilter
|
|||||||
}
|
}
|
||||||
$includeNone = in_array(self::NONE_VALUE, $projectIds, true);
|
$includeNone = in_array(self::NONE_VALUE, $projectIds, true);
|
||||||
$projectIds = array_values(array_filter($projectIds, fn (string $id): bool => $id !== self::NONE_VALUE));
|
$projectIds = array_values(array_filter($projectIds, fn (string $id): bool => $id !== self::NONE_VALUE));
|
||||||
|
// An empty selection (no project IDs and not filtering for "none") is no constraint, so apply nothing
|
||||||
|
if (count($projectIds) === 0 && ! $includeNone) {
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
$this->builder->where(function (Builder $builder) use ($projectIds, $includeNone): void {
|
$this->builder->where(function (Builder $builder) use ($projectIds, $includeNone): void {
|
||||||
if (count($projectIds) > 0) {
|
if (count($projectIds) > 0) {
|
||||||
@@ -269,6 +278,10 @@ class TimeEntryFilter
|
|||||||
}
|
}
|
||||||
$includeNone = in_array(self::NONE_VALUE, $taskIds, true);
|
$includeNone = in_array(self::NONE_VALUE, $taskIds, true);
|
||||||
$taskIds = array_values(array_filter($taskIds, fn (string $id): bool => $id !== self::NONE_VALUE));
|
$taskIds = array_values(array_filter($taskIds, fn (string $id): bool => $id !== self::NONE_VALUE));
|
||||||
|
// An empty selection (no task IDs and not filtering for "none") is no constraint, so apply nothing
|
||||||
|
if (count($taskIds) === 0 && ! $includeNone) {
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
$this->builder->where(function (Builder $builder) use ($taskIds, $includeNone): void {
|
$this->builder->where(function (Builder $builder) use ($taskIds, $includeNone): void {
|
||||||
if (count($taskIds) > 0) {
|
if (count($taskIds) > 0) {
|
||||||
|
|||||||
@@ -28,30 +28,7 @@ return [
|
|||||||
/*
|
/*
|
||||||
* Description rendered on the home page of the API documentation (`/docs/api`).
|
* Description rendered on the home page of the API documentation (`/docs/api`).
|
||||||
*/
|
*/
|
||||||
'description' => <<<'MD'
|
'description' => '',
|
||||||
## Getting started
|
|
||||||
|
|
||||||
All organization endpoints live under `/v1/organizations/{organization}`, where `{organization}` is the organization's ID. Authenticate with `Authorization: Bearer <token>` and send `Accept: application/json`.
|
|
||||||
|
|
||||||
**1. Find yourself.** Call `GET /v1/users/me/memberships`. Each membership contains the **organization ID** (use it as `{organization}` in paths) and your **member ID** in that organization (the membership `id`). Most endpoints filter by member ID, not by user ID.
|
|
||||||
|
|
||||||
**2. Scope to your own data.** For owners and admins, `GET /time-entries` and `GET /time-entries/aggregate` return the whole organization's time entries unless you pass `member_id`. When acting for "me", always pass your member ID, both when reading and before changing entries.
|
|
||||||
|
|
||||||
**3. Resolve names to IDs.** Look up projects, clients, tags, tasks and members by name with their list endpoints (`GET /projects`, `GET /clients`, `GET /tags`, `GET /tasks`, `GET /members`). Never guess IDs.
|
|
||||||
|
|
||||||
**4. Use UTC.** All timestamps are sent and returned in UTC as `Y-m-d\TH:i:s\Z` (example: `2026-10-02T07:30:00Z`). Convert the user's local times and day boundaries to UTC before sending them.
|
|
||||||
|
|
||||||
**5. Money is in cents.** Billable rates and costs are integers in cents of the organization's currency (`8000` means 80.00).
|
|
||||||
|
|
||||||
## Common tasks
|
|
||||||
|
|
||||||
- **Start a timer:** stop the running entry first (find it with `GET /v1/users/me/time-entries/active`, then `PUT` its `end`), then `POST /time-entries` with `start` and `end: null`. Only one entry can run per member.
|
|
||||||
- **Log past work:** `POST /time-entries` once per block with `member_id`, `start`, `end`, `project_id` and `billable` set to the project's `is_billable` (it is not derived automatically).
|
|
||||||
- **Fix or stop an entry:** `PUT /time-entries/{timeEntry}` with the new `start` or `end` in UTC.
|
|
||||||
- **Move entries to another project:** list them with `member_id` and filters, then `PATCH /time-entries` with their `ids` and `changes.project_id`, plus `changes.task_id` set to a task of the new project or `null`.
|
|
||||||
- **Totals and reports:** `GET /time-entries/aggregate` with `group` (for example `client` or `project`) and `start`/`end`; durations are in `seconds`, amounts in `cost` (cents).
|
|
||||||
- **Share a report:** `POST /reports` with `is_public: true` and use the returned `shareable_link`.
|
|
||||||
MD,
|
|
||||||
],
|
],
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
|||||||
@@ -606,6 +606,51 @@ class ReportEndpointTest extends ApiEndpointTestAbstract
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function test_store_endpoint_stores_empty_id_filters_as_null(): void
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
$data = $this->createUserWithPermission([
|
||||||
|
'reports:create',
|
||||||
|
]);
|
||||||
|
Passport::actingAs($data->user);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
$response = $this->postJson(route('api.v1.reports.store', [$data->organization->getKey()]), [
|
||||||
|
'name' => 'Test Report with empty Filters',
|
||||||
|
'is_public' => false,
|
||||||
|
'properties' => [
|
||||||
|
'start' => Carbon::now()->subDays(30)->toIso8601ZuluString(),
|
||||||
|
'end' => Carbon::now()->toIso8601ZuluString(),
|
||||||
|
'group' => TimeEntryAggregationType::Project->value,
|
||||||
|
'sub_group' => TimeEntryAggregationType::Task->value,
|
||||||
|
'history_group' => TimeEntryAggregationType::Day->value,
|
||||||
|
'member_ids' => [],
|
||||||
|
'project_ids' => [],
|
||||||
|
'client_ids' => [],
|
||||||
|
'tag_ids' => [],
|
||||||
|
'task_ids' => [],
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
$response->assertStatus(201);
|
||||||
|
$response->assertJson(fn (AssertableJson $json) => $json
|
||||||
|
->where('data.properties.member_ids', null)
|
||||||
|
->where('data.properties.project_ids', null)
|
||||||
|
->where('data.properties.client_ids', null)
|
||||||
|
->where('data.properties.tag_ids', null)
|
||||||
|
->where('data.properties.task_ids', null)
|
||||||
|
->etc()
|
||||||
|
);
|
||||||
|
/** @var Report $report */
|
||||||
|
$report = Report::query()->findOrFail($response->json('data.id'));
|
||||||
|
$this->assertNull($report->properties->memberIds);
|
||||||
|
$this->assertNull($report->properties->projectIds);
|
||||||
|
$this->assertNull($report->properties->clientIds);
|
||||||
|
$this->assertNull($report->properties->tagIds);
|
||||||
|
$this->assertNull($report->properties->taskIds);
|
||||||
|
}
|
||||||
|
|
||||||
public function test_store_endpoint_creates_report_with_none_filter_values(): void
|
public function test_store_endpoint_creates_report_with_none_filter_values(): void
|
||||||
{
|
{
|
||||||
// Arrange
|
// Arrange
|
||||||
|
|||||||
@@ -88,4 +88,25 @@ class ReportPropertiesDtoTest extends TestCase
|
|||||||
$this->assertSame(TimeEntryType::Work, $dtoWork->timeEntryType);
|
$this->assertSame(TimeEntryType::Work, $dtoWork->timeEntryType);
|
||||||
$this->assertSame(TimeEntryType::Break, $dtoBreak->timeEntryType);
|
$this->assertSame(TimeEntryType::Break, $dtoBreak->timeEntryType);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function test_empty_id_filters_of_a_persisted_report_are_read_as_null(): void
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
$properties = $this->getBaseProperties();
|
||||||
|
$properties['memberIds'] = [];
|
||||||
|
$properties['clientIds'] = [];
|
||||||
|
$properties['projectIds'] = [];
|
||||||
|
$properties['tagIds'] = [];
|
||||||
|
$properties['taskIds'] = [];
|
||||||
|
|
||||||
|
// Act
|
||||||
|
$dto = $this->castFromJson($properties);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
$this->assertNull($dto->memberIds);
|
||||||
|
$this->assertNull($dto->clientIds);
|
||||||
|
$this->assertNull($dto->projectIds);
|
||||||
|
$this->assertNull($dto->tagIds);
|
||||||
|
$this->assertNull($dto->taskIds);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -416,6 +416,81 @@ class TimeEntryFilterTest extends TestCaseWithDatabase
|
|||||||
$this->assertCount(3, $builderContains->get());
|
$this->assertCount(3, $builderContains->get());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function test_add_member_ids_filter_with_empty_array_applies_no_filter(): void
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
TimeEntry::factory()->createMany(2);
|
||||||
|
|
||||||
|
$builder = TimeEntry::query();
|
||||||
|
$filter = new TimeEntryFilter($builder);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
$filter->addMemberIdsFilter([]);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
$this->assertCount(2, $builder->get());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_add_project_ids_filter_with_empty_array_applies_no_filter(): void
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
$project = Project::factory()->create();
|
||||||
|
TimeEntry::factory()->create([
|
||||||
|
'project_id' => $project->getKey(),
|
||||||
|
'organization_id' => $project->organization_id,
|
||||||
|
]);
|
||||||
|
TimeEntry::factory()->create(['project_id' => null]);
|
||||||
|
|
||||||
|
$builder = TimeEntry::query();
|
||||||
|
$filter = new TimeEntryFilter($builder);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
$filter->addProjectIdsFilter([]);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
$this->assertCount(2, $builder->get());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_add_task_ids_filter_with_empty_array_applies_no_filter(): void
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
$task = Task::factory()->create();
|
||||||
|
TimeEntry::factory()->create([
|
||||||
|
'task_id' => $task->getKey(),
|
||||||
|
'organization_id' => $task->organization_id,
|
||||||
|
]);
|
||||||
|
TimeEntry::factory()->create(['task_id' => null]);
|
||||||
|
|
||||||
|
$builder = TimeEntry::query();
|
||||||
|
$filter = new TimeEntryFilter($builder);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
$filter->addTaskIdsFilter([]);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
$this->assertCount(2, $builder->get());
|
||||||
|
}
|
||||||
|
|
||||||
|
public function test_add_client_ids_filter_with_empty_array_applies_no_filter(): void
|
||||||
|
{
|
||||||
|
// Arrange
|
||||||
|
$client = Client::factory()->create();
|
||||||
|
TimeEntry::factory()->create([
|
||||||
|
'client_id' => $client->getKey(),
|
||||||
|
'organization_id' => $client->organization_id,
|
||||||
|
]);
|
||||||
|
TimeEntry::factory()->create(['client_id' => null]);
|
||||||
|
|
||||||
|
$builder = TimeEntry::query();
|
||||||
|
$filter = new TimeEntryFilter($builder);
|
||||||
|
|
||||||
|
// Act
|
||||||
|
$filter->addClientIdsFilter([]);
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
$this->assertCount(2, $builder->get());
|
||||||
|
}
|
||||||
|
|
||||||
public function test_add_tag_ids_filter_with_null_match_type_defaults_to_contains(): void
|
public function test_add_tag_ids_filter_with_null_match_type_defaults_to_contains(): void
|
||||||
{
|
{
|
||||||
// Arrange
|
// Arrange
|
||||||
|
|||||||
Reference in New Issue
Block a user