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/Operations/IssueCustomFieldValuesApps.php

<?php

namespace Jira\Client\Operations;

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

/** @phpstan-require-extends Client */
trait IssueCustomFieldValuesApps
{
    /**
     * Updates the value of one or more custom fields on one or more issues.
     * Combinations of custom field and issue should be unique within the request
     * 
     * Apps can only perform this operation on "custom fields" and "custom field types" declared in their own manifests
     * 
     * **"Permissions" required:** Only the app that owns the custom field or custom field type can update its values with this operation
     * 
     * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app.
     * However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
     * 
     * @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/
     * @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/
     * 
     * @param bool $generateChangelog Whether to generate a changelog for this update.
     */
    public function updateMultipleCustomFieldValues(
        Schema\MultipleCustomFieldValuesUpdateDetails $request,
        ?bool $generateChangelog = true,
    ): true {
        return $this->call(
            uri: '/rest/api/3/app/field/value',
            method: 'post',
            body: $request,
            query: compact('generateChangelog'),
            success: 204,
            schema: true,
        );
    }

    /**
     * Updates the value of a custom field on one or more issues
     * 
     * Apps can only perform this operation on "custom fields" and "custom field types" declared in their own manifests
     * 
     * **"Permissions" required:** Only the app that owns the custom field or custom field type can update its values with this operation
     * 
     * The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app.
     * However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
     * 
     * @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/
     * @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/
     * 
     * @param string $fieldIdOrKey The ID or key of the custom field.
     *                             For example, `customfield_10010`.
     * @param bool $generateChangelog Whether to generate a changelog for this update.
     */
    public function updateCustomFieldValue(
        Schema\CustomFieldValueUpdateDetails $request,
        string $fieldIdOrKey,
        ?bool $generateChangelog = true,
    ): true {
        return $this->call(
            uri: '/rest/api/3/app/field/{fieldIdOrKey}/value',
            method: 'put',
            body: $request,
            query: compact('generateChangelog'),
            path: compact('fieldIdOrKey'),
            success: 204,
            schema: true,
        );
    }
}

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 IssueCustomFieldValuesApps
10	{
11	/**
12	* Updates the value of one or more custom fields on one or more issues.
13	* Combinations of custom field and issue should be unique within the request
14	*
15	* Apps can only perform this operation on "custom fields" and "custom field types" declared in their own manifests
16	*
17	* "Permissions" required: Only the app that owns the custom field or custom field type can update its values with this operation
18	*
19	* The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app.
20	* However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
21	*
22	* @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/
23	* @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/
24	*
25	* @param bool $generateChangelog Whether to generate a changelog for this update.
26	*/
27	public function updateMultipleCustomFieldValues(	×
28	Schema\MultipleCustomFieldValuesUpdateDetails $request,
29	?bool $generateChangelog = true,
30	): true {
31	return $this->call(	×
32	uri: '/rest/api/3/app/field/value',	×
33	method: 'post',	×
34	body: $request,	×
35	query: compact('generateChangelog'),	×
36	success: 204,	×
37	schema: true,	×
38	);	×
39	}
40
41	/**
42	* Updates the value of a custom field on one or more issues
43	*
44	* Apps can only perform this operation on "custom fields" and "custom field types" declared in their own manifests
45	*
46	* "Permissions" required: Only the app that owns the custom field or custom field type can update its values with this operation
47	*
48	* The new `write:app-data:jira` OAuth scope is 100% optional now, and not using it won't break your app.
49	* However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
50	*
51	* @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/
52	* @link https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/
53	*
54	* @param string $fieldIdOrKey The ID or key of the custom field.
55	* For example, `customfield_10010`.
56	* @param bool $generateChangelog Whether to generate a changelog for this update.
57	*/
58	public function updateCustomFieldValue(	×
59	Schema\CustomFieldValueUpdateDetails $request,
60	string $fieldIdOrKey,
61	?bool $generateChangelog = true,
62	): true {
63	return $this->call(	×
64	uri: '/rest/api/3/app/field/{fieldIdOrKey}/value',	×
65	method: 'put',	×
66	body: $request,	×
67	query: compact('generateChangelog'),	×
68	path: compact('fieldIdOrKey'),	×
69	success: 204,	×
70	schema: true,	×
71	);	×
72	}
73	}

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