13678007438

Committed 05 Mar 2025 02:15PM UTC coverage: 2.081% (+0.01%) from 2.067%

Build # 13678007438

Build Type

push

github

Committed by

tylernathanreed

Commit Message

Merge branch 'master' of github.com:tylernathanreed/jira-client-php

Run Details

141 of 6775 relevant lines covered (2.08%)

0.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Operations/TimeTracking.php

<?php

namespace Jira\Client\Operations;

use Jira\Client\Client;
use Jira\Client\Schema;

/** @phpstan-require-extends Client */
trait TimeTracking
{
    /**
     * Returns the time tracking provider that is currently selected.
     * Note that if time tracking is disabled, then a successful but empty response is returned
     * 
     * **"Permissions" required:** *Administer Jira* "global permission".
     * 
     * @link https://confluence.atlassian.com/x/x4dKLg
     */
    public function getSelectedTimeTrackingImplementation(): Schema\TimeTrackingProvider
    {
        return $this->call(
            uri: '/rest/api/3/configuration/timetracking',
            method: 'get',
            success: 200,
            schema: Schema\TimeTrackingProvider::class,
        );
    }

    /**
     * Selects a time tracking provider
     * 
     * **"Permissions" required:** *Administer Jira* "global permission".
     * 
     * @link https://confluence.atlassian.com/x/x4dKLg
     */
    public function selectTimeTrackingImplementation(
        Schema\TimeTrackingProvider $request,
    ): true {
        return $this->call(
            uri: '/rest/api/3/configuration/timetracking',
            method: 'put',
            body: $request,
            success: 204,
            schema: true,
        );
    }

    /**
     * Returns all time tracking providers.
     * By default, Jira only has one time tracking provider: *JIRA provided time tracking*.
     * However, you can install other time tracking providers via apps from the Atlassian Marketplace.
     * For more information on time tracking providers, see the documentation for the " Time Tracking Provider" module
     * 
     * **"Permissions" required:** *Administer Jira* "global permission".
     * 
     * @link https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/
     * @link https://confluence.atlassian.com/x/x4dKLg
     * 
     * @return list<Schema\TimeTrackingProvider>
     */
    public function getAvailableTimeTrackingImplementations(): array
    {
        return $this->call(
            uri: '/rest/api/3/configuration/timetracking/list',
            method: 'get',
            success: 200,
            schema: [Schema\TimeTrackingProvider::class],
        );
    }

    /**
     * Returns the time tracking settings.
     * This includes settings such as the time format, default time unit, and others.
     * For more information, see "Configuring time tracking"
     * 
     * **"Permissions" required:** *Administer Jira* "global permission".
     * 
     * @link https://confluence.atlassian.com/x/qoXKM
     * @link https://confluence.atlassian.com/x/x4dKLg
     */
    public function getSharedTimeTrackingConfiguration(): Schema\TimeTrackingConfiguration
    {
        return $this->call(
            uri: '/rest/api/3/configuration/timetracking/options',
            method: 'get',
            success: 200,
            schema: Schema\TimeTrackingConfiguration::class,
        );
    }

    /**
     * Sets the time tracking settings
     * 
     * **"Permissions" required:** *Administer Jira* "global permission".
     * 
     * @link https://confluence.atlassian.com/x/x4dKLg
     */
    public function setSharedTimeTrackingConfiguration(
        Schema\TimeTrackingConfiguration $request,
    ): Schema\TimeTrackingConfiguration {
        return $this->call(
            uri: '/rest/api/3/configuration/timetracking/options',
            method: 'put',
            body: $request,
            success: 200,
            schema: Schema\TimeTrackingConfiguration::class,
        );
    }
}

1	<?php
2
3	namespace Jira\Client\Operations;
4
5	use Jira\Client\Client;
6	use Jira\Client\Schema;
7
8	/** @phpstan-require-extends Client */
9	trait TimeTracking
10	{
11	/**
12	* Returns the time tracking provider that is currently selected.
13	* Note that if time tracking is disabled, then a successful but empty response is returned
14	*
15	* "Permissions" required: Administer Jira "global permission".
16	*
17	* @link https://confluence.atlassian.com/x/x4dKLg
18	*/
19	public function getSelectedTimeTrackingImplementation(): Schema\TimeTrackingProvider	×
20	{
21	return $this->call(	×
22	uri: '/rest/api/3/configuration/timetracking',	×
23	method: 'get',	×
24	success: 200,	×
25	schema: Schema\TimeTrackingProvider::class,	×
26	);	×
27	}
28
29	/**
30	* Selects a time tracking provider
31	*
32	* "Permissions" required: Administer Jira "global permission".
33	*
34	* @link https://confluence.atlassian.com/x/x4dKLg
35	*/
36	public function selectTimeTrackingImplementation(	×
37	Schema\TimeTrackingProvider $request,
38	): true {
39	return $this->call(	×
40	uri: '/rest/api/3/configuration/timetracking',	×
41	method: 'put',	×
42	body: $request,	×
43	success: 204,	×
44	schema: true,	×
45	);	×
46	}
47
48	/**
49	* Returns all time tracking providers.
50	* By default, Jira only has one time tracking provider: JIRA provided time tracking.
51	* However, you can install other time tracking providers via apps from the Atlassian Marketplace.
52	* For more information on time tracking providers, see the documentation for the " Time Tracking Provider" module
53	*
54	* "Permissions" required: Administer Jira "global permission".
55	*
56	* @link https://developer.atlassian.com/cloud/jira/platform/modules/time-tracking-provider/
57	* @link https://confluence.atlassian.com/x/x4dKLg
58	*
59	* @return list<Schema\TimeTrackingProvider>
60	*/
61	public function getAvailableTimeTrackingImplementations(): array	×
62	{
63	return $this->call(	×
64	uri: '/rest/api/3/configuration/timetracking/list',	×
65	method: 'get',	×
66	success: 200,	×
67	schema: [Schema\TimeTrackingProvider::class],	×
68	);	×
69	}
70
71	/**
72	* Returns the time tracking settings.
73	* This includes settings such as the time format, default time unit, and others.
74	* For more information, see "Configuring time tracking"
75	*
76	* "Permissions" required: Administer Jira "global permission".
77	*
78	* @link https://confluence.atlassian.com/x/qoXKM
79	* @link https://confluence.atlassian.com/x/x4dKLg
80	*/
81	public function getSharedTimeTrackingConfiguration(): Schema\TimeTrackingConfiguration	×
82	{
83	return $this->call(	×
84	uri: '/rest/api/3/configuration/timetracking/options',	×
85	method: 'get',	×
86	success: 200,	×
87	schema: Schema\TimeTrackingConfiguration::class,	×
88	);	×
89	}
90
91	/**
92	* Sets the time tracking settings
93	*
94	* "Permissions" required: Administer Jira "global permission".
95	*
96	* @link https://confluence.atlassian.com/x/x4dKLg
97	*/
98	public function setSharedTimeTrackingConfiguration(	×
99	Schema\TimeTrackingConfiguration $request,
100	): Schema\TimeTrackingConfiguration {
101	return $this->call(	×
102	uri: '/rest/api/3/configuration/timetracking/options',	×
103	method: 'put',	×
104	body: $request,	×
105	success: 200,	×
106	schema: Schema\TimeTrackingConfiguration::class,	×
107	);	×
108	}
109	}

tylernathanreed / jira-client-php / 13678007438

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous