13634794100

Committed 03 Mar 2025 03:19PM UTC coverage: 2.067% (-0.1%) from 2.21%

Build # 13634794100

Build Type

push

github

Committed by

web-flow

Commit Message

~ Try coveralls action

Run Details

140 of 6773 relevant lines covered (2.07%)

0.03 hits per line

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

0.0

/src/Schema/User.php

<?php

namespace Jira\Client\Schema;

use Jira\Client\Dto;

/**
 * A user with details as permitted by the user's Atlassian Account privacy settings.
 * However, be aware of these exceptions:
 * 
 *  - User record deleted from Atlassian: This occurs as the result of a right to be forgotten request.
 * In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank)
 *  - User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users.
 * In this case, `accountId` returns *unknown* and all other parameters have fallback values
 *  - User record unavailable: This usually occurs due to an internal service outage.
 * In this case, all parameters have fallback values.
 */
final readonly class User extends Dto
{
    public function __construct(
        /**
         * The account ID of the user, which uniquely identifies the user across all Atlassian products.
         * For example, *5b10ac8d82e05b22cc7d4ef5*.
         * Required in requests.
         */
        public ?string $accountId = null,

        /**
         * The user account type.
         * Can take the following values:
         * 
         *  - `atlassian` regular Atlassian user account
         *  - `app` system account used for Connect applications and OAuth to represent external systems
         *  - `customer` Jira Service Desk account representing an external service desk
         * 
         * @var 'atlassian'|'app'|'customer'|'unknown'|null
         */
        public ?string $accountType = null,

        /** Whether the user is active. */
        public ?bool $active = null,

        /** The application roles the user is assigned to. */
        public ?SimpleListWrapperApplicationRole $applicationRoles = null,

        /** The avatars of the user. */
        public ?AvatarUrlsBean $avatarUrls = null,

        /**
         * The display name of the user.
         * Depending on the user’s privacy setting, this may return an alternative value.
         */
        public ?string $displayName = null,

        /**
         * The email address of the user.
         * Depending on the user’s privacy setting, this may be returned as null.
         */
        public ?string $emailAddress = null,

        /** Expand options that include additional user details in the response. */
        public ?string $expand = null,

        /** The groups that the user belongs to. */
        public ?SimpleListWrapperGroupName $groups = null,

        /**
         * This property is no longer available and will be removed from the documentation soon.
         * See the "deprecation notice" for details.
         * 
         * @link https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/
         */
        public ?string $key = null,

        /**
         * The locale of the user.
         * Depending on the user’s privacy setting, this may be returned as null.
         */
        public ?string $locale = null,

        /**
         * This property is no longer available and will be removed from the documentation soon.
         * See the "deprecation notice" for details.
         * 
         * @link https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/
         */
        public ?string $name = null,

        /** The URL of the user. */
        public ?string $self = null,

        /**
         * The time zone specified in the user's profile.
         * If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.
         */
        public ?string $timeZone = null,
    ) {
    }
}

1	<?php
2
3	namespace Jira\Client\Schema;
4
5	use Jira\Client\Dto;
6
7	/**
8	* A user with details as permitted by the user's Atlassian Account privacy settings.
9	* However, be aware of these exceptions:
10	*
11	* - User record deleted from Atlassian: This occurs as the result of a right to be forgotten request.
12	* In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank)
13	* - User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users.
14	* In this case, `accountId` returns unknown and all other parameters have fallback values
15	* - User record unavailable: This usually occurs due to an internal service outage.
16	* In this case, all parameters have fallback values.
17	*/
18	final readonly class User extends Dto
19	{
20	public function __construct(	×
21	/**
22	* The account ID of the user, which uniquely identifies the user across all Atlassian products.
23	* For example, 5b10ac8d82e05b22cc7d4ef5.
24	* Required in requests.
25	*/
26	public ?string $accountId = null,
27
28	/**
29	* The user account type.
30	* Can take the following values:
31	*
32	* - `atlassian` regular Atlassian user account
33	* - `app` system account used for Connect applications and OAuth to represent external systems
34	* - `customer` Jira Service Desk account representing an external service desk
35	*
36	* @var 'atlassian'\|'app'\|'customer'\|'unknown'\|null
37	*/
38	public ?string $accountType = null,
39
40	/** Whether the user is active. */
41	public ?bool $active = null,
42
43	/** The application roles the user is assigned to. */
44	public ?SimpleListWrapperApplicationRole $applicationRoles = null,
45
46	/** The avatars of the user. */
47	public ?AvatarUrlsBean $avatarUrls = null,
48
49	/**
50	* The display name of the user.
51	* Depending on the user’s privacy setting, this may return an alternative value.
52	*/
53	public ?string $displayName = null,
54
55	/**
56	* The email address of the user.
57	* Depending on the user’s privacy setting, this may be returned as null.
58	*/
59	public ?string $emailAddress = null,
60
61	/** Expand options that include additional user details in the response. */
62	public ?string $expand = null,
63
64	/** The groups that the user belongs to. */
65	public ?SimpleListWrapperGroupName $groups = null,
66
67	/**
68	* This property is no longer available and will be removed from the documentation soon.
69	* See the "deprecation notice" for details.
70	*
71	* @link https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/
72	*/
73	public ?string $key = null,
74
75	/**
76	* The locale of the user.
77	* Depending on the user’s privacy setting, this may be returned as null.
78	*/
79	public ?string $locale = null,
80
81	/**
82	* This property is no longer available and will be removed from the documentation soon.
83	* See the "deprecation notice" for details.
84	*
85	* @link https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/
86	*/
87	public ?string $name = null,
88
89	/** The URL of the user. */
90	public ?string $self = null,
91
92	/**
93	* The time zone specified in the user's profile.
94	* If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.
95	*/
96	public ?string $timeZone = null,
97	) {
98	}	×
99	}

tylernathanreed / jira-client-php / 13634794100

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