@@ -63,7 +63,18 @@ def list_org_campaigns(
63
63
sort : Missing [Literal ["created" , "updated" , "ends_at" , "published" ]] = UNSET ,
64
64
headers : Optional [Mapping [str , str ]] = None ,
65
65
) -> Response [list [CampaignSummary ], list [CampaignSummaryType ]]:
66
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization"""
66
+ """campaigns/list-org-campaigns
67
+
68
+ GET /orgs/{org}/campaigns
69
+
70
+ Lists campaigns in an organization.
71
+
72
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
73
+
74
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
75
+
76
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization
77
+ """
67
78
68
79
from ..models import (
69
80
BasicError ,
@@ -106,7 +117,18 @@ async def async_list_org_campaigns(
106
117
sort : Missing [Literal ["created" , "updated" , "ends_at" , "published" ]] = UNSET ,
107
118
headers : Optional [Mapping [str , str ]] = None ,
108
119
) -> Response [list [CampaignSummary ], list [CampaignSummaryType ]]:
109
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization"""
120
+ """campaigns/list-org-campaigns
121
+
122
+ GET /orgs/{org}/campaigns
123
+
124
+ Lists campaigns in an organization.
125
+
126
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
127
+
128
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
129
+
130
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#list-campaigns-for-an-organization
131
+ """
110
132
111
133
from ..models import (
112
134
BasicError ,
@@ -174,7 +196,21 @@ def create_campaign(
174
196
data : Missing [OrgsOrgCampaignsPostBodyType ] = UNSET ,
175
197
** kwargs ,
176
198
) -> Response [CampaignSummary , CampaignSummaryType ]:
177
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization"""
199
+ """campaigns/create-campaign
200
+
201
+ POST /orgs/{org}/campaigns
202
+
203
+ Create a campaign for an organization.
204
+
205
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
206
+
207
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
208
+
209
+ Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
210
+ in the campaign.
211
+
212
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization
213
+ """
178
214
179
215
from ..models import (
180
216
BasicError ,
@@ -246,7 +282,21 @@ async def async_create_campaign(
246
282
data : Missing [OrgsOrgCampaignsPostBodyType ] = UNSET ,
247
283
** kwargs ,
248
284
) -> Response [CampaignSummary , CampaignSummaryType ]:
249
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization"""
285
+ """campaigns/create-campaign
286
+
287
+ POST /orgs/{org}/campaigns
288
+
289
+ Create a campaign for an organization.
290
+
291
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
292
+
293
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
294
+
295
+ Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included
296
+ in the campaign.
297
+
298
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#create-a-campaign-for-an-organization
299
+ """
250
300
251
301
from ..models import (
252
302
BasicError ,
@@ -289,7 +339,18 @@ def get_campaign_summary(
289
339
* ,
290
340
headers : Optional [Mapping [str , str ]] = None ,
291
341
) -> Response [CampaignSummary , CampaignSummaryType ]:
292
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization"""
342
+ """campaigns/get-campaign-summary
343
+
344
+ GET /orgs/{org}/campaigns/{campaign_number}
345
+
346
+ Gets a campaign for an organization.
347
+
348
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
349
+
350
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
351
+
352
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization
353
+ """
293
354
294
355
from ..models import (
295
356
BasicError ,
@@ -320,7 +381,18 @@ async def async_get_campaign_summary(
320
381
* ,
321
382
headers : Optional [Mapping [str , str ]] = None ,
322
383
) -> Response [CampaignSummary , CampaignSummaryType ]:
323
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization"""
384
+ """campaigns/get-campaign-summary
385
+
386
+ GET /orgs/{org}/campaigns/{campaign_number}
387
+
388
+ Gets a campaign for an organization.
389
+
390
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
391
+
392
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
393
+
394
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#get-a-campaign-for-an-organization
395
+ """
324
396
325
397
from ..models import (
326
398
BasicError ,
@@ -351,7 +423,18 @@ def delete_campaign(
351
423
* ,
352
424
headers : Optional [Mapping [str , str ]] = None ,
353
425
) -> Response :
354
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization"""
426
+ """campaigns/delete-campaign
427
+
428
+ DELETE /orgs/{org}/campaigns/{campaign_number}
429
+
430
+ Deletes a campaign in an organization.
431
+
432
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
433
+
434
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
435
+
436
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization
437
+ """
355
438
356
439
from ..models import (
357
440
BasicError ,
@@ -379,7 +462,18 @@ async def async_delete_campaign(
379
462
* ,
380
463
headers : Optional [Mapping [str , str ]] = None ,
381
464
) -> Response :
382
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization"""
465
+ """campaigns/delete-campaign
466
+
467
+ DELETE /orgs/{org}/campaigns/{campaign_number}
468
+
469
+ Deletes a campaign in an organization.
470
+
471
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
472
+
473
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
474
+
475
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#delete-a-campaign-for-an-organization
476
+ """
383
477
384
478
from ..models import (
385
479
BasicError ,
@@ -436,7 +530,18 @@ def update_campaign(
436
530
data : Missing [OrgsOrgCampaignsCampaignNumberPatchBodyType ] = UNSET ,
437
531
** kwargs ,
438
532
) -> Response [CampaignSummary , CampaignSummaryType ]:
439
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign"""
533
+ """campaigns/update-campaign
534
+
535
+ PATCH /orgs/{org}/campaigns/{campaign_number}
536
+
537
+ Updates a campaign in an organization.
538
+
539
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
540
+
541
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
542
+
543
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign
544
+ """
440
545
441
546
from ..models import (
442
547
BasicError ,
@@ -508,7 +613,18 @@ async def async_update_campaign(
508
613
data : Missing [OrgsOrgCampaignsCampaignNumberPatchBodyType ] = UNSET ,
509
614
** kwargs ,
510
615
) -> Response [CampaignSummary , CampaignSummaryType ]:
511
- """See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign"""
616
+ """campaigns/update-campaign
617
+
618
+ PATCH /orgs/{org}/campaigns/{campaign_number}
619
+
620
+ Updates a campaign in an organization.
621
+
622
+ The authenticated user must be an owner or security manager for the organization to use this endpoint.
623
+
624
+ OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint.
625
+
626
+ See also: https://docs.github.com/enterprise-cloud@latest//rest/campaigns/campaigns#update-a-campaign
627
+ """
512
628
513
629
from ..models import (
514
630
BasicError ,
0 commit comments