waldur-js-client 7.8.8-dev.7 → 7.8.8-dev.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/sdk.gen.js CHANGED
@@ -31,7 +31,8 @@ export const apiAuthKeycloakInitRetrieve = (options) => {
31
31
  });
32
32
  };
33
33
  /**
34
- * Logout from the system. If single logout is supported, returns logout URL.
34
+ * Log out
35
+ * Logs out the current user by deleting their authentication token. If single logout (SLO) is supported for the current authentication method (e.g., SAML2 or OIDC), this endpoint may return a logout URL to which the user should be redirected to complete the logout process on the identity provider side.
35
36
  */
36
37
  export const apiAuthLogout = (options) => {
37
38
  return (options?.client ?? _heyApiClient).post({
@@ -49,6 +50,10 @@ export const apiAuthLogout = (options) => {
49
50
  ...options
50
51
  });
51
52
  };
53
+ /**
54
+ * Obtain authentication token
55
+ * Authenticates a user with username and password and returns an authentication token.
56
+ */
52
57
  export const apiAuthPassword = (options) => {
53
58
  return (options.client ?? _heyApiClient).post({
54
59
  security: [
@@ -149,7 +154,8 @@ export const apiAuthTaraInitRetrieve = (options) => {
149
154
  });
150
155
  };
151
156
  /**
152
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
157
+ * List access subnets
158
+ * Retrieve a list of access subnets. Staff and support users can see all subnets, while other users can only see subnets associated with customers they have a role in.
153
159
  */
154
160
  export const accessSubnetsList = (options) => {
155
161
  return (options?.client ?? _heyApiClient).get({
@@ -168,6 +174,7 @@ export const accessSubnetsList = (options) => {
168
174
  });
169
175
  };
170
176
  /**
177
+ * List access subnets
171
178
  * Get number of items in the collection matching the request parameters.
172
179
  */
173
180
  export const accessSubnetsCount = (options) => {
@@ -186,6 +193,10 @@ export const accessSubnetsCount = (options) => {
186
193
  ...options
187
194
  });
188
195
  };
196
+ /**
197
+ * Create an access subnet
198
+ * Create a new access subnet for a customer.
199
+ */
189
200
  export const accessSubnetsCreate = (options) => {
190
201
  return (options.client ?? _heyApiClient).post({
191
202
  security: [
@@ -206,6 +217,10 @@ export const accessSubnetsCreate = (options) => {
206
217
  }
207
218
  });
208
219
  };
220
+ /**
221
+ * Delete an access subnet
222
+ * Delete an existing access subnet.
223
+ */
209
224
  export const accessSubnetsDestroy = (options) => {
210
225
  return (options.client ?? _heyApiClient).delete({
211
226
  security: [
@@ -222,6 +237,10 @@ export const accessSubnetsDestroy = (options) => {
222
237
  ...options
223
238
  });
224
239
  };
240
+ /**
241
+ * Retrieve access subnet
242
+ * Fetch the details of a specific access subnet by its UUID.
243
+ */
225
244
  export const accessSubnetsRetrieve = (options) => {
226
245
  return (options.client ?? _heyApiClient).get({
227
246
  security: [
@@ -238,6 +257,10 @@ export const accessSubnetsRetrieve = (options) => {
238
257
  ...options
239
258
  });
240
259
  };
260
+ /**
261
+ * Partially update an access subnet
262
+ * Partially update an existing access subnet.
263
+ */
241
264
  export const accessSubnetsPartialUpdate = (options) => {
242
265
  return (options.client ?? _heyApiClient).patch({
243
266
  security: [
@@ -258,6 +281,10 @@ export const accessSubnetsPartialUpdate = (options) => {
258
281
  }
259
282
  });
260
283
  };
284
+ /**
285
+ * Update an access subnet
286
+ * Update an existing access subnet.
287
+ */
261
288
  export const accessSubnetsUpdate = (options) => {
262
289
  return (options.client ?? _heyApiClient).put({
263
290
  security: [
@@ -278,9 +305,6 @@ export const accessSubnetsUpdate = (options) => {
278
305
  }
279
306
  });
280
307
  };
281
- /**
282
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
283
- */
284
308
  export const adminAnnouncementsList = (options) => {
285
309
  return (options?.client ?? _heyApiClient).get({
286
310
  security: [
@@ -408,9 +432,6 @@ export const adminAnnouncementsUpdate = (options) => {
408
432
  }
409
433
  });
410
434
  };
411
- /**
412
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
413
- */
414
435
  export const authTokensList = (options) => {
415
436
  return (options?.client ?? _heyApiClient).get({
416
437
  security: [
@@ -676,9 +697,6 @@ export const autoprovisioningRulesUpdate = (options) => {
676
697
  }
677
698
  });
678
699
  };
679
- /**
680
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
681
- */
682
700
  export const awsImagesList = (options) => {
683
701
  return (options?.client ?? _heyApiClient).get({
684
702
  security: [
@@ -730,9 +748,6 @@ export const awsImagesRetrieve = (options) => {
730
748
  ...options
731
749
  });
732
750
  };
733
- /**
734
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
735
- */
736
751
  export const awsInstancesList = (options) => {
737
752
  return (options?.client ?? _heyApiClient).get({
738
753
  security: [
@@ -860,6 +875,10 @@ export const awsInstancesUpdate = (options) => {
860
875
  }
861
876
  });
862
877
  };
878
+ /**
879
+ * Synchronize resource state
880
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
881
+ */
863
882
  export const awsInstancesPull = (options) => {
864
883
  return (options.client ?? _heyApiClient).post({
865
884
  security: [
@@ -945,6 +964,7 @@ export const awsInstancesStop = (options) => {
945
964
  });
946
965
  };
947
966
  /**
967
+ * Unlink resource
948
968
  * Delete resource from the database without scheduling operations on backend
949
969
  * and without checking current state of the resource. It is intended to be used
950
970
  * for removing resource stuck in transitioning state.
@@ -965,9 +985,6 @@ export const awsInstancesUnlink = (options) => {
965
985
  ...options
966
986
  });
967
987
  };
968
- /**
969
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
970
- */
971
988
  export const awsRegionsList = (options) => {
972
989
  return (options?.client ?? _heyApiClient).get({
973
990
  security: [
@@ -1019,9 +1036,6 @@ export const awsRegionsRetrieve = (options) => {
1019
1036
  ...options
1020
1037
  });
1021
1038
  };
1022
- /**
1023
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1024
- */
1025
1039
  export const awsSizesList = (options) => {
1026
1040
  return (options?.client ?? _heyApiClient).get({
1027
1041
  security: [
@@ -1073,9 +1087,6 @@ export const awsSizesRetrieve = (options) => {
1073
1087
  ...options
1074
1088
  });
1075
1089
  };
1076
- /**
1077
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1078
- */
1079
1090
  export const awsVolumesList = (options) => {
1080
1091
  return (options?.client ?? _heyApiClient).get({
1081
1092
  security: [
@@ -1235,6 +1246,10 @@ export const awsVolumesDetach = (options) => {
1235
1246
  ...options
1236
1247
  });
1237
1248
  };
1249
+ /**
1250
+ * Synchronize resource state
1251
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1252
+ */
1238
1253
  export const awsVolumesPull = (options) => {
1239
1254
  return (options.client ?? _heyApiClient).post({
1240
1255
  security: [
@@ -1252,6 +1267,7 @@ export const awsVolumesPull = (options) => {
1252
1267
  });
1253
1268
  };
1254
1269
  /**
1270
+ * Unlink resource
1255
1271
  * Delete resource from the database without scheduling operations on backend
1256
1272
  * and without checking current state of the resource. It is intended to be used
1257
1273
  * for removing resource stuck in transitioning state.
@@ -1272,9 +1288,6 @@ export const awsVolumesUnlink = (options) => {
1272
1288
  ...options
1273
1289
  });
1274
1290
  };
1275
- /**
1276
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1277
- */
1278
1291
  export const azureImagesList = (options) => {
1279
1292
  return (options?.client ?? _heyApiClient).get({
1280
1293
  security: [
@@ -1326,9 +1339,6 @@ export const azureImagesRetrieve = (options) => {
1326
1339
  ...options
1327
1340
  });
1328
1341
  };
1329
- /**
1330
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1331
- */
1332
1342
  export const azureLocationsList = (options) => {
1333
1343
  return (options?.client ?? _heyApiClient).get({
1334
1344
  security: [
@@ -1380,9 +1390,6 @@ export const azureLocationsRetrieve = (options) => {
1380
1390
  ...options
1381
1391
  });
1382
1392
  };
1383
- /**
1384
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1385
- */
1386
1393
  export const azurePublicIpsList = (options) => {
1387
1394
  return (options?.client ?? _heyApiClient).get({
1388
1395
  security: [
@@ -1510,6 +1517,10 @@ export const azurePublicIpsUpdate = (options) => {
1510
1517
  }
1511
1518
  });
1512
1519
  };
1520
+ /**
1521
+ * Synchronize resource state
1522
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1523
+ */
1513
1524
  export const azurePublicIpsPull = (options) => {
1514
1525
  return (options.client ?? _heyApiClient).post({
1515
1526
  security: [
@@ -1527,6 +1538,7 @@ export const azurePublicIpsPull = (options) => {
1527
1538
  });
1528
1539
  };
1529
1540
  /**
1541
+ * Unlink resource
1530
1542
  * Delete resource from the database without scheduling operations on backend
1531
1543
  * and without checking current state of the resource. It is intended to be used
1532
1544
  * for removing resource stuck in transitioning state.
@@ -1547,9 +1559,6 @@ export const azurePublicIpsUnlink = (options) => {
1547
1559
  ...options
1548
1560
  });
1549
1561
  };
1550
- /**
1551
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1552
- */
1553
1562
  export const azureResourceGroupsList = (options) => {
1554
1563
  return (options?.client ?? _heyApiClient).get({
1555
1564
  security: [
@@ -1601,9 +1610,6 @@ export const azureResourceGroupsRetrieve = (options) => {
1601
1610
  ...options
1602
1611
  });
1603
1612
  };
1604
- /**
1605
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1606
- */
1607
1613
  export const azureSizesList = (options) => {
1608
1614
  return (options?.client ?? _heyApiClient).get({
1609
1615
  security: [
@@ -1655,9 +1661,6 @@ export const azureSizesRetrieve = (options) => {
1655
1661
  ...options
1656
1662
  });
1657
1663
  };
1658
- /**
1659
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1660
- */
1661
1664
  export const azureSqlDatabasesList = (options) => {
1662
1665
  return (options?.client ?? _heyApiClient).get({
1663
1666
  security: [
@@ -1785,6 +1788,10 @@ export const azureSqlDatabasesUpdate = (options) => {
1785
1788
  }
1786
1789
  });
1787
1790
  };
1791
+ /**
1792
+ * Synchronize resource state
1793
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1794
+ */
1788
1795
  export const azureSqlDatabasesPull = (options) => {
1789
1796
  return (options.client ?? _heyApiClient).post({
1790
1797
  security: [
@@ -1802,6 +1809,7 @@ export const azureSqlDatabasesPull = (options) => {
1802
1809
  });
1803
1810
  };
1804
1811
  /**
1812
+ * Unlink resource
1805
1813
  * Delete resource from the database without scheduling operations on backend
1806
1814
  * and without checking current state of the resource. It is intended to be used
1807
1815
  * for removing resource stuck in transitioning state.
@@ -1822,9 +1830,6 @@ export const azureSqlDatabasesUnlink = (options) => {
1822
1830
  ...options
1823
1831
  });
1824
1832
  };
1825
- /**
1826
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
1827
- */
1828
1833
  export const azureSqlServersList = (options) => {
1829
1834
  return (options?.client ?? _heyApiClient).get({
1830
1835
  security: [
@@ -1972,6 +1977,10 @@ export const azureSqlServersCreateDatabase = (options) => {
1972
1977
  }
1973
1978
  });
1974
1979
  };
1980
+ /**
1981
+ * Synchronize resource state
1982
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
1983
+ */
1975
1984
  export const azureSqlServersPull = (options) => {
1976
1985
  return (options.client ?? _heyApiClient).post({
1977
1986
  security: [
@@ -1989,6 +1998,7 @@ export const azureSqlServersPull = (options) => {
1989
1998
  });
1990
1999
  };
1991
2000
  /**
2001
+ * Unlink resource
1992
2002
  * Delete resource from the database without scheduling operations on backend
1993
2003
  * and without checking current state of the resource. It is intended to be used
1994
2004
  * for removing resource stuck in transitioning state.
@@ -2009,9 +2019,6 @@ export const azureSqlServersUnlink = (options) => {
2009
2019
  ...options
2010
2020
  });
2011
2021
  };
2012
- /**
2013
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2014
- */
2015
2022
  export const azureVirtualmachinesList = (options) => {
2016
2023
  return (options?.client ?? _heyApiClient).get({
2017
2024
  security: [
@@ -2139,6 +2146,10 @@ export const azureVirtualmachinesUpdate = (options) => {
2139
2146
  }
2140
2147
  });
2141
2148
  };
2149
+ /**
2150
+ * Synchronize resource state
2151
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
2152
+ */
2142
2153
  export const azureVirtualmachinesPull = (options) => {
2143
2154
  return (options.client ?? _heyApiClient).post({
2144
2155
  security: [
@@ -2204,6 +2215,7 @@ export const azureVirtualmachinesStop = (options) => {
2204
2215
  });
2205
2216
  };
2206
2217
  /**
2218
+ * Unlink resource
2207
2219
  * Delete resource from the database without scheduling operations on backend
2208
2220
  * and without checking current state of the resource. It is intended to be used
2209
2221
  * for removing resource stuck in transitioning state.
@@ -2224,9 +2236,6 @@ export const azureVirtualmachinesUnlink = (options) => {
2224
2236
  ...options
2225
2237
  });
2226
2238
  };
2227
- /**
2228
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2229
- */
2230
2239
  export const backendResourceRequestsList = (options) => {
2231
2240
  return (options?.client ?? _heyApiClient).get({
2232
2241
  security: [
@@ -2350,9 +2359,6 @@ export const backendResourceRequestsStartProcessing = (options) => {
2350
2359
  ...options
2351
2360
  });
2352
2361
  };
2353
- /**
2354
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2355
- */
2356
2362
  export const backendResourcesList = (options) => {
2357
2363
  return (options?.client ?? _heyApiClient).get({
2358
2364
  security: [
@@ -2476,9 +2482,6 @@ export const billingTotalCostRetrieve = (options) => {
2476
2482
  ...options
2477
2483
  });
2478
2484
  };
2479
- /**
2480
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2481
- */
2482
2485
  export const bookingOfferingsList = (options) => {
2483
2486
  return (options?.client ?? _heyApiClient).get({
2484
2487
  security: [
@@ -2578,9 +2581,6 @@ export const bookingOfferingsUnshareGoogleCalendar = (options) => {
2578
2581
  ...options
2579
2582
  });
2580
2583
  };
2581
- /**
2582
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2583
- */
2584
2584
  export const bookingResourcesList = (options) => {
2585
2585
  return (options?.client ?? _heyApiClient).get({
2586
2586
  security: [
@@ -2664,9 +2664,6 @@ export const bookingResourcesReject = (options) => {
2664
2664
  ...options
2665
2665
  });
2666
2666
  };
2667
- /**
2668
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2669
- */
2670
2667
  export const broadcastMessageTemplatesList = (options) => {
2671
2668
  return (options?.client ?? _heyApiClient).get({
2672
2669
  security: [
@@ -2794,9 +2791,6 @@ export const broadcastMessageTemplatesUpdate = (options) => {
2794
2791
  }
2795
2792
  });
2796
2793
  };
2797
- /**
2798
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2799
- */
2800
2794
  export const broadcastMessagesList = (options) => {
2801
2795
  return (options?.client ?? _heyApiClient).get({
2802
2796
  security: [
@@ -2991,9 +2985,6 @@ export const broadcastMessagesRecipientsCount = (options) => {
2991
2985
  ...options
2992
2986
  });
2993
2987
  };
2994
- /**
2995
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
2996
- */
2997
2988
  export const callManagingOrganisationsList = (options) => {
2998
2989
  return (options?.client ?? _heyApiClient).get({
2999
2990
  security: [
@@ -3216,9 +3207,6 @@ export const callManagingOrganisationsUpdateUser = (options) => {
3216
3207
  }
3217
3208
  });
3218
3209
  };
3219
- /**
3220
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
3221
- */
3222
3210
  export const callProposalProjectRoleMappingsList = (options) => {
3223
3211
  return (options?.client ?? _heyApiClient).get({
3224
3212
  security: [
@@ -3346,9 +3334,6 @@ export const callProposalProjectRoleMappingsUpdate = (options) => {
3346
3334
  }
3347
3335
  });
3348
3336
  };
3349
- /**
3350
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
3351
- */
3352
3337
  export const callRoundsList = (options) => {
3353
3338
  return (options?.client ?? _heyApiClient).get({
3354
3339
  security: [
@@ -3419,6 +3404,10 @@ export const callRoundsReviewersList = (options) => {
3419
3404
  ...options
3420
3405
  });
3421
3406
  };
3407
+ /**
3408
+ * Get Celery worker statistics
3409
+ * Provides a snapshot of the Celery workers' status, including active, scheduled, reserved, and revoked tasks, as well as worker-specific statistics. Requires support user permissions.
3410
+ */
3422
3411
  export const celeryStatsRetrieve = (options) => {
3423
3412
  return (options?.client ?? _heyApiClient).get({
3424
3413
  security: [
@@ -3435,9 +3424,6 @@ export const celeryStatsRetrieve = (options) => {
3435
3424
  ...options
3436
3425
  });
3437
3426
  };
3438
- /**
3439
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
3440
- */
3441
3427
  export const checklistsAdminList = (options) => {
3442
3428
  return (options?.client ?? _heyApiClient).get({
3443
3429
  security: [
@@ -3493,9 +3479,6 @@ export const checklistsAdminCreate = (options) => {
3493
3479
  }
3494
3480
  });
3495
3481
  };
3496
- /**
3497
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
3498
- */
3499
3482
  export const checklistsAdminCategoriesList = (options) => {
3500
3483
  return (options?.client ?? _heyApiClient).get({
3501
3484
  security: [
@@ -3623,9 +3606,6 @@ export const checklistsAdminCategoriesUpdate = (options) => {
3623
3606
  }
3624
3607
  });
3625
3608
  };
3626
- /**
3627
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
3628
- */
3629
3609
  export const checklistsAdminQuestionDependenciesList = (options) => {
3630
3610
  return (options?.client ?? _heyApiClient).get({
3631
3611
  security: [
@@ -3753,9 +3733,6 @@ export const checklistsAdminQuestionDependenciesUpdate = (options) => {
3753
3733
  }
3754
3734
  });
3755
3735
  };
3756
- /**
3757
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
3758
- */
3759
3736
  export const checklistsAdminQuestionOptionsList = (options) => {
3760
3737
  return (options?.client ?? _heyApiClient).get({
3761
3738
  security: [
@@ -3883,9 +3860,6 @@ export const checklistsAdminQuestionOptionsUpdate = (options) => {
3883
3860
  }
3884
3861
  });
3885
3862
  };
3886
- /**
3887
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
3888
- */
3889
3863
  export const checklistsAdminQuestionsList = (options) => {
3890
3864
  return (options?.client ?? _heyApiClient).get({
3891
3865
  security: [
@@ -4104,9 +4078,6 @@ export const checklistsAdminChecklistQuestions = (options) => {
4104
4078
  ...options
4105
4079
  });
4106
4080
  };
4107
- /**
4108
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
4109
- */
4110
4081
  export const componentUserUsageLimitsList = (options) => {
4111
4082
  return (options?.client ?? _heyApiClient).get({
4112
4083
  security: [
@@ -4235,7 +4206,8 @@ export const componentUserUsageLimitsUpdate = (options) => {
4235
4206
  });
4236
4207
  };
4237
4208
  /**
4238
- * Retrieve public settings
4209
+ * Get public configuration
4210
+ * Returns a dictionary of public settings for the Waldur deployment. This includes feature flags, authentication methods, and other configuration details that are safe to expose to any user.
4239
4211
  */
4240
4212
  export const configurationRetrieve = (options) => {
4241
4213
  return (options?.client ?? _heyApiClient).get({
@@ -4253,9 +4225,6 @@ export const configurationRetrieve = (options) => {
4253
4225
  ...options
4254
4226
  });
4255
4227
  };
4256
- /**
4257
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
4258
- */
4259
4228
  export const customerCreditsList = (options) => {
4260
4229
  return (options?.client ?? _heyApiClient).get({
4261
4230
  security: [
@@ -4442,9 +4411,6 @@ export const customerCreditsConsumptionsList = (options) => {
4442
4411
  ...options
4443
4412
  });
4444
4413
  };
4445
- /**
4446
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
4447
- */
4448
4414
  export const customerPermissionsReviewsList = (options) => {
4449
4415
  return (options?.client ?? _heyApiClient).get({
4450
4416
  security: [
@@ -4497,7 +4463,7 @@ export const customerPermissionsReviewsRetrieve = (options) => {
4497
4463
  });
4498
4464
  };
4499
4465
  /**
4500
- * Close customer permission review.
4466
+ * Close customer permission review
4501
4467
  */
4502
4468
  export const customerPermissionsReviewsClose = (options) => {
4503
4469
  return (options.client ?? _heyApiClient).post({
@@ -4554,7 +4520,8 @@ export const customerQuotasCount = (options) => {
4554
4520
  });
4555
4521
  };
4556
4522
  /**
4557
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
4523
+ * List customers
4524
+ * Retrieve a list of customers. The list is filtered based on the user's permissions.
4558
4525
  */
4559
4526
  export const customersList = (options) => {
4560
4527
  return (options?.client ?? _heyApiClient).get({
@@ -4573,6 +4540,7 @@ export const customersList = (options) => {
4573
4540
  });
4574
4541
  };
4575
4542
  /**
4543
+ * List customers
4576
4544
  * Get number of items in the collection matching the request parameters.
4577
4545
  */
4578
4546
  export const customersCount = (options) => {
@@ -4592,7 +4560,8 @@ export const customersCount = (options) => {
4592
4560
  });
4593
4561
  };
4594
4562
  /**
4595
- * A new customer can only be created by users with staff privilege
4563
+ * Create a new customer
4564
+ * A new customer can only be created by users with staff privilege.
4596
4565
  */
4597
4566
  export const customersCreate = (options) => {
4598
4567
  return (options.client ?? _heyApiClient).post({
@@ -4615,7 +4584,8 @@ export const customersCreate = (options) => {
4615
4584
  });
4616
4585
  };
4617
4586
  /**
4618
- * Get detailed project compliance information.
4587
+ * Get detailed project metadata compliance
4588
+ * Provides detailed compliance status for all projects within a customer, including individual answers and completion status.
4619
4589
  */
4620
4590
  export const customersProjectMetadataComplianceDetailsList = (options) => {
4621
4591
  return (options.client ?? _heyApiClient).get({
@@ -4634,7 +4604,8 @@ export const customersProjectMetadataComplianceDetailsList = (options) => {
4634
4604
  });
4635
4605
  };
4636
4606
  /**
4637
- * Get compliance overview statistics for all projects.
4607
+ * Get project metadata compliance overview
4608
+ * Provides aggregated statistics about project metadata compliance for all projects within a customer.
4638
4609
  */
4639
4610
  export const customersProjectMetadataComplianceOverviewList = (options) => {
4640
4611
  return (options.client ?? _heyApiClient).get({
@@ -4653,7 +4624,8 @@ export const customersProjectMetadataComplianceOverviewList = (options) => {
4653
4624
  });
4654
4625
  };
4655
4626
  /**
4656
- * List project checklist answer data.
4627
+ * List projects with compliance data
4628
+ * Provides a paginated list of projects with their checklist completion status and answer details.
4657
4629
  */
4658
4630
  export const customersProjectMetadataComplianceProjectsList = (options) => {
4659
4631
  return (options.client ?? _heyApiClient).get({
@@ -4673,6 +4645,7 @@ export const customersProjectMetadataComplianceProjectsList = (options) => {
4673
4645
  };
4674
4646
  /**
4675
4647
  * List questions with project answers
4648
+ * Provides a paginated list of all questions from the customer's compliance checklist, including the answers given in each project.
4676
4649
  */
4677
4650
  export const customersProjectMetadataQuestionAnswersList = (options) => {
4678
4651
  return (options.client ?? _heyApiClient).get({
@@ -4691,7 +4664,8 @@ export const customersProjectMetadataQuestionAnswersList = (options) => {
4691
4664
  });
4692
4665
  };
4693
4666
  /**
4694
- * A list of users connected to the customer.
4667
+ * List users of a customer
4668
+ * Lists all users who have a role in the specified customer or any of its projects. Requires permissions to list customer users.
4695
4669
  */
4696
4670
  export const customersUsersList = (options) => {
4697
4671
  return (options.client ?? _heyApiClient).get({
@@ -4710,7 +4684,8 @@ export const customersUsersList = (options) => {
4710
4684
  });
4711
4685
  };
4712
4686
  /**
4713
- * If a customer has connected projects, deletion request will fail with 409 response code.
4687
+ * Delete a customer
4688
+ * Delete a customer. This action is only available to staff users. If a customer has any active projects, the deletion request will fail with a 409 Conflict response.
4714
4689
  */
4715
4690
  export const customersDestroy = (options) => {
4716
4691
  return (options.client ?? _heyApiClient).delete({
@@ -4728,6 +4703,10 @@ export const customersDestroy = (options) => {
4728
4703
  ...options
4729
4704
  });
4730
4705
  };
4706
+ /**
4707
+ * Retrieve customer details
4708
+ * Fetch the details of a specific customer by its UUID.
4709
+ */
4731
4710
  export const customersRetrieve = (options) => {
4732
4711
  return (options.client ?? _heyApiClient).get({
4733
4712
  security: [
@@ -4744,6 +4723,10 @@ export const customersRetrieve = (options) => {
4744
4723
  ...options
4745
4724
  });
4746
4725
  };
4726
+ /**
4727
+ * Partially update a customer
4728
+ * Partially update the details of an existing customer. Requires customer owner or staff permissions.
4729
+ */
4747
4730
  export const customersPartialUpdate = (options) => {
4748
4731
  return (options.client ?? _heyApiClient).patch({
4749
4732
  security: [
@@ -4764,6 +4747,10 @@ export const customersPartialUpdate = (options) => {
4764
4747
  }
4765
4748
  });
4766
4749
  };
4750
+ /**
4751
+ * Update a customer
4752
+ * Update the details of an existing customer. Requires customer owner or staff permissions.
4753
+ */
4767
4754
  export const customersUpdate = (options) => {
4768
4755
  return (options.client ?? _heyApiClient).put({
4769
4756
  security: [
@@ -4841,7 +4828,8 @@ export const customersListUsersList = (options) => {
4841
4828
  });
4842
4829
  };
4843
4830
  /**
4844
- * Return statistics about customer resources usage
4831
+ * Get customer resource usage statistics
4832
+ * Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all projects within a customer. Can be filtered to show usage for the current month only.
4845
4833
  */
4846
4834
  export const customersStatsRetrieve = (options) => {
4847
4835
  return (options.client ?? _heyApiClient).get({
@@ -4860,7 +4848,8 @@ export const customersStatsRetrieve = (options) => {
4860
4848
  });
4861
4849
  };
4862
4850
  /**
4863
- * Update organization groups for customer
4851
+ * Update organization groups for a customer
4852
+ * Assigns a customer to one or more organization groups. This action is restricted to staff users.
4864
4853
  */
4865
4854
  export const customersUpdateOrganizationGroups = (options) => {
4866
4855
  return (options.client ?? _heyApiClient).post({
@@ -4903,7 +4892,8 @@ export const customersUpdateUser = (options) => {
4903
4892
  });
4904
4893
  };
4905
4894
  /**
4906
- * Return list of countries
4895
+ * Get list of available countries
4896
+ * Returns a list of countries that can be used when creating or updating a customer. The list can be configured by the service provider.
4907
4897
  */
4908
4898
  export const customersCountriesList = (options) => {
4909
4899
  return (options?.client ?? _heyApiClient).get({
@@ -4922,6 +4912,7 @@ export const customersCountriesList = (options) => {
4922
4912
  });
4923
4913
  };
4924
4914
  /**
4915
+ * Get list of available countries
4925
4916
  * Get number of items in the collection matching the request parameters.
4926
4917
  */
4927
4918
  export const customersCountriesCount = (options) => {
@@ -4956,6 +4947,10 @@ export const dailyQuotasRetrieve = (options) => {
4956
4947
  ...options
4957
4948
  });
4958
4949
  };
4950
+ /**
4951
+ * Get database table statistics
4952
+ * Retrieves statistics about the database, including the top 10 largest tables by total size. This information is useful for monitoring and maintenance. Requires support user permissions.
4953
+ */
4959
4954
  export const databaseStatsList = (options) => {
4960
4955
  return (options?.client ?? _heyApiClient).get({
4961
4956
  security: [
@@ -4972,9 +4967,6 @@ export const databaseStatsList = (options) => {
4972
4967
  ...options
4973
4968
  });
4974
4969
  };
4975
- /**
4976
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
4977
- */
4978
4970
  export const digitaloceanDropletsList = (options) => {
4979
4971
  return (options?.client ?? _heyApiClient).get({
4980
4972
  security: [
@@ -5102,6 +5094,10 @@ export const digitaloceanDropletsUpdate = (options) => {
5102
5094
  }
5103
5095
  });
5104
5096
  };
5097
+ /**
5098
+ * Synchronize resource state
5099
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
5100
+ */
5105
5101
  export const digitaloceanDropletsPull = (options) => {
5106
5102
  return (options.client ?? _heyApiClient).post({
5107
5103
  security: [
@@ -5199,6 +5195,7 @@ export const digitaloceanDropletsStop = (options) => {
5199
5195
  });
5200
5196
  };
5201
5197
  /**
5198
+ * Unlink resource
5202
5199
  * Delete resource from the database without scheduling operations on backend
5203
5200
  * and without checking current state of the resource. It is intended to be used
5204
5201
  * for removing resource stuck in transitioning state.
@@ -5219,9 +5216,6 @@ export const digitaloceanDropletsUnlink = (options) => {
5219
5216
  ...options
5220
5217
  });
5221
5218
  };
5222
- /**
5223
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5224
- */
5225
5219
  export const digitaloceanImagesList = (options) => {
5226
5220
  return (options?.client ?? _heyApiClient).get({
5227
5221
  security: [
@@ -5273,9 +5267,6 @@ export const digitaloceanImagesRetrieve = (options) => {
5273
5267
  ...options
5274
5268
  });
5275
5269
  };
5276
- /**
5277
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5278
- */
5279
5270
  export const digitaloceanRegionsList = (options) => {
5280
5271
  return (options?.client ?? _heyApiClient).get({
5281
5272
  security: [
@@ -5327,9 +5318,6 @@ export const digitaloceanRegionsRetrieve = (options) => {
5327
5318
  ...options
5328
5319
  });
5329
5320
  };
5330
- /**
5331
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5332
- */
5333
5321
  export const digitaloceanSizesList = (options) => {
5334
5322
  return (options?.client ?? _heyApiClient).get({
5335
5323
  security: [
@@ -5381,9 +5369,6 @@ export const digitaloceanSizesRetrieve = (options) => {
5381
5369
  ...options
5382
5370
  });
5383
5371
  };
5384
- /**
5385
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5386
- */
5387
5372
  export const emailLogsList = (options) => {
5388
5373
  return (options?.client ?? _heyApiClient).get({
5389
5374
  security: [
@@ -5435,9 +5420,6 @@ export const emailLogsRetrieve = (options) => {
5435
5420
  ...options
5436
5421
  });
5437
5422
  };
5438
- /**
5439
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5440
- */
5441
5423
  export const eventSubscriptionsList = (options) => {
5442
5424
  return (options?.client ?? _heyApiClient).get({
5443
5425
  security: [
@@ -5525,9 +5507,6 @@ export const eventSubscriptionsRetrieve = (options) => {
5525
5507
  ...options
5526
5508
  });
5527
5509
  };
5528
- /**
5529
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5530
- */
5531
5510
  export const eventsList = (options) => {
5532
5511
  return (options?.client ?? _heyApiClient).get({
5533
5512
  security: [
@@ -5563,9 +5542,6 @@ export const eventsCount = (options) => {
5563
5542
  ...options
5564
5543
  });
5565
5544
  };
5566
- /**
5567
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5568
- */
5569
5545
  export const eventsStatsList = (options) => {
5570
5546
  return (options?.client ?? _heyApiClient).get({
5571
5547
  security: [
@@ -5730,7 +5706,8 @@ export const eventsScopeTypesCount = (options) => {
5730
5706
  });
5731
5707
  };
5732
5708
  /**
5733
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5709
+ * List external links
5710
+ * Retrieve a list of external links available in the system.
5734
5711
  */
5735
5712
  export const externalLinksList = (options) => {
5736
5713
  return (options?.client ?? _heyApiClient).get({
@@ -5749,6 +5726,7 @@ export const externalLinksList = (options) => {
5749
5726
  });
5750
5727
  };
5751
5728
  /**
5729
+ * List external links
5752
5730
  * Get number of items in the collection matching the request parameters.
5753
5731
  */
5754
5732
  export const externalLinksCount = (options) => {
@@ -5767,6 +5745,10 @@ export const externalLinksCount = (options) => {
5767
5745
  ...options
5768
5746
  });
5769
5747
  };
5748
+ /**
5749
+ * Create an external link
5750
+ * Create a new external link. This action is restricted to staff users.
5751
+ */
5770
5752
  export const externalLinksCreate = (options) => {
5771
5753
  return (options.client ?? _heyApiClient).post({
5772
5754
  security: [
@@ -5787,6 +5769,10 @@ export const externalLinksCreate = (options) => {
5787
5769
  }
5788
5770
  });
5789
5771
  };
5772
+ /**
5773
+ * Delete an external link
5774
+ * Delete an existing external link. This action is restricted to staff users.
5775
+ */
5790
5776
  export const externalLinksDestroy = (options) => {
5791
5777
  return (options.client ?? _heyApiClient).delete({
5792
5778
  security: [
@@ -5803,6 +5789,10 @@ export const externalLinksDestroy = (options) => {
5803
5789
  ...options
5804
5790
  });
5805
5791
  };
5792
+ /**
5793
+ * Retrieve external link
5794
+ * Fetch the details of a specific external link by its UUID.
5795
+ */
5806
5796
  export const externalLinksRetrieve = (options) => {
5807
5797
  return (options.client ?? _heyApiClient).get({
5808
5798
  security: [
@@ -5819,6 +5809,10 @@ export const externalLinksRetrieve = (options) => {
5819
5809
  ...options
5820
5810
  });
5821
5811
  };
5812
+ /**
5813
+ * Partially update an external link
5814
+ * Partially update an existing external link. This action is restricted to staff users.
5815
+ */
5822
5816
  export const externalLinksPartialUpdate = (options) => {
5823
5817
  return (options.client ?? _heyApiClient).patch({
5824
5818
  security: [
@@ -5839,6 +5833,10 @@ export const externalLinksPartialUpdate = (options) => {
5839
5833
  }
5840
5834
  });
5841
5835
  };
5836
+ /**
5837
+ * Update an external link
5838
+ * Update an existing external link. This action is restricted to staff users.
5839
+ */
5842
5840
  export const externalLinksUpdate = (options) => {
5843
5841
  return (options.client ?? _heyApiClient).put({
5844
5842
  security: [
@@ -5860,7 +5858,8 @@ export const externalLinksUpdate = (options) => {
5860
5858
  });
5861
5859
  };
5862
5860
  /**
5863
- * Override feature values
5861
+ * Update feature flags
5862
+ * Allows administrators to enable or disable specific feature flags in the system. The request should be a dictionary where keys are feature sections and values are dictionaries of feature keys and their boolean state.
5864
5863
  */
5865
5864
  export const featureValues = (options) => {
5866
5865
  return (options?.client ?? _heyApiClient).post({
@@ -5882,9 +5881,6 @@ export const featureValues = (options) => {
5882
5881
  }
5883
5882
  });
5884
5883
  };
5885
- /**
5886
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5887
- */
5888
5884
  export const financialReportsList = (options) => {
5889
5885
  return (options?.client ?? _heyApiClient).get({
5890
5886
  security: [
@@ -5936,9 +5932,6 @@ export const financialReportsRetrieve = (options) => {
5936
5932
  ...options
5937
5933
  });
5938
5934
  };
5939
- /**
5940
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
5941
- */
5942
5935
  export const freeipaProfilesList = (options) => {
5943
5936
  return (options?.client ?? _heyApiClient).get({
5944
5937
  security: [
@@ -6065,9 +6058,6 @@ export const freeipaProfilesUpdateSshKeys = (options) => {
6065
6058
  ...options
6066
6059
  });
6067
6060
  };
6068
- /**
6069
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
6070
- */
6071
6061
  export const googleAuthList = (options) => {
6072
6062
  return (options?.client ?? _heyApiClient).get({
6073
6063
  security: [
@@ -6173,9 +6163,6 @@ export const googleAuthCallbackCount = (options) => {
6173
6163
  ...options
6174
6164
  });
6175
6165
  };
6176
- /**
6177
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
6178
- */
6179
6166
  export const hooksList = (options) => {
6180
6167
  return (options?.client ?? _heyApiClient).get({
6181
6168
  security: [
@@ -6211,9 +6198,6 @@ export const hooksCount = (options) => {
6211
6198
  ...options
6212
6199
  });
6213
6200
  };
6214
- /**
6215
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
6216
- */
6217
6201
  export const hooksEmailList = (options) => {
6218
6202
  return (options?.client ?? _heyApiClient).get({
6219
6203
  security: [
@@ -6341,9 +6325,6 @@ export const hooksEmailUpdate = (options) => {
6341
6325
  }
6342
6326
  });
6343
6327
  };
6344
- /**
6345
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
6346
- */
6347
6328
  export const hooksWebList = (options) => {
6348
6329
  return (options?.client ?? _heyApiClient).get({
6349
6330
  security: [
@@ -6496,9 +6477,6 @@ export const hooksWebUpdate = (options) => {
6496
6477
  }
6497
6478
  });
6498
6479
  };
6499
- /**
6500
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
6501
- */
6502
6480
  export const identityProvidersList = (options) => {
6503
6481
  return (options?.client ?? _heyApiClient).get({
6504
6482
  security: [
@@ -6626,9 +6604,6 @@ export const identityProvidersUpdate = (options) => {
6626
6604
  }
6627
6605
  });
6628
6606
  };
6629
- /**
6630
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
6631
- */
6632
6607
  export const invoiceItemsList = (options) => {
6633
6608
  return (options?.client ?? _heyApiClient).get({
6634
6609
  security: [
@@ -6967,9 +6942,6 @@ export const invoiceSendFinancialReportByMail = (options) => {
6967
6942
  }
6968
6943
  });
6969
6944
  };
6970
- /**
6971
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
6972
- */
6973
6945
  export const invoicesList = (options) => {
6974
6946
  return (options?.client ?? _heyApiClient).get({
6975
6947
  security: [
@@ -7210,9 +7182,6 @@ export const invoicesGrowthCount = (options) => {
7210
7182
  ...options
7211
7183
  });
7212
7184
  };
7213
- /**
7214
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7215
- */
7216
7185
  export const keycloakGroupsList = (options) => {
7217
7186
  return (options?.client ?? _heyApiClient).get({
7218
7187
  security: [
@@ -7264,9 +7233,6 @@ export const keycloakGroupsRetrieve = (options) => {
7264
7233
  ...options
7265
7234
  });
7266
7235
  };
7267
- /**
7268
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7269
- */
7270
7236
  export const keycloakUserGroupMembershipsList = (options) => {
7271
7237
  return (options?.client ?? _heyApiClient).get({
7272
7238
  security: [
@@ -7394,9 +7360,6 @@ export const keycloakUserGroupMembershipsUpdate = (options) => {
7394
7360
  }
7395
7361
  });
7396
7362
  };
7397
- /**
7398
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7399
- */
7400
7363
  export const keysList = (options) => {
7401
7364
  return (options?.client ?? _heyApiClient).get({
7402
7365
  security: [
@@ -7484,9 +7447,6 @@ export const keysRetrieve = (options) => {
7484
7447
  ...options
7485
7448
  });
7486
7449
  };
7487
- /**
7488
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7489
- */
7490
7450
  export const lexisLinksList = (options) => {
7491
7451
  return (options?.client ?? _heyApiClient).get({
7492
7452
  security: [
@@ -7614,9 +7574,6 @@ export const lexisLinksUpdate = (options) => {
7614
7574
  }
7615
7575
  });
7616
7576
  };
7617
- /**
7618
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7619
- */
7620
7577
  export const maintenanceAnnouncementOfferingsList = (options) => {
7621
7578
  return (options?.client ?? _heyApiClient).get({
7622
7579
  security: [
@@ -7744,9 +7701,6 @@ export const maintenanceAnnouncementOfferingsUpdate = (options) => {
7744
7701
  }
7745
7702
  });
7746
7703
  };
7747
- /**
7748
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7749
- */
7750
7704
  export const maintenanceAnnouncementTemplateOfferingsList = (options) => {
7751
7705
  return (options?.client ?? _heyApiClient).get({
7752
7706
  security: [
@@ -7874,9 +7828,6 @@ export const maintenanceAnnouncementTemplateOfferingsUpdate = (options) => {
7874
7828
  }
7875
7829
  });
7876
7830
  };
7877
- /**
7878
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7879
- */
7880
7831
  export const maintenanceAnnouncementsList = (options) => {
7881
7832
  return (options?.client ?? _heyApiClient).get({
7882
7833
  security: [
@@ -7932,9 +7883,6 @@ export const maintenanceAnnouncementsCreate = (options) => {
7932
7883
  }
7933
7884
  });
7934
7885
  };
7935
- /**
7936
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
7937
- */
7938
7886
  export const maintenanceAnnouncementsTemplateList = (options) => {
7939
7887
  return (options?.client ?? _heyApiClient).get({
7940
7888
  security: [
@@ -8229,9 +8177,6 @@ export const maintenanceAnnouncementsUnschedule = (options) => {
8229
8177
  ...options
8230
8178
  });
8231
8179
  };
8232
- /**
8233
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
8234
- */
8235
8180
  export const managedRancherClusterResourcesList = (options) => {
8236
8181
  return (options?.client ?? _heyApiClient).get({
8237
8182
  security: [
@@ -8319,9 +8264,6 @@ export const marketplaceBookingsList = (options) => {
8319
8264
  ...options
8320
8265
  });
8321
8266
  };
8322
- /**
8323
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
8324
- */
8325
8267
  export const marketplaceCategoriesList = (options) => {
8326
8268
  return (options?.client ?? _heyApiClient).get({
8327
8269
  security: [
@@ -8449,9 +8391,6 @@ export const marketplaceCategoriesUpdate = (options) => {
8449
8391
  }
8450
8392
  });
8451
8393
  };
8452
- /**
8453
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
8454
- */
8455
8394
  export const marketplaceCategoryColumnsList = (options) => {
8456
8395
  return (options?.client ?? _heyApiClient).get({
8457
8396
  security: [
@@ -8579,9 +8518,6 @@ export const marketplaceCategoryColumnsUpdate = (options) => {
8579
8518
  }
8580
8519
  });
8581
8520
  };
8582
- /**
8583
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
8584
- */
8585
8521
  export const marketplaceCategoryComponentUsagesList = (options) => {
8586
8522
  return (options?.client ?? _heyApiClient).get({
8587
8523
  security: [
@@ -8633,9 +8569,6 @@ export const marketplaceCategoryComponentUsagesRetrieve = (options) => {
8633
8569
  ...options
8634
8570
  });
8635
8571
  };
8636
- /**
8637
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
8638
- */
8639
8572
  export const marketplaceCategoryComponentsList = (options) => {
8640
8573
  return (options?.client ?? _heyApiClient).get({
8641
8574
  security: [
@@ -8763,9 +8696,6 @@ export const marketplaceCategoryComponentsUpdate = (options) => {
8763
8696
  }
8764
8697
  });
8765
8698
  };
8766
- /**
8767
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
8768
- */
8769
8699
  export const marketplaceCategoryGroupsList = (options) => {
8770
8700
  return (options?.client ?? _heyApiClient).get({
8771
8701
  security: [
@@ -8893,9 +8823,6 @@ export const marketplaceCategoryGroupsUpdate = (options) => {
8893
8823
  }
8894
8824
  });
8895
8825
  };
8896
- /**
8897
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
8898
- */
8899
8826
  export const marketplaceCategoryHelpArticlesList = (options) => {
8900
8827
  return (options?.client ?? _heyApiClient).get({
8901
8828
  security: [
@@ -9023,9 +8950,6 @@ export const marketplaceCategoryHelpArticlesUpdate = (options) => {
9023
8950
  }
9024
8951
  });
9025
8952
  };
9026
- /**
9027
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9028
- */
9029
8953
  export const marketplaceComponentUsagesList = (options) => {
9030
8954
  return (options?.client ?? _heyApiClient).get({
9031
8955
  security: [
@@ -9117,9 +9041,6 @@ export const marketplaceComponentUsagesSetUsage = (options) => {
9117
9041
  }
9118
9042
  });
9119
9043
  };
9120
- /**
9121
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9122
- */
9123
9044
  export const marketplaceComponentUserUsagesList = (options) => {
9124
9045
  return (options?.client ?? _heyApiClient).get({
9125
9046
  security: [
@@ -9171,9 +9092,6 @@ export const marketplaceComponentUserUsagesRetrieve = (options) => {
9171
9092
  ...options
9172
9093
  });
9173
9094
  };
9174
- /**
9175
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9176
- */
9177
9095
  export const marketplaceCourseAccountsList = (options) => {
9178
9096
  return (options?.client ?? _heyApiClient).get({
9179
9097
  security: [
@@ -9281,9 +9199,6 @@ export const marketplaceCourseAccountsCreateBulk = (options) => {
9281
9199
  }
9282
9200
  });
9283
9201
  };
9284
- /**
9285
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9286
- */
9287
9202
  export const marketplaceCustomerComponentUsagePoliciesList = (options) => {
9288
9203
  return (options?.client ?? _heyApiClient).get({
9289
9204
  security: [
@@ -9446,9 +9361,6 @@ export const marketplaceCustomerComponentUsagePoliciesActionsCount = (options) =
9446
9361
  ...options
9447
9362
  });
9448
9363
  };
9449
- /**
9450
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9451
- */
9452
9364
  export const marketplaceCustomerEstimatedCostPoliciesList = (options) => {
9453
9365
  return (options?.client ?? _heyApiClient).get({
9454
9366
  security: [
@@ -9611,9 +9523,6 @@ export const marketplaceCustomerEstimatedCostPoliciesActionsCount = (options) =>
9611
9523
  ...options
9612
9524
  });
9613
9525
  };
9614
- /**
9615
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9616
- */
9617
9526
  export const marketplaceCustomerServiceAccountsList = (options) => {
9618
9527
  return (options?.client ?? _heyApiClient).get({
9619
9528
  security: [
@@ -9776,9 +9685,6 @@ export const marketplaceGlobalCategoriesRetrieve = (options) => {
9776
9685
  ...options
9777
9686
  });
9778
9687
  };
9779
- /**
9780
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9781
- */
9782
9688
  export const marketplaceIntegrationStatusesList = (options) => {
9783
9689
  return (options?.client ?? _heyApiClient).get({
9784
9690
  security: [
@@ -9830,9 +9736,6 @@ export const marketplaceIntegrationStatusesRetrieve = (options) => {
9830
9736
  ...options
9831
9737
  });
9832
9738
  };
9833
- /**
9834
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
9835
- */
9836
9739
  export const marketplaceOfferingEstimatedCostPoliciesList = (options) => {
9837
9740
  return (options?.client ?? _heyApiClient).get({
9838
9741
  security: [
@@ -9998,9 +9901,6 @@ export const marketplaceOfferingEstimatedCostPoliciesActionsCount = (options) =>
9998
9901
  ...options
9999
9902
  });
10000
9903
  };
10001
- /**
10002
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10003
- */
10004
9904
  export const marketplaceOfferingFilesList = (options) => {
10005
9905
  return (options?.client ?? _heyApiClient).get({
10006
9906
  security: [
@@ -10088,9 +9988,6 @@ export const marketplaceOfferingFilesRetrieve = (options) => {
10088
9988
  ...options
10089
9989
  });
10090
9990
  };
10091
- /**
10092
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10093
- */
10094
9991
  export const marketplaceOfferingPermissionsList = (options) => {
10095
9992
  return (options?.client ?? _heyApiClient).get({
10096
9993
  security: [
@@ -10126,9 +10023,6 @@ export const marketplaceOfferingPermissionsCount = (options) => {
10126
10023
  ...options
10127
10024
  });
10128
10025
  };
10129
- /**
10130
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10131
- */
10132
10026
  export const marketplaceOfferingPermissionsLogList = (options) => {
10133
10027
  return (options?.client ?? _heyApiClient).get({
10134
10028
  security: [
@@ -10196,9 +10090,6 @@ export const marketplaceOfferingPermissionsRetrieve = (options) => {
10196
10090
  ...options
10197
10091
  });
10198
10092
  };
10199
- /**
10200
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10201
- */
10202
10093
  export const marketplaceOfferingReferralsList = (options) => {
10203
10094
  return (options?.client ?? _heyApiClient).get({
10204
10095
  security: [
@@ -10250,9 +10141,6 @@ export const marketplaceOfferingReferralsRetrieve = (options) => {
10250
10141
  ...options
10251
10142
  });
10252
10143
  };
10253
- /**
10254
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10255
- */
10256
10144
  export const marketplaceOfferingTermsOfServiceList = (options) => {
10257
10145
  return (options?.client ?? _heyApiClient).get({
10258
10146
  security: [
@@ -10380,9 +10268,6 @@ export const marketplaceOfferingTermsOfServiceUpdate = (options) => {
10380
10268
  }
10381
10269
  });
10382
10270
  };
10383
- /**
10384
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10385
- */
10386
10271
  export const marketplaceOfferingUsagePoliciesList = (options) => {
10387
10272
  return (options?.client ?? _heyApiClient).get({
10388
10273
  security: [
@@ -10599,9 +10484,6 @@ export const marketplaceOfferingUserChecklistCompletionsRetrieve = (options) =>
10599
10484
  ...options
10600
10485
  });
10601
10486
  };
10602
- /**
10603
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10604
- */
10605
10487
  export const marketplaceOfferingUserRolesList = (options) => {
10606
10488
  return (options?.client ?? _heyApiClient).get({
10607
10489
  security: [
@@ -10729,9 +10611,6 @@ export const marketplaceOfferingUserRolesUpdate = (options) => {
10729
10611
  }
10730
10612
  });
10731
10613
  };
10732
- /**
10733
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
10734
- */
10735
10614
  export const marketplaceOfferingUsersList = (options) => {
10736
10615
  return (options?.client ?? _heyApiClient).get({
10737
10616
  security: [
@@ -11216,9 +11095,6 @@ export const marketplaceOfferingUsersChecklistTemplateCount = (options) => {
11216
11095
  ...options
11217
11096
  });
11218
11097
  };
11219
- /**
11220
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
11221
- */
11222
11098
  export const marketplaceOrdersList = (options) => {
11223
11099
  return (options?.client ?? _heyApiClient).get({
11224
11100
  security: [
@@ -11532,9 +11408,6 @@ export const marketplaceOrdersUpdateAttachment = (options) => {
11532
11408
  }
11533
11409
  });
11534
11410
  };
11535
- /**
11536
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
11537
- */
11538
11411
  export const marketplacePlanComponentsList = (options) => {
11539
11412
  return (options?.client ?? _heyApiClient).get({
11540
11413
  security: [
@@ -11586,9 +11459,6 @@ export const marketplacePlanComponentsRetrieve = (options) => {
11586
11459
  ...options
11587
11460
  });
11588
11461
  };
11589
- /**
11590
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
11591
- */
11592
11462
  export const marketplacePlansList = (options) => {
11593
11463
  return (options?.client ?? _heyApiClient).get({
11594
11464
  security: [
@@ -11880,9 +11750,6 @@ export const marketplacePluginsList = (options) => {
11880
11750
  ...options
11881
11751
  });
11882
11752
  };
11883
- /**
11884
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
11885
- */
11886
11753
  export const marketplaceProjectEstimatedCostPoliciesList = (options) => {
11887
11754
  return (options?.client ?? _heyApiClient).get({
11888
11755
  security: [
@@ -12045,9 +11912,6 @@ export const marketplaceProjectEstimatedCostPoliciesActionsCount = (options) =>
12045
11912
  ...options
12046
11913
  });
12047
11914
  };
12048
- /**
12049
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
12050
- */
12051
11915
  export const marketplaceProjectServiceAccountsList = (options) => {
12052
11916
  return (options?.client ?? _heyApiClient).get({
12053
11917
  security: [
@@ -12191,9 +12055,6 @@ export const marketplaceProjectServiceAccountsRotateApiKey = (options) => {
12191
12055
  ...options
12192
12056
  });
12193
12057
  };
12194
- /**
12195
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
12196
- */
12197
12058
  export const marketplaceProjectUpdateRequestsList = (options) => {
12198
12059
  return (options?.client ?? _heyApiClient).get({
12199
12060
  security: [
@@ -12291,9 +12152,6 @@ export const marketplaceProjectUpdateRequestsReject = (options) => {
12291
12152
  }
12292
12153
  });
12293
12154
  };
12294
- /**
12295
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
12296
- */
12297
12155
  export const marketplaceProviderOfferingsList = (options) => {
12298
12156
  return (options?.client ?? _heyApiClient).get({
12299
12157
  security: [
@@ -13468,9 +13326,6 @@ export const marketplaceProviderOfferingsGroupsCount = (options) => {
13468
13326
  ...options
13469
13327
  });
13470
13328
  };
13471
- /**
13472
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
13473
- */
13474
13329
  export const marketplaceProviderResourcesList = (options) => {
13475
13330
  return (options?.client ?? _heyApiClient).get({
13476
13331
  security: [
@@ -14123,9 +13978,6 @@ export const marketplacePublicApiSetUsage = (options) => {
14123
13978
  }
14124
13979
  });
14125
13980
  };
14126
- /**
14127
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
14128
- */
14129
13981
  export const marketplacePublicOfferingsList = (options) => {
14130
13982
  return (options?.client ?? _heyApiClient).get({
14131
13983
  security: [
@@ -14225,9 +14077,6 @@ export const marketplaceRelatedCustomersList = (options) => {
14225
14077
  ...options
14226
14078
  });
14227
14079
  };
14228
- /**
14229
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
14230
- */
14231
14080
  export const marketplaceRemoteSynchronisationsList = (options) => {
14232
14081
  return (options?.client ?? _heyApiClient).get({
14233
14082
  security: [
@@ -14387,9 +14236,6 @@ export const marketplaceResourceOfferingsList = (options) => {
14387
14236
  ...options
14388
14237
  });
14389
14238
  };
14390
- /**
14391
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
14392
- */
14393
14239
  export const marketplaceResourceUsersList = (options) => {
14394
14240
  return (options?.client ?? _heyApiClient).get({
14395
14241
  security: [
@@ -14477,9 +14323,6 @@ export const marketplaceResourceUsersRetrieve = (options) => {
14477
14323
  ...options
14478
14324
  });
14479
14325
  };
14480
- /**
14481
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
14482
- */
14483
14326
  export const marketplaceResourcesList = (options) => {
14484
14327
  return (options?.client ?? _heyApiClient).get({
14485
14328
  security: [
@@ -14991,9 +14834,6 @@ export const marketplaceResourcesSuggestName = (options) => {
14991
14834
  }
14992
14835
  });
14993
14836
  };
14994
- /**
14995
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
14996
- */
14997
14837
  export const marketplaceRobotAccountsList = (options) => {
14998
14838
  return (options?.client ?? _heyApiClient).get({
14999
14839
  security: [
@@ -15224,9 +15064,6 @@ export const marketplaceRuntimeStatesList = (options) => {
15224
15064
  ...options
15225
15065
  });
15226
15066
  };
15227
- /**
15228
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
15229
- */
15230
15067
  export const marketplaceScreenshotsList = (options) => {
15231
15068
  return (options?.client ?? _heyApiClient).get({
15232
15069
  security: [
@@ -15354,9 +15191,6 @@ export const marketplaceScreenshotsUpdate = (options) => {
15354
15191
  }
15355
15192
  });
15356
15193
  };
15357
- /**
15358
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
15359
- */
15360
15194
  export const marketplaceScriptAsyncDryRunList = (options) => {
15361
15195
  return (options?.client ?? _heyApiClient).get({
15362
15196
  security: [
@@ -15474,9 +15308,6 @@ export const marketplaceScriptSyncResource = (options) => {
15474
15308
  }
15475
15309
  });
15476
15310
  };
15477
- /**
15478
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
15479
- */
15480
15311
  export const marketplaceSectionsList = (options) => {
15481
15312
  return (options?.client ?? _heyApiClient).get({
15482
15313
  security: [
@@ -15604,9 +15435,6 @@ export const marketplaceSectionsUpdate = (options) => {
15604
15435
  }
15605
15436
  });
15606
15437
  };
15607
- /**
15608
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
15609
- */
15610
15438
  export const marketplaceServiceProvidersList = (options) => {
15611
15439
  return (options?.client ?? _heyApiClient).get({
15612
15440
  security: [
@@ -16198,9 +16026,6 @@ export const marketplaceServiceProvidersUpdateUser = (options) => {
16198
16026
  }
16199
16027
  });
16200
16028
  };
16201
- /**
16202
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
16203
- */
16204
16029
  export const marketplaceSiteAgentIdentitiesList = (options) => {
16205
16030
  return (options?.client ?? _heyApiClient).get({
16206
16031
  security: [
@@ -16354,9 +16179,6 @@ export const marketplaceSiteAgentIdentitiesRegisterService = (options) => {
16354
16179
  }
16355
16180
  });
16356
16181
  };
16357
- /**
16358
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
16359
- */
16360
16182
  export const marketplaceSiteAgentProcessorsList = (options) => {
16361
16183
  return (options?.client ?? _heyApiClient).get({
16362
16184
  security: [
@@ -16408,9 +16230,6 @@ export const marketplaceSiteAgentProcessorsRetrieve = (options) => {
16408
16230
  ...options
16409
16231
  });
16410
16232
  };
16411
- /**
16412
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
16413
- */
16414
16233
  export const marketplaceSiteAgentServicesList = (options) => {
16415
16234
  return (options?.client ?? _heyApiClient).get({
16416
16235
  security: [
@@ -16508,9 +16327,6 @@ export const marketplaceSiteAgentServicesSetStatistics = (options) => {
16508
16327
  }
16509
16328
  });
16510
16329
  };
16511
- /**
16512
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
16513
- */
16514
16330
  export const marketplaceSlurmPeriodicUsagePoliciesList = (options) => {
16515
16331
  return (options?.client ?? _heyApiClient).get({
16516
16332
  security: [
@@ -16673,9 +16489,6 @@ export const marketplaceSlurmPeriodicUsagePoliciesActionsCount = (options) => {
16673
16489
  ...options
16674
16490
  });
16675
16491
  };
16676
- /**
16677
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
16678
- */
16679
16492
  export const marketplaceSoftwareCatalogsList = (options) => {
16680
16493
  return (options?.client ?? _heyApiClient).get({
16681
16494
  security: [
@@ -16803,9 +16616,6 @@ export const marketplaceSoftwareCatalogsUpdate = (options) => {
16803
16616
  }
16804
16617
  });
16805
16618
  };
16806
- /**
16807
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
16808
- */
16809
16619
  export const marketplaceSoftwarePackagesList = (options) => {
16810
16620
  return (options?.client ?? _heyApiClient).get({
16811
16621
  security: [
@@ -16933,9 +16743,6 @@ export const marketplaceSoftwarePackagesUpdate = (options) => {
16933
16743
  }
16934
16744
  });
16935
16745
  };
16936
- /**
16937
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
16938
- */
16939
16746
  export const marketplaceSoftwareTargetsList = (options) => {
16940
16747
  return (options?.client ?? _heyApiClient).get({
16941
16748
  security: [
@@ -17051,9 +16858,6 @@ export const marketplaceSoftwareTargetsUpdate = (options) => {
17051
16858
  ...options
17052
16859
  });
17053
16860
  };
17054
- /**
17055
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
17056
- */
17057
16861
  export const marketplaceSoftwareVersionsList = (options) => {
17058
16862
  return (options?.client ?? _heyApiClient).get({
17059
16863
  security: [
@@ -18005,9 +17809,6 @@ export const marketplaceStatsTotalCostOfActiveResourcesPerOfferingCount = (optio
18005
17809
  ...options
18006
17810
  });
18007
17811
  };
18008
- /**
18009
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
18010
- */
18011
17812
  export const marketplaceUserOfferingConsentsList = (options) => {
18012
17813
  return (options?.client ?? _heyApiClient).get({
18013
17814
  security: [
@@ -18174,7 +17975,8 @@ export const mediaRetrieve = (options) => {
18174
17975
  });
18175
17976
  };
18176
17977
  /**
18177
- * Get event metadata grouped by categories
17978
+ * Get event metadata
17979
+ * Retrieves metadata for all available event types, grouped by categories. This endpoint is publicly accessible and is useful for building UIs for event filtering or webhook configuration.
18178
17980
  */
18179
17981
  export const metadataEventsRetrieve = (options) => {
18180
17982
  return (options?.client ?? _heyApiClient).get({
@@ -18183,7 +17985,8 @@ export const metadataEventsRetrieve = (options) => {
18183
17985
  });
18184
17986
  };
18185
17987
  /**
18186
- * Get feature metadata including toggles and descriptions
17988
+ * Get feature flag metadata
17989
+ * Retrieves metadata for all available feature flags, including their keys, descriptions, and grouping sections. This endpoint is publicly accessible and helps UIs to dynamically render feature-related settings.
18187
17990
  */
18188
17991
  export const metadataFeaturesRetrieve = (options) => {
18189
17992
  return (options?.client ?? _heyApiClient).get({
@@ -18192,7 +17995,8 @@ export const metadataFeaturesRetrieve = (options) => {
18192
17995
  });
18193
17996
  };
18194
17997
  /**
18195
- * Get permission metadata including roles, permissions, and descriptions
17998
+ * Get permission metadata
17999
+ * Retrieves metadata about roles, permissions, and their descriptions. This endpoint is publicly accessible and provides data needed for UI components, such as role selection dropdowns and permission management interfaces.
18196
18000
  */
18197
18001
  export const metadataPermissionsRetrieve = (options) => {
18198
18002
  return (options?.client ?? _heyApiClient).get({
@@ -18201,7 +18005,8 @@ export const metadataPermissionsRetrieve = (options) => {
18201
18005
  });
18202
18006
  };
18203
18007
  /**
18204
- * Get settings metadata from Constance configuration
18008
+ * Get overridable settings metadata
18009
+ * Retrieves metadata for all settings that can be configured via the Constance backend. This includes setting keys, human-readable descriptions, default values, and types. This endpoint is publicly accessible.
18205
18010
  */
18206
18011
  export const metadataSettingsRetrieve = (options) => {
18207
18012
  return (options?.client ?? _heyApiClient).get({
@@ -18209,9 +18014,6 @@ export const metadataSettingsRetrieve = (options) => {
18209
18014
  ...options
18210
18015
  });
18211
18016
  };
18212
- /**
18213
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
18214
- */
18215
18017
  export const notificationMessagesList = (options) => {
18216
18018
  return (options?.client ?? _heyApiClient).get({
18217
18019
  security: [
@@ -18267,9 +18069,6 @@ export const notificationMessagesCreate = (options) => {
18267
18069
  }
18268
18070
  });
18269
18071
  };
18270
- /**
18271
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
18272
- */
18273
18072
  export const notificationMessagesTemplatesList = (options) => {
18274
18073
  return (options?.client ?? _heyApiClient).get({
18275
18074
  security: [
@@ -18397,6 +18196,9 @@ export const notificationMessagesTemplatesUpdate = (options) => {
18397
18196
  }
18398
18197
  });
18399
18198
  };
18199
+ /**
18200
+ * Override notification template content
18201
+ */
18400
18202
  export const notificationMessagesTemplatesOverride = (options) => {
18401
18203
  return (options.client ?? _heyApiClient).post({
18402
18204
  security: [
@@ -18489,6 +18291,9 @@ export const notificationMessagesUpdate = (options) => {
18489
18291
  }
18490
18292
  });
18491
18293
  };
18294
+ /**
18295
+ * Disable a notification
18296
+ */
18492
18297
  export const notificationMessagesDisable = (options) => {
18493
18298
  return (options.client ?? _heyApiClient).post({
18494
18299
  security: [
@@ -18505,6 +18310,9 @@ export const notificationMessagesDisable = (options) => {
18505
18310
  ...options
18506
18311
  });
18507
18312
  };
18313
+ /**
18314
+ * Enable a notification
18315
+ */
18508
18316
  export const notificationMessagesEnable = (options) => {
18509
18317
  return (options.client ?? _heyApiClient).post({
18510
18318
  security: [
@@ -18521,9 +18329,6 @@ export const notificationMessagesEnable = (options) => {
18521
18329
  ...options
18522
18330
  });
18523
18331
  };
18524
- /**
18525
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
18526
- */
18527
18332
  export const onboardingCountryConfigsList = (options) => {
18528
18333
  return (options?.client ?? _heyApiClient).get({
18529
18334
  security: [
@@ -18651,9 +18456,6 @@ export const onboardingCountryConfigsUpdate = (options) => {
18651
18456
  }
18652
18457
  });
18653
18458
  };
18654
- /**
18655
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
18656
- */
18657
18459
  export const onboardingJustificationsList = (options) => {
18658
18460
  return (options?.client ?? _heyApiClient).get({
18659
18461
  security: [
@@ -18873,9 +18675,6 @@ export const onboardingJustificationsCreateJustification = (options) => {
18873
18675
  }
18874
18676
  });
18875
18677
  };
18876
- /**
18877
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
18878
- */
18879
18678
  export const onboardingQuestionMetadataList = (options) => {
18880
18679
  return (options?.client ?? _heyApiClient).get({
18881
18680
  security: [
@@ -19003,9 +18802,6 @@ export const onboardingQuestionMetadataUpdate = (options) => {
19003
18802
  }
19004
18803
  });
19005
18804
  };
19006
- /**
19007
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
19008
- */
19009
18805
  export const onboardingVerificationsList = (options) => {
19010
18806
  return (options?.client ?? _heyApiClient).get({
19011
18807
  security: [
@@ -19312,9 +19108,6 @@ export const onboardingSupportedCountriesRetrieve = (options) => {
19312
19108
  ...options
19313
19109
  });
19314
19110
  };
19315
- /**
19316
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
19317
- */
19318
19111
  export const openportalAllocationUserUsageList = (options) => {
19319
19112
  return (options?.client ?? _heyApiClient).get({
19320
19113
  security: [
@@ -19366,9 +19159,6 @@ export const openportalAllocationUserUsageRetrieve = (options) => {
19366
19159
  ...options
19367
19160
  });
19368
19161
  };
19369
- /**
19370
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
19371
- */
19372
19162
  export const openportalAllocationsList = (options) => {
19373
19163
  return (options?.client ?? _heyApiClient).get({
19374
19164
  security: [
@@ -19496,6 +19286,10 @@ export const openportalAllocationsUpdate = (options) => {
19496
19286
  }
19497
19287
  });
19498
19288
  };
19289
+ /**
19290
+ * Synchronize resource state
19291
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
19292
+ */
19499
19293
  export const openportalAllocationsPull = (options) => {
19500
19294
  return (options.client ?? _heyApiClient).post({
19501
19295
  security: [
@@ -19533,6 +19327,7 @@ export const openportalAllocationsSetLimits = (options) => {
19533
19327
  });
19534
19328
  };
19535
19329
  /**
19330
+ * Unlink resource
19536
19331
  * Delete resource from the database without scheduling operations on backend
19537
19332
  * and without checking current state of the resource. It is intended to be used
19538
19333
  * for removing resource stuck in transitioning state.
@@ -19553,9 +19348,6 @@ export const openportalAllocationsUnlink = (options) => {
19553
19348
  ...options
19554
19349
  });
19555
19350
  };
19556
- /**
19557
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
19558
- */
19559
19351
  export const openportalAssociationsList = (options) => {
19560
19352
  return (options?.client ?? _heyApiClient).get({
19561
19353
  security: [
@@ -19790,9 +19582,6 @@ export const openportalManagedProjectsReject = (options) => {
19790
19582
  }
19791
19583
  });
19792
19584
  };
19793
- /**
19794
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
19795
- */
19796
19585
  export const openportalProjectTemplateList = (options) => {
19797
19586
  return (options?.client ?? _heyApiClient).get({
19798
19587
  security: [
@@ -19948,9 +19737,6 @@ export const openportalProjectTemplateDeleteDestroy = (options) => {
19948
19737
  ...options
19949
19738
  });
19950
19739
  };
19951
- /**
19952
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
19953
- */
19954
19740
  export const openportalProjectinfoList = (options) => {
19955
19741
  return (options?.client ?? _heyApiClient).get({
19956
19742
  security: [
@@ -20118,9 +19904,6 @@ export const openportalProjectinfoSetShortnameUpdate = (options) => {
20118
19904
  }
20119
19905
  });
20120
19906
  };
20121
- /**
20122
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
20123
- */
20124
19907
  export const openportalRemoteAllocationsList = (options) => {
20125
19908
  return (options?.client ?? _heyApiClient).get({
20126
19909
  security: [
@@ -20248,6 +20031,10 @@ export const openportalRemoteAllocationsUpdate = (options) => {
20248
20031
  }
20249
20032
  });
20250
20033
  };
20034
+ /**
20035
+ * Synchronize resource state
20036
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
20037
+ */
20251
20038
  export const openportalRemoteAllocationsPull = (options) => {
20252
20039
  return (options.client ?? _heyApiClient).post({
20253
20040
  security: [
@@ -20285,6 +20072,7 @@ export const openportalRemoteAllocationsSetLimits = (options) => {
20285
20072
  });
20286
20073
  };
20287
20074
  /**
20075
+ * Unlink resource
20288
20076
  * Delete resource from the database without scheduling operations on backend
20289
20077
  * and without checking current state of the resource. It is intended to be used
20290
20078
  * for removing resource stuck in transitioning state.
@@ -20305,9 +20093,6 @@ export const openportalRemoteAllocationsUnlink = (options) => {
20305
20093
  ...options
20306
20094
  });
20307
20095
  };
20308
- /**
20309
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
20310
- */
20311
20096
  export const openportalRemoteAssociationsList = (options) => {
20312
20097
  return (options?.client ?? _heyApiClient).get({
20313
20098
  security: [
@@ -20360,7 +20145,8 @@ export const openportalRemoteAssociationsRetrieve = (options) => {
20360
20145
  });
20361
20146
  };
20362
20147
  /**
20363
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
20148
+ * List projects
20149
+ * Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.
20364
20150
  */
20365
20151
  export const openportalUnmanagedProjectsList = (options) => {
20366
20152
  return (options?.client ?? _heyApiClient).get({
@@ -20379,6 +20165,7 @@ export const openportalUnmanagedProjectsList = (options) => {
20379
20165
  });
20380
20166
  };
20381
20167
  /**
20168
+ * List projects
20382
20169
  * Get number of items in the collection matching the request parameters.
20383
20170
  */
20384
20171
  export const openportalUnmanagedProjectsCount = (options) => {
@@ -20398,8 +20185,8 @@ export const openportalUnmanagedProjectsCount = (options) => {
20398
20185
  });
20399
20186
  };
20400
20187
  /**
20401
- * A new project can be created by users with staff privilege (is_staff=True) or customer owners.
20402
- * Project resource quota is optional.
20188
+ * Create a new project
20189
+ * A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.
20403
20190
  */
20404
20191
  export const openportalUnmanagedProjectsCreate = (options) => {
20405
20192
  return (options.client ?? _heyApiClient).post({
@@ -20422,7 +20209,8 @@ export const openportalUnmanagedProjectsCreate = (options) => {
20422
20209
  });
20423
20210
  };
20424
20211
  /**
20425
- * If a project has connected instances, deletion request will fail with 409 response code.
20212
+ * Delete a project
20213
+ * Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.
20426
20214
  */
20427
20215
  export const openportalUnmanagedProjectsDestroy = (options) => {
20428
20216
  return (options.client ?? _heyApiClient).delete({
@@ -20440,6 +20228,10 @@ export const openportalUnmanagedProjectsDestroy = (options) => {
20440
20228
  ...options
20441
20229
  });
20442
20230
  };
20231
+ /**
20232
+ * Retrieve project details
20233
+ * Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.
20234
+ */
20443
20235
  export const openportalUnmanagedProjectsRetrieve = (options) => {
20444
20236
  return (options.client ?? _heyApiClient).get({
20445
20237
  security: [
@@ -20456,6 +20248,10 @@ export const openportalUnmanagedProjectsRetrieve = (options) => {
20456
20248
  ...options
20457
20249
  });
20458
20250
  };
20251
+ /**
20252
+ * Partially update project details
20253
+ * Partially update the details of a project. Requires project administrator or customer owner permissions.
20254
+ */
20459
20255
  export const openportalUnmanagedProjectsPartialUpdate = (options) => {
20460
20256
  return (options.client ?? _heyApiClient).patch({
20461
20257
  security: [
@@ -20476,6 +20272,10 @@ export const openportalUnmanagedProjectsPartialUpdate = (options) => {
20476
20272
  }
20477
20273
  });
20478
20274
  };
20275
+ /**
20276
+ * Update project details
20277
+ * Update the details of a project. Requires project administrator or customer owner permissions.
20278
+ */
20479
20279
  export const openportalUnmanagedProjectsUpdate = (options) => {
20480
20280
  return (options.client ?? _heyApiClient).put({
20481
20281
  security: [
@@ -20590,6 +20390,10 @@ export const openportalUnmanagedProjectsListUsersList = (options) => {
20590
20390
  ...options
20591
20391
  });
20592
20392
  };
20393
+ /**
20394
+ * Move project to another customer
20395
+ * Moves a project and its associated resources to a different customer. This is a staff-only action. You can choose whether to preserve existing project permissions for users.
20396
+ */
20593
20397
  export const openportalUnmanagedProjectsMoveProject = (options) => {
20594
20398
  return (options.client ?? _heyApiClient).post({
20595
20399
  security: [
@@ -20611,7 +20415,8 @@ export const openportalUnmanagedProjectsMoveProject = (options) => {
20611
20415
  });
20612
20416
  };
20613
20417
  /**
20614
- * Recover a soft-deleted project with team member restoration
20418
+ * Recover a soft-deleted project
20419
+ * Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.
20615
20420
  */
20616
20421
  export const openportalUnmanagedProjectsRecover = (options) => {
20617
20422
  return (options.client ?? _heyApiClient).post({
@@ -20634,7 +20439,8 @@ export const openportalUnmanagedProjectsRecover = (options) => {
20634
20439
  });
20635
20440
  };
20636
20441
  /**
20637
- * Return statistics about project resources usage
20442
+ * Get project resource usage statistics
20443
+ * Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.
20638
20444
  */
20639
20445
  export const openportalUnmanagedProjectsStatsRetrieve = (options) => {
20640
20446
  return (options.client ?? _heyApiClient).get({
@@ -20733,9 +20539,6 @@ export const openportalUnmanagedProjectsChecklistTemplateCount = (options) => {
20733
20539
  ...options
20734
20540
  });
20735
20541
  };
20736
- /**
20737
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
20738
- */
20739
20542
  export const openportalUserinfoList = (options) => {
20740
20543
  return (options?.client ?? _heyApiClient).get({
20741
20544
  security: [
@@ -20918,9 +20721,6 @@ export const openportalUserinfoMeCount = (options) => {
20918
20721
  ...options
20919
20722
  });
20920
20723
  };
20921
- /**
20922
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
20923
- */
20924
20724
  export const openstackBackupsList = (options) => {
20925
20725
  return (options?.client ?? _heyApiClient).get({
20926
20726
  security: [
@@ -21028,6 +20828,10 @@ export const openstackBackupsUpdate = (options) => {
21028
20828
  }
21029
20829
  });
21030
20830
  };
20831
+ /**
20832
+ * Synchronize resource state
20833
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
20834
+ */
21031
20835
  export const openstackBackupsPull = (options) => {
21032
20836
  return (options.client ?? _heyApiClient).post({
21033
20837
  security: [
@@ -21068,6 +20872,7 @@ export const openstackBackupsRestore = (options) => {
21068
20872
  });
21069
20873
  };
21070
20874
  /**
20875
+ * Unlink resource
21071
20876
  * Delete resource from the database without scheduling operations on backend
21072
20877
  * and without checking current state of the resource. It is intended to be used
21073
20878
  * for removing resource stuck in transitioning state.
@@ -21088,9 +20893,6 @@ export const openstackBackupsUnlink = (options) => {
21088
20893
  ...options
21089
20894
  });
21090
20895
  };
21091
- /**
21092
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
21093
- */
21094
20896
  export const openstackFlavorsList = (options) => {
21095
20897
  return (options?.client ?? _heyApiClient).get({
21096
20898
  security: [
@@ -21289,6 +21091,10 @@ export const openstackFloatingIpsDetachFromPort = (options) => {
21289
21091
  ...options
21290
21092
  });
21291
21093
  };
21094
+ /**
21095
+ * Synchronize resource state
21096
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
21097
+ */
21292
21098
  export const openstackFloatingIpsPull = (options) => {
21293
21099
  return (options.client ?? _heyApiClient).post({
21294
21100
  security: [
@@ -21306,6 +21112,7 @@ export const openstackFloatingIpsPull = (options) => {
21306
21112
  });
21307
21113
  };
21308
21114
  /**
21115
+ * Unlink resource
21309
21116
  * Delete resource from the database without scheduling operations on backend
21310
21117
  * and without checking current state of the resource. It is intended to be used
21311
21118
  * for removing resource stuck in transitioning state.
@@ -21349,9 +21156,6 @@ export const openstackFloatingIpsUpdateDescription = (options) => {
21349
21156
  }
21350
21157
  });
21351
21158
  };
21352
- /**
21353
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
21354
- */
21355
21159
  export const openstackImagesList = (options) => {
21356
21160
  return (options?.client ?? _heyApiClient).get({
21357
21161
  security: [
@@ -21438,9 +21242,6 @@ export const openstackImagesUsageStatsCount = (options) => {
21438
21242
  ...options
21439
21243
  });
21440
21244
  };
21441
- /**
21442
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
21443
- */
21444
21245
  export const openstackInstanceAvailabilityZonesList = (options) => {
21445
21246
  return (options?.client ?? _heyApiClient).get({
21446
21247
  security: [
@@ -21492,9 +21293,6 @@ export const openstackInstanceAvailabilityZonesRetrieve = (options) => {
21492
21293
  ...options
21493
21294
  });
21494
21295
  };
21495
- /**
21496
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
21497
- */
21498
21296
  export const openstackInstancesList = (options) => {
21499
21297
  return (options?.client ?? _heyApiClient).get({
21500
21298
  security: [
@@ -21708,6 +21506,10 @@ export const openstackInstancesPortsList = (options) => {
21708
21506
  ...options
21709
21507
  });
21710
21508
  };
21509
+ /**
21510
+ * Synchronize resource state
21511
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
21512
+ */
21711
21513
  export const openstackInstancesPull = (options) => {
21712
21514
  return (options.client ?? _heyApiClient).post({
21713
21515
  security: [
@@ -21782,6 +21584,7 @@ export const openstackInstancesStop = (options) => {
21782
21584
  });
21783
21585
  };
21784
21586
  /**
21587
+ * Unlink resource
21785
21588
  * Delete resource from the database without scheduling operations on backend
21786
21589
  * and without checking current state of the resource. It is intended to be used
21787
21590
  * for removing resource stuck in transitioning state.
@@ -21894,9 +21697,6 @@ export const openstackInstancesUpdateSecurityGroups = (options) => {
21894
21697
  }
21895
21698
  });
21896
21699
  };
21897
- /**
21898
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
21899
- */
21900
21700
  export const openstackMarketplaceTenantsList = (options) => {
21901
21701
  return (options?.client ?? _heyApiClient).get({
21902
21702
  security: [
@@ -21988,9 +21788,6 @@ export const openstackMarketplaceTenantsUploadImageData = (options) => {
21988
21788
  }
21989
21789
  });
21990
21790
  };
21991
- /**
21992
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
21993
- */
21994
21791
  export const openstackMigrationsList = (options) => {
21995
21792
  return (options?.client ?? _heyApiClient).get({
21996
21793
  security: [
@@ -22118,9 +21915,6 @@ export const openstackMigrationsUpdate = (options) => {
22118
21915
  }
22119
21916
  });
22120
21917
  };
22121
- /**
22122
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
22123
- */
22124
21918
  export const openstackNetworkRbacPoliciesList = (options) => {
22125
21919
  return (options?.client ?? _heyApiClient).get({
22126
21920
  security: [
@@ -22254,9 +22048,6 @@ export const openstackNetworkRbacPoliciesUpdate = (options) => {
22254
22048
  }
22255
22049
  });
22256
22050
  };
22257
- /**
22258
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
22259
- */
22260
22051
  export const openstackNetworksList = (options) => {
22261
22052
  return (options?.client ?? _heyApiClient).get({
22262
22053
  security: [
@@ -22384,6 +22175,10 @@ export const openstackNetworksCreateSubnet = (options) => {
22384
22175
  }
22385
22176
  });
22386
22177
  };
22178
+ /**
22179
+ * Synchronize resource state
22180
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
22181
+ */
22387
22182
  export const openstackNetworksPull = (options) => {
22388
22183
  return (options.client ?? _heyApiClient).post({
22389
22184
  security: [
@@ -22463,6 +22258,7 @@ export const openstackNetworksSetMtu = (options) => {
22463
22258
  });
22464
22259
  };
22465
22260
  /**
22261
+ * Unlink resource
22466
22262
  * Delete resource from the database without scheduling operations on backend
22467
22263
  * and without checking current state of the resource. It is intended to be used
22468
22264
  * for removing resource stuck in transitioning state.
@@ -22483,9 +22279,6 @@ export const openstackNetworksUnlink = (options) => {
22483
22279
  ...options
22484
22280
  });
22485
22281
  };
22486
- /**
22487
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
22488
- */
22489
22282
  export const openstackPortsList = (options) => {
22490
22283
  return (options?.client ?? _heyApiClient).get({
22491
22284
  security: [
@@ -22689,6 +22482,10 @@ export const openstackPortsEnablePortSecurity = (options) => {
22689
22482
  ...options
22690
22483
  });
22691
22484
  };
22485
+ /**
22486
+ * Synchronize resource state
22487
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
22488
+ */
22692
22489
  export const openstackPortsPull = (options) => {
22693
22490
  return (options.client ?? _heyApiClient).post({
22694
22491
  security: [
@@ -22706,6 +22503,7 @@ export const openstackPortsPull = (options) => {
22706
22503
  });
22707
22504
  };
22708
22505
  /**
22506
+ * Unlink resource
22709
22507
  * Delete resource from the database without scheduling operations on backend
22710
22508
  * and without checking current state of the resource. It is intended to be used
22711
22509
  * for removing resource stuck in transitioning state.
@@ -22772,9 +22570,6 @@ export const openstackPortsUpdateSecurityGroups = (options) => {
22772
22570
  }
22773
22571
  });
22774
22572
  };
22775
- /**
22776
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
22777
- */
22778
22573
  export const openstackRoutersList = (options) => {
22779
22574
  return (options?.client ?? _heyApiClient).get({
22780
22575
  security: [
@@ -22928,9 +22723,6 @@ export const openstackRoutersSetRoutes = (options) => {
22928
22723
  }
22929
22724
  });
22930
22725
  };
22931
- /**
22932
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
22933
- */
22934
22726
  export const openstackSecurityGroupsList = (options) => {
22935
22727
  return (options?.client ?? _heyApiClient).get({
22936
22728
  security: [
@@ -23038,6 +22830,10 @@ export const openstackSecurityGroupsUpdate = (options) => {
23038
22830
  }
23039
22831
  });
23040
22832
  };
22833
+ /**
22834
+ * Synchronize resource state
22835
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
22836
+ */
23041
22837
  export const openstackSecurityGroupsPull = (options) => {
23042
22838
  return (options.client ?? _heyApiClient).post({
23043
22839
  security: [
@@ -23078,6 +22874,7 @@ export const openstackSecurityGroupsSetRules = (options) => {
23078
22874
  });
23079
22875
  };
23080
22876
  /**
22877
+ * Unlink resource
23081
22878
  * Delete resource from the database without scheduling operations on backend
23082
22879
  * and without checking current state of the resource. It is intended to be used
23083
22880
  * for removing resource stuck in transitioning state.
@@ -23098,9 +22895,6 @@ export const openstackSecurityGroupsUnlink = (options) => {
23098
22895
  ...options
23099
22896
  });
23100
22897
  };
23101
- /**
23102
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
23103
- */
23104
22898
  export const openstackServerGroupsList = (options) => {
23105
22899
  return (options?.client ?? _heyApiClient).get({
23106
22900
  security: [
@@ -23228,6 +23022,10 @@ export const openstackServerGroupsUpdate = (options) => {
23228
23022
  }
23229
23023
  });
23230
23024
  };
23025
+ /**
23026
+ * Synchronize resource state
23027
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
23028
+ */
23231
23029
  export const openstackServerGroupsPull = (options) => {
23232
23030
  return (options.client ?? _heyApiClient).post({
23233
23031
  security: [
@@ -23245,6 +23043,7 @@ export const openstackServerGroupsPull = (options) => {
23245
23043
  });
23246
23044
  };
23247
23045
  /**
23046
+ * Unlink resource
23248
23047
  * Delete resource from the database without scheduling operations on backend
23249
23048
  * and without checking current state of the resource. It is intended to be used
23250
23049
  * for removing resource stuck in transitioning state.
@@ -23265,9 +23064,6 @@ export const openstackServerGroupsUnlink = (options) => {
23265
23064
  ...options
23266
23065
  });
23267
23066
  };
23268
- /**
23269
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
23270
- */
23271
23067
  export const openstackSnapshotsList = (options) => {
23272
23068
  return (options?.client ?? _heyApiClient).get({
23273
23069
  security: [
@@ -23375,6 +23171,10 @@ export const openstackSnapshotsUpdate = (options) => {
23375
23171
  }
23376
23172
  });
23377
23173
  };
23174
+ /**
23175
+ * Synchronize resource state
23176
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
23177
+ */
23378
23178
  export const openstackSnapshotsPull = (options) => {
23379
23179
  return (options.client ?? _heyApiClient).post({
23380
23180
  security: [
@@ -23434,6 +23234,7 @@ export const openstackSnapshotsRestore = (options) => {
23434
23234
  });
23435
23235
  };
23436
23236
  /**
23237
+ * Unlink resource
23437
23238
  * Delete resource from the database without scheduling operations on backend
23438
23239
  * and without checking current state of the resource. It is intended to be used
23439
23240
  * for removing resource stuck in transitioning state.
@@ -23454,9 +23255,6 @@ export const openstackSnapshotsUnlink = (options) => {
23454
23255
  ...options
23455
23256
  });
23456
23257
  };
23457
- /**
23458
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
23459
- */
23460
23258
  export const openstackSubnetsList = (options) => {
23461
23259
  return (options?.client ?? _heyApiClient).get({
23462
23260
  security: [
@@ -23596,6 +23394,10 @@ export const openstackSubnetsDisconnect = (options) => {
23596
23394
  ...options
23597
23395
  });
23598
23396
  };
23397
+ /**
23398
+ * Synchronize resource state
23399
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
23400
+ */
23599
23401
  export const openstackSubnetsPull = (options) => {
23600
23402
  return (options.client ?? _heyApiClient).post({
23601
23403
  security: [
@@ -23613,6 +23415,7 @@ export const openstackSubnetsPull = (options) => {
23613
23415
  });
23614
23416
  };
23615
23417
  /**
23418
+ * Unlink resource
23616
23419
  * Delete resource from the database without scheduling operations on backend
23617
23420
  * and without checking current state of the resource. It is intended to be used
23618
23421
  * for removing resource stuck in transitioning state.
@@ -23633,9 +23436,6 @@ export const openstackSubnetsUnlink = (options) => {
23633
23436
  ...options
23634
23437
  });
23635
23438
  };
23636
- /**
23637
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
23638
- */
23639
23439
  export const openstackTenantsList = (options) => {
23640
23440
  return (options?.client ?? _heyApiClient).get({
23641
23441
  security: [
@@ -23906,6 +23706,10 @@ export const openstackTenantsCreateServerGroup = (options) => {
23906
23706
  }
23907
23707
  });
23908
23708
  };
23709
+ /**
23710
+ * Synchronize resource state
23711
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
23712
+ */
23909
23713
  export const openstackTenantsPull = (options) => {
23910
23714
  return (options.client ?? _heyApiClient).post({
23911
23715
  security: [
@@ -24047,6 +23851,7 @@ export const openstackTenantsSetQuotas = (options) => {
24047
23851
  });
24048
23852
  };
24049
23853
  /**
23854
+ * Unlink resource
24050
23855
  * Delete resource from the database without scheduling operations on backend
24051
23856
  * and without checking current state of the resource. It is intended to be used
24052
23857
  * for removing resource stuck in transitioning state.
@@ -24067,9 +23872,6 @@ export const openstackTenantsUnlink = (options) => {
24067
23872
  ...options
24068
23873
  });
24069
23874
  };
24070
- /**
24071
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24072
- */
24073
23875
  export const openstackVolumeAvailabilityZonesList = (options) => {
24074
23876
  return (options?.client ?? _heyApiClient).get({
24075
23877
  security: [
@@ -24121,9 +23923,6 @@ export const openstackVolumeAvailabilityZonesRetrieve = (options) => {
24121
23923
  ...options
24122
23924
  });
24123
23925
  };
24124
- /**
24125
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24126
- */
24127
23926
  export const openstackVolumeTypesList = (options) => {
24128
23927
  return (options?.client ?? _heyApiClient).get({
24129
23928
  security: [
@@ -24213,9 +24012,6 @@ export const openstackVolumeTypesNamesCount = (options) => {
24213
24012
  ...options
24214
24013
  });
24215
24014
  };
24216
- /**
24217
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24218
- */
24219
24015
  export const openstackVolumesList = (options) => {
24220
24016
  return (options?.client ?? _heyApiClient).get({
24221
24017
  security: [
@@ -24372,6 +24168,10 @@ export const openstackVolumesExtend = (options) => {
24372
24168
  }
24373
24169
  });
24374
24170
  };
24171
+ /**
24172
+ * Synchronize resource state
24173
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
24174
+ */
24375
24175
  export const openstackVolumesPull = (options) => {
24376
24176
  return (options.client ?? _heyApiClient).post({
24377
24177
  security: [
@@ -24435,6 +24235,7 @@ export const openstackVolumesSnapshot = (options) => {
24435
24235
  });
24436
24236
  };
24437
24237
  /**
24238
+ * Unlink resource
24438
24239
  * Delete resource from the database without scheduling operations on backend
24439
24240
  * and without checking current state of the resource. It is intended to be used
24440
24241
  * for removing resource stuck in transitioning state.
@@ -24455,9 +24256,6 @@ export const openstackVolumesUnlink = (options) => {
24455
24256
  ...options
24456
24257
  });
24457
24258
  };
24458
- /**
24459
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24460
- */
24461
24259
  export const organizationGroupsList = (options) => {
24462
24260
  return (options?.client ?? _heyApiClient).get({
24463
24261
  security: [
@@ -24585,6 +24383,10 @@ export const organizationGroupsUpdate = (options) => {
24585
24383
  }
24586
24384
  });
24587
24385
  };
24386
+ /**
24387
+ * Get all overridable settings
24388
+ * Returns all settings that can be overridden in the database via the Constance backend. Requires admin permissions.
24389
+ */
24588
24390
  export const overrideSettingsRetrieve = (options) => {
24589
24391
  return (options?.client ?? _heyApiClient).get({
24590
24392
  security: [
@@ -24601,6 +24403,10 @@ export const overrideSettingsRetrieve = (options) => {
24601
24403
  ...options
24602
24404
  });
24603
24405
  };
24406
+ /**
24407
+ * Update overridable settings
24408
+ * Updates one or more settings in the database via the Constance backend. Requires admin permissions.
24409
+ */
24604
24410
  export const overrideSettings = (options) => {
24605
24411
  return (options?.client ?? _heyApiClient).post({
24606
24412
  security: [
@@ -24621,9 +24427,6 @@ export const overrideSettings = (options) => {
24621
24427
  }
24622
24428
  });
24623
24429
  };
24624
- /**
24625
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24626
- */
24627
24430
  export const paymentProfilesList = (options) => {
24628
24431
  return (options?.client ?? _heyApiClient).get({
24629
24432
  security: [
@@ -24767,9 +24570,6 @@ export const paymentProfilesEnable = (options) => {
24767
24570
  ...options
24768
24571
  });
24769
24572
  };
24770
- /**
24771
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24772
- */
24773
24573
  export const paymentsList = (options) => {
24774
24574
  return (options?.client ?? _heyApiClient).get({
24775
24575
  security: [
@@ -24939,9 +24739,6 @@ export const paymentsUnlinkFromInvoice = (options) => {
24939
24739
  ...options
24940
24740
  });
24941
24741
  };
24942
- /**
24943
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24944
- */
24945
24742
  export const projectCreditsList = (options) => {
24946
24743
  return (options?.client ?? _heyApiClient).get({
24947
24744
  security: [
@@ -25069,9 +24866,6 @@ export const projectCreditsUpdate = (options) => {
25069
24866
  }
25070
24867
  });
25071
24868
  };
25072
- /**
25073
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
25074
- */
25075
24869
  export const projectPermissionsReviewsList = (options) => {
25076
24870
  return (options?.client ?? _heyApiClient).get({
25077
24871
  security: [
@@ -25124,6 +24918,7 @@ export const projectPermissionsReviewsRetrieve = (options) => {
25124
24918
  });
25125
24919
  };
25126
24920
  /**
24921
+ * Close project permission review
25127
24922
  * Complete project permission review.
25128
24923
  */
25129
24924
  export const projectPermissionsReviewsClose = (options) => {
@@ -25181,7 +24976,8 @@ export const projectQuotasCount = (options) => {
25181
24976
  });
25182
24977
  };
25183
24978
  /**
25184
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
24979
+ * List project types
24980
+ * Retrieve a list of available project types.
25185
24981
  */
25186
24982
  export const projectTypesList = (options) => {
25187
24983
  return (options?.client ?? _heyApiClient).get({
@@ -25200,6 +24996,7 @@ export const projectTypesList = (options) => {
25200
24996
  });
25201
24997
  };
25202
24998
  /**
24999
+ * List project types
25203
25000
  * Get number of items in the collection matching the request parameters.
25204
25001
  */
25205
25002
  export const projectTypesCount = (options) => {
@@ -25218,6 +25015,10 @@ export const projectTypesCount = (options) => {
25218
25015
  ...options
25219
25016
  });
25220
25017
  };
25018
+ /**
25019
+ * Retrieve project type details
25020
+ * Fetch details of a specific project type by its UUID.
25021
+ */
25221
25022
  export const projectTypesRetrieve = (options) => {
25222
25023
  return (options.client ?? _heyApiClient).get({
25223
25024
  security: [
@@ -25235,7 +25036,8 @@ export const projectTypesRetrieve = (options) => {
25235
25036
  });
25236
25037
  };
25237
25038
  /**
25238
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
25039
+ * List projects
25040
+ * Retrieve a list of projects. The list is filtered based on the user's permissions. By default, only active projects are shown.
25239
25041
  */
25240
25042
  export const projectsList = (options) => {
25241
25043
  return (options?.client ?? _heyApiClient).get({
@@ -25254,6 +25056,7 @@ export const projectsList = (options) => {
25254
25056
  });
25255
25057
  };
25256
25058
  /**
25059
+ * List projects
25257
25060
  * Get number of items in the collection matching the request parameters.
25258
25061
  */
25259
25062
  export const projectsCount = (options) => {
@@ -25273,8 +25076,8 @@ export const projectsCount = (options) => {
25273
25076
  });
25274
25077
  };
25275
25078
  /**
25276
- * A new project can be created by users with staff privilege (is_staff=True) or customer owners.
25277
- * Project resource quota is optional.
25079
+ * Create a new project
25080
+ * A new project can be created by users with staff privilege (is_staff=True) or customer owners. Project resource quota is optional.
25278
25081
  */
25279
25082
  export const projectsCreate = (options) => {
25280
25083
  return (options.client ?? _heyApiClient).post({
@@ -25316,7 +25119,8 @@ export const projectsOtherUsersList = (options) => {
25316
25119
  });
25317
25120
  };
25318
25121
  /**
25319
- * If a project has connected instances, deletion request will fail with 409 response code.
25122
+ * Delete a project
25123
+ * Delete a project. If the project has any active resources, the deletion request will fail with a 409 Conflict response. This action performs a soft-delete, and the project can be recovered later.
25320
25124
  */
25321
25125
  export const projectsDestroy = (options) => {
25322
25126
  return (options.client ?? _heyApiClient).delete({
@@ -25334,6 +25138,10 @@ export const projectsDestroy = (options) => {
25334
25138
  ...options
25335
25139
  });
25336
25140
  };
25141
+ /**
25142
+ * Retrieve project details
25143
+ * Fetch the details of a specific project by its UUID. Users can access details of terminated projects they previously had access to.
25144
+ */
25337
25145
  export const projectsRetrieve = (options) => {
25338
25146
  return (options.client ?? _heyApiClient).get({
25339
25147
  security: [
@@ -25350,6 +25158,10 @@ export const projectsRetrieve = (options) => {
25350
25158
  ...options
25351
25159
  });
25352
25160
  };
25161
+ /**
25162
+ * Partially update project details
25163
+ * Partially update the details of a project. Requires project administrator or customer owner permissions.
25164
+ */
25353
25165
  export const projectsPartialUpdate = (options) => {
25354
25166
  return (options.client ?? _heyApiClient).patch({
25355
25167
  security: [
@@ -25370,6 +25182,10 @@ export const projectsPartialUpdate = (options) => {
25370
25182
  }
25371
25183
  });
25372
25184
  };
25185
+ /**
25186
+ * Update project details
25187
+ * Update the details of a project. Requires project administrator or customer owner permissions.
25188
+ */
25373
25189
  export const projectsUpdate = (options) => {
25374
25190
  return (options.client ?? _heyApiClient).put({
25375
25191
  security: [
@@ -25484,6 +25300,10 @@ export const projectsListUsersList = (options) => {
25484
25300
  ...options
25485
25301
  });
25486
25302
  };
25303
+ /**
25304
+ * Move project to another customer
25305
+ * Moves a project and its associated resources to a different customer. This is a staff-only action. You can choose whether to preserve existing project permissions for users.
25306
+ */
25487
25307
  export const projectsMoveProject = (options) => {
25488
25308
  return (options.client ?? _heyApiClient).post({
25489
25309
  security: [
@@ -25505,7 +25325,8 @@ export const projectsMoveProject = (options) => {
25505
25325
  });
25506
25326
  };
25507
25327
  /**
25508
- * Recover a soft-deleted project with team member restoration
25328
+ * Recover a soft-deleted project
25329
+ * Recovers a soft-deleted (terminated) project, making it active again. Provides options to restore previous team members automatically (staff-only) or send them new invitations.
25509
25330
  */
25510
25331
  export const projectsRecover = (options) => {
25511
25332
  return (options.client ?? _heyApiClient).post({
@@ -25528,7 +25349,8 @@ export const projectsRecover = (options) => {
25528
25349
  });
25529
25350
  };
25530
25351
  /**
25531
- * Return statistics about project resources usage
25352
+ * Get project resource usage statistics
25353
+ * Provides statistics about the resource usage (e.g., CPU, RAM, storage) for all resources within a project. Can be filtered to show usage for the current month only.
25532
25354
  */
25533
25355
  export const projectsStatsRetrieve = (options) => {
25534
25356
  return (options.client ?? _heyApiClient).get({
@@ -25646,9 +25468,6 @@ export const projectsChecklistTemplateCount = (options) => {
25646
25468
  ...options
25647
25469
  });
25648
25470
  };
25649
- /**
25650
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
25651
- */
25652
25471
  export const promotionsCampaignsList = (options) => {
25653
25472
  return (options?.client ?? _heyApiClient).get({
25654
25473
  security: [
@@ -25832,9 +25651,6 @@ export const promotionsCampaignsTerminate = (options) => {
25832
25651
  ...options
25833
25652
  });
25834
25653
  };
25835
- /**
25836
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
25837
- */
25838
25654
  export const proposalProposalsList = (options) => {
25839
25655
  return (options?.client ?? _heyApiClient).get({
25840
25656
  security: [
@@ -26360,9 +26176,6 @@ export const proposalProposalsChecklistTemplateCount = (options) => {
26360
26176
  ...options
26361
26177
  });
26362
26178
  };
26363
- /**
26364
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
26365
- */
26366
26179
  export const proposalProtectedCallsList = (options) => {
26367
26180
  return (options?.client ?? _heyApiClient).get({
26368
26181
  security: [
@@ -27073,9 +26886,6 @@ export const proposalProtectedCallsUpdateUser = (options) => {
27073
26886
  }
27074
26887
  });
27075
26888
  };
27076
- /**
27077
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27078
- */
27079
26889
  export const proposalPublicCallsList = (options) => {
27080
26890
  return (options?.client ?? _heyApiClient).get({
27081
26891
  security: [
@@ -27127,9 +26937,6 @@ export const proposalPublicCallsRetrieve = (options) => {
27127
26937
  ...options
27128
26938
  });
27129
26939
  };
27130
- /**
27131
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27132
- */
27133
26940
  export const proposalRequestedOfferingsList = (options) => {
27134
26941
  return (options?.client ?? _heyApiClient).get({
27135
26942
  security: [
@@ -27219,9 +27026,6 @@ export const proposalRequestedOfferingsCancel = (options) => {
27219
27026
  ...options
27220
27027
  });
27221
27028
  };
27222
- /**
27223
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27224
- */
27225
27029
  export const proposalRequestedResourcesList = (options) => {
27226
27030
  return (options?.client ?? _heyApiClient).get({
27227
27031
  security: [
@@ -27273,9 +27077,6 @@ export const proposalRequestedResourcesRetrieve = (options) => {
27273
27077
  ...options
27274
27078
  });
27275
27079
  };
27276
- /**
27277
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27278
- */
27279
27080
  export const proposalReviewsList = (options) => {
27280
27081
  return (options?.client ?? _heyApiClient).get({
27281
27082
  security: [
@@ -27464,9 +27265,6 @@ export const proposalReviewsSubmit = (options) => {
27464
27265
  }
27465
27266
  });
27466
27267
  };
27467
- /**
27468
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27469
- */
27470
27268
  export const providerInvoiceItemsList = (options) => {
27471
27269
  return (options?.client ?? _heyApiClient).get({
27472
27270
  security: [
@@ -27518,9 +27316,6 @@ export const providerInvoiceItemsRetrieve = (options) => {
27518
27316
  ...options
27519
27317
  });
27520
27318
  };
27521
- /**
27522
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27523
- */
27524
27319
  export const publicMaintenanceAnnouncementsList = (options) => {
27525
27320
  return (options?.client ?? _heyApiClient).get({
27526
27321
  security: [
@@ -27573,7 +27368,8 @@ export const publicMaintenanceAnnouncementsRetrieve = (options) => {
27573
27368
  });
27574
27369
  };
27575
27370
  /**
27576
- * Execute SQL query against readonly database
27371
+ * Execute read-only SQL query
27372
+ * Execute a given SQL query against a read-only database replica. This is a powerful tool for diagnostics and reporting, but should be used with caution. Requires support user permissions.
27577
27373
  */
27578
27374
  export const query = (options) => {
27579
27375
  return (options.client ?? _heyApiClient).post({
@@ -27627,9 +27423,6 @@ export const rabbitmqVhostStatsList = (options) => {
27627
27423
  ...options
27628
27424
  });
27629
27425
  };
27630
- /**
27631
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27632
- */
27633
27426
  export const rancherAppsList = (options) => {
27634
27427
  return (options?.client ?? _heyApiClient).get({
27635
27428
  security: [
@@ -27757,6 +27550,10 @@ export const rancherAppsUpdate = (options) => {
27757
27550
  }
27758
27551
  });
27759
27552
  };
27553
+ /**
27554
+ * Synchronize resource state
27555
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
27556
+ */
27760
27557
  export const rancherAppsPull = (options) => {
27761
27558
  return (options.client ?? _heyApiClient).post({
27762
27559
  security: [
@@ -27774,6 +27571,7 @@ export const rancherAppsPull = (options) => {
27774
27571
  });
27775
27572
  };
27776
27573
  /**
27574
+ * Unlink resource
27777
27575
  * Delete resource from the database without scheduling operations on backend
27778
27576
  * and without checking current state of the resource. It is intended to be used
27779
27577
  * for removing resource stuck in transitioning state.
@@ -27794,9 +27592,6 @@ export const rancherAppsUnlink = (options) => {
27794
27592
  ...options
27795
27593
  });
27796
27594
  };
27797
- /**
27798
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27799
- */
27800
27595
  export const rancherCatalogsList = (options) => {
27801
27596
  return (options?.client ?? _heyApiClient).get({
27802
27597
  security: [
@@ -27944,9 +27739,6 @@ export const rancherCatalogsRefresh = (options) => {
27944
27739
  }
27945
27740
  });
27946
27741
  };
27947
- /**
27948
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
27949
- */
27950
27742
  export const rancherClusterSecurityGroupsList = (options) => {
27951
27743
  return (options?.client ?? _heyApiClient).get({
27952
27744
  security: [
@@ -28038,9 +27830,6 @@ export const rancherClusterSecurityGroupsUpdate = (options) => {
28038
27830
  }
28039
27831
  });
28040
27832
  };
28041
- /**
28042
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
28043
- */
28044
27833
  export const rancherClusterTemplatesList = (options) => {
28045
27834
  return (options?.client ?? _heyApiClient).get({
28046
27835
  security: [
@@ -28092,9 +27881,6 @@ export const rancherClusterTemplatesRetrieve = (options) => {
28092
27881
  ...options
28093
27882
  });
28094
27883
  };
28095
- /**
28096
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
28097
- */
28098
27884
  export const rancherClustersList = (options) => {
28099
27885
  return (options?.client ?? _heyApiClient).get({
28100
27886
  security: [
@@ -28226,6 +28012,10 @@ export const rancherClustersImportYaml = (options) => {
28226
28012
  }
28227
28013
  });
28228
28014
  };
28015
+ /**
28016
+ * Synchronize resource state
28017
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
28018
+ */
28229
28019
  export const rancherClustersPull = (options) => {
28230
28020
  return (options.client ?? _heyApiClient).post({
28231
28021
  security: [
@@ -28243,6 +28033,7 @@ export const rancherClustersPull = (options) => {
28243
28033
  });
28244
28034
  };
28245
28035
  /**
28036
+ * Unlink resource
28246
28037
  * Delete resource from the database without scheduling operations on backend
28247
28038
  * and without checking current state of the resource. It is intended to be used
28248
28039
  * for removing resource stuck in transitioning state.
@@ -28263,9 +28054,6 @@ export const rancherClustersUnlink = (options) => {
28263
28054
  ...options
28264
28055
  });
28265
28056
  };
28266
- /**
28267
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
28268
- */
28269
28057
  export const rancherHpasList = (options) => {
28270
28058
  return (options?.client ?? _heyApiClient).get({
28271
28059
  security: [
@@ -28393,6 +28181,10 @@ export const rancherHpasUpdate = (options) => {
28393
28181
  }
28394
28182
  });
28395
28183
  };
28184
+ /**
28185
+ * Synchronize resource state
28186
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
28187
+ */
28396
28188
  export const rancherHpasPull = (options) => {
28397
28189
  return (options.client ?? _heyApiClient).post({
28398
28190
  security: [
@@ -28410,6 +28202,7 @@ export const rancherHpasPull = (options) => {
28410
28202
  });
28411
28203
  };
28412
28204
  /**
28205
+ * Unlink resource
28413
28206
  * Delete resource from the database without scheduling operations on backend
28414
28207
  * and without checking current state of the resource. It is intended to be used
28415
28208
  * for removing resource stuck in transitioning state.
@@ -28466,9 +28259,6 @@ export const rancherHpasYamlUpdate = (options) => {
28466
28259
  }
28467
28260
  });
28468
28261
  };
28469
- /**
28470
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
28471
- */
28472
28262
  export const rancherIngressesList = (options) => {
28473
28263
  return (options?.client ?? _heyApiClient).get({
28474
28264
  security: [
@@ -28596,6 +28386,10 @@ export const rancherIngressesUpdate = (options) => {
28596
28386
  }
28597
28387
  });
28598
28388
  };
28389
+ /**
28390
+ * Synchronize resource state
28391
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
28392
+ */
28599
28393
  export const rancherIngressesPull = (options) => {
28600
28394
  return (options.client ?? _heyApiClient).post({
28601
28395
  security: [
@@ -28613,6 +28407,7 @@ export const rancherIngressesPull = (options) => {
28613
28407
  });
28614
28408
  };
28615
28409
  /**
28410
+ * Unlink resource
28616
28411
  * Delete resource from the database without scheduling operations on backend
28617
28412
  * and without checking current state of the resource. It is intended to be used
28618
28413
  * for removing resource stuck in transitioning state.
@@ -28669,9 +28464,6 @@ export const rancherIngressesYamlUpdate = (options) => {
28669
28464
  }
28670
28465
  });
28671
28466
  };
28672
- /**
28673
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
28674
- */
28675
28467
  export const rancherNamespacesList = (options) => {
28676
28468
  return (options?.client ?? _heyApiClient).get({
28677
28469
  security: [
@@ -28723,9 +28515,6 @@ export const rancherNamespacesRetrieve = (options) => {
28723
28515
  ...options
28724
28516
  });
28725
28517
  };
28726
- /**
28727
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
28728
- */
28729
28518
  export const rancherNodesList = (options) => {
28730
28519
  return (options?.client ?? _heyApiClient).get({
28731
28520
  security: [
@@ -28874,6 +28663,10 @@ export const rancherNodesLinkOpenstack = (options) => {
28874
28663
  }
28875
28664
  });
28876
28665
  };
28666
+ /**
28667
+ * Synchronize resource state
28668
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
28669
+ */
28877
28670
  export const rancherNodesPull = (options) => {
28878
28671
  return (options.client ?? _heyApiClient).post({
28879
28672
  security: [
@@ -28891,6 +28684,7 @@ export const rancherNodesPull = (options) => {
28891
28684
  });
28892
28685
  };
28893
28686
  /**
28687
+ * Unlink resource
28894
28688
  * Delete resource from the database without scheduling operations on backend
28895
28689
  * and without checking current state of the resource. It is intended to be used
28896
28690
  * for removing resource stuck in transitioning state.
@@ -28930,9 +28724,6 @@ export const rancherNodesUnlinkOpenstack = (options) => {
28930
28724
  ...options
28931
28725
  });
28932
28726
  };
28933
- /**
28934
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
28935
- */
28936
28727
  export const rancherProjectsList = (options) => {
28937
28728
  return (options?.client ?? _heyApiClient).get({
28938
28729
  security: [
@@ -29003,9 +28794,6 @@ export const rancherProjectsSecretsRetrieve = (options) => {
29003
28794
  ...options
29004
28795
  });
29005
28796
  };
29006
- /**
29007
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
29008
- */
29009
28797
  export const rancherRoleTemplatesList = (options) => {
29010
28798
  return (options?.client ?? _heyApiClient).get({
29011
28799
  security: [
@@ -29057,9 +28845,6 @@ export const rancherRoleTemplatesRetrieve = (options) => {
29057
28845
  ...options
29058
28846
  });
29059
28847
  };
29060
- /**
29061
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
29062
- */
29063
28848
  export const rancherServicesList = (options) => {
29064
28849
  return (options?.client ?? _heyApiClient).get({
29065
28850
  security: [
@@ -29187,6 +28972,10 @@ export const rancherServicesUpdate = (options) => {
29187
28972
  }
29188
28973
  });
29189
28974
  };
28975
+ /**
28976
+ * Synchronize resource state
28977
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
28978
+ */
29190
28979
  export const rancherServicesPull = (options) => {
29191
28980
  return (options.client ?? _heyApiClient).post({
29192
28981
  security: [
@@ -29204,6 +28993,7 @@ export const rancherServicesPull = (options) => {
29204
28993
  });
29205
28994
  };
29206
28995
  /**
28996
+ * Unlink resource
29207
28997
  * Delete resource from the database without scheduling operations on backend
29208
28998
  * and without checking current state of the resource. It is intended to be used
29209
28999
  * for removing resource stuck in transitioning state.
@@ -29276,9 +29066,6 @@ export const rancherTemplateVersionsRetrieve = (options) => {
29276
29066
  ...options
29277
29067
  });
29278
29068
  };
29279
- /**
29280
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
29281
- */
29282
29069
  export const rancherTemplatesList = (options) => {
29283
29070
  return (options?.client ?? _heyApiClient).get({
29284
29071
  security: [
@@ -29330,9 +29117,6 @@ export const rancherTemplatesRetrieve = (options) => {
29330
29117
  ...options
29331
29118
  });
29332
29119
  };
29333
- /**
29334
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
29335
- */
29336
29120
  export const rancherUsersList = (options) => {
29337
29121
  return (options?.client ?? _heyApiClient).get({
29338
29122
  security: [
@@ -29384,9 +29168,6 @@ export const rancherUsersRetrieve = (options) => {
29384
29168
  ...options
29385
29169
  });
29386
29170
  };
29387
- /**
29388
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
29389
- */
29390
29171
  export const rancherWorkloadsList = (options) => {
29391
29172
  return (options?.client ?? _heyApiClient).get({
29392
29173
  security: [
@@ -29952,9 +29733,6 @@ export const remoteWaldurApiSyncResourceProjectPermissions = (options) => {
29952
29733
  ...options
29953
29734
  });
29954
29735
  };
29955
- /**
29956
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
29957
- */
29958
29736
  export const rolesList = (options) => {
29959
29737
  return (options?.client ?? _heyApiClient).get({
29960
29738
  security: [
@@ -30134,9 +29912,6 @@ export const rolesUpdateDescriptionsUpdate = (options) => {
30134
29912
  }
30135
29913
  });
30136
29914
  };
30137
- /**
30138
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30139
- */
30140
29915
  export const serviceSettingsList = (options) => {
30141
29916
  return (options?.client ?? _heyApiClient).get({
30142
29917
  security: [
@@ -30188,9 +29963,6 @@ export const serviceSettingsRetrieve = (options) => {
30188
29963
  ...options
30189
29964
  });
30190
29965
  };
30191
- /**
30192
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30193
- */
30194
29966
  export const slurmAllocationUserUsageList = (options) => {
30195
29967
  return (options?.client ?? _heyApiClient).get({
30196
29968
  security: [
@@ -30242,9 +30014,6 @@ export const slurmAllocationUserUsageRetrieve = (options) => {
30242
30014
  ...options
30243
30015
  });
30244
30016
  };
30245
- /**
30246
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30247
- */
30248
30017
  export const slurmAllocationsList = (options) => {
30249
30018
  return (options?.client ?? _heyApiClient).get({
30250
30019
  security: [
@@ -30372,6 +30141,10 @@ export const slurmAllocationsUpdate = (options) => {
30372
30141
  }
30373
30142
  });
30374
30143
  };
30144
+ /**
30145
+ * Synchronize resource state
30146
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
30147
+ */
30375
30148
  export const slurmAllocationsPull = (options) => {
30376
30149
  return (options.client ?? _heyApiClient).post({
30377
30150
  security: [
@@ -30409,6 +30182,7 @@ export const slurmAllocationsSetLimits = (options) => {
30409
30182
  });
30410
30183
  };
30411
30184
  /**
30185
+ * Unlink resource
30412
30186
  * Delete resource from the database without scheduling operations on backend
30413
30187
  * and without checking current state of the resource. It is intended to be used
30414
30188
  * for removing resource stuck in transitioning state.
@@ -30429,9 +30203,6 @@ export const slurmAllocationsUnlink = (options) => {
30429
30203
  ...options
30430
30204
  });
30431
30205
  };
30432
- /**
30433
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30434
- */
30435
30206
  export const slurmAssociationsList = (options) => {
30436
30207
  return (options?.client ?? _heyApiClient).get({
30437
30208
  security: [
@@ -30483,9 +30254,6 @@ export const slurmAssociationsRetrieve = (options) => {
30483
30254
  ...options
30484
30255
  });
30485
30256
  };
30486
- /**
30487
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30488
- */
30489
30257
  export const slurmJobsList = (options) => {
30490
30258
  return (options?.client ?? _heyApiClient).get({
30491
30259
  security: [
@@ -30613,6 +30381,10 @@ export const slurmJobsUpdate = (options) => {
30613
30381
  }
30614
30382
  });
30615
30383
  };
30384
+ /**
30385
+ * Synchronize resource state
30386
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
30387
+ */
30616
30388
  export const slurmJobsPull = (options) => {
30617
30389
  return (options.client ?? _heyApiClient).post({
30618
30390
  security: [
@@ -30630,6 +30402,7 @@ export const slurmJobsPull = (options) => {
30630
30402
  });
30631
30403
  };
30632
30404
  /**
30405
+ * Unlink resource
30633
30406
  * Delete resource from the database without scheduling operations on backend
30634
30407
  * and without checking current state of the resource. It is intended to be used
30635
30408
  * for removing resource stuck in transitioning state.
@@ -30650,9 +30423,6 @@ export const slurmJobsUnlink = (options) => {
30650
30423
  ...options
30651
30424
  });
30652
30425
  };
30653
- /**
30654
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30655
- */
30656
30426
  export const supportAttachmentsList = (options) => {
30657
30427
  return (options?.client ?? _heyApiClient).get({
30658
30428
  security: [
@@ -30740,9 +30510,6 @@ export const supportAttachmentsRetrieve = (options) => {
30740
30510
  ...options
30741
30511
  });
30742
30512
  };
30743
- /**
30744
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30745
- */
30746
30513
  export const supportCommentsList = (options) => {
30747
30514
  return (options?.client ?? _heyApiClient).get({
30748
30515
  security: [
@@ -30882,9 +30649,6 @@ export const supportFeedbackReportRetrieve = (options) => {
30882
30649
  ...options
30883
30650
  });
30884
30651
  };
30885
- /**
30886
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30887
- */
30888
30652
  export const supportFeedbacksList = (options) => {
30889
30653
  return (options?.client ?? _heyApiClient).get({
30890
30654
  security: [
@@ -30956,9 +30720,6 @@ export const supportFeedbacksRetrieve = (options) => {
30956
30720
  ...options
30957
30721
  });
30958
30722
  };
30959
- /**
30960
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
30961
- */
30962
30723
  export const supportIssueStatusesList = (options) => {
30963
30724
  return (options?.client ?? _heyApiClient).get({
30964
30725
  security: [
@@ -31086,9 +30847,6 @@ export const supportIssueStatusesUpdate = (options) => {
31086
30847
  }
31087
30848
  });
31088
30849
  };
31089
- /**
31090
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31091
- */
31092
30850
  export const supportIssuesList = (options) => {
31093
30851
  return (options?.client ?? _heyApiClient).get({
31094
30852
  security: [
@@ -31266,9 +31024,6 @@ export const supportJiraWebhook = (options) => {
31266
31024
  }
31267
31025
  });
31268
31026
  };
31269
- /**
31270
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31271
- */
31272
31027
  export const supportPrioritiesList = (options) => {
31273
31028
  return (options?.client ?? _heyApiClient).get({
31274
31029
  security: [
@@ -31346,9 +31101,6 @@ export const supportStatisticsRetrieve = (options) => {
31346
31101
  ...options
31347
31102
  });
31348
31103
  };
31349
- /**
31350
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31351
- */
31352
31104
  export const supportTemplatesList = (options) => {
31353
31105
  return (options?.client ?? _heyApiClient).get({
31354
31106
  security: [
@@ -31519,9 +31271,6 @@ export const supportTemplatesDeleteAttachments = (options) => {
31519
31271
  }
31520
31272
  });
31521
31273
  };
31522
- /**
31523
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31524
- */
31525
31274
  export const supportUsersList = (options) => {
31526
31275
  return (options?.client ?? _heyApiClient).get({
31527
31276
  security: [
@@ -31617,9 +31366,6 @@ export const syncIssues = (options) => {
31617
31366
  ...options
31618
31367
  });
31619
31368
  };
31620
- /**
31621
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31622
- */
31623
31369
  export const userAgreementsList = (options) => {
31624
31370
  return (options?.client ?? _heyApiClient).get({
31625
31371
  security: [
@@ -31748,7 +31494,8 @@ export const userAgreementsUpdate = (options) => {
31748
31494
  });
31749
31495
  };
31750
31496
  /**
31751
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31497
+ * List group invitations
31498
+ * Retrieve a list of group invitations. Unauthenticated users can only see public invitations.
31752
31499
  */
31753
31500
  export const userGroupInvitationsList = (options) => {
31754
31501
  return (options?.client ?? _heyApiClient).get({
@@ -31767,6 +31514,7 @@ export const userGroupInvitationsList = (options) => {
31767
31514
  });
31768
31515
  };
31769
31516
  /**
31517
+ * List group invitations
31770
31518
  * Get number of items in the collection matching the request parameters.
31771
31519
  */
31772
31520
  export const userGroupInvitationsCount = (options) => {
@@ -31785,6 +31533,10 @@ export const userGroupInvitationsCount = (options) => {
31785
31533
  ...options
31786
31534
  });
31787
31535
  };
31536
+ /**
31537
+ * Create group invitation
31538
+ * Create a new group invitation, which acts as a template for users to request permissions.
31539
+ */
31788
31540
  export const userGroupInvitationsCreate = (options) => {
31789
31541
  return (options.client ?? _heyApiClient).post({
31790
31542
  security: [
@@ -31805,6 +31557,10 @@ export const userGroupInvitationsCreate = (options) => {
31805
31557
  }
31806
31558
  });
31807
31559
  };
31560
+ /**
31561
+ * Retrieve group invitation
31562
+ * Retrieve details of a specific group invitation. Unauthenticated users can only see public invitations.
31563
+ */
31808
31564
  export const userGroupInvitationsRetrieve = (options) => {
31809
31565
  return (options.client ?? _heyApiClient).get({
31810
31566
  security: [
@@ -31822,7 +31578,8 @@ export const userGroupInvitationsRetrieve = (options) => {
31822
31578
  });
31823
31579
  };
31824
31580
  /**
31825
- * Cancel group invitation
31581
+ * Cancel a group invitation
31582
+ * Cancels an active group invitation, preventing new permission requests from being created.
31826
31583
  */
31827
31584
  export const userGroupInvitationsCancel = (options) => {
31828
31585
  return (options.client ?? _heyApiClient).post({
@@ -31841,7 +31598,8 @@ export const userGroupInvitationsCancel = (options) => {
31841
31598
  });
31842
31599
  };
31843
31600
  /**
31844
- * Return projects for group invitation
31601
+ * List projects for a customer-scoped group invitation
31602
+ * For a group invitation scoped to a customer, this endpoint lists all projects within that customer.
31845
31603
  */
31846
31604
  export const userGroupInvitationsProjectsList = (options) => {
31847
31605
  return (options.client ?? _heyApiClient).get({
@@ -31859,6 +31617,10 @@ export const userGroupInvitationsProjectsList = (options) => {
31859
31617
  ...options
31860
31618
  });
31861
31619
  };
31620
+ /**
31621
+ * Submit a permission request
31622
+ * Creates a permission request based on a group invitation for the currently authenticated user.
31623
+ */
31862
31624
  export const userGroupInvitationsSubmitRequest = (options) => {
31863
31625
  return (options.client ?? _heyApiClient).post({
31864
31626
  security: [
@@ -31876,7 +31638,8 @@ export const userGroupInvitationsSubmitRequest = (options) => {
31876
31638
  });
31877
31639
  };
31878
31640
  /**
31879
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31641
+ * List user invitations
31642
+ * Retrieve a list of user invitations visible to the current user.
31880
31643
  */
31881
31644
  export const userInvitationsList = (options) => {
31882
31645
  return (options?.client ?? _heyApiClient).get({
@@ -31895,6 +31658,7 @@ export const userInvitationsList = (options) => {
31895
31658
  });
31896
31659
  };
31897
31660
  /**
31661
+ * List user invitations
31898
31662
  * Get number of items in the collection matching the request parameters.
31899
31663
  */
31900
31664
  export const userInvitationsCount = (options) => {
@@ -31913,6 +31677,10 @@ export const userInvitationsCount = (options) => {
31913
31677
  ...options
31914
31678
  });
31915
31679
  };
31680
+ /**
31681
+ * Create user invitation
31682
+ * Create a new user invitation to grant a role in a specific scope (e.g., organization or project).
31683
+ */
31916
31684
  export const userInvitationsCreate = (options) => {
31917
31685
  return (options.client ?? _heyApiClient).post({
31918
31686
  security: [
@@ -31933,6 +31701,10 @@ export const userInvitationsCreate = (options) => {
31933
31701
  }
31934
31702
  });
31935
31703
  };
31704
+ /**
31705
+ * Retrieve user invitation
31706
+ * Retrieve details of a specific user invitation.
31707
+ */
31936
31708
  export const userInvitationsRetrieve = (options) => {
31937
31709
  return (options.client ?? _heyApiClient).get({
31938
31710
  security: [
@@ -31950,7 +31722,8 @@ export const userInvitationsRetrieve = (options) => {
31950
31722
  });
31951
31723
  };
31952
31724
  /**
31953
- * Accept invitation for current user.
31725
+ * Accept an invitation
31726
+ * Accepts an invitation for the currently authenticated user. This grants the user the specified role in the invitation's scope.
31954
31727
  */
31955
31728
  export const userInvitationsAccept = (options) => {
31956
31729
  return (options.client ?? _heyApiClient).post({
@@ -31968,6 +31741,10 @@ export const userInvitationsAccept = (options) => {
31968
31741
  ...options
31969
31742
  });
31970
31743
  };
31744
+ /**
31745
+ * Cancel an invitation
31746
+ * Cancels a pending or planned (pending_project) invitation.
31747
+ */
31971
31748
  export const userInvitationsCancel = (options) => {
31972
31749
  return (options.client ?? _heyApiClient).post({
31973
31750
  security: [
@@ -31984,6 +31761,10 @@ export const userInvitationsCancel = (options) => {
31984
31761
  ...options
31985
31762
  });
31986
31763
  };
31764
+ /**
31765
+ * Check invitation validity
31766
+ * Checks if an invitation is pending and returns its email and whether a civil number is required for acceptance. This endpoint is public and does not require authentication.
31767
+ */
31987
31768
  export const userInvitationsCheck = (options) => {
31988
31769
  return (options.client ?? _heyApiClient).post({
31989
31770
  security: [
@@ -32000,6 +31781,10 @@ export const userInvitationsCheck = (options) => {
32000
31781
  ...options
32001
31782
  });
32002
31783
  };
31784
+ /**
31785
+ * Delete an invitation (staff only)
31786
+ * Deletes an invitation. This action is restricted to staff users.
31787
+ */
32003
31788
  export const userInvitationsDelete = (options) => {
32004
31789
  return (options.client ?? _heyApiClient).post({
32005
31790
  security: [
@@ -32016,6 +31801,10 @@ export const userInvitationsDelete = (options) => {
32016
31801
  ...options
32017
31802
  });
32018
31803
  };
31804
+ /**
31805
+ * Get public invitation details
31806
+ * Retrieves public-facing details of an invitation. This is used to show information to a user before they accept it.
31807
+ */
32019
31808
  export const userInvitationsDetailsRetrieve = (options) => {
32020
31809
  return (options.client ?? _heyApiClient).get({
32021
31810
  security: [
@@ -32032,6 +31821,10 @@ export const userInvitationsDetailsRetrieve = (options) => {
32032
31821
  ...options
32033
31822
  });
32034
31823
  };
31824
+ /**
31825
+ * Resend an invitation
31826
+ * Resends an email for a pending, expired, or canceled invitation. If the invitation was expired or canceled, its state is reset to 'pending' and its creation time is updated.
31827
+ */
32035
31828
  export const userInvitationsSend = (options) => {
32036
31829
  return (options.client ?? _heyApiClient).post({
32037
31830
  security: [
@@ -32049,8 +31842,11 @@ export const userInvitationsSend = (options) => {
32049
31842
  });
32050
31843
  };
32051
31844
  /**
31845
+ * Approve a requested invitation
31846
+ *
32052
31847
  * For user's convenience invitation approval is performed without authentication.
32053
31848
  * User UUID and invitation UUID is encoded into cryptographically signed token.
31849
+ *
32054
31850
  */
32055
31851
  export const userInvitationsApprove = (options) => {
32056
31852
  return (options.client ?? _heyApiClient).post({
@@ -32073,8 +31869,11 @@ export const userInvitationsApprove = (options) => {
32073
31869
  });
32074
31870
  };
32075
31871
  /**
31872
+ * Reject a requested invitation
31873
+ *
32076
31874
  * For user's convenience invitation reject action is performed without authentication.
32077
31875
  * User UUID and invitation UUID is encoded into cryptographically signed token.
31876
+ *
32078
31877
  */
32079
31878
  export const userInvitationsReject = (options) => {
32080
31879
  return (options.client ?? _heyApiClient).post({
@@ -32097,7 +31896,8 @@ export const userInvitationsReject = (options) => {
32097
31896
  });
32098
31897
  };
32099
31898
  /**
32100
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
31899
+ * List permission requests
31900
+ * Retrieve a list of permission requests visible to the user.
32101
31901
  */
32102
31902
  export const userPermissionRequestsList = (options) => {
32103
31903
  return (options?.client ?? _heyApiClient).get({
@@ -32116,6 +31916,7 @@ export const userPermissionRequestsList = (options) => {
32116
31916
  });
32117
31917
  };
32118
31918
  /**
31919
+ * List permission requests
32119
31920
  * Get number of items in the collection matching the request parameters.
32120
31921
  */
32121
31922
  export const userPermissionRequestsCount = (options) => {
@@ -32134,6 +31935,10 @@ export const userPermissionRequestsCount = (options) => {
32134
31935
  ...options
32135
31936
  });
32136
31937
  };
31938
+ /**
31939
+ * Retrieve permission request
31940
+ * Retrieve details of a specific permission request.
31941
+ */
32137
31942
  export const userPermissionRequestsRetrieve = (options) => {
32138
31943
  return (options.client ?? _heyApiClient).get({
32139
31944
  security: [
@@ -32150,6 +31955,10 @@ export const userPermissionRequestsRetrieve = (options) => {
32150
31955
  ...options
32151
31956
  });
32152
31957
  };
31958
+ /**
31959
+ * Approve a permission request
31960
+ * Approves a pending permission request, granting the requesting user the permissions defined in the associated group invitation.
31961
+ */
32153
31962
  export const userPermissionRequestsApprove = (options) => {
32154
31963
  return (options.client ?? _heyApiClient).post({
32155
31964
  security: [
@@ -32171,7 +31980,8 @@ export const userPermissionRequestsApprove = (options) => {
32171
31980
  });
32172
31981
  };
32173
31982
  /**
32174
- * Cancel permission request. Users can cancel their own requests, staff can cancel any request.
31983
+ * Cancel a permission request
31984
+ * Cancels a pending or draft permission request. This can be done by the user who created the request or by a staff member.
32175
31985
  */
32176
31986
  export const userPermissionRequestsCancelRequest = (options) => {
32177
31987
  return (options.client ?? _heyApiClient).post({
@@ -32189,6 +31999,10 @@ export const userPermissionRequestsCancelRequest = (options) => {
32189
31999
  ...options
32190
32000
  });
32191
32001
  };
32002
+ /**
32003
+ * Reject a permission request
32004
+ * Rejects a pending permission request.
32005
+ */
32192
32006
  export const userPermissionRequestsReject = (options) => {
32193
32007
  return (options.client ?? _heyApiClient).post({
32194
32008
  security: [
@@ -32209,9 +32023,6 @@ export const userPermissionRequestsReject = (options) => {
32209
32023
  }
32210
32024
  });
32211
32025
  };
32212
- /**
32213
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32214
- */
32215
32026
  export const userPermissionsList = (options) => {
32216
32027
  return (options?.client ?? _heyApiClient).get({
32217
32028
  security: [
@@ -32263,9 +32074,6 @@ export const userPermissionsRetrieve = (options) => {
32263
32074
  ...options
32264
32075
  });
32265
32076
  };
32266
- /**
32267
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32268
- */
32269
32077
  export const usersList = (options) => {
32270
32078
  return (options?.client ?? _heyApiClient).get({
32271
32079
  security: [
@@ -32394,6 +32202,7 @@ export const usersUpdate = (options) => {
32394
32202
  });
32395
32203
  };
32396
32204
  /**
32205
+ * Cancel email change request
32397
32206
  * Cancel email update request
32398
32207
  */
32399
32208
  export const usersCancelChangeEmail = (options) => {
@@ -32413,6 +32222,7 @@ export const usersCancelChangeEmail = (options) => {
32413
32222
  });
32414
32223
  };
32415
32224
  /**
32225
+ * Request email change
32416
32226
  * Allows to change email for user.
32417
32227
  */
32418
32228
  export const usersChangeEmail = (options) => {
@@ -32436,6 +32246,7 @@ export const usersChangeEmail = (options) => {
32436
32246
  });
32437
32247
  };
32438
32248
  /**
32249
+ * Change user password
32439
32250
  * Allows staff user to change password for any user.
32440
32251
  */
32441
32252
  export const usersChangePassword = (options) => {
@@ -32459,7 +32270,7 @@ export const usersChangePassword = (options) => {
32459
32270
  });
32460
32271
  };
32461
32272
  /**
32462
- * Pulls remote user data from eduTEAMS.
32273
+ * Synchronize user details from eduTEAMS
32463
32274
  */
32464
32275
  export const usersPullRemoteUser = (options) => {
32465
32276
  return (options.client ?? _heyApiClient).post({
@@ -32478,7 +32289,7 @@ export const usersPullRemoteUser = (options) => {
32478
32289
  });
32479
32290
  };
32480
32291
  /**
32481
- * Allows to refresh user auth token.
32292
+ * Refresh user auth token
32482
32293
  */
32483
32294
  export const usersRefreshToken = (options) => {
32484
32295
  return (options.client ?? _heyApiClient).post({
@@ -32496,6 +32307,9 @@ export const usersRefreshToken = (options) => {
32496
32307
  ...options
32497
32308
  });
32498
32309
  };
32310
+ /**
32311
+ * Get user auth token
32312
+ */
32499
32313
  export const usersTokenRetrieve = (options) => {
32500
32314
  return (options.client ?? _heyApiClient).get({
32501
32315
  security: [
@@ -32513,6 +32327,7 @@ export const usersTokenRetrieve = (options) => {
32513
32327
  });
32514
32328
  };
32515
32329
  /**
32330
+ * Confirm email change
32516
32331
  * Confirm email update using code
32517
32332
  */
32518
32333
  export const usersConfirmEmail = (options) => {
@@ -32536,6 +32351,7 @@ export const usersConfirmEmail = (options) => {
32536
32351
  });
32537
32352
  };
32538
32353
  /**
32354
+ * Get current user details
32539
32355
  * Get current user details, including authentication token.
32540
32356
  */
32541
32357
  export const usersMeRetrieve = (options) => {
@@ -32555,6 +32371,7 @@ export const usersMeRetrieve = (options) => {
32555
32371
  });
32556
32372
  };
32557
32373
  /**
32374
+ * Get current user details
32558
32375
  * Get number of items in the collection matching the request parameters.
32559
32376
  */
32560
32377
  export const usersMeCount = (options) => {
@@ -32574,7 +32391,8 @@ export const usersMeCount = (options) => {
32574
32391
  });
32575
32392
  };
32576
32393
  /**
32577
- * Retrieve current version of the application and the latest available version from GitHub (if available).
32394
+ * Get application version
32395
+ * Retrieves the current installed version of the application and the latest available version from GitHub (if available). Requires staff or support user permissions.
32578
32396
  */
32579
32397
  export const versionRetrieve = (options) => {
32580
32398
  return (options?.client ?? _heyApiClient).get({
@@ -32592,9 +32410,6 @@ export const versionRetrieve = (options) => {
32592
32410
  ...options
32593
32411
  });
32594
32412
  };
32595
- /**
32596
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32597
- */
32598
32413
  export const vmwareClustersList = (options) => {
32599
32414
  return (options?.client ?? _heyApiClient).get({
32600
32415
  security: [
@@ -32646,9 +32461,6 @@ export const vmwareClustersRetrieve = (options) => {
32646
32461
  ...options
32647
32462
  });
32648
32463
  };
32649
- /**
32650
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32651
- */
32652
32464
  export const vmwareDatastoresList = (options) => {
32653
32465
  return (options?.client ?? _heyApiClient).get({
32654
32466
  security: [
@@ -32700,9 +32512,6 @@ export const vmwareDatastoresRetrieve = (options) => {
32700
32512
  ...options
32701
32513
  });
32702
32514
  };
32703
- /**
32704
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32705
- */
32706
32515
  export const vmwareDisksList = (options) => {
32707
32516
  return (options?.client ?? _heyApiClient).get({
32708
32517
  security: [
@@ -32793,6 +32602,10 @@ export const vmwareDisksExtend = (options) => {
32793
32602
  }
32794
32603
  });
32795
32604
  };
32605
+ /**
32606
+ * Synchronize resource state
32607
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
32608
+ */
32796
32609
  export const vmwareDisksPull = (options) => {
32797
32610
  return (options.client ?? _heyApiClient).post({
32798
32611
  security: [
@@ -32810,6 +32623,7 @@ export const vmwareDisksPull = (options) => {
32810
32623
  });
32811
32624
  };
32812
32625
  /**
32626
+ * Unlink resource
32813
32627
  * Delete resource from the database without scheduling operations on backend
32814
32628
  * and without checking current state of the resource. It is intended to be used
32815
32629
  * for removing resource stuck in transitioning state.
@@ -32830,9 +32644,6 @@ export const vmwareDisksUnlink = (options) => {
32830
32644
  ...options
32831
32645
  });
32832
32646
  };
32833
- /**
32834
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32835
- */
32836
32647
  export const vmwareFoldersList = (options) => {
32837
32648
  return (options?.client ?? _heyApiClient).get({
32838
32649
  security: [
@@ -32900,9 +32711,6 @@ export const vmwareLimitsRetrieve = (options) => {
32900
32711
  ...options
32901
32712
  });
32902
32713
  };
32903
- /**
32904
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32905
- */
32906
32714
  export const vmwareNetworksList = (options) => {
32907
32715
  return (options?.client ?? _heyApiClient).get({
32908
32716
  security: [
@@ -32954,9 +32762,6 @@ export const vmwareNetworksRetrieve = (options) => {
32954
32762
  ...options
32955
32763
  });
32956
32764
  };
32957
- /**
32958
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
32959
- */
32960
32765
  export const vmwarePortsList = (options) => {
32961
32766
  return (options?.client ?? _heyApiClient).get({
32962
32767
  security: [
@@ -33024,6 +32829,10 @@ export const vmwarePortsRetrieve = (options) => {
33024
32829
  ...options
33025
32830
  });
33026
32831
  };
32832
+ /**
32833
+ * Synchronize resource state
32834
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
32835
+ */
33027
32836
  export const vmwarePortsPull = (options) => {
33028
32837
  return (options.client ?? _heyApiClient).post({
33029
32838
  security: [
@@ -33041,6 +32850,7 @@ export const vmwarePortsPull = (options) => {
33041
32850
  });
33042
32851
  };
33043
32852
  /**
32853
+ * Unlink resource
33044
32854
  * Delete resource from the database without scheduling operations on backend
33045
32855
  * and without checking current state of the resource. It is intended to be used
33046
32856
  * for removing resource stuck in transitioning state.
@@ -33061,9 +32871,6 @@ export const vmwarePortsUnlink = (options) => {
33061
32871
  ...options
33062
32872
  });
33063
32873
  };
33064
- /**
33065
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
33066
- */
33067
32874
  export const vmwareTemplatesList = (options) => {
33068
32875
  return (options?.client ?? _heyApiClient).get({
33069
32876
  security: [
@@ -33115,9 +32922,6 @@ export const vmwareTemplatesRetrieve = (options) => {
33115
32922
  ...options
33116
32923
  });
33117
32924
  };
33118
- /**
33119
- * Mixin to optimize HEAD requests for DRF views bypassing serializer processing
33120
- */
33121
32925
  export const vmwareVirtualMachineList = (options) => {
33122
32926
  return (options?.client ?? _heyApiClient).get({
33123
32927
  security: [
@@ -33304,6 +33108,10 @@ export const vmwareVirtualMachineCreatePort = (options) => {
33304
33108
  }
33305
33109
  });
33306
33110
  };
33111
+ /**
33112
+ * Synchronize resource state
33113
+ * Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
33114
+ */
33307
33115
  export const vmwareVirtualMachinePull = (options) => {
33308
33116
  return (options.client ?? _heyApiClient).post({
33309
33117
  security: [
@@ -33417,6 +33225,7 @@ export const vmwareVirtualMachineSuspend = (options) => {
33417
33225
  });
33418
33226
  };
33419
33227
  /**
33228
+ * Unlink resource
33420
33229
  * Delete resource from the database without scheduling operations on backend
33421
33230
  * and without checking current state of the resource. It is intended to be used
33422
33231
  * for removing resource stuck in transitioning state.