Skip to content

Commit b8476a6

Browse files
pkolmannpkolmann
committed
Add MS Teams and Jira Integrations APIs
1 parent 362450f commit b8476a6

File tree

5 files changed

+550
-0
lines changed

5 files changed

+550
-0
lines changed

‎src/Api/Integrations.php

+331
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,331 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/*
6+
* This file is part of the Gitlab API library.
7+
*
8+
* (c) Matt Humphrey <matth@windsor-telecom.co.uk>
9+
* (c) Graham Campbell <hello@gjcampbell.co.uk>
10+
*
11+
* For the full copyright and license information, please view the LICENSE
12+
* file that was distributed with this source code.
13+
*/
14+
15+
namespace Gitlab\Api;
16+
17+
use Symfony\Component\OptionsResolver\Options;
18+
use Symfony\Component\OptionsResolver\OptionsResolver;
19+
20+
class Integrations extends AbstractApi
21+
{
22+
/**
23+
* @param int|string $project_id
24+
*
25+
* @return mixed
26+
*/
27+
public function all(int|string $project_id): mixed
28+
{
29+
$path = $this->getProjectPath($project_id, 'integrations');
30+
31+
return $this->get($path);
32+
}
33+
34+
// Microsoft Teams
35+
36+
/**
37+
* Create Microsoft Teams integration
38+
* Set Microsoft Teams integration for a project.
39+
*
40+
* @param int|string $project_id
41+
* @param array $params {
42+
*
43+
* @return mixed
44+
*@var string $webhook The Microsoft Teams webhook
45+
* @var bool $notify_only_broken_pipelines Send notifications for broken pipelines
46+
* @var string $branches_to_be_notified Branches to send notifications for. Valid options are all, default,
47+
* protected, and default_and_protected. The default value is "default"
48+
* @var bool $push_events Enable notifications for push events
49+
* @var bool $issues_events Enable notifications for issue events
50+
* @var bool $confidential_issues_events Enable notifications for confidential issue events
51+
* @var bool $merge_requests_events Enable notifications for merge request events
52+
* @var bool $tag_push_events Enable notifications for tag push events
53+
* @var bool $note_events Enable notifications for note events
54+
* @var bool $confidential_note_events Enable notifications for confidential note events
55+
* @var bool $pipeline_events Enable notifications for pipeline events
56+
* @var bool $wiki_page_events Enable notifications for wiki page events
57+
* }
58+
*
59+
*/
60+
public function createMicrosoftTeams(int|string $project_id, array $params = []): mixed
61+
{
62+
$resolver = new OptionsResolver();
63+
$booleanNormalizer = function (Options $resolver, $value): string {
64+
return $value ? 'true' : 'false';
65+
};
66+
67+
$resolver->setDefined('webhook')
68+
->setAllowedTypes('webhook', 'string')
69+
->setRequired('webhook')
70+
;
71+
$resolver->setDefined('notify_only_broken_pipelines')
72+
->setAllowedTypes('notify_only_broken_pipelines', 'bool')
73+
->setNormalizer('notify_only_broken_pipelines', $booleanNormalizer)
74+
;
75+
$resolver->setDefined('branches_to_be_notified')
76+
->setAllowedTypes('branches_to_be_notified', 'string')
77+
->setAllowedValues('branches_to_be_notified', ['all', 'default', 'protected', 'default_and_protected'])
78+
;
79+
$resolver->setDefined('push_events')
80+
->setAllowedTypes('push_events', 'bool')
81+
->setNormalizer('push_events', $booleanNormalizer)
82+
;
83+
$resolver->setDefined('issues_events')
84+
->setAllowedTypes('issues_events', 'bool')
85+
->setNormalizer('issues_events', $booleanNormalizer)
86+
;
87+
$resolver->setDefined('confidential_issues_events')
88+
->setAllowedTypes('confidential_issues_events', 'bool')
89+
->setNormalizer('confidential_issues_events', $booleanNormalizer)
90+
;
91+
$resolver->setDefined('merge_requests_events')
92+
->setAllowedTypes('merge_requests_events', 'bool')
93+
->setNormalizer('merge_requests_events', $booleanNormalizer)
94+
;
95+
$resolver->setDefined('tag_push_events')
96+
->setAllowedTypes('tag_push_events', 'bool')
97+
->setNormalizer('tag_push_events', $booleanNormalizer)
98+
;
99+
$resolver->setDefined('note_events')
100+
->setAllowedTypes('note_events', 'bool')
101+
->setNormalizer('note_events', $booleanNormalizer)
102+
;
103+
$resolver->setDefined('confidential_note_events')
104+
->setAllowedTypes('confidential_note_events', 'bool')
105+
->setNormalizer('confidential_note_events', $booleanNormalizer)
106+
;
107+
$resolver->setDefined('pipeline_events')
108+
->setAllowedTypes('pipeline_events', 'bool')
109+
->setNormalizer('pipeline_events', $booleanNormalizer)
110+
;
111+
$resolver->setDefined('wiki_page_events')
112+
->setAllowedTypes('wiki_page_events', 'bool')
113+
->setNormalizer('wiki_page_events', $booleanNormalizer)
114+
;
115+
116+
return $this->put($this->getProjectPath($project_id, 'integrations/microsoft-teams'), $resolver->resolve($params));
117+
}
118+
119+
/**
120+
* Update Microsoft Teams integration
121+
* Set Microsoft Teams integration for a project.
122+
*
123+
* @param int|string $project_id
124+
* @param array $params {
125+
*
126+
* @return mixed
127+
*@var string $webhook The Microsoft Teams webhook
128+
* @var bool $notify_only_broken_pipelines Send notifications for broken pipelines
129+
* @var string $branches_to_be_notified Branches to send notifications for. Valid options are all, default,
130+
* protected, and default_and_protected. The default value is "default"
131+
* @var bool $push_events Enable notifications for push events
132+
* @var bool $issues_events Enable notifications for issue events
133+
* @var bool $confidential_issues_events Enable notifications for confidential issue events
134+
* @var bool $merge_requests_events Enable notifications for merge request events
135+
* @var bool $tag_push_events Enable notifications for tag push events
136+
* @var bool $note_events Enable notifications for note events
137+
* @var bool $confidential_note_events Enable notifications for confidential note events
138+
* @var bool $pipeline_events Enable notifications for pipeline events
139+
* @var bool $wiki_page_events Enable notifications for wiki page events
140+
* }
141+
*
142+
*/
143+
public function updateMicrosoftTeams(int|string $project_id, array $params = []): mixed
144+
{
145+
return $this->createMicrosoftTeams($project_id, $params);
146+
}
147+
148+
/**
149+
* Get Microsoft Teams integration settings for a project.
150+
*
151+
* @param int|string $project_id
152+
*
153+
* @return mixed
154+
*/
155+
public function getMicrosoftTeams(int|string $project_id): mixed
156+
{
157+
return $this->get($this->getProjectPath($project_id, 'integrations/microsoft-teams'));
158+
}
159+
160+
/**
161+
* Disable the Microsoft Teams integration for a project. Integration settings are reset.
162+
*
163+
* @param int|string $project_id
164+
*
165+
* @return mixed
166+
*/
167+
public function removeMicrosoftTeams(int|string $project_id): mixed
168+
{
169+
return $this->delete($this->getProjectPath($project_id, 'integrations/microsoft-teams'));
170+
}
171+
172+
// JIRA
173+
174+
/**
175+
* Create Jira integration
176+
* Set Jira integration for a project.
177+
*
178+
* @param int|string $project_id
179+
* @param array $params {
180+
*
181+
* @return mixed
182+
*@var string $url The URL to the Jira project which is being linked to this GitLab project
183+
* @var bool $api_url The base URL to the Jira instance API. Web URL value is used if not set
184+
* @var string $username The email or username to be used with Jira. For Jira Cloud use an email,
185+
* for Jira Data Center and Jira Server use a username. Required when using
186+
* Basic authentication (jira_auth_type is 0)
187+
* @var string $password The Jira API token, password, or personal access token to be used with
188+
* Jira. When your authentication method is Basic (jira_auth_type is 0) use
189+
* an API token for Jira Cloud, or a password for Jira Data Center or Jira
190+
* Server. When your authentication method is Jira personal access token
191+
* (jira_auth_type is 1) use a personal access token.
192+
* @var string $active Activates or deactivates the integration. Defaults to false (deactivated).
193+
* @var string $jira_auth_type The authentication method to be used with Jira. 0 means Basic
194+
* Authentication. 1 means Jira personal access token. Defaults to 0.
195+
* @var string $jira_issue_prefix Prefix to match Jira issue keys
196+
* @var string $jira_issue_regex Regular expression to match Jira issue keys
197+
* @var string $jira_issue_transition_automatic Enable automatic issue transitions. Takes precedence over
198+
* jira_issue_transition_id if enabled. Defaults to false
199+
* @var string $jira_issue_transition_id The ID of one or more transitions for custom issue
200+
* transitions. Ignored if jira_issue_transition_automatic is
201+
* enabled. Defaults to a blank string, which disables custom
202+
* transitions.
203+
* @var string $commit_events Enable notifications for commit events
204+
* @var string $merge_requests_events Enable notifications for merge request events
205+
* @var string $comment_on_event_enabled Enable comments inside Jira issues on each GitLab event
206+
* (commit / merge request)
207+
* }
208+
*
209+
*/
210+
public function createJira(int|string $project_id, array $params = []): mixed
211+
{
212+
$resolver = new OptionsResolver();
213+
$booleanNormalizer = function (Options $resolver, $value): string {
214+
return $value ? 'true' : 'false';
215+
};
216+
217+
$resolver->setDefined('url')
218+
->setAllowedTypes('url', 'string')
219+
->setRequired('url')
220+
;
221+
$resolver->setDefined('api_url')
222+
->setAllowedTypes('api_url', 'string')
223+
;
224+
$resolver->setDefined('username')
225+
->setAllowedTypes('username', 'string')
226+
;
227+
$resolver->setDefined('password')
228+
->setAllowedTypes('password', 'string')
229+
->setRequired('password')
230+
;
231+
$resolver->setDefined('active')
232+
->setAllowedTypes('active', 'bool')
233+
->setNormalizer('active', $booleanNormalizer)
234+
;
235+
$resolver->setDefined('jira_auth_type')
236+
->setAllowedTypes('jira_auth_type', 'int')
237+
;
238+
$resolver->setDefined('jira_issue_prefix')
239+
->setAllowedTypes('jira_issue_prefix', 'string')
240+
;
241+
$resolver->setDefined('jira_issue_regex')
242+
->setAllowedTypes('jira_issue_regex', 'string')
243+
;
244+
$resolver->setDefined('jira_issue_transition_automatic')
245+
->setAllowedTypes('jira_issue_transition_automatic', 'bool')
246+
->setNormalizer('jira_issue_transition_automatic', $booleanNormalizer)
247+
;
248+
$resolver->setDefined('jira_issue_transition_id')
249+
->setAllowedTypes('jira_issue_transition_id', 'string')
250+
;
251+
$resolver->setDefined('commit_events')
252+
->setAllowedTypes('commit_events', 'bool')
253+
->setNormalizer('commit_events', $booleanNormalizer)
254+
;
255+
$resolver->setDefined('merge_requests_events')
256+
->setAllowedTypes('merge_requests_events', 'bool')
257+
->setNormalizer('merge_requests_events', $booleanNormalizer)
258+
;
259+
$resolver->setDefined('comment_on_event_enabled')
260+
->setAllowedTypes('comment_on_event_enabled', 'bool')
261+
->setNormalizer('comment_on_event_enabled', $booleanNormalizer)
262+
;
263+
264+
return $this->put($this->getProjectPath($project_id, 'integrations/jira'), $resolver->resolve($params));
265+
}
266+
267+
/**
268+
* Update Jira integration
269+
* Set Jira integration for a project.
270+
*
271+
* @param int|string $project_id
272+
* @param array $params {
273+
*
274+
* @return mixed
275+
*@var string $url The URL to the Jira project which is being linked to this GitLab project
276+
* @var bool $api_url The base URL to the Jira instance API. Web URL value is used if not set
277+
* @var string $username The email or username to be used with Jira. For Jira Cloud use an email,
278+
* for Jira Data Center and Jira Server use a username. Required when using
279+
* Basic authentication (jira_auth_type is 0)
280+
* @var string $password The Jira API token, password, or personal access token to be used with
281+
* Jira. When your authentication method is Basic (jira_auth_type is 0) use
282+
* an API token for Jira Cloud, or a password for Jira Data Center or Jira
283+
* Server. When your authentication method is Jira personal access token
284+
* (jira_auth_type is 1) use a personal access token.
285+
* @var string $active Activates or deactivates the integration. Defaults to false (deactivated).
286+
* @var string $jira_auth_type The authentication method to be used with Jira. 0 means Basic
287+
* Authentication. 1 means Jira personal access token. Defaults to 0.
288+
* @var string $jira_issue_prefix Prefix to match Jira issue keys
289+
* @var string $jira_issue_regex Regular expression to match Jira issue keys
290+
* @var string $jira_issue_transition_automatic Enable automatic issue transitions. Takes precedence over
291+
* jira_issue_transition_id if enabled. Defaults to false
292+
* @var string $jira_issue_transition_id The ID of one or more transitions for custom issue
293+
* transitions. Ignored if jira_issue_transition_automatic is
294+
* enabled. Defaults to a blank string, which disables custom
295+
* transitions.
296+
* @var string $commit_events Enable notifications for commit events
297+
* @var string $merge_requests_events Enable notifications for merge request events
298+
* @var string $comment_on_event_enabled Enable comments inside Jira issues on each GitLab event
299+
* (commit / merge request)
300+
* }
301+
*
302+
*/
303+
public function updateJira(int|string $project_id, array $params = []): mixed
304+
{
305+
return $this->createJira($project_id, $params);
306+
}
307+
308+
/**
309+
* Get Jira integration settings for a project.
310+
*
311+
* @param int|string $project_id
312+
*
313+
* @return mixed
314+
*/
315+
public function getJira(int|string $project_id): mixed
316+
{
317+
return $this->get($this->getProjectPath($project_id, 'integrations/jira'));
318+
}
319+
320+
/**
321+
* Disable the Jira integration for a project. Integration settings are reset.
322+
*
323+
* @param int|string $project_id
324+
*
325+
* @return mixed
326+
*/
327+
public function removeJira(int|string $project_id): mixed
328+
{
329+
return $this->delete($this->getProjectPath($project_id, 'integrations/jira'));
330+
}
331+
}

‎src/Api/Projects.php

+10
Original file line numberDiff line numberDiff line change
@@ -1280,4 +1280,14 @@ public function search(int|string $id, array $parameters = []): mixed
12801280

12811281
return $this->get('projects/'.self::encodePath($id).'/search', $resolver->resolve($parameters));
12821282
}
1283+
1284+
/**
1285+
* @param int|string $project_id
1286+
*
1287+
* @return mixed
1288+
*/
1289+
public function integrations(int|string $project_id): mixed
1290+
{
1291+
return $this->get($this->getProjectPath($project_id, 'integrations'));
1292+
}
12831293
}

‎src/Client.php

+6
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
use Gitlab\Api\GroupsBoards;
2323
use Gitlab\Api\GroupsEpics;
2424
use Gitlab\Api\GroupsMilestones;
25+
use Gitlab\Api\Integrations;
2526
use Gitlab\Api\IssueBoards;
2627
use Gitlab\Api\IssueLinks;
2728
use Gitlab\Api\Issues;
@@ -295,6 +296,11 @@ public function wiki(): Wiki
295296
return new Wiki($this);
296297
}
297298

299+
public function integrations(): Integrations
300+
{
301+
return new Integrations($this);
302+
}
303+
298304
/**
299305
* Authenticate a user for all next requests.
300306
*

0 commit comments

Comments
 (0)