-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathscm_integrations.py
More file actions
854 lines (695 loc) · 32.1 KB
/
scm_integrations.py
File metadata and controls
854 lines (695 loc) · 32.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Optional
import httpx
from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from ...._utils import maybe_transform, async_maybe_transform
from ...._compat import cached_property
from ...._resource import SyncAPIResource, AsyncAPIResource
from ...._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from ....pagination import SyncIntegrationsPage, AsyncIntegrationsPage
from ...._base_client import AsyncPaginator, make_request_options
from ....types.runners.configurations import (
scm_integration_list_params,
scm_integration_create_params,
scm_integration_delete_params,
scm_integration_update_params,
scm_integration_retrieve_params,
)
from ....types.runners.configurations.scm_integration import ScmIntegration
from ....types.runners.configurations.scm_integration_create_response import ScmIntegrationCreateResponse
from ....types.runners.configurations.scm_integration_retrieve_response import ScmIntegrationRetrieveResponse
__all__ = ["ScmIntegrationsResource", "AsyncScmIntegrationsResource"]
class ScmIntegrationsResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> ScmIntegrationsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return ScmIntegrationsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> ScmIntegrationsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return ScmIntegrationsResourceWithStreamingResponse(self)
def create(
self,
*,
host: str | Omit = omit,
issuer_url: Optional[str] | Omit = omit,
oauth_client_id: Optional[str] | Omit = omit,
oauth_plaintext_client_secret: Optional[str] | Omit = omit,
pat: bool | Omit = omit,
runner_id: str | Omit = omit,
scm_id: str | Omit = omit,
virtual_directory: Optional[str] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> ScmIntegrationCreateResponse:
"""
Creates a new SCM integration for a runner.
Use this method to:
- Configure source control access
- Set up repository integrations
- Enable code synchronization
### Examples
- Create GitHub integration:
Sets up GitHub SCM integration.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmId: "github"
host: "github.com"
oauthClientId: "client_id"
oauthPlaintextClientSecret: "client_secret"
```
Args:
issuer_url: issuer_url can be set to override the authentication provider URL, if it doesn't
match the SCM host.
oauth_client_id: oauth_client_id is the OAuth app's client ID, if OAuth is configured. If
configured, oauth_plaintext_client_secret must also be set.
oauth_plaintext_client_secret: oauth_plaintext_client_secret is the OAuth app's client secret in clear text.
This will first be encrypted with the runner's public key before being stored.
scm_id: scm_id references the scm_id in the runner's configuration schema that this
integration is for
virtual_directory: virtual_directory is the virtual directory path for Azure DevOps Server (e.g.,
"/tfs"). This field is only used for Azure DevOps Server SCM integrations and
should be empty for other SCM types. Azure DevOps Server APIs work without
collection when PAT scope is 'All accessible organizations'.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration",
body=maybe_transform(
{
"host": host,
"issuer_url": issuer_url,
"oauth_client_id": oauth_client_id,
"oauth_plaintext_client_secret": oauth_plaintext_client_secret,
"pat": pat,
"runner_id": runner_id,
"scm_id": scm_id,
"virtual_directory": virtual_directory,
},
scm_integration_create_params.ScmIntegrationCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ScmIntegrationCreateResponse,
)
def retrieve(
self,
*,
id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> ScmIntegrationRetrieveResponse:
"""
Gets details about a specific SCM integration.
Use this method to:
- View integration settings
- Check integration status
- Verify configuration
### Examples
- Get integration details:
Retrieves information about a specific integration.
```yaml
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerConfigurationService/GetSCMIntegration",
body=maybe_transform({"id": id}, scm_integration_retrieve_params.ScmIntegrationRetrieveParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ScmIntegrationRetrieveResponse,
)
def update(
self,
*,
id: str | Omit = omit,
issuer_url: Optional[str] | Omit = omit,
oauth_client_id: Optional[str] | Omit = omit,
oauth_plaintext_client_secret: Optional[str] | Omit = omit,
pat: Optional[bool] | Omit = omit,
virtual_directory: Optional[str] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> object:
"""
Updates an existing SCM integration.
Use this method to:
- Modify integration settings
- Update credentials
- Change configuration
### Examples
- Update integration:
Updates OAuth credentials.
```yaml
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
oauthClientId: "new_client_id"
oauthPlaintextClientSecret: "new_client_secret"
```
Args:
issuer_url: issuer_url can be set to override the authentication provider URL, if it doesn't
match the SCM host.
oauth_client_id: oauth_client_id can be set to update the OAuth app's client ID. If an empty
string is set, the OAuth configuration will be removed (regardless of whether a
client secret is set), and any existing Host Authentication Tokens for the SCM
integration's runner and host that were created using the OAuth app will be
deleted. This might lead to users being unable to access their repositories
until they re-authenticate.
oauth_plaintext_client_secret: oauth_plaintext_client_secret can be set to update the OAuth app's client
secret. The cleartext secret will be encrypted with the runner's public key
before being stored.
pat: pat can be set to enable or disable Personal Access Tokens support. When
disabling PATs, any existing Host Authentication Tokens for the SCM
integration's runner and host that were created using a PAT will be deleted.
This might lead to users being unable to access their repositories until they
re-authenticate.
virtual_directory: virtual_directory is the virtual directory path for Azure DevOps Server (e.g.,
"/tfs"). This field is only used for Azure DevOps Server SCM integrations and
should be empty for other SCM types. Azure DevOps Server APIs work without
collection when PAT scope is 'All accessible organizations'.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration",
body=maybe_transform(
{
"id": id,
"issuer_url": issuer_url,
"oauth_client_id": oauth_client_id,
"oauth_plaintext_client_secret": oauth_plaintext_client_secret,
"pat": pat,
"virtual_directory": virtual_directory,
},
scm_integration_update_params.ScmIntegrationUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=object,
)
def list(
self,
*,
token: str | Omit = omit,
page_size: int | Omit = omit,
filter: scm_integration_list_params.Filter | Omit = omit,
pagination: scm_integration_list_params.Pagination | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> SyncIntegrationsPage[ScmIntegration]:
"""
Lists SCM integrations for a runner.
Use this method to:
- View all integrations
- Monitor integration status
- Check available SCMs
### Examples
- List integrations:
Shows all SCM integrations.
```yaml
filter:
runnerIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
pagination:
pageSize: 20
```
Args:
pagination: pagination contains the pagination options for listing scm integrations
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/gitpod.v1.RunnerConfigurationService/ListSCMIntegrations",
page=SyncIntegrationsPage[ScmIntegration],
body=maybe_transform(
{
"filter": filter,
"pagination": pagination,
},
scm_integration_list_params.ScmIntegrationListParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"token": token,
"page_size": page_size,
},
scm_integration_list_params.ScmIntegrationListParams,
),
),
model=ScmIntegration,
method="post",
)
def delete(
self,
*,
id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> object:
"""
Deletes an SCM integration.
Use this method to:
- Remove unused integrations
- Clean up configurations
- Revoke SCM access
### Examples
- Delete integration:
Removes an SCM integration.
```yaml
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._post(
"/gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration",
body=maybe_transform({"id": id}, scm_integration_delete_params.ScmIntegrationDeleteParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=object,
)
class AsyncScmIntegrationsResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncScmIntegrationsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#accessing-raw-response-data-eg-headers
"""
return AsyncScmIntegrationsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncScmIntegrationsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/gitpod-io/gitpod-sdk-python#with_streaming_response
"""
return AsyncScmIntegrationsResourceWithStreamingResponse(self)
async def create(
self,
*,
host: str | Omit = omit,
issuer_url: Optional[str] | Omit = omit,
oauth_client_id: Optional[str] | Omit = omit,
oauth_plaintext_client_secret: Optional[str] | Omit = omit,
pat: bool | Omit = omit,
runner_id: str | Omit = omit,
scm_id: str | Omit = omit,
virtual_directory: Optional[str] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> ScmIntegrationCreateResponse:
"""
Creates a new SCM integration for a runner.
Use this method to:
- Configure source control access
- Set up repository integrations
- Enable code synchronization
### Examples
- Create GitHub integration:
Sets up GitHub SCM integration.
```yaml
runnerId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
scmId: "github"
host: "github.com"
oauthClientId: "client_id"
oauthPlaintextClientSecret: "client_secret"
```
Args:
issuer_url: issuer_url can be set to override the authentication provider URL, if it doesn't
match the SCM host.
oauth_client_id: oauth_client_id is the OAuth app's client ID, if OAuth is configured. If
configured, oauth_plaintext_client_secret must also be set.
oauth_plaintext_client_secret: oauth_plaintext_client_secret is the OAuth app's client secret in clear text.
This will first be encrypted with the runner's public key before being stored.
scm_id: scm_id references the scm_id in the runner's configuration schema that this
integration is for
virtual_directory: virtual_directory is the virtual directory path for Azure DevOps Server (e.g.,
"/tfs"). This field is only used for Azure DevOps Server SCM integrations and
should be empty for other SCM types. Azure DevOps Server APIs work without
collection when PAT scope is 'All accessible organizations'.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/gitpod.v1.RunnerConfigurationService/CreateSCMIntegration",
body=await async_maybe_transform(
{
"host": host,
"issuer_url": issuer_url,
"oauth_client_id": oauth_client_id,
"oauth_plaintext_client_secret": oauth_plaintext_client_secret,
"pat": pat,
"runner_id": runner_id,
"scm_id": scm_id,
"virtual_directory": virtual_directory,
},
scm_integration_create_params.ScmIntegrationCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ScmIntegrationCreateResponse,
)
async def retrieve(
self,
*,
id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> ScmIntegrationRetrieveResponse:
"""
Gets details about a specific SCM integration.
Use this method to:
- View integration settings
- Check integration status
- Verify configuration
### Examples
- Get integration details:
Retrieves information about a specific integration.
```yaml
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/gitpod.v1.RunnerConfigurationService/GetSCMIntegration",
body=await async_maybe_transform({"id": id}, scm_integration_retrieve_params.ScmIntegrationRetrieveParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ScmIntegrationRetrieveResponse,
)
async def update(
self,
*,
id: str | Omit = omit,
issuer_url: Optional[str] | Omit = omit,
oauth_client_id: Optional[str] | Omit = omit,
oauth_plaintext_client_secret: Optional[str] | Omit = omit,
pat: Optional[bool] | Omit = omit,
virtual_directory: Optional[str] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> object:
"""
Updates an existing SCM integration.
Use this method to:
- Modify integration settings
- Update credentials
- Change configuration
### Examples
- Update integration:
Updates OAuth credentials.
```yaml
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
oauthClientId: "new_client_id"
oauthPlaintextClientSecret: "new_client_secret"
```
Args:
issuer_url: issuer_url can be set to override the authentication provider URL, if it doesn't
match the SCM host.
oauth_client_id: oauth_client_id can be set to update the OAuth app's client ID. If an empty
string is set, the OAuth configuration will be removed (regardless of whether a
client secret is set), and any existing Host Authentication Tokens for the SCM
integration's runner and host that were created using the OAuth app will be
deleted. This might lead to users being unable to access their repositories
until they re-authenticate.
oauth_plaintext_client_secret: oauth_plaintext_client_secret can be set to update the OAuth app's client
secret. The cleartext secret will be encrypted with the runner's public key
before being stored.
pat: pat can be set to enable or disable Personal Access Tokens support. When
disabling PATs, any existing Host Authentication Tokens for the SCM
integration's runner and host that were created using a PAT will be deleted.
This might lead to users being unable to access their repositories until they
re-authenticate.
virtual_directory: virtual_directory is the virtual directory path for Azure DevOps Server (e.g.,
"/tfs"). This field is only used for Azure DevOps Server SCM integrations and
should be empty for other SCM types. Azure DevOps Server APIs work without
collection when PAT scope is 'All accessible organizations'.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/gitpod.v1.RunnerConfigurationService/UpdateSCMIntegration",
body=await async_maybe_transform(
{
"id": id,
"issuer_url": issuer_url,
"oauth_client_id": oauth_client_id,
"oauth_plaintext_client_secret": oauth_plaintext_client_secret,
"pat": pat,
"virtual_directory": virtual_directory,
},
scm_integration_update_params.ScmIntegrationUpdateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=object,
)
def list(
self,
*,
token: str | Omit = omit,
page_size: int | Omit = omit,
filter: scm_integration_list_params.Filter | Omit = omit,
pagination: scm_integration_list_params.Pagination | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> AsyncPaginator[ScmIntegration, AsyncIntegrationsPage[ScmIntegration]]:
"""
Lists SCM integrations for a runner.
Use this method to:
- View all integrations
- Monitor integration status
- Check available SCMs
### Examples
- List integrations:
Shows all SCM integrations.
```yaml
filter:
runnerIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
pagination:
pageSize: 20
```
Args:
pagination: pagination contains the pagination options for listing scm integrations
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get_api_list(
"/gitpod.v1.RunnerConfigurationService/ListSCMIntegrations",
page=AsyncIntegrationsPage[ScmIntegration],
body=maybe_transform(
{
"filter": filter,
"pagination": pagination,
},
scm_integration_list_params.ScmIntegrationListParams,
),
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"token": token,
"page_size": page_size,
},
scm_integration_list_params.ScmIntegrationListParams,
),
),
model=ScmIntegration,
method="post",
)
async def delete(
self,
*,
id: str | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> object:
"""
Deletes an SCM integration.
Use this method to:
- Remove unused integrations
- Clean up configurations
- Revoke SCM access
### Examples
- Delete integration:
Removes an SCM integration.
```yaml
id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return await self._post(
"/gitpod.v1.RunnerConfigurationService/DeleteSCMIntegration",
body=await async_maybe_transform({"id": id}, scm_integration_delete_params.ScmIntegrationDeleteParams),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=object,
)
class ScmIntegrationsResourceWithRawResponse:
def __init__(self, scm_integrations: ScmIntegrationsResource) -> None:
self._scm_integrations = scm_integrations
self.create = to_raw_response_wrapper(
scm_integrations.create,
)
self.retrieve = to_raw_response_wrapper(
scm_integrations.retrieve,
)
self.update = to_raw_response_wrapper(
scm_integrations.update,
)
self.list = to_raw_response_wrapper(
scm_integrations.list,
)
self.delete = to_raw_response_wrapper(
scm_integrations.delete,
)
class AsyncScmIntegrationsResourceWithRawResponse:
def __init__(self, scm_integrations: AsyncScmIntegrationsResource) -> None:
self._scm_integrations = scm_integrations
self.create = async_to_raw_response_wrapper(
scm_integrations.create,
)
self.retrieve = async_to_raw_response_wrapper(
scm_integrations.retrieve,
)
self.update = async_to_raw_response_wrapper(
scm_integrations.update,
)
self.list = async_to_raw_response_wrapper(
scm_integrations.list,
)
self.delete = async_to_raw_response_wrapper(
scm_integrations.delete,
)
class ScmIntegrationsResourceWithStreamingResponse:
def __init__(self, scm_integrations: ScmIntegrationsResource) -> None:
self._scm_integrations = scm_integrations
self.create = to_streamed_response_wrapper(
scm_integrations.create,
)
self.retrieve = to_streamed_response_wrapper(
scm_integrations.retrieve,
)
self.update = to_streamed_response_wrapper(
scm_integrations.update,
)
self.list = to_streamed_response_wrapper(
scm_integrations.list,
)
self.delete = to_streamed_response_wrapper(
scm_integrations.delete,
)
class AsyncScmIntegrationsResourceWithStreamingResponse:
def __init__(self, scm_integrations: AsyncScmIntegrationsResource) -> None:
self._scm_integrations = scm_integrations
self.create = async_to_streamed_response_wrapper(
scm_integrations.create,
)
self.retrieve = async_to_streamed_response_wrapper(
scm_integrations.retrieve,
)
self.update = async_to_streamed_response_wrapper(
scm_integrations.update,
)
self.list = async_to_streamed_response_wrapper(
scm_integrations.list,
)
self.delete = async_to_streamed_response_wrapper(
scm_integrations.delete,
)