waldur-js-client 7.8.8-dev.10 → 7.8.8-dev.11

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
@@ -2236,6 +2236,10 @@ export const azureVirtualmachinesUnlink = (options) => {
2236
2236
  ...options
2237
2237
  });
2238
2238
  };
2239
+ /**
2240
+ * List backend resource requests
2241
+ * Returns a paginated list of requests for backend resources.
2242
+ */
2239
2243
  export const backendResourceRequestsList = (options) => {
2240
2244
  return (options?.client ?? _heyApiClient).get({
2241
2245
  security: [
@@ -2253,6 +2257,7 @@ export const backendResourceRequestsList = (options) => {
2253
2257
  });
2254
2258
  };
2255
2259
  /**
2260
+ * List backend resource requests
2256
2261
  * Get number of items in the collection matching the request parameters.
2257
2262
  */
2258
2263
  export const backendResourceRequestsCount = (options) => {
@@ -2271,6 +2276,10 @@ export const backendResourceRequestsCount = (options) => {
2271
2276
  ...options
2272
2277
  });
2273
2278
  };
2279
+ /**
2280
+ * Create a backend resource request
2281
+ * Creates a new request to fetch a list of importable resources from a backend. This is typically used by staff to trigger a site agent to report available resources.
2282
+ */
2274
2283
  export const backendResourceRequestsCreate = (options) => {
2275
2284
  return (options.client ?? _heyApiClient).post({
2276
2285
  security: [
@@ -2291,6 +2300,10 @@ export const backendResourceRequestsCreate = (options) => {
2291
2300
  }
2292
2301
  });
2293
2302
  };
2303
+ /**
2304
+ * Retrieve a backend resource request
2305
+ * Returns the details of a specific backend resource request.
2306
+ */
2294
2307
  export const backendResourceRequestsRetrieve = (options) => {
2295
2308
  return (options.client ?? _heyApiClient).get({
2296
2309
  security: [
@@ -2307,6 +2320,10 @@ export const backendResourceRequestsRetrieve = (options) => {
2307
2320
  ...options
2308
2321
  });
2309
2322
  };
2323
+ /**
2324
+ * Mark a request as done
2325
+ * Transitions the request state from 'Processing' to 'Done'. This is used by a site agent to signal that it has successfully reported all available resources.
2326
+ */
2310
2327
  export const backendResourceRequestsSetDone = (options) => {
2311
2328
  return (options.client ?? _heyApiClient).post({
2312
2329
  security: [
@@ -2323,6 +2340,10 @@ export const backendResourceRequestsSetDone = (options) => {
2323
2340
  ...options
2324
2341
  });
2325
2342
  };
2343
+ /**
2344
+ * Mark a request as erred
2345
+ * Transitions the request state to 'Erred'. This is used by a site agent to report a failure during the resource fetching process. An error message and traceback should be provided.
2346
+ */
2326
2347
  export const backendResourceRequestsSetErred = (options) => {
2327
2348
  return (options.client ?? _heyApiClient).post({
2328
2349
  security: [
@@ -2343,6 +2364,10 @@ export const backendResourceRequestsSetErred = (options) => {
2343
2364
  }
2344
2365
  });
2345
2366
  };
2367
+ /**
2368
+ * Start processing a request
2369
+ * Transitions the request state from 'Sent' to 'Processing'. This is used by a site agent to acknowledge that it has started fetching the resource list.
2370
+ */
2346
2371
  export const backendResourceRequestsStartProcessing = (options) => {
2347
2372
  return (options.client ?? _heyApiClient).post({
2348
2373
  security: [
@@ -2359,6 +2384,10 @@ export const backendResourceRequestsStartProcessing = (options) => {
2359
2384
  ...options
2360
2385
  });
2361
2386
  };
2387
+ /**
2388
+ * List backend resources
2389
+ * Returns a paginated list of backend resources that are available for import. This endpoint is typically used by site agents to see which resources they have reported.
2390
+ */
2362
2391
  export const backendResourcesList = (options) => {
2363
2392
  return (options?.client ?? _heyApiClient).get({
2364
2393
  security: [
@@ -2376,6 +2405,7 @@ export const backendResourcesList = (options) => {
2376
2405
  });
2377
2406
  };
2378
2407
  /**
2408
+ * List backend resources
2379
2409
  * Get number of items in the collection matching the request parameters.
2380
2410
  */
2381
2411
  export const backendResourcesCount = (options) => {
@@ -2394,6 +2424,10 @@ export const backendResourcesCount = (options) => {
2394
2424
  ...options
2395
2425
  });
2396
2426
  };
2427
+ /**
2428
+ * Create a backend resource
2429
+ * Creates a new backend resource record. This is typically done by a site agent to report a resource that is available for import into the marketplace.
2430
+ */
2397
2431
  export const backendResourcesCreate = (options) => {
2398
2432
  return (options.client ?? _heyApiClient).post({
2399
2433
  security: [
@@ -2414,6 +2448,10 @@ export const backendResourcesCreate = (options) => {
2414
2448
  }
2415
2449
  });
2416
2450
  };
2451
+ /**
2452
+ * Delete a backend resource
2453
+ * Deletes a backend resource record. This is typically done when the resource is no longer available for import.
2454
+ */
2417
2455
  export const backendResourcesDestroy = (options) => {
2418
2456
  return (options.client ?? _heyApiClient).delete({
2419
2457
  security: [
@@ -2430,6 +2468,10 @@ export const backendResourcesDestroy = (options) => {
2430
2468
  ...options
2431
2469
  });
2432
2470
  };
2471
+ /**
2472
+ * Retrieve a backend resource
2473
+ * Returns the details of a specific backend resource.
2474
+ */
2433
2475
  export const backendResourcesRetrieve = (options) => {
2434
2476
  return (options.client ?? _heyApiClient).get({
2435
2477
  security: [
@@ -2446,6 +2488,14 @@ export const backendResourcesRetrieve = (options) => {
2446
2488
  ...options
2447
2489
  });
2448
2490
  };
2491
+ /**
2492
+ * Import a backend resource (staff only)
2493
+ *
2494
+ * Converts a backend resource into a full marketplace resource. This action is restricted to staff users.
2495
+ * Upon successful import, the original backend resource record is deleted. A fake order in the 'done'
2496
+ * state is created to represent the import event.
2497
+ *
2498
+ */
2449
2499
  export const backendResourcesImportResource = (options) => {
2450
2500
  return (options.client ?? _heyApiClient).post({
2451
2501
  security: [
@@ -4094,6 +4144,10 @@ export const checklistsAdminChecklistQuestions = (options) => {
4094
4144
  ...options
4095
4145
  });
4096
4146
  };
4147
+ /**
4148
+ * List component usage limits for users
4149
+ * Returns a paginated list of usage limits set for specific users on resource components.
4150
+ */
4097
4151
  export const componentUserUsageLimitsList = (options) => {
4098
4152
  return (options?.client ?? _heyApiClient).get({
4099
4153
  security: [
@@ -4111,6 +4165,7 @@ export const componentUserUsageLimitsList = (options) => {
4111
4165
  });
4112
4166
  };
4113
4167
  /**
4168
+ * List component usage limits for users
4114
4169
  * Get number of items in the collection matching the request parameters.
4115
4170
  */
4116
4171
  export const componentUserUsageLimitsCount = (options) => {
@@ -4129,6 +4184,10 @@ export const componentUserUsageLimitsCount = (options) => {
4129
4184
  ...options
4130
4185
  });
4131
4186
  };
4187
+ /**
4188
+ * Create a component usage limit for a user
4189
+ * Sets a usage limit for a specific user on a resource's component. This is only applicable for offerings that support per-user consumption limitation.
4190
+ */
4132
4191
  export const componentUserUsageLimitsCreate = (options) => {
4133
4192
  return (options.client ?? _heyApiClient).post({
4134
4193
  security: [
@@ -4149,6 +4208,10 @@ export const componentUserUsageLimitsCreate = (options) => {
4149
4208
  }
4150
4209
  });
4151
4210
  };
4211
+ /**
4212
+ * Delete a component usage limit
4213
+ * Removes a usage limit for a user on a component.
4214
+ */
4152
4215
  export const componentUserUsageLimitsDestroy = (options) => {
4153
4216
  return (options.client ?? _heyApiClient).delete({
4154
4217
  security: [
@@ -4165,6 +4228,10 @@ export const componentUserUsageLimitsDestroy = (options) => {
4165
4228
  ...options
4166
4229
  });
4167
4230
  };
4231
+ /**
4232
+ * Retrieve a component usage limit
4233
+ * Returns the details of a specific user's usage limit for a component.
4234
+ */
4168
4235
  export const componentUserUsageLimitsRetrieve = (options) => {
4169
4236
  return (options.client ?? _heyApiClient).get({
4170
4237
  security: [
@@ -4181,6 +4248,10 @@ export const componentUserUsageLimitsRetrieve = (options) => {
4181
4248
  ...options
4182
4249
  });
4183
4250
  };
4251
+ /**
4252
+ * Partially update a component usage limit
4253
+ * Partially updates an existing usage limit for a user on a component.
4254
+ */
4184
4255
  export const componentUserUsageLimitsPartialUpdate = (options) => {
4185
4256
  return (options.client ?? _heyApiClient).patch({
4186
4257
  security: [
@@ -4201,6 +4272,10 @@ export const componentUserUsageLimitsPartialUpdate = (options) => {
4201
4272
  }
4202
4273
  });
4203
4274
  };
4275
+ /**
4276
+ * Update a component usage limit
4277
+ * Updates an existing usage limit for a user on a component.
4278
+ */
4204
4279
  export const componentUserUsageLimitsUpdate = (options) => {
4205
4280
  return (options.client ?? _heyApiClient).put({
4206
4281
  security: [
@@ -7606,6 +7681,10 @@ export const lexisLinksUpdate = (options) => {
7606
7681
  }
7607
7682
  });
7608
7683
  };
7684
+ /**
7685
+ * List affected offerings for maintenance
7686
+ * Returns a paginated list of offerings affected by maintenance announcements.
7687
+ */
7609
7688
  export const maintenanceAnnouncementOfferingsList = (options) => {
7610
7689
  return (options?.client ?? _heyApiClient).get({
7611
7690
  security: [
@@ -7623,6 +7702,7 @@ export const maintenanceAnnouncementOfferingsList = (options) => {
7623
7702
  });
7624
7703
  };
7625
7704
  /**
7705
+ * List affected offerings for maintenance
7626
7706
  * Get number of items in the collection matching the request parameters.
7627
7707
  */
7628
7708
  export const maintenanceAnnouncementOfferingsCount = (options) => {
@@ -7641,6 +7721,10 @@ export const maintenanceAnnouncementOfferingsCount = (options) => {
7641
7721
  ...options
7642
7722
  });
7643
7723
  };
7724
+ /**
7725
+ * Link an offering to a maintenance announcement
7726
+ * Creates a new association between an offering and a maintenance announcement, specifying the expected impact.
7727
+ */
7644
7728
  export const maintenanceAnnouncementOfferingsCreate = (options) => {
7645
7729
  return (options.client ?? _heyApiClient).post({
7646
7730
  security: [
@@ -7661,6 +7745,10 @@ export const maintenanceAnnouncementOfferingsCreate = (options) => {
7661
7745
  }
7662
7746
  });
7663
7747
  };
7748
+ /**
7749
+ * Unlink an offering from a maintenance announcement
7750
+ * Removes the association between an offering and a maintenance announcement.
7751
+ */
7664
7752
  export const maintenanceAnnouncementOfferingsDestroy = (options) => {
7665
7753
  return (options.client ?? _heyApiClient).delete({
7666
7754
  security: [
@@ -7677,6 +7765,10 @@ export const maintenanceAnnouncementOfferingsDestroy = (options) => {
7677
7765
  ...options
7678
7766
  });
7679
7767
  };
7768
+ /**
7769
+ * Retrieve an affected offering link
7770
+ * Returns the details of a specific link between a maintenance announcement and an offering, including the impact level and description.
7771
+ */
7680
7772
  export const maintenanceAnnouncementOfferingsRetrieve = (options) => {
7681
7773
  return (options.client ?? _heyApiClient).get({
7682
7774
  security: [
@@ -7693,6 +7785,10 @@ export const maintenanceAnnouncementOfferingsRetrieve = (options) => {
7693
7785
  ...options
7694
7786
  });
7695
7787
  };
7788
+ /**
7789
+ * Partially update an affected offering link
7790
+ * Partially updates the impact level or description for an offering linked to a maintenance announcement.
7791
+ */
7696
7792
  export const maintenanceAnnouncementOfferingsPartialUpdate = (options) => {
7697
7793
  return (options.client ?? _heyApiClient).patch({
7698
7794
  security: [
@@ -7713,6 +7809,10 @@ export const maintenanceAnnouncementOfferingsPartialUpdate = (options) => {
7713
7809
  }
7714
7810
  });
7715
7811
  };
7812
+ /**
7813
+ * Update an affected offering link
7814
+ * Updates the impact level or description for an offering linked to a maintenance announcement.
7815
+ */
7716
7816
  export const maintenanceAnnouncementOfferingsUpdate = (options) => {
7717
7817
  return (options.client ?? _heyApiClient).put({
7718
7818
  security: [
@@ -7733,6 +7833,10 @@ export const maintenanceAnnouncementOfferingsUpdate = (options) => {
7733
7833
  }
7734
7834
  });
7735
7835
  };
7836
+ /**
7837
+ * List affected offering templates
7838
+ * Returns a paginated list of associations between maintenance announcement templates and offerings.
7839
+ */
7736
7840
  export const maintenanceAnnouncementTemplateOfferingsList = (options) => {
7737
7841
  return (options?.client ?? _heyApiClient).get({
7738
7842
  security: [
@@ -7750,6 +7854,7 @@ export const maintenanceAnnouncementTemplateOfferingsList = (options) => {
7750
7854
  });
7751
7855
  };
7752
7856
  /**
7857
+ * List affected offering templates
7753
7858
  * Get number of items in the collection matching the request parameters.
7754
7859
  */
7755
7860
  export const maintenanceAnnouncementTemplateOfferingsCount = (options) => {
@@ -7768,6 +7873,10 @@ export const maintenanceAnnouncementTemplateOfferingsCount = (options) => {
7768
7873
  ...options
7769
7874
  });
7770
7875
  };
7876
+ /**
7877
+ * Link an offering to a maintenance template
7878
+ * Creates a reusable association between an offering and a maintenance announcement template, specifying a default impact level and description.
7879
+ */
7771
7880
  export const maintenanceAnnouncementTemplateOfferingsCreate = (options) => {
7772
7881
  return (options.client ?? _heyApiClient).post({
7773
7882
  security: [
@@ -7788,6 +7897,10 @@ export const maintenanceAnnouncementTemplateOfferingsCreate = (options) => {
7788
7897
  }
7789
7898
  });
7790
7899
  };
7900
+ /**
7901
+ * Unlink an offering from a maintenance template
7902
+ * Removes the association between an offering and a maintenance announcement template.
7903
+ */
7791
7904
  export const maintenanceAnnouncementTemplateOfferingsDestroy = (options) => {
7792
7905
  return (options.client ?? _heyApiClient).delete({
7793
7906
  security: [
@@ -7804,6 +7917,10 @@ export const maintenanceAnnouncementTemplateOfferingsDestroy = (options) => {
7804
7917
  ...options
7805
7918
  });
7806
7919
  };
7920
+ /**
7921
+ * Retrieve an affected offering template link
7922
+ * Returns the details of a specific link between a maintenance announcement template and an offering.
7923
+ */
7807
7924
  export const maintenanceAnnouncementTemplateOfferingsRetrieve = (options) => {
7808
7925
  return (options.client ?? _heyApiClient).get({
7809
7926
  security: [
@@ -7820,6 +7937,10 @@ export const maintenanceAnnouncementTemplateOfferingsRetrieve = (options) => {
7820
7937
  ...options
7821
7938
  });
7822
7939
  };
7940
+ /**
7941
+ * Partially update an affected offering template link
7942
+ * Partially updates the default impact level or description for an offering linked to a maintenance template.
7943
+ */
7823
7944
  export const maintenanceAnnouncementTemplateOfferingsPartialUpdate = (options) => {
7824
7945
  return (options.client ?? _heyApiClient).patch({
7825
7946
  security: [
@@ -7840,6 +7961,10 @@ export const maintenanceAnnouncementTemplateOfferingsPartialUpdate = (options) =
7840
7961
  }
7841
7962
  });
7842
7963
  };
7964
+ /**
7965
+ * Update an affected offering template link
7966
+ * Updates the default impact level or description for an offering linked to a maintenance template.
7967
+ */
7843
7968
  export const maintenanceAnnouncementTemplateOfferingsUpdate = (options) => {
7844
7969
  return (options.client ?? _heyApiClient).put({
7845
7970
  security: [
@@ -7860,6 +7985,10 @@ export const maintenanceAnnouncementTemplateOfferingsUpdate = (options) => {
7860
7985
  }
7861
7986
  });
7862
7987
  };
7988
+ /**
7989
+ * List maintenance announcements
7990
+ * Returns a paginated list of maintenance announcements.
7991
+ */
7863
7992
  export const maintenanceAnnouncementsList = (options) => {
7864
7993
  return (options?.client ?? _heyApiClient).get({
7865
7994
  security: [
@@ -7877,6 +8006,7 @@ export const maintenanceAnnouncementsList = (options) => {
7877
8006
  });
7878
8007
  };
7879
8008
  /**
8009
+ * List maintenance announcements
7880
8010
  * Get number of items in the collection matching the request parameters.
7881
8011
  */
7882
8012
  export const maintenanceAnnouncementsCount = (options) => {
@@ -7895,6 +8025,10 @@ export const maintenanceAnnouncementsCount = (options) => {
7895
8025
  ...options
7896
8026
  });
7897
8027
  };
8028
+ /**
8029
+ * Create a maintenance announcement
8030
+ * Creates a new maintenance announcement in the 'Draft' state.
8031
+ */
7898
8032
  export const maintenanceAnnouncementsCreate = (options) => {
7899
8033
  return (options.client ?? _heyApiClient).post({
7900
8034
  security: [
@@ -7915,6 +8049,10 @@ export const maintenanceAnnouncementsCreate = (options) => {
7915
8049
  }
7916
8050
  });
7917
8051
  };
8052
+ /**
8053
+ * List maintenance announcement templates
8054
+ * Returns a paginated list of reusable templates for maintenance announcements.
8055
+ */
7918
8056
  export const maintenanceAnnouncementsTemplateList = (options) => {
7919
8057
  return (options?.client ?? _heyApiClient).get({
7920
8058
  security: [
@@ -7932,6 +8070,7 @@ export const maintenanceAnnouncementsTemplateList = (options) => {
7932
8070
  });
7933
8071
  };
7934
8072
  /**
8073
+ * List maintenance announcement templates
7935
8074
  * Get number of items in the collection matching the request parameters.
7936
8075
  */
7937
8076
  export const maintenanceAnnouncementsTemplateCount = (options) => {
@@ -7950,6 +8089,10 @@ export const maintenanceAnnouncementsTemplateCount = (options) => {
7950
8089
  ...options
7951
8090
  });
7952
8091
  };
8092
+ /**
8093
+ * Create a maintenance announcement template
8094
+ * Creates a new reusable template for maintenance announcements, including a default message and type.
8095
+ */
7953
8096
  export const maintenanceAnnouncementsTemplateCreate = (options) => {
7954
8097
  return (options.client ?? _heyApiClient).post({
7955
8098
  security: [
@@ -7970,6 +8113,10 @@ export const maintenanceAnnouncementsTemplateCreate = (options) => {
7970
8113
  }
7971
8114
  });
7972
8115
  };
8116
+ /**
8117
+ * Delete a maintenance announcement template
8118
+ * Deletes a maintenance announcement template.
8119
+ */
7973
8120
  export const maintenanceAnnouncementsTemplateDestroy = (options) => {
7974
8121
  return (options.client ?? _heyApiClient).delete({
7975
8122
  security: [
@@ -7986,6 +8133,10 @@ export const maintenanceAnnouncementsTemplateDestroy = (options) => {
7986
8133
  ...options
7987
8134
  });
7988
8135
  };
8136
+ /**
8137
+ * Retrieve a maintenance announcement template
8138
+ * Returns the details of a specific maintenance announcement template.
8139
+ */
7989
8140
  export const maintenanceAnnouncementsTemplateRetrieve = (options) => {
7990
8141
  return (options.client ?? _heyApiClient).get({
7991
8142
  security: [
@@ -8002,6 +8153,10 @@ export const maintenanceAnnouncementsTemplateRetrieve = (options) => {
8002
8153
  ...options
8003
8154
  });
8004
8155
  };
8156
+ /**
8157
+ * Partially update a maintenance announcement template
8158
+ * Partially updates an existing maintenance announcement template.
8159
+ */
8005
8160
  export const maintenanceAnnouncementsTemplatePartialUpdate = (options) => {
8006
8161
  return (options.client ?? _heyApiClient).patch({
8007
8162
  security: [
@@ -8022,6 +8177,10 @@ export const maintenanceAnnouncementsTemplatePartialUpdate = (options) => {
8022
8177
  }
8023
8178
  });
8024
8179
  };
8180
+ /**
8181
+ * Update a maintenance announcement template
8182
+ * Updates an existing maintenance announcement template.
8183
+ */
8025
8184
  export const maintenanceAnnouncementsTemplateUpdate = (options) => {
8026
8185
  return (options.client ?? _heyApiClient).put({
8027
8186
  security: [
@@ -8042,6 +8201,10 @@ export const maintenanceAnnouncementsTemplateUpdate = (options) => {
8042
8201
  }
8043
8202
  });
8044
8203
  };
8204
+ /**
8205
+ * Delete a maintenance announcement
8206
+ * Deletes a maintenance announcement.
8207
+ */
8045
8208
  export const maintenanceAnnouncementsDestroy = (options) => {
8046
8209
  return (options.client ?? _heyApiClient).delete({
8047
8210
  security: [
@@ -8058,6 +8221,10 @@ export const maintenanceAnnouncementsDestroy = (options) => {
8058
8221
  ...options
8059
8222
  });
8060
8223
  };
8224
+ /**
8225
+ * Retrieve a maintenance announcement
8226
+ * Returns the details of a specific maintenance announcement.
8227
+ */
8061
8228
  export const maintenanceAnnouncementsRetrieve = (options) => {
8062
8229
  return (options.client ?? _heyApiClient).get({
8063
8230
  security: [
@@ -8074,6 +8241,10 @@ export const maintenanceAnnouncementsRetrieve = (options) => {
8074
8241
  ...options
8075
8242
  });
8076
8243
  };
8244
+ /**
8245
+ * Partially update a maintenance announcement
8246
+ * Partially updates an existing maintenance announcement.
8247
+ */
8077
8248
  export const maintenanceAnnouncementsPartialUpdate = (options) => {
8078
8249
  return (options.client ?? _heyApiClient).patch({
8079
8250
  security: [
@@ -8094,6 +8265,10 @@ export const maintenanceAnnouncementsPartialUpdate = (options) => {
8094
8265
  }
8095
8266
  });
8096
8267
  };
8268
+ /**
8269
+ * Update a maintenance announcement
8270
+ * Updates an existing maintenance announcement.
8271
+ */
8097
8272
  export const maintenanceAnnouncementsUpdate = (options) => {
8098
8273
  return (options.client ?? _heyApiClient).put({
8099
8274
  security: [
@@ -8116,6 +8291,7 @@ export const maintenanceAnnouncementsUpdate = (options) => {
8116
8291
  };
8117
8292
  /**
8118
8293
  * Cancel the maintenance announcement
8294
+ * Transitions a 'Draft' or 'Scheduled' maintenance announcement to 'Cancelled'.
8119
8295
  */
8120
8296
  export const maintenanceAnnouncementsCancelMaintenance = (options) => {
8121
8297
  return (options.client ?? _heyApiClient).post({
@@ -8135,6 +8311,7 @@ export const maintenanceAnnouncementsCancelMaintenance = (options) => {
8135
8311
  };
8136
8312
  /**
8137
8313
  * Complete the maintenance announcement
8314
+ * Transitions an 'In progress' maintenance announcement to 'Completed', indicating that the maintenance work has finished.
8138
8315
  */
8139
8316
  export const maintenanceAnnouncementsCompleteMaintenance = (options) => {
8140
8317
  return (options.client ?? _heyApiClient).post({
@@ -8154,6 +8331,7 @@ export const maintenanceAnnouncementsCompleteMaintenance = (options) => {
8154
8331
  };
8155
8332
  /**
8156
8333
  * Schedule/publish the maintenance announcement
8334
+ * Transitions a 'Draft' maintenance announcement to the 'Scheduled' state, making it publicly visible.
8157
8335
  */
8158
8336
  export const maintenanceAnnouncementsSchedule = (options) => {
8159
8337
  return (options.client ?? _heyApiClient).post({
@@ -8173,6 +8351,7 @@ export const maintenanceAnnouncementsSchedule = (options) => {
8173
8351
  };
8174
8352
  /**
8175
8353
  * Start the maintenance announcement
8354
+ * Transitions a 'Scheduled' maintenance announcement to 'In progress', indicating that the maintenance work has begun.
8176
8355
  */
8177
8356
  export const maintenanceAnnouncementsStartMaintenance = (options) => {
8178
8357
  return (options.client ?? _heyApiClient).post({
@@ -8192,6 +8371,7 @@ export const maintenanceAnnouncementsStartMaintenance = (options) => {
8192
8371
  };
8193
8372
  /**
8194
8373
  * Unschedule/unpublish the maintenance announcement
8374
+ * Transitions a 'Scheduled' maintenance announcement back to the 'Draft' state, hiding it from public view.
8195
8375
  */
8196
8376
  export const maintenanceAnnouncementsUnschedule = (options) => {
8197
8377
  return (options.client ?? _heyApiClient).post({
@@ -8296,6 +8476,10 @@ export const marketplaceBookingsList = (options) => {
8296
8476
  ...options
8297
8477
  });
8298
8478
  };
8479
+ /**
8480
+ * List categories
8481
+ * Returns a paginated list of marketplace categories.
8482
+ */
8299
8483
  export const marketplaceCategoriesList = (options) => {
8300
8484
  return (options?.client ?? _heyApiClient).get({
8301
8485
  security: [
@@ -8313,6 +8497,7 @@ export const marketplaceCategoriesList = (options) => {
8313
8497
  });
8314
8498
  };
8315
8499
  /**
8500
+ * List categories
8316
8501
  * Get number of items in the collection matching the request parameters.
8317
8502
  */
8318
8503
  export const marketplaceCategoriesCount = (options) => {
@@ -8331,6 +8516,10 @@ export const marketplaceCategoriesCount = (options) => {
8331
8516
  ...options
8332
8517
  });
8333
8518
  };
8519
+ /**
8520
+ * Create a category
8521
+ * Creates a new marketplace category. Requires staff permissions.
8522
+ */
8334
8523
  export const marketplaceCategoriesCreate = (options) => {
8335
8524
  return (options.client ?? _heyApiClient).post({
8336
8525
  security: [
@@ -8351,6 +8540,10 @@ export const marketplaceCategoriesCreate = (options) => {
8351
8540
  }
8352
8541
  });
8353
8542
  };
8543
+ /**
8544
+ * Delete a category
8545
+ * Deletes a marketplace category. Requires staff permissions.
8546
+ */
8354
8547
  export const marketplaceCategoriesDestroy = (options) => {
8355
8548
  return (options.client ?? _heyApiClient).delete({
8356
8549
  security: [
@@ -8367,6 +8560,10 @@ export const marketplaceCategoriesDestroy = (options) => {
8367
8560
  ...options
8368
8561
  });
8369
8562
  };
8563
+ /**
8564
+ * Retrieve a category
8565
+ * Returns details of a specific marketplace category.
8566
+ */
8370
8567
  export const marketplaceCategoriesRetrieve = (options) => {
8371
8568
  return (options.client ?? _heyApiClient).get({
8372
8569
  security: [
@@ -8383,6 +8580,10 @@ export const marketplaceCategoriesRetrieve = (options) => {
8383
8580
  ...options
8384
8581
  });
8385
8582
  };
8583
+ /**
8584
+ * Partially update a category
8585
+ * Partially updates an existing marketplace category. Requires staff permissions.
8586
+ */
8386
8587
  export const marketplaceCategoriesPartialUpdate = (options) => {
8387
8588
  return (options.client ?? _heyApiClient).patch({
8388
8589
  security: [
@@ -8403,6 +8604,10 @@ export const marketplaceCategoriesPartialUpdate = (options) => {
8403
8604
  }
8404
8605
  });
8405
8606
  };
8607
+ /**
8608
+ * Update a category
8609
+ * Updates an existing marketplace category. Requires staff permissions.
8610
+ */
8406
8611
  export const marketplaceCategoriesUpdate = (options) => {
8407
8612
  return (options.client ?? _heyApiClient).put({
8408
8613
  security: [
@@ -8423,6 +8628,10 @@ export const marketplaceCategoriesUpdate = (options) => {
8423
8628
  }
8424
8629
  });
8425
8630
  };
8631
+ /**
8632
+ * List category columns
8633
+ * Returns a paginated list of category columns used for resource table rendering.
8634
+ */
8426
8635
  export const marketplaceCategoryColumnsList = (options) => {
8427
8636
  return (options?.client ?? _heyApiClient).get({
8428
8637
  security: [
@@ -8440,6 +8649,7 @@ export const marketplaceCategoryColumnsList = (options) => {
8440
8649
  });
8441
8650
  };
8442
8651
  /**
8652
+ * List category columns
8443
8653
  * Get number of items in the collection matching the request parameters.
8444
8654
  */
8445
8655
  export const marketplaceCategoryColumnsCount = (options) => {
@@ -8458,6 +8668,10 @@ export const marketplaceCategoryColumnsCount = (options) => {
8458
8668
  ...options
8459
8669
  });
8460
8670
  };
8671
+ /**
8672
+ * Create a category column
8673
+ * Creates a new category column. Requires staff permissions.
8674
+ */
8461
8675
  export const marketplaceCategoryColumnsCreate = (options) => {
8462
8676
  return (options.client ?? _heyApiClient).post({
8463
8677
  security: [
@@ -8478,6 +8692,10 @@ export const marketplaceCategoryColumnsCreate = (options) => {
8478
8692
  }
8479
8693
  });
8480
8694
  };
8695
+ /**
8696
+ * Delete a category column
8697
+ * Deletes a category column. Requires staff permissions.
8698
+ */
8481
8699
  export const marketplaceCategoryColumnsDestroy = (options) => {
8482
8700
  return (options.client ?? _heyApiClient).delete({
8483
8701
  security: [
@@ -8494,6 +8712,10 @@ export const marketplaceCategoryColumnsDestroy = (options) => {
8494
8712
  ...options
8495
8713
  });
8496
8714
  };
8715
+ /**
8716
+ * Retrieve a category column
8717
+ * Returns details of a specific category column.
8718
+ */
8497
8719
  export const marketplaceCategoryColumnsRetrieve = (options) => {
8498
8720
  return (options.client ?? _heyApiClient).get({
8499
8721
  security: [
@@ -8510,6 +8732,10 @@ export const marketplaceCategoryColumnsRetrieve = (options) => {
8510
8732
  ...options
8511
8733
  });
8512
8734
  };
8735
+ /**
8736
+ * Partially update a category column
8737
+ * Partially updates an existing category column. Requires staff permissions.
8738
+ */
8513
8739
  export const marketplaceCategoryColumnsPartialUpdate = (options) => {
8514
8740
  return (options.client ?? _heyApiClient).patch({
8515
8741
  security: [
@@ -8530,6 +8756,10 @@ export const marketplaceCategoryColumnsPartialUpdate = (options) => {
8530
8756
  }
8531
8757
  });
8532
8758
  };
8759
+ /**
8760
+ * Update a category column
8761
+ * Updates an existing category column. Requires staff permissions.
8762
+ */
8533
8763
  export const marketplaceCategoryColumnsUpdate = (options) => {
8534
8764
  return (options.client ?? _heyApiClient).put({
8535
8765
  security: [
@@ -8550,6 +8780,17 @@ export const marketplaceCategoryColumnsUpdate = (options) => {
8550
8780
  }
8551
8781
  });
8552
8782
  };
8783
+ /**
8784
+ * List aggregated category component usages
8785
+ *
8786
+ * Returns a paginated list of aggregated component usages for marketplace categories.
8787
+ * This data is scoped to either a customer or a project and represents the total usage
8788
+ * of a component type (e.g., total 'CPU hours' used across all resources of a certain category
8789
+ * within a project).
8790
+ *
8791
+ * The list **must** be filtered by a `scope` parameter (either a customer or project URL).
8792
+ *
8793
+ */
8553
8794
  export const marketplaceCategoryComponentUsagesList = (options) => {
8554
8795
  return (options?.client ?? _heyApiClient).get({
8555
8796
  security: [
@@ -8567,6 +8808,7 @@ export const marketplaceCategoryComponentUsagesList = (options) => {
8567
8808
  });
8568
8809
  };
8569
8810
  /**
8811
+ * List aggregated category component usages
8570
8812
  * Get number of items in the collection matching the request parameters.
8571
8813
  */
8572
8814
  export const marketplaceCategoryComponentUsagesCount = (options) => {
@@ -8585,6 +8827,10 @@ export const marketplaceCategoryComponentUsagesCount = (options) => {
8585
8827
  ...options
8586
8828
  });
8587
8829
  };
8830
+ /**
8831
+ * Retrieve an aggregated category component usage record
8832
+ * Returns the details of a single aggregated usage record for a category component, identified by its database ID.
8833
+ */
8588
8834
  export const marketplaceCategoryComponentUsagesRetrieve = (options) => {
8589
8835
  return (options.client ?? _heyApiClient).get({
8590
8836
  security: [
@@ -8601,6 +8847,10 @@ export const marketplaceCategoryComponentUsagesRetrieve = (options) => {
8601
8847
  ...options
8602
8848
  });
8603
8849
  };
8850
+ /**
8851
+ * List category components
8852
+ * Returns a paginated list of all components defined at the category level. These act as templates for components in offerings.
8853
+ */
8604
8854
  export const marketplaceCategoryComponentsList = (options) => {
8605
8855
  return (options?.client ?? _heyApiClient).get({
8606
8856
  security: [
@@ -8618,6 +8868,7 @@ export const marketplaceCategoryComponentsList = (options) => {
8618
8868
  });
8619
8869
  };
8620
8870
  /**
8871
+ * List category components
8621
8872
  * Get number of items in the collection matching the request parameters.
8622
8873
  */
8623
8874
  export const marketplaceCategoryComponentsCount = (options) => {
@@ -8636,6 +8887,10 @@ export const marketplaceCategoryComponentsCount = (options) => {
8636
8887
  ...options
8637
8888
  });
8638
8889
  };
8890
+ /**
8891
+ * Create a category component
8892
+ * Creates a new component for a category. Requires staff permissions.
8893
+ */
8639
8894
  export const marketplaceCategoryComponentsCreate = (options) => {
8640
8895
  return (options.client ?? _heyApiClient).post({
8641
8896
  security: [
@@ -8656,6 +8911,10 @@ export const marketplaceCategoryComponentsCreate = (options) => {
8656
8911
  }
8657
8912
  });
8658
8913
  };
8914
+ /**
8915
+ * Delete a category component
8916
+ * Deletes a category component. Requires staff permissions.
8917
+ */
8659
8918
  export const marketplaceCategoryComponentsDestroy = (options) => {
8660
8919
  return (options.client ?? _heyApiClient).delete({
8661
8920
  security: [
@@ -8672,6 +8931,10 @@ export const marketplaceCategoryComponentsDestroy = (options) => {
8672
8931
  ...options
8673
8932
  });
8674
8933
  };
8934
+ /**
8935
+ * Retrieve a category component
8936
+ * Returns the details of a specific category component, identified by its ID.
8937
+ */
8675
8938
  export const marketplaceCategoryComponentsRetrieve = (options) => {
8676
8939
  return (options.client ?? _heyApiClient).get({
8677
8940
  security: [
@@ -8688,6 +8951,10 @@ export const marketplaceCategoryComponentsRetrieve = (options) => {
8688
8951
  ...options
8689
8952
  });
8690
8953
  };
8954
+ /**
8955
+ * Partially update a category component
8956
+ * Partially updates an existing category component. Requires staff permissions.
8957
+ */
8691
8958
  export const marketplaceCategoryComponentsPartialUpdate = (options) => {
8692
8959
  return (options.client ?? _heyApiClient).patch({
8693
8960
  security: [
@@ -8708,6 +8975,10 @@ export const marketplaceCategoryComponentsPartialUpdate = (options) => {
8708
8975
  }
8709
8976
  });
8710
8977
  };
8978
+ /**
8979
+ * Update a category component
8980
+ * Updates an existing category component. Requires staff permissions.
8981
+ */
8711
8982
  export const marketplaceCategoryComponentsUpdate = (options) => {
8712
8983
  return (options.client ?? _heyApiClient).put({
8713
8984
  security: [
@@ -8728,6 +8999,10 @@ export const marketplaceCategoryComponentsUpdate = (options) => {
8728
8999
  }
8729
9000
  });
8730
9001
  };
9002
+ /**
9003
+ * List category groups
9004
+ * Returns a paginated list of category groups.
9005
+ */
8731
9006
  export const marketplaceCategoryGroupsList = (options) => {
8732
9007
  return (options?.client ?? _heyApiClient).get({
8733
9008
  security: [
@@ -8745,6 +9020,7 @@ export const marketplaceCategoryGroupsList = (options) => {
8745
9020
  });
8746
9021
  };
8747
9022
  /**
9023
+ * List category groups
8748
9024
  * Get number of items in the collection matching the request parameters.
8749
9025
  */
8750
9026
  export const marketplaceCategoryGroupsCount = (options) => {
@@ -8763,6 +9039,10 @@ export const marketplaceCategoryGroupsCount = (options) => {
8763
9039
  ...options
8764
9040
  });
8765
9041
  };
9042
+ /**
9043
+ * Create a category group
9044
+ * Creates a new category group. Requires staff permissions.
9045
+ */
8766
9046
  export const marketplaceCategoryGroupsCreate = (options) => {
8767
9047
  return (options.client ?? _heyApiClient).post({
8768
9048
  security: [
@@ -8783,6 +9063,10 @@ export const marketplaceCategoryGroupsCreate = (options) => {
8783
9063
  }
8784
9064
  });
8785
9065
  };
9066
+ /**
9067
+ * Delete a category group
9068
+ * Deletes a category group. Requires staff permissions.
9069
+ */
8786
9070
  export const marketplaceCategoryGroupsDestroy = (options) => {
8787
9071
  return (options.client ?? _heyApiClient).delete({
8788
9072
  security: [
@@ -8799,6 +9083,10 @@ export const marketplaceCategoryGroupsDestroy = (options) => {
8799
9083
  ...options
8800
9084
  });
8801
9085
  };
9086
+ /**
9087
+ * Retrieve a category group
9088
+ * Returns details of a specific category group.
9089
+ */
8802
9090
  export const marketplaceCategoryGroupsRetrieve = (options) => {
8803
9091
  return (options.client ?? _heyApiClient).get({
8804
9092
  security: [
@@ -8815,6 +9103,10 @@ export const marketplaceCategoryGroupsRetrieve = (options) => {
8815
9103
  ...options
8816
9104
  });
8817
9105
  };
9106
+ /**
9107
+ * Partially update a category group
9108
+ * Partially updates an existing category group. Requires staff permissions.
9109
+ */
8818
9110
  export const marketplaceCategoryGroupsPartialUpdate = (options) => {
8819
9111
  return (options.client ?? _heyApiClient).patch({
8820
9112
  security: [
@@ -8835,6 +9127,10 @@ export const marketplaceCategoryGroupsPartialUpdate = (options) => {
8835
9127
  }
8836
9128
  });
8837
9129
  };
9130
+ /**
9131
+ * Update a category group
9132
+ * Updates an existing category group. Requires staff permissions.
9133
+ */
8838
9134
  export const marketplaceCategoryGroupsUpdate = (options) => {
8839
9135
  return (options.client ?? _heyApiClient).put({
8840
9136
  security: [
@@ -8855,6 +9151,10 @@ export const marketplaceCategoryGroupsUpdate = (options) => {
8855
9151
  }
8856
9152
  });
8857
9153
  };
9154
+ /**
9155
+ * List category help articles
9156
+ * Returns a paginated list of all help articles associated with marketplace categories.
9157
+ */
8858
9158
  export const marketplaceCategoryHelpArticlesList = (options) => {
8859
9159
  return (options?.client ?? _heyApiClient).get({
8860
9160
  security: [
@@ -8872,6 +9172,7 @@ export const marketplaceCategoryHelpArticlesList = (options) => {
8872
9172
  });
8873
9173
  };
8874
9174
  /**
9175
+ * List category help articles
8875
9176
  * Get number of items in the collection matching the request parameters.
8876
9177
  */
8877
9178
  export const marketplaceCategoryHelpArticlesCount = (options) => {
@@ -8890,6 +9191,10 @@ export const marketplaceCategoryHelpArticlesCount = (options) => {
8890
9191
  ...options
8891
9192
  });
8892
9193
  };
9194
+ /**
9195
+ * Create a category help article
9196
+ * Creates a new help article and associates it with one or more categories. Requires staff permissions.
9197
+ */
8893
9198
  export const marketplaceCategoryHelpArticlesCreate = (options) => {
8894
9199
  return (options.client ?? _heyApiClient).post({
8895
9200
  security: [
@@ -8910,6 +9215,10 @@ export const marketplaceCategoryHelpArticlesCreate = (options) => {
8910
9215
  }
8911
9216
  });
8912
9217
  };
9218
+ /**
9219
+ * Delete a category help article
9220
+ * Deletes a help article. Requires staff permissions.
9221
+ */
8913
9222
  export const marketplaceCategoryHelpArticlesDestroy = (options) => {
8914
9223
  return (options.client ?? _heyApiClient).delete({
8915
9224
  security: [
@@ -8926,6 +9235,10 @@ export const marketplaceCategoryHelpArticlesDestroy = (options) => {
8926
9235
  ...options
8927
9236
  });
8928
9237
  };
9238
+ /**
9239
+ * Retrieve a category help article
9240
+ * Returns the details of a specific help article, identified by its ID.
9241
+ */
8929
9242
  export const marketplaceCategoryHelpArticlesRetrieve = (options) => {
8930
9243
  return (options.client ?? _heyApiClient).get({
8931
9244
  security: [
@@ -8942,6 +9255,10 @@ export const marketplaceCategoryHelpArticlesRetrieve = (options) => {
8942
9255
  ...options
8943
9256
  });
8944
9257
  };
9258
+ /**
9259
+ * Partially update a category help article
9260
+ * Partially updates an existing help article. Requires staff permissions.
9261
+ */
8945
9262
  export const marketplaceCategoryHelpArticlesPartialUpdate = (options) => {
8946
9263
  return (options.client ?? _heyApiClient).patch({
8947
9264
  security: [
@@ -8962,6 +9279,10 @@ export const marketplaceCategoryHelpArticlesPartialUpdate = (options) => {
8962
9279
  }
8963
9280
  });
8964
9281
  };
9282
+ /**
9283
+ * Update a category help article
9284
+ * Updates an existing help article. Requires staff permissions.
9285
+ */
8965
9286
  export const marketplaceCategoryHelpArticlesUpdate = (options) => {
8966
9287
  return (options.client ?? _heyApiClient).put({
8967
9288
  security: [
@@ -8982,6 +9303,10 @@ export const marketplaceCategoryHelpArticlesUpdate = (options) => {
8982
9303
  }
8983
9304
  });
8984
9305
  };
9306
+ /**
9307
+ * List component usage records
9308
+ * Returns a paginated list of component usage records for resources. This data is used for billing and usage tracking.
9309
+ */
8985
9310
  export const marketplaceComponentUsagesList = (options) => {
8986
9311
  return (options?.client ?? _heyApiClient).get({
8987
9312
  security: [
@@ -8999,6 +9324,7 @@ export const marketplaceComponentUsagesList = (options) => {
8999
9324
  });
9000
9325
  };
9001
9326
  /**
9327
+ * List component usage records
9002
9328
  * Get number of items in the collection matching the request parameters.
9003
9329
  */
9004
9330
  export const marketplaceComponentUsagesCount = (options) => {
@@ -9017,6 +9343,10 @@ export const marketplaceComponentUsagesCount = (options) => {
9017
9343
  ...options
9018
9344
  });
9019
9345
  };
9346
+ /**
9347
+ * Retrieve a component usage record
9348
+ * Returns the details of a specific component usage record.
9349
+ */
9020
9350
  export const marketplaceComponentUsagesRetrieve = (options) => {
9021
9351
  return (options.client ?? _heyApiClient).get({
9022
9352
  security: [
@@ -9033,6 +9363,16 @@ export const marketplaceComponentUsagesRetrieve = (options) => {
9033
9363
  ...options
9034
9364
  });
9035
9365
  };
9366
+ /**
9367
+ * Set user-specific component usage
9368
+ *
9369
+ * Allows a service provider to report usage for a specific user associated with a resource's component.
9370
+ * This is used for detailed, per-user usage tracking within a single resource.
9371
+ *
9372
+ * - If a user-specific usage record already exists for the given component usage, it will be updated.
9373
+ * - Otherwise, a new record is created.
9374
+ *
9375
+ */
9036
9376
  export const marketplaceComponentUsagesSetUserUsage = (options) => {
9037
9377
  return (options.client ?? _heyApiClient).post({
9038
9378
  security: [
@@ -9053,6 +9393,17 @@ export const marketplaceComponentUsagesSetUserUsage = (options) => {
9053
9393
  }
9054
9394
  });
9055
9395
  };
9396
+ /**
9397
+ * Set component usage for a resource
9398
+ *
9399
+ * Allows a service provider to report usage for one or more components of a specific resource.
9400
+ * This endpoint is typically used by backend systems or agents to submit periodic usage data.
9401
+ *
9402
+ * - If a `plan_period` is provided, the usage is associated with that period.
9403
+ * - If only a `resource` is provided, the system will determine the correct plan period based on the current date.
9404
+ * - If a usage record for the same resource, component, and billing period already exists, it will be updated. Otherwise, a new record is created.
9405
+ *
9406
+ */
9056
9407
  export const marketplaceComponentUsagesSetUsage = (options) => {
9057
9408
  return (options.client ?? _heyApiClient).post({
9058
9409
  security: [
@@ -9073,6 +9424,14 @@ export const marketplaceComponentUsagesSetUsage = (options) => {
9073
9424
  }
9074
9425
  });
9075
9426
  };
9427
+ /**
9428
+ * List user-specific component usages
9429
+ *
9430
+ * Returns a paginated list of component usage records attributed to specific users.
9431
+ * This provides a granular view of resource consumption, breaking down the total usage of a component
9432
+ * by individual users.
9433
+ *
9434
+ */
9076
9435
  export const marketplaceComponentUserUsagesList = (options) => {
9077
9436
  return (options?.client ?? _heyApiClient).get({
9078
9437
  security: [
@@ -9090,6 +9449,7 @@ export const marketplaceComponentUserUsagesList = (options) => {
9090
9449
  });
9091
9450
  };
9092
9451
  /**
9452
+ * List user-specific component usages
9093
9453
  * Get number of items in the collection matching the request parameters.
9094
9454
  */
9095
9455
  export const marketplaceComponentUserUsagesCount = (options) => {
@@ -9108,6 +9468,10 @@ export const marketplaceComponentUserUsagesCount = (options) => {
9108
9468
  ...options
9109
9469
  });
9110
9470
  };
9471
+ /**
9472
+ * Retrieve a user-specific component usage record
9473
+ * Returns the details of a single user-specific component usage record.
9474
+ */
9111
9475
  export const marketplaceComponentUserUsagesRetrieve = (options) => {
9112
9476
  return (options.client ?? _heyApiClient).get({
9113
9477
  security: [
@@ -9124,6 +9488,10 @@ export const marketplaceComponentUserUsagesRetrieve = (options) => {
9124
9488
  ...options
9125
9489
  });
9126
9490
  };
9491
+ /**
9492
+ * List course accounts
9493
+ * Returns a paginated list of course accounts accessible to the current user.
9494
+ */
9127
9495
  export const marketplaceCourseAccountsList = (options) => {
9128
9496
  return (options?.client ?? _heyApiClient).get({
9129
9497
  security: [
@@ -9141,6 +9509,7 @@ export const marketplaceCourseAccountsList = (options) => {
9141
9509
  });
9142
9510
  };
9143
9511
  /**
9512
+ * List course accounts
9144
9513
  * Get number of items in the collection matching the request parameters.
9145
9514
  */
9146
9515
  export const marketplaceCourseAccountsCount = (options) => {
@@ -9159,6 +9528,10 @@ export const marketplaceCourseAccountsCount = (options) => {
9159
9528
  ...options
9160
9529
  });
9161
9530
  };
9531
+ /**
9532
+ * Create a course account
9533
+ * Creates a new temporary course account within a specified course project.
9534
+ */
9162
9535
  export const marketplaceCourseAccountsCreate = (options) => {
9163
9536
  return (options.client ?? _heyApiClient).post({
9164
9537
  security: [
@@ -9179,6 +9552,10 @@ export const marketplaceCourseAccountsCreate = (options) => {
9179
9552
  }
9180
9553
  });
9181
9554
  };
9555
+ /**
9556
+ * Delete (close) a course account
9557
+ * Deletes a course account, which triggers a 'close' operation in the backend.
9558
+ */
9182
9559
  export const marketplaceCourseAccountsDestroy = (options) => {
9183
9560
  return (options.client ?? _heyApiClient).delete({
9184
9561
  security: [
@@ -9195,6 +9572,10 @@ export const marketplaceCourseAccountsDestroy = (options) => {
9195
9572
  ...options
9196
9573
  });
9197
9574
  };
9575
+ /**
9576
+ * Retrieve a course account
9577
+ * Returns the details of a specific course account.
9578
+ */
9198
9579
  export const marketplaceCourseAccountsRetrieve = (options) => {
9199
9580
  return (options.client ?? _heyApiClient).get({
9200
9581
  security: [
@@ -9211,6 +9592,10 @@ export const marketplaceCourseAccountsRetrieve = (options) => {
9211
9592
  ...options
9212
9593
  });
9213
9594
  };
9595
+ /**
9596
+ * Bulk create course accounts
9597
+ * Creates multiple course accounts within a specified course project in a single request.
9598
+ */
9214
9599
  export const marketplaceCourseAccountsCreateBulk = (options) => {
9215
9600
  return (options.client ?? _heyApiClient).post({
9216
9601
  security: [
@@ -9555,6 +9940,9 @@ export const marketplaceCustomerEstimatedCostPoliciesActionsCount = (options) =>
9555
9940
  ...options
9556
9941
  });
9557
9942
  };
9943
+ /**
9944
+ * List service accounts
9945
+ */
9558
9946
  export const marketplaceCustomerServiceAccountsList = (options) => {
9559
9947
  return (options?.client ?? _heyApiClient).get({
9560
9948
  security: [
@@ -9572,6 +9960,7 @@ export const marketplaceCustomerServiceAccountsList = (options) => {
9572
9960
  });
9573
9961
  };
9574
9962
  /**
9963
+ * List service accounts
9575
9964
  * Get number of items in the collection matching the request parameters.
9576
9965
  */
9577
9966
  export const marketplaceCustomerServiceAccountsCount = (options) => {
@@ -9590,6 +9979,10 @@ export const marketplaceCustomerServiceAccountsCount = (options) => {
9590
9979
  ...options
9591
9980
  });
9592
9981
  };
9982
+ /**
9983
+ * Create a customer service account
9984
+ * Creates a new service account scoped to a specific customer (organization). This generates an API key that can be used for automated access to resources across all projects within that customer.
9985
+ */
9593
9986
  export const marketplaceCustomerServiceAccountsCreate = (options) => {
9594
9987
  return (options.client ?? _heyApiClient).post({
9595
9988
  security: [
@@ -9610,6 +10003,10 @@ export const marketplaceCustomerServiceAccountsCreate = (options) => {
9610
10003
  }
9611
10004
  });
9612
10005
  };
10006
+ /**
10007
+ * Close a customer service account
10008
+ * Deactivates a customer service account and revokes its API key.
10009
+ */
9613
10010
  export const marketplaceCustomerServiceAccountsDestroy = (options) => {
9614
10011
  return (options.client ?? _heyApiClient).delete({
9615
10012
  security: [
@@ -9626,6 +10023,9 @@ export const marketplaceCustomerServiceAccountsDestroy = (options) => {
9626
10023
  ...options
9627
10024
  });
9628
10025
  };
10026
+ /**
10027
+ * Retrieve a service account
10028
+ */
9629
10029
  export const marketplaceCustomerServiceAccountsRetrieve = (options) => {
9630
10030
  return (options.client ?? _heyApiClient).get({
9631
10031
  security: [
@@ -9642,6 +10042,9 @@ export const marketplaceCustomerServiceAccountsRetrieve = (options) => {
9642
10042
  ...options
9643
10043
  });
9644
10044
  };
10045
+ /**
10046
+ * Partially update a service account
10047
+ */
9645
10048
  export const marketplaceCustomerServiceAccountsPartialUpdate = (options) => {
9646
10049
  return (options.client ?? _heyApiClient).patch({
9647
10050
  security: [
@@ -9662,6 +10065,9 @@ export const marketplaceCustomerServiceAccountsPartialUpdate = (options) => {
9662
10065
  }
9663
10066
  });
9664
10067
  };
10068
+ /**
10069
+ * Update a service account
10070
+ */
9665
10071
  export const marketplaceCustomerServiceAccountsUpdate = (options) => {
9666
10072
  return (options.client ?? _heyApiClient).put({
9667
10073
  security: [
@@ -9682,6 +10088,10 @@ export const marketplaceCustomerServiceAccountsUpdate = (options) => {
9682
10088
  }
9683
10089
  });
9684
10090
  };
10091
+ /**
10092
+ * Rotate API key for a customer service account
10093
+ * Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.
10094
+ */
9685
10095
  export const marketplaceCustomerServiceAccountsRotateApiKey = (options) => {
9686
10096
  return (options.client ?? _heyApiClient).post({
9687
10097
  security: [
@@ -9699,7 +10109,14 @@ export const marketplaceCustomerServiceAccountsRotateApiKey = (options) => {
9699
10109
  });
9700
10110
  };
9701
10111
  /**
9702
- * Count of resource categories for all resources accessible by user.
10112
+ * Get resource counts by category
10113
+ *
10114
+ * Returns a dictionary mapping marketplace category UUIDs to the count of active (non-terminated)
10115
+ * resources the current user has access to within that category. This is primarily used for UI
10116
+ * dashboards or sidebars to display the number of resources in each category filter.
10117
+ *
10118
+ * The counts can be further filtered by providing a `project_uuid` or `customer_uuid`.
10119
+ *
9703
10120
  */
9704
10121
  export const marketplaceGlobalCategoriesRetrieve = (options) => {
9705
10122
  return (options?.client ?? _heyApiClient).get({
@@ -9717,6 +10134,10 @@ export const marketplaceGlobalCategoriesRetrieve = (options) => {
9717
10134
  ...options
9718
10135
  });
9719
10136
  };
10137
+ /**
10138
+ * List integration statuses
10139
+ * Returns a paginated list of integration statuses for offerings. This is used to monitor the connectivity and health of backend agents (e.g., site agents) associated with offerings.
10140
+ */
9720
10141
  export const marketplaceIntegrationStatusesList = (options) => {
9721
10142
  return (options?.client ?? _heyApiClient).get({
9722
10143
  security: [
@@ -9734,6 +10155,7 @@ export const marketplaceIntegrationStatusesList = (options) => {
9734
10155
  });
9735
10156
  };
9736
10157
  /**
10158
+ * List integration statuses
9737
10159
  * Get number of items in the collection matching the request parameters.
9738
10160
  */
9739
10161
  export const marketplaceIntegrationStatusesCount = (options) => {
@@ -9752,6 +10174,10 @@ export const marketplaceIntegrationStatusesCount = (options) => {
9752
10174
  ...options
9753
10175
  });
9754
10176
  };
10177
+ /**
10178
+ * Retrieve an integration status
10179
+ * Returns the details of a specific integration status, including the agent type, status, and last request timestamp.
10180
+ */
9755
10181
  export const marketplaceIntegrationStatusesRetrieve = (options) => {
9756
10182
  return (options.client ?? _heyApiClient).get({
9757
10183
  security: [
@@ -10122,6 +10548,10 @@ export const marketplaceOfferingPermissionsRetrieve = (options) => {
10122
10548
  ...options
10123
10549
  });
10124
10550
  };
10551
+ /**
10552
+ * List Datacite referrals for offerings
10553
+ * Returns a paginated list of Datacite referrals associated with marketplace offerings. Referrals represent relationships between an offering (identified by a DOI) and other research outputs, such as publications or datasets. The list must be filtered by the offering's scope.
10554
+ */
10125
10555
  export const marketplaceOfferingReferralsList = (options) => {
10126
10556
  return (options?.client ?? _heyApiClient).get({
10127
10557
  security: [
@@ -10139,6 +10569,7 @@ export const marketplaceOfferingReferralsList = (options) => {
10139
10569
  });
10140
10570
  };
10141
10571
  /**
10572
+ * List Datacite referrals for offerings
10142
10573
  * Get number of items in the collection matching the request parameters.
10143
10574
  */
10144
10575
  export const marketplaceOfferingReferralsCount = (options) => {
@@ -10157,6 +10588,10 @@ export const marketplaceOfferingReferralsCount = (options) => {
10157
10588
  ...options
10158
10589
  });
10159
10590
  };
10591
+ /**
10592
+ * Retrieve a specific Datacite referral
10593
+ * Returns the details of a single Datacite referral record, identified by its UUID. Details include the related identifier (PID), the type of relationship, and metadata about the related work.
10594
+ */
10160
10595
  export const marketplaceOfferingReferralsRetrieve = (options) => {
10161
10596
  return (options.client ?? _heyApiClient).get({
10162
10597
  security: [
@@ -10173,6 +10608,10 @@ export const marketplaceOfferingReferralsRetrieve = (options) => {
10173
10608
  ...options
10174
10609
  });
10175
10610
  };
10611
+ /**
10612
+ * List Terms of Service configurations
10613
+ * Returns a paginated list of Terms of Service configurations for offerings. Visibility depends on user permissions: staff/support see all; service providers see their own; regular users see ToS for offerings they have consented to or shared offerings.
10614
+ */
10176
10615
  export const marketplaceOfferingTermsOfServiceList = (options) => {
10177
10616
  return (options?.client ?? _heyApiClient).get({
10178
10617
  security: [
@@ -10190,6 +10629,7 @@ export const marketplaceOfferingTermsOfServiceList = (options) => {
10190
10629
  });
10191
10630
  };
10192
10631
  /**
10632
+ * List Terms of Service configurations
10193
10633
  * Get number of items in the collection matching the request parameters.
10194
10634
  */
10195
10635
  export const marketplaceOfferingTermsOfServiceCount = (options) => {
@@ -10208,6 +10648,10 @@ export const marketplaceOfferingTermsOfServiceCount = (options) => {
10208
10648
  ...options
10209
10649
  });
10210
10650
  };
10651
+ /**
10652
+ * Create a Terms of Service configuration
10653
+ * Creates a new Terms of Service configuration for an offering. Only one active ToS configuration is allowed per offering.
10654
+ */
10211
10655
  export const marketplaceOfferingTermsOfServiceCreate = (options) => {
10212
10656
  return (options.client ?? _heyApiClient).post({
10213
10657
  security: [
@@ -10228,6 +10672,10 @@ export const marketplaceOfferingTermsOfServiceCreate = (options) => {
10228
10672
  }
10229
10673
  });
10230
10674
  };
10675
+ /**
10676
+ * Delete a Terms of Service configuration
10677
+ * Deletes a Terms of Service configuration. This is a hard delete and should be used with caution.
10678
+ */
10231
10679
  export const marketplaceOfferingTermsOfServiceDestroy = (options) => {
10232
10680
  return (options.client ?? _heyApiClient).delete({
10233
10681
  security: [
@@ -10244,6 +10692,10 @@ export const marketplaceOfferingTermsOfServiceDestroy = (options) => {
10244
10692
  ...options
10245
10693
  });
10246
10694
  };
10695
+ /**
10696
+ * Retrieve a Terms of Service configuration
10697
+ * Returns the details of a specific Terms of Service configuration.
10698
+ */
10247
10699
  export const marketplaceOfferingTermsOfServiceRetrieve = (options) => {
10248
10700
  return (options.client ?? _heyApiClient).get({
10249
10701
  security: [
@@ -10260,6 +10712,10 @@ export const marketplaceOfferingTermsOfServiceRetrieve = (options) => {
10260
10712
  ...options
10261
10713
  });
10262
10714
  };
10715
+ /**
10716
+ * Partially update a Terms of Service configuration
10717
+ * Partially updates an existing Terms of Service configuration.
10718
+ */
10263
10719
  export const marketplaceOfferingTermsOfServicePartialUpdate = (options) => {
10264
10720
  return (options.client ?? _heyApiClient).patch({
10265
10721
  security: [
@@ -10280,6 +10736,10 @@ export const marketplaceOfferingTermsOfServicePartialUpdate = (options) => {
10280
10736
  }
10281
10737
  });
10282
10738
  };
10739
+ /**
10740
+ * Update a Terms of Service configuration
10741
+ * Updates an existing Terms of Service configuration. Note that some fields like `version` and `requires_reconsent` are protected and cannot be changed after creation.
10742
+ */
10283
10743
  export const marketplaceOfferingTermsOfServiceUpdate = (options) => {
10284
10744
  return (options.client ?? _heyApiClient).put({
10285
10745
  security: [
@@ -10463,7 +10923,12 @@ export const marketplaceOfferingUsagePoliciesActionsCount = (options) => {
10463
10923
  });
10464
10924
  };
10465
10925
  /**
10466
- * Override list to add OfferingUser data optimization.
10926
+ * List checklist completions for offering users
10927
+ *
10928
+ * Returns a paginated list of all checklist completions for offering users that the current user is allowed to see.
10929
+ * This endpoint is used by service providers to monitor compliance status and by users to see their own required checklists.
10930
+ * Visibility follows the same rules as the `OfferingUsers` endpoint.
10931
+ *
10467
10932
  */
10468
10933
  export const marketplaceOfferingUserChecklistCompletionsList = (options) => {
10469
10934
  return (options?.client ?? _heyApiClient).get({
@@ -10482,6 +10947,7 @@ export const marketplaceOfferingUserChecklistCompletionsList = (options) => {
10482
10947
  });
10483
10948
  };
10484
10949
  /**
10950
+ * List checklist completions for offering users
10485
10951
  * Get number of items in the collection matching the request parameters.
10486
10952
  */
10487
10953
  export const marketplaceOfferingUserChecklistCompletionsCount = (options) => {
@@ -10500,6 +10966,10 @@ export const marketplaceOfferingUserChecklistCompletionsCount = (options) => {
10500
10966
  ...options
10501
10967
  });
10502
10968
  };
10969
+ /**
10970
+ * Retrieve a checklist completion
10971
+ * Returns the details of a specific checklist completion for an offering user.
10972
+ */
10503
10973
  export const marketplaceOfferingUserChecklistCompletionsRetrieve = (options) => {
10504
10974
  return (options.client ?? _heyApiClient).get({
10505
10975
  security: [
@@ -10643,6 +11113,10 @@ export const marketplaceOfferingUserRolesUpdate = (options) => {
10643
11113
  }
10644
11114
  });
10645
11115
  };
11116
+ /**
11117
+ * List offering users
11118
+ * Returns a paginated list of users associated with offerings. The visibility of users depends on the role of the authenticated user. Staff and support can see all users. Service providers can see users of their offerings if the user has consented. Regular users can only see their own offering-user records.
11119
+ */
10646
11120
  export const marketplaceOfferingUsersList = (options) => {
10647
11121
  return (options?.client ?? _heyApiClient).get({
10648
11122
  security: [
@@ -10660,6 +11134,7 @@ export const marketplaceOfferingUsersList = (options) => {
10660
11134
  });
10661
11135
  };
10662
11136
  /**
11137
+ * List offering users
10663
11138
  * Get number of items in the collection matching the request parameters.
10664
11139
  */
10665
11140
  export const marketplaceOfferingUsersCount = (options) => {
@@ -10678,6 +11153,10 @@ export const marketplaceOfferingUsersCount = (options) => {
10678
11153
  ...options
10679
11154
  });
10680
11155
  };
11156
+ /**
11157
+ * Create an offering user
11158
+ * Associates a user with a specific offering, creating an offering-specific user account. This is typically done by a service provider.
11159
+ */
10681
11160
  export const marketplaceOfferingUsersCreate = (options) => {
10682
11161
  return (options?.client ?? _heyApiClient).post({
10683
11162
  security: [
@@ -10698,6 +11177,10 @@ export const marketplaceOfferingUsersCreate = (options) => {
10698
11177
  }
10699
11178
  });
10700
11179
  };
11180
+ /**
11181
+ * Delete an offering user
11182
+ * Removes the association between a user and an offering. This action may trigger backend cleanup processes depending on the offering type.
11183
+ */
10701
11184
  export const marketplaceOfferingUsersDestroy = (options) => {
10702
11185
  return (options.client ?? _heyApiClient).delete({
10703
11186
  security: [
@@ -10714,6 +11197,10 @@ export const marketplaceOfferingUsersDestroy = (options) => {
10714
11197
  ...options
10715
11198
  });
10716
11199
  };
11200
+ /**
11201
+ * Retrieve an offering user
11202
+ * Returns the details of a specific offering-user link. Visibility follows the same rules as the list view.
11203
+ */
10717
11204
  export const marketplaceOfferingUsersRetrieve = (options) => {
10718
11205
  return (options.client ?? _heyApiClient).get({
10719
11206
  security: [
@@ -10770,6 +11257,10 @@ export const marketplaceOfferingUsersUpdate = (options) => {
10770
11257
  }
10771
11258
  });
10772
11259
  };
11260
+ /**
11261
+ * Begin creation process
11262
+ * Transitions the offering user state from 'Requested' or 'Error Creating' to 'Creating'. This is typically used by an agent to signal that the creation process has started.
11263
+ */
10773
11264
  export const marketplaceOfferingUsersBeginCreating = (options) => {
10774
11265
  return (options.client ?? _heyApiClient).post({
10775
11266
  security: [
@@ -10863,7 +11354,8 @@ export const marketplaceOfferingUsersCompletionStatusRetrieve = (options) => {
10863
11354
  });
10864
11355
  };
10865
11356
  /**
10866
- * Action to request deletion of an offering user account.
11357
+ * Request deletion of an offering user
11358
+ * Initiates the deletion process for an offering user account by transitioning it to the 'Deletion Requested' state.
10867
11359
  */
10868
11360
  export const marketplaceOfferingUsersRequestDeletion = (options) => {
10869
11361
  return (options.client ?? _heyApiClient).post({
@@ -10882,7 +11374,8 @@ export const marketplaceOfferingUsersRequestDeletion = (options) => {
10882
11374
  });
10883
11375
  };
10884
11376
  /**
10885
- * Action to mark an offering user as successfully deleted.
11377
+ * Set state to Deleted
11378
+ * Transitions the offering user to the 'Deleted' state, marking the successful completion of the deletion process.
10886
11379
  */
10887
11380
  export const marketplaceOfferingUsersSetDeleted = (options) => {
10888
11381
  return (options.client ?? _heyApiClient).post({
@@ -10901,7 +11394,8 @@ export const marketplaceOfferingUsersSetDeleted = (options) => {
10901
11394
  });
10902
11395
  };
10903
11396
  /**
10904
- * Action to begin the deletion process for an offering user.
11397
+ * Begin deletion process
11398
+ * Transitions the offering user to the 'Deleting' state. This is typically used by an agent to signal that the deletion process has started.
10905
11399
  */
10906
11400
  export const marketplaceOfferingUsersSetDeleting = (options) => {
10907
11401
  return (options.client ?? _heyApiClient).post({
@@ -10919,6 +11413,10 @@ export const marketplaceOfferingUsersSetDeleting = (options) => {
10919
11413
  ...options
10920
11414
  });
10921
11415
  };
11416
+ /**
11417
+ * Set state to Error Creating
11418
+ * Manually moves the offering user into the 'Error Creating' state. This is typically used by an agent to report a failure during the creation process.
11419
+ */
10922
11420
  export const marketplaceOfferingUsersSetErrorCreating = (options) => {
10923
11421
  return (options.client ?? _heyApiClient).post({
10924
11422
  security: [
@@ -10935,6 +11433,10 @@ export const marketplaceOfferingUsersSetErrorCreating = (options) => {
10935
11433
  ...options
10936
11434
  });
10937
11435
  };
11436
+ /**
11437
+ * Set state to Error Deleting
11438
+ * Manually moves the offering user into the 'Error Deleting' state. This is typically used by an agent to report a failure during the deletion process.
11439
+ */
10938
11440
  export const marketplaceOfferingUsersSetErrorDeleting = (options) => {
10939
11441
  return (options.client ?? _heyApiClient).post({
10940
11442
  security: [
@@ -10951,6 +11453,10 @@ export const marketplaceOfferingUsersSetErrorDeleting = (options) => {
10951
11453
  ...options
10952
11454
  });
10953
11455
  };
11456
+ /**
11457
+ * Set state to OK
11458
+ * Manually sets the offering user state to 'OK'. This can be used to recover from an error state or to complete a manual creation process.
11459
+ */
10954
11460
  export const marketplaceOfferingUsersSetOk = (options) => {
10955
11461
  return (options.client ?? _heyApiClient).post({
10956
11462
  security: [
@@ -10967,6 +11473,10 @@ export const marketplaceOfferingUsersSetOk = (options) => {
10967
11473
  ...options
10968
11474
  });
10969
11475
  };
11476
+ /**
11477
+ * Set state to Pending Account Linking
11478
+ * Transitions the state to 'Pending Account Linking' and allows a service provider to add a comment and a URL to guide the user.
11479
+ */
10970
11480
  export const marketplaceOfferingUsersSetPendingAccountLinking = (options) => {
10971
11481
  return (options.client ?? _heyApiClient).post({
10972
11482
  security: [
@@ -10987,6 +11497,10 @@ export const marketplaceOfferingUsersSetPendingAccountLinking = (options) => {
10987
11497
  }
10988
11498
  });
10989
11499
  };
11500
+ /**
11501
+ * Set state to Pending Additional Validation
11502
+ * Transitions the state to 'Pending Additional Validation' and allows a service provider to add a comment and a URL for the user to follow.
11503
+ */
10990
11504
  export const marketplaceOfferingUsersSetPendingAdditionalValidation = (options) => {
10991
11505
  return (options.client ?? _heyApiClient).post({
10992
11506
  security: [
@@ -11007,6 +11521,10 @@ export const marketplaceOfferingUsersSetPendingAdditionalValidation = (options)
11007
11521
  }
11008
11522
  });
11009
11523
  };
11524
+ /**
11525
+ * Set state to Validation Complete
11526
+ * Transitions the state from a pending validation state to 'OK', indicating that the user has completed the required steps. This clears any service provider comments.
11527
+ */
11010
11528
  export const marketplaceOfferingUsersSetValidationComplete = (options) => {
11011
11529
  return (options.client ?? _heyApiClient).post({
11012
11530
  security: [
@@ -11047,7 +11565,8 @@ export const marketplaceOfferingUsersSubmitAnswers = (options) => {
11047
11565
  });
11048
11566
  };
11049
11567
  /**
11050
- * Action for service providers to update comment and comment URL fields.
11568
+ * Update service provider comments
11569
+ * Allows a service provider to update the `service_provider_comment` and `service_provider_comment_url` fields for an offering user. This is often used to provide feedback or instructions during a pending state.
11051
11570
  */
11052
11571
  export const marketplaceOfferingUsersUpdateCommentsPartialUpdate = (options) => {
11053
11572
  return (options.client ?? _heyApiClient).patch({
@@ -11069,6 +11588,10 @@ export const marketplaceOfferingUsersUpdateCommentsPartialUpdate = (options) =>
11069
11588
  }
11070
11589
  });
11071
11590
  };
11591
+ /**
11592
+ * Update restriction status
11593
+ * Allows a service provider to mark an offering user as restricted or unrestricted. A restricted user may have limited access to the resource.
11594
+ */
11072
11595
  export const marketplaceOfferingUsersUpdateRestricted = (options) => {
11073
11596
  return (options.client ?? _heyApiClient).post({
11074
11597
  security: [
@@ -11127,6 +11650,10 @@ export const marketplaceOfferingUsersChecklistTemplateCount = (options) => {
11127
11650
  ...options
11128
11651
  });
11129
11652
  };
11653
+ /**
11654
+ * List orders
11655
+ * Returns a paginated list of orders accessible to the current user. Orders are visible to service consumers (project/customer members with appropriate permissions) and service providers.
11656
+ */
11130
11657
  export const marketplaceOrdersList = (options) => {
11131
11658
  return (options?.client ?? _heyApiClient).get({
11132
11659
  security: [
@@ -11144,6 +11671,7 @@ export const marketplaceOrdersList = (options) => {
11144
11671
  });
11145
11672
  };
11146
11673
  /**
11674
+ * List orders
11147
11675
  * Get number of items in the collection matching the request parameters.
11148
11676
  */
11149
11677
  export const marketplaceOrdersCount = (options) => {
@@ -11162,6 +11690,10 @@ export const marketplaceOrdersCount = (options) => {
11162
11690
  ...options
11163
11691
  });
11164
11692
  };
11693
+ /**
11694
+ * Create an order
11695
+ * Creates a new order to provision a resource. The order will be placed in a pending state and may require approval depending on the offering and user permissions.
11696
+ */
11165
11697
  export const marketplaceOrdersCreate = (options) => {
11166
11698
  return (options.client ?? _heyApiClient).post({
11167
11699
  security: [
@@ -11182,6 +11714,10 @@ export const marketplaceOrdersCreate = (options) => {
11182
11714
  }
11183
11715
  });
11184
11716
  };
11717
+ /**
11718
+ * Delete a pending order
11719
+ * Deletes an order that is still in a pending state (e.g., `pending-consumer` or `pending-provider`). Executing or completed orders cannot be deleted.
11720
+ */
11185
11721
  export const marketplaceOrdersDestroy = (options) => {
11186
11722
  return (options.client ?? _heyApiClient).delete({
11187
11723
  security: [
@@ -11198,6 +11734,10 @@ export const marketplaceOrdersDestroy = (options) => {
11198
11734
  ...options
11199
11735
  });
11200
11736
  };
11737
+ /**
11738
+ * Retrieve an order
11739
+ * Returns the details of a specific order.
11740
+ */
11201
11741
  export const marketplaceOrdersRetrieve = (options) => {
11202
11742
  return (options.client ?? _heyApiClient).get({
11203
11743
  security: [
@@ -11214,6 +11754,10 @@ export const marketplaceOrdersRetrieve = (options) => {
11214
11754
  ...options
11215
11755
  });
11216
11756
  };
11757
+ /**
11758
+ * Approve an order (consumer)
11759
+ * Approves a pending order from the consumer's side (e.g., project manager, customer owner). This transitions the order to the next state, which could be pending provider approval or executing.
11760
+ */
11217
11761
  export const marketplaceOrdersApproveByConsumer = (options) => {
11218
11762
  return (options.client ?? _heyApiClient).post({
11219
11763
  security: [
@@ -11230,6 +11774,10 @@ export const marketplaceOrdersApproveByConsumer = (options) => {
11230
11774
  ...options
11231
11775
  });
11232
11776
  };
11777
+ /**
11778
+ * Approve an order (provider)
11779
+ * Approves a pending order from the provider's side. This typically transitions the order to the executing state.
11780
+ */
11233
11781
  export const marketplaceOrdersApproveByProvider = (options) => {
11234
11782
  return (options.client ?? _heyApiClient).post({
11235
11783
  security: [
@@ -11246,6 +11794,10 @@ export const marketplaceOrdersApproveByProvider = (options) => {
11246
11794
  ...options
11247
11795
  });
11248
11796
  };
11797
+ /**
11798
+ * Cancel an order
11799
+ * Cancels an order. This is typically only possible for certain offering types (e.g., basic support) and in specific states (pending or executing).
11800
+ */
11249
11801
  export const marketplaceOrdersCancel = (options) => {
11250
11802
  return (options.client ?? _heyApiClient).post({
11251
11803
  security: [
@@ -11263,7 +11815,8 @@ export const marketplaceOrdersCancel = (options) => {
11263
11815
  });
11264
11816
  };
11265
11817
  /**
11266
- * Delete the attachment from a pending order.
11818
+ * Delete order attachment
11819
+ * Allows deleting an attachment from a pending order.
11267
11820
  */
11268
11821
  export const marketplaceOrdersDeleteAttachment = (options) => {
11269
11822
  return (options.client ?? _heyApiClient).post({
@@ -11281,6 +11834,10 @@ export const marketplaceOrdersDeleteAttachment = (options) => {
11281
11834
  ...options
11282
11835
  });
11283
11836
  };
11837
+ /**
11838
+ * Get offering details
11839
+ * Returns details of the offering connected to the requested object.
11840
+ */
11284
11841
  export const marketplaceOrdersOfferingRetrieve = (options) => {
11285
11842
  return (options.client ?? _heyApiClient).get({
11286
11843
  security: [
@@ -11297,6 +11854,10 @@ export const marketplaceOrdersOfferingRetrieve = (options) => {
11297
11854
  ...options
11298
11855
  });
11299
11856
  };
11857
+ /**
11858
+ * Reject an order (consumer)
11859
+ * Rejects a pending order from the consumer's side. This moves the order to the 'rejected' state.
11860
+ */
11300
11861
  export const marketplaceOrdersRejectByConsumer = (options) => {
11301
11862
  return (options.client ?? _heyApiClient).post({
11302
11863
  security: [
@@ -11313,6 +11874,10 @@ export const marketplaceOrdersRejectByConsumer = (options) => {
11313
11874
  ...options
11314
11875
  });
11315
11876
  };
11877
+ /**
11878
+ * Reject an order (provider)
11879
+ * Rejects a pending order from the provider's side. This moves the order to the 'rejected' state.
11880
+ */
11316
11881
  export const marketplaceOrdersRejectByProvider = (options) => {
11317
11882
  return (options.client ?? _heyApiClient).post({
11318
11883
  security: [
@@ -11329,6 +11894,10 @@ export const marketplaceOrdersRejectByProvider = (options) => {
11329
11894
  ...options
11330
11895
  });
11331
11896
  };
11897
+ /**
11898
+ * Set order backend ID
11899
+ * Allows a service provider or staff to set or update the backend ID associated with an order. This is useful for linking the order to an external system's identifier.
11900
+ */
11332
11901
  export const marketplaceOrdersSetBackendId = (options) => {
11333
11902
  return (options.client ?? _heyApiClient).post({
11334
11903
  security: [
@@ -11349,6 +11918,10 @@ export const marketplaceOrdersSetBackendId = (options) => {
11349
11918
  }
11350
11919
  });
11351
11920
  };
11921
+ /**
11922
+ * Set order state to done (agent)
11923
+ * Used by external agents (e.g., site agent) to manually transition the order state to 'done'. This is only applicable for specific offering types.
11924
+ */
11352
11925
  export const marketplaceOrdersSetStateDone = (options) => {
11353
11926
  return (options.client ?? _heyApiClient).post({
11354
11927
  security: [
@@ -11365,6 +11938,10 @@ export const marketplaceOrdersSetStateDone = (options) => {
11365
11938
  ...options
11366
11939
  });
11367
11940
  };
11941
+ /**
11942
+ * Set order state to erred (agent)
11943
+ * Used by external agents to report a failure during order processing. An error message and traceback can be provided.
11944
+ */
11368
11945
  export const marketplaceOrdersSetStateErred = (options) => {
11369
11946
  return (options.client ?? _heyApiClient).post({
11370
11947
  security: [
@@ -11385,6 +11962,10 @@ export const marketplaceOrdersSetStateErred = (options) => {
11385
11962
  }
11386
11963
  });
11387
11964
  };
11965
+ /**
11966
+ * Set order state to executing (agent)
11967
+ * Used by external agents (e.g., site agent) to manually transition the order state to 'executing'. This is only applicable for specific offering types.
11968
+ */
11388
11969
  export const marketplaceOrdersSetStateExecuting = (options) => {
11389
11970
  return (options.client ?? _heyApiClient).post({
11390
11971
  security: [
@@ -11401,6 +11982,10 @@ export const marketplaceOrdersSetStateExecuting = (options) => {
11401
11982
  ...options
11402
11983
  });
11403
11984
  };
11985
+ /**
11986
+ * Unlink an order (staff only)
11987
+ * Forcefully deletes an order from the database without affecting the backend resource. This is a staff-only administrative action used to clean up stuck or invalid orders.
11988
+ */
11404
11989
  export const marketplaceOrdersUnlink = (options) => {
11405
11990
  return (options.client ?? _heyApiClient).post({
11406
11991
  security: [
@@ -11418,7 +12003,8 @@ export const marketplaceOrdersUnlink = (options) => {
11418
12003
  });
11419
12004
  };
11420
12005
  /**
11421
- * Update the attachment for a pending order.
12006
+ * Update order attachment
12007
+ * Allows uploading or replacing a file attachment (e.g., a purchase order) for a pending order.
11422
12008
  */
11423
12009
  export const marketplaceOrdersUpdateAttachment = (options) => {
11424
12010
  return (options.client ?? _heyApiClient).post({
@@ -11440,6 +12026,10 @@ export const marketplaceOrdersUpdateAttachment = (options) => {
11440
12026
  }
11441
12027
  });
11442
12028
  };
12029
+ /**
12030
+ * List plan components
12031
+ * Returns a paginated list of all plan components. A plan component defines the pricing and quotas for an offering component within a billing plan. The list is filtered based on the current user's access permissions and organization group memberships.
12032
+ */
11443
12033
  export const marketplacePlanComponentsList = (options) => {
11444
12034
  return (options?.client ?? _heyApiClient).get({
11445
12035
  security: [
@@ -11457,6 +12047,7 @@ export const marketplacePlanComponentsList = (options) => {
11457
12047
  });
11458
12048
  };
11459
12049
  /**
12050
+ * List plan components
11460
12051
  * Get number of items in the collection matching the request parameters.
11461
12052
  */
11462
12053
  export const marketplacePlanComponentsCount = (options) => {
@@ -11475,6 +12066,10 @@ export const marketplacePlanComponentsCount = (options) => {
11475
12066
  ...options
11476
12067
  });
11477
12068
  };
12069
+ /**
12070
+ * Retrieve a plan component
12071
+ * Returns the details of a specific plan component, including its pricing, quotas, and associated offering and plan information.
12072
+ */
11478
12073
  export const marketplacePlanComponentsRetrieve = (options) => {
11479
12074
  return (options.client ?? _heyApiClient).get({
11480
12075
  security: [
@@ -11491,6 +12086,10 @@ export const marketplacePlanComponentsRetrieve = (options) => {
11491
12086
  ...options
11492
12087
  });
11493
12088
  };
12089
+ /**
12090
+ * List provider plans
12091
+ * Returns a paginated list of plans managed by the provider. The list is filtered based on the current user's access to the offering's customer.
12092
+ */
11494
12093
  export const marketplacePlansList = (options) => {
11495
12094
  return (options?.client ?? _heyApiClient).get({
11496
12095
  security: [
@@ -11508,6 +12107,7 @@ export const marketplacePlansList = (options) => {
11508
12107
  });
11509
12108
  };
11510
12109
  /**
12110
+ * List provider plans
11511
12111
  * Get number of items in the collection matching the request parameters.
11512
12112
  */
11513
12113
  export const marketplacePlansCount = (options) => {
@@ -11526,6 +12126,10 @@ export const marketplacePlansCount = (options) => {
11526
12126
  ...options
11527
12127
  });
11528
12128
  };
12129
+ /**
12130
+ * Create a provider plan
12131
+ * Creates a new billing plan for an offering.
12132
+ */
11529
12133
  export const marketplacePlansCreate = (options) => {
11530
12134
  return (options.client ?? _heyApiClient).post({
11531
12135
  security: [
@@ -11546,6 +12150,10 @@ export const marketplacePlansCreate = (options) => {
11546
12150
  }
11547
12151
  });
11548
12152
  };
12153
+ /**
12154
+ * Delete a provider plan
12155
+ * Deletes a plan. This is a hard delete and should be used with caution.
12156
+ */
11549
12157
  export const marketplacePlansDestroy = (options) => {
11550
12158
  return (options.client ?? _heyApiClient).delete({
11551
12159
  security: [
@@ -11562,6 +12170,10 @@ export const marketplacePlansDestroy = (options) => {
11562
12170
  ...options
11563
12171
  });
11564
12172
  };
12173
+ /**
12174
+ * Retrieve a provider plan
12175
+ * Returns details of a specific plan.
12176
+ */
11565
12177
  export const marketplacePlansRetrieve = (options) => {
11566
12178
  return (options.client ?? _heyApiClient).get({
11567
12179
  security: [
@@ -11578,6 +12190,10 @@ export const marketplacePlansRetrieve = (options) => {
11578
12190
  ...options
11579
12191
  });
11580
12192
  };
12193
+ /**
12194
+ * Partially update a provider plan
12195
+ * Partially updates an existing plan. Note: A plan cannot be updated if it is already used by resources.
12196
+ */
11581
12197
  export const marketplacePlansPartialUpdate = (options) => {
11582
12198
  return (options.client ?? _heyApiClient).patch({
11583
12199
  security: [
@@ -11598,6 +12214,10 @@ export const marketplacePlansPartialUpdate = (options) => {
11598
12214
  }
11599
12215
  });
11600
12216
  };
12217
+ /**
12218
+ * Update a provider plan
12219
+ * Updates an existing plan. Note: A plan cannot be updated if it is already used by resources.
12220
+ */
11601
12221
  export const marketplacePlansUpdate = (options) => {
11602
12222
  return (options.client ?? _heyApiClient).put({
11603
12223
  security: [
@@ -11618,6 +12238,10 @@ export const marketplacePlansUpdate = (options) => {
11618
12238
  }
11619
12239
  });
11620
12240
  };
12241
+ /**
12242
+ * Archive a plan
12243
+ * Marks a plan as archived. Archived plans cannot be used for provisioning new resources, but existing resources will continue to be billed according to this plan.
12244
+ */
11621
12245
  export const marketplacePlansArchive = (options) => {
11622
12246
  return (options.client ?? _heyApiClient).post({
11623
12247
  security: [
@@ -11634,6 +12258,10 @@ export const marketplacePlansArchive = (options) => {
11634
12258
  ...options
11635
12259
  });
11636
12260
  };
12261
+ /**
12262
+ * Remove all organization groups from a plan
12263
+ * Removes all organization group associations from this plan, making it accessible to all users (subject to offering-level restrictions).
12264
+ */
11637
12265
  export const marketplacePlansDeleteOrganizationGroups = (options) => {
11638
12266
  return (options.client ?? _heyApiClient).post({
11639
12267
  security: [
@@ -11651,6 +12279,8 @@ export const marketplacePlansDeleteOrganizationGroups = (options) => {
11651
12279
  });
11652
12280
  };
11653
12281
  /**
12282
+ * Update plan component discounts
12283
+ *
11654
12284
  * Update volume discount configuration for plan components.
11655
12285
  *
11656
12286
  * This endpoint allows updating discount thresholds and rates for multiple
@@ -11658,8 +12288,9 @@ export const marketplacePlansDeleteOrganizationGroups = (options) => {
11658
12288
  * when limit quantities meet or exceed the threshold.
11659
12289
  *
11660
12290
  * The discount configuration affects future billing:
11661
- * - Creates separate invoice items showing the discount
11662
- * - Can be enabled or disabled per component
12291
+ * - Creates separate invoice items showing the discount.
12292
+ * - Can be enabled or disabled per component.
12293
+ *
11663
12294
  */
11664
12295
  export const marketplacePlansUpdateDiscounts = (options) => {
11665
12296
  return (options.client ?? _heyApiClient).post({
@@ -11681,6 +12312,10 @@ export const marketplacePlansUpdateDiscounts = (options) => {
11681
12312
  }
11682
12313
  });
11683
12314
  };
12315
+ /**
12316
+ * Update organization groups for a plan
12317
+ * Sets the list of organization groups that are allowed to access this plan. If the list is empty, the plan is accessible to all.
12318
+ */
11684
12319
  export const marketplacePlansUpdateOrganizationGroups = (options) => {
11685
12320
  return (options.client ?? _heyApiClient).post({
11686
12321
  security: [
@@ -11701,6 +12336,10 @@ export const marketplacePlansUpdateOrganizationGroups = (options) => {
11701
12336
  }
11702
12337
  });
11703
12338
  };
12339
+ /**
12340
+ * Update plan component prices
12341
+ * Updates the prices for one or more components of a specific plan. If the plan is already in use by resources, this action updates the `future_price`, which will be applied from the next billing period. Otherwise, the current `price` is updated directly.
12342
+ */
11704
12343
  export const marketplacePlansUpdatePrices = (options) => {
11705
12344
  return (options.client ?? _heyApiClient).post({
11706
12345
  security: [
@@ -11721,6 +12360,10 @@ export const marketplacePlansUpdatePrices = (options) => {
11721
12360
  }
11722
12361
  });
11723
12362
  };
12363
+ /**
12364
+ * Update plan component quotas
12365
+ * Updates the quotas (fixed amounts) for one or more components of a specific plan. This is only applicable for components with a 'fixed-price' billing type.
12366
+ */
11724
12367
  export const marketplacePlansUpdateQuotas = (options) => {
11725
12368
  return (options.client ?? _heyApiClient).post({
11726
12369
  security: [
@@ -11741,6 +12384,10 @@ export const marketplacePlansUpdateQuotas = (options) => {
11741
12384
  }
11742
12385
  });
11743
12386
  };
12387
+ /**
12388
+ * Get plan usage statistics
12389
+ * Returns aggregated statistics on how many resources are currently using each plan. Can be filtered by offering or service provider.
12390
+ */
11744
12391
  export const marketplacePlansUsageStatsList = (options) => {
11745
12392
  return (options?.client ?? _heyApiClient).get({
11746
12393
  security: [
@@ -11758,6 +12405,7 @@ export const marketplacePlansUsageStatsList = (options) => {
11758
12405
  });
11759
12406
  };
11760
12407
  /**
12408
+ * Get plan usage statistics
11761
12409
  * Get number of items in the collection matching the request parameters.
11762
12410
  */
11763
12411
  export const marketplacePlansUsageStatsCount = (options) => {
@@ -11776,6 +12424,18 @@ export const marketplacePlansUsageStatsCount = (options) => {
11776
12424
  ...options
11777
12425
  });
11778
12426
  };
12427
+ /**
12428
+ * List available marketplace plugins and their components
12429
+ *
12430
+ * Returns a list of all registered marketplace plugins (offering types) and the components
12431
+ * associated with each. This endpoint is public and does not require authentication.
12432
+ *
12433
+ * Each plugin entry includes:
12434
+ * - `offering_type`: A unique identifier for the plugin.
12435
+ * - `components`: A list of components provided by the plugin, each with its `type`, `name`, `measured_unit`, and `billing_type`.
12436
+ * - `available_limits`: A list of component types that support user-defined limits for this plugin.
12437
+ *
12438
+ */
11779
12439
  export const marketplacePluginsList = (options) => {
11780
12440
  return (options?.client ?? _heyApiClient).get({
11781
12441
  url: '/api/marketplace-plugins/',
@@ -11944,6 +12604,9 @@ export const marketplaceProjectEstimatedCostPoliciesActionsCount = (options) =>
11944
12604
  ...options
11945
12605
  });
11946
12606
  };
12607
+ /**
12608
+ * List service accounts
12609
+ */
11947
12610
  export const marketplaceProjectServiceAccountsList = (options) => {
11948
12611
  return (options?.client ?? _heyApiClient).get({
11949
12612
  security: [
@@ -11961,6 +12624,7 @@ export const marketplaceProjectServiceAccountsList = (options) => {
11961
12624
  });
11962
12625
  };
11963
12626
  /**
12627
+ * List service accounts
11964
12628
  * Get number of items in the collection matching the request parameters.
11965
12629
  */
11966
12630
  export const marketplaceProjectServiceAccountsCount = (options) => {
@@ -11979,6 +12643,10 @@ export const marketplaceProjectServiceAccountsCount = (options) => {
11979
12643
  ...options
11980
12644
  });
11981
12645
  };
12646
+ /**
12647
+ * Create a project service account
12648
+ * Creates a new service account scoped to a specific project. This generates an API key that can be used for automated access to resources within that project.
12649
+ */
11982
12650
  export const marketplaceProjectServiceAccountsCreate = (options) => {
11983
12651
  return (options.client ?? _heyApiClient).post({
11984
12652
  security: [
@@ -11999,6 +12667,10 @@ export const marketplaceProjectServiceAccountsCreate = (options) => {
11999
12667
  }
12000
12668
  });
12001
12669
  };
12670
+ /**
12671
+ * Close a project service account
12672
+ * Deactivates a project service account and revokes its API key.
12673
+ */
12002
12674
  export const marketplaceProjectServiceAccountsDestroy = (options) => {
12003
12675
  return (options.client ?? _heyApiClient).delete({
12004
12676
  security: [
@@ -12015,6 +12687,9 @@ export const marketplaceProjectServiceAccountsDestroy = (options) => {
12015
12687
  ...options
12016
12688
  });
12017
12689
  };
12690
+ /**
12691
+ * Retrieve a service account
12692
+ */
12018
12693
  export const marketplaceProjectServiceAccountsRetrieve = (options) => {
12019
12694
  return (options.client ?? _heyApiClient).get({
12020
12695
  security: [
@@ -12031,6 +12706,9 @@ export const marketplaceProjectServiceAccountsRetrieve = (options) => {
12031
12706
  ...options
12032
12707
  });
12033
12708
  };
12709
+ /**
12710
+ * Partially update a service account
12711
+ */
12034
12712
  export const marketplaceProjectServiceAccountsPartialUpdate = (options) => {
12035
12713
  return (options.client ?? _heyApiClient).patch({
12036
12714
  security: [
@@ -12051,6 +12729,9 @@ export const marketplaceProjectServiceAccountsPartialUpdate = (options) => {
12051
12729
  }
12052
12730
  });
12053
12731
  };
12732
+ /**
12733
+ * Update a service account
12734
+ */
12054
12735
  export const marketplaceProjectServiceAccountsUpdate = (options) => {
12055
12736
  return (options.client ?? _heyApiClient).put({
12056
12737
  security: [
@@ -12071,6 +12752,10 @@ export const marketplaceProjectServiceAccountsUpdate = (options) => {
12071
12752
  }
12072
12753
  });
12073
12754
  };
12755
+ /**
12756
+ * Rotate API key for a project service account
12757
+ * Generates a new API key for the service account, immediately invalidating the old one. The new key is returned in the response.
12758
+ */
12074
12759
  export const marketplaceProjectServiceAccountsRotateApiKey = (options) => {
12075
12760
  return (options.client ?? _heyApiClient).post({
12076
12761
  security: [
@@ -12184,6 +12869,10 @@ export const marketplaceProjectUpdateRequestsReject = (options) => {
12184
12869
  }
12185
12870
  });
12186
12871
  };
12872
+ /**
12873
+ * List provider offerings
12874
+ * Returns a paginated list of offerings for the provider.
12875
+ */
12187
12876
  export const marketplaceProviderOfferingsList = (options) => {
12188
12877
  return (options?.client ?? _heyApiClient).get({
12189
12878
  security: [
@@ -12201,6 +12890,7 @@ export const marketplaceProviderOfferingsList = (options) => {
12201
12890
  });
12202
12891
  };
12203
12892
  /**
12893
+ * List provider offerings
12204
12894
  * Get number of items in the collection matching the request parameters.
12205
12895
  */
12206
12896
  export const marketplaceProviderOfferingsCount = (options) => {
@@ -12219,6 +12909,10 @@ export const marketplaceProviderOfferingsCount = (options) => {
12219
12909
  ...options
12220
12910
  });
12221
12911
  };
12912
+ /**
12913
+ * Create a provider offering
12914
+ * Creates a new provider offering.
12915
+ */
12222
12916
  export const marketplaceProviderOfferingsCreate = (options) => {
12223
12917
  return (options.client ?? _heyApiClient).post({
12224
12918
  security: [
@@ -12239,6 +12933,10 @@ export const marketplaceProviderOfferingsCreate = (options) => {
12239
12933
  }
12240
12934
  });
12241
12935
  };
12936
+ /**
12937
+ * Delete a provider offering
12938
+ * Deletes a provider offering. Only possible for offerings in a Draft state with no associated resources.
12939
+ */
12242
12940
  export const marketplaceProviderOfferingsDestroy = (options) => {
12243
12941
  return (options.client ?? _heyApiClient).delete({
12244
12942
  security: [
@@ -12255,6 +12953,10 @@ export const marketplaceProviderOfferingsDestroy = (options) => {
12255
12953
  ...options
12256
12954
  });
12257
12955
  };
12956
+ /**
12957
+ * Retrieve a provider offering
12958
+ * Returns details of a specific provider offering.
12959
+ */
12258
12960
  export const marketplaceProviderOfferingsRetrieve = (options) => {
12259
12961
  return (options.client ?? _heyApiClient).get({
12260
12962
  security: [
@@ -12271,6 +12973,10 @@ export const marketplaceProviderOfferingsRetrieve = (options) => {
12271
12973
  ...options
12272
12974
  });
12273
12975
  };
12976
+ /**
12977
+ * Activate an offering
12978
+ * Activates a draft or paused offering, making it available for ordering.
12979
+ */
12274
12980
  export const marketplaceProviderOfferingsActivate = (options) => {
12275
12981
  return (options.client ?? _heyApiClient).post({
12276
12982
  security: [
@@ -12288,7 +12994,8 @@ export const marketplaceProviderOfferingsActivate = (options) => {
12288
12994
  });
12289
12995
  };
12290
12996
  /**
12291
- * Add endpoint to offering.
12997
+ * Add an access endpoint to an offering
12998
+ * Adds a new access endpoint (URL) to an offering.
12292
12999
  */
12293
13000
  export const marketplaceProviderOfferingsAddEndpoint = (options) => {
12294
13001
  return (options.client ?? _heyApiClient).post({
@@ -12311,7 +13018,8 @@ export const marketplaceProviderOfferingsAddEndpoint = (options) => {
12311
13018
  });
12312
13019
  };
12313
13020
  /**
12314
- * Add SLURM partition configuration to offering.
13021
+ * Add a partition to an offering
13022
+ * Adds a new partition configuration to an offering.
12315
13023
  */
12316
13024
  export const marketplaceProviderOfferingsAddPartition = (options) => {
12317
13025
  return (options.client ?? _heyApiClient).post({
@@ -12334,7 +13042,8 @@ export const marketplaceProviderOfferingsAddPartition = (options) => {
12334
13042
  });
12335
13043
  };
12336
13044
  /**
12337
- * Add software catalog to offering.
13045
+ * Add a software catalog to an offering
13046
+ * Associates a software catalog with an offering and configures enabled CPU architectures.
12338
13047
  */
12339
13048
  export const marketplaceProviderOfferingsAddSoftwareCatalog = (options) => {
12340
13049
  return (options.client ?? _heyApiClient).post({
@@ -12380,6 +13089,10 @@ export const marketplaceProviderOfferingsAddUser = (options) => {
12380
13089
  }
12381
13090
  });
12382
13091
  };
13092
+ /**
13093
+ * Archive an offering
13094
+ * Archives an offering, making it permanently unavailable for new orders.
13095
+ */
12383
13096
  export const marketplaceProviderOfferingsArchive = (options) => {
12384
13097
  return (options.client ?? _heyApiClient).post({
12385
13098
  security: [
@@ -12397,7 +13110,8 @@ export const marketplaceProviderOfferingsArchive = (options) => {
12397
13110
  });
12398
13111
  };
12399
13112
  /**
12400
- * Get statistics for offering components.
13113
+ * Get statistics for offering components
13114
+ * Returns monthly usage statistics for the components of an offering within a specified date range.
12401
13115
  */
12402
13116
  export const marketplaceProviderOfferingsComponentStatsList = (options) => {
12403
13117
  return (options.client ?? _heyApiClient).get({
@@ -12416,7 +13130,8 @@ export const marketplaceProviderOfferingsComponentStatsList = (options) => {
12416
13130
  });
12417
13131
  };
12418
13132
  /**
12419
- * Get costs for offering.
13133
+ * Get costs for an offering
13134
+ * Returns monthly cost data for an offering within a specified date range.
12420
13135
  */
12421
13136
  export const marketplaceProviderOfferingsCostsList = (options) => {
12422
13137
  return (options.client ?? _heyApiClient).get({
@@ -12434,6 +13149,10 @@ export const marketplaceProviderOfferingsCostsList = (options) => {
12434
13149
  ...options
12435
13150
  });
12436
13151
  };
13152
+ /**
13153
+ * Create an offering component
13154
+ * Adds a new custom component to an offering.
13155
+ */
12437
13156
  export const marketplaceProviderOfferingsCreateOfferingComponent = (options) => {
12438
13157
  return (options.client ?? _heyApiClient).post({
12439
13158
  security: [
@@ -12455,7 +13174,8 @@ export const marketplaceProviderOfferingsCreateOfferingComponent = (options) =>
12455
13174
  });
12456
13175
  };
12457
13176
  /**
12458
- * Get customers for offering.
13177
+ * Get customers for an offering
13178
+ * Returns a paginated list of customers who have resources for this offering.
12459
13179
  */
12460
13180
  export const marketplaceProviderOfferingsCustomersList = (options) => {
12461
13181
  return (options.client ?? _heyApiClient).get({
@@ -12474,7 +13194,8 @@ export const marketplaceProviderOfferingsCustomersList = (options) => {
12474
13194
  });
12475
13195
  };
12476
13196
  /**
12477
- * Delete endpoint from offering.
13197
+ * Delete an access endpoint from an offering
13198
+ * Deletes an existing access endpoint from an offering by its UUID.
12478
13199
  */
12479
13200
  export const marketplaceProviderOfferingsDeleteEndpoint = (options) => {
12480
13201
  return (options.client ?? _heyApiClient).post({
@@ -12497,7 +13218,8 @@ export const marketplaceProviderOfferingsDeleteEndpoint = (options) => {
12497
13218
  });
12498
13219
  };
12499
13220
  /**
12500
- * Delete offering image.
13221
+ * Delete offering image
13222
+ * Deletes the main image of an offering.
12501
13223
  */
12502
13224
  export const marketplaceProviderOfferingsDeleteImage = (options) => {
12503
13225
  return (options.client ?? _heyApiClient).post({
@@ -12516,7 +13238,8 @@ export const marketplaceProviderOfferingsDeleteImage = (options) => {
12516
13238
  });
12517
13239
  };
12518
13240
  /**
12519
- * Delete organization groups for offering.
13241
+ * Delete organization groups for offering
13242
+ * Removes all organization group associations from this offering, making it accessible to all.
12520
13243
  */
12521
13244
  export const marketplaceProviderOfferingsDeleteOrganizationGroups = (options) => {
12522
13245
  return (options.client ?? _heyApiClient).post({
@@ -12535,7 +13258,8 @@ export const marketplaceProviderOfferingsDeleteOrganizationGroups = (options) =>
12535
13258
  });
12536
13259
  };
12537
13260
  /**
12538
- * Delete offering thumbnail.
13261
+ * Delete offering thumbnail
13262
+ * Deletes the thumbnail image of an offering.
12539
13263
  */
12540
13264
  export const marketplaceProviderOfferingsDeleteThumbnail = (options) => {
12541
13265
  return (options.client ?? _heyApiClient).post({
@@ -12577,6 +13301,10 @@ export const marketplaceProviderOfferingsDeleteUser = (options) => {
12577
13301
  }
12578
13302
  });
12579
13303
  };
13304
+ /**
13305
+ * Move an offering to draft
13306
+ * Moves an active or paused offering back to the draft state for editing.
13307
+ */
12580
13308
  export const marketplaceProviderOfferingsDraft = (options) => {
12581
13309
  return (options.client ?? _heyApiClient).post({
12582
13310
  security: [
@@ -12594,10 +13322,24 @@ export const marketplaceProviderOfferingsDraft = (options) => {
12594
13322
  });
12595
13323
  };
12596
13324
  /**
12597
- * This endpoint provides a config file for GLauth
12598
- * Example: https://github.com/glauth/glauth/blob/master/v2/sample-simple.cfg
12599
- * It is assumed that the config is used by an external agent,
12600
- * which synchronizes data from Waldur to GLauth
13325
+ * Get GLauth user configuration
13326
+ *
13327
+ * This endpoint provides a configuration file for GLauth.
13328
+ * It is intended to be used by an external agent to synchronize user data from Waldur to GLauth.
13329
+ *
13330
+ * Example output format:
13331
+ * ```
13332
+ * [[users]]
13333
+ * name = "johndoe"
13334
+ * givenname="John"
13335
+ * sn="Doe"
13336
+ * mail = "john.doe@example.com"
13337
+ * ...
13338
+ * [[groups]]
13339
+ * name = "group1"
13340
+ * gidnumber = 1001
13341
+ * ```
13342
+ *
12601
13343
  */
12602
13344
  export const marketplaceProviderOfferingsGlauthUsersConfigRetrieve = (options) => {
12603
13345
  return (options.client ?? _heyApiClient).get({
@@ -12615,6 +13357,10 @@ export const marketplaceProviderOfferingsGlauthUsersConfigRetrieve = (options) =
12615
13357
  ...options
12616
13358
  });
12617
13359
  };
13360
+ /**
13361
+ * Import a resource
13362
+ * Imports a backend resource into the marketplace.
13363
+ */
12618
13364
  export const marketplaceProviderOfferingsImportResource = (options) => {
12619
13365
  return (options.client ?? _heyApiClient).post({
12620
13366
  security: [
@@ -12636,7 +13382,8 @@ export const marketplaceProviderOfferingsImportResource = (options) => {
12636
13382
  });
12637
13383
  };
12638
13384
  /**
12639
- * List importable resources for offering.
13385
+ * List importable resources
13386
+ * Returns a paginated list of resources that can be imported for this offering.
12640
13387
  */
12641
13388
  export const marketplaceProviderOfferingsImportableResourcesList = (options) => {
12642
13389
  return (options.client ?? _heyApiClient).get({
@@ -12654,7 +13401,11 @@ export const marketplaceProviderOfferingsImportableResourcesList = (options) =>
12654
13401
  ...options
12655
13402
  });
12656
13403
  };
12657
- export const marketplaceProviderOfferingsListCourseAccountsRetrieve = (options) => {
13404
+ /**
13405
+ * List course accounts for an offering
13406
+ * Returns a paginated list of course accounts for projects that have resources of this offering.
13407
+ */
13408
+ export const marketplaceProviderOfferingsListCourseAccountsList = (options) => {
12658
13409
  return (options.client ?? _heyApiClient).get({
12659
13410
  security: [
12660
13411
  {
@@ -12670,6 +13421,10 @@ export const marketplaceProviderOfferingsListCourseAccountsRetrieve = (options)
12670
13421
  ...options
12671
13422
  });
12672
13423
  };
13424
+ /**
13425
+ * List customer projects for an offering
13426
+ * Returns a paginated list of projects that have consumed resources of this offering.
13427
+ */
12673
13428
  export const marketplaceProviderOfferingsListCustomerProjectsList = (options) => {
12674
13429
  return (options.client ?? _heyApiClient).get({
12675
13430
  security: [
@@ -12686,7 +13441,11 @@ export const marketplaceProviderOfferingsListCustomerProjectsList = (options) =>
12686
13441
  ...options
12687
13442
  });
12688
13443
  };
12689
- export const marketplaceProviderOfferingsListCustomerServiceAccountsRetrieve = (options) => {
13444
+ /**
13445
+ * List customer service accounts for an offering
13446
+ * Returns a paginated list of customer-level service accounts for customers who have resources of this offering.
13447
+ */
13448
+ export const marketplaceProviderOfferingsListCustomerServiceAccountsList = (options) => {
12690
13449
  return (options.client ?? _heyApiClient).get({
12691
13450
  security: [
12692
13451
  {
@@ -12702,6 +13461,10 @@ export const marketplaceProviderOfferingsListCustomerServiceAccountsRetrieve = (
12702
13461
  ...options
12703
13462
  });
12704
13463
  };
13464
+ /**
13465
+ * List customer users for an offering
13466
+ * Returns a paginated list of users who have access to resources of this offering.
13467
+ */
12705
13468
  export const marketplaceProviderOfferingsListCustomerUsersList = (options) => {
12706
13469
  return (options.client ?? _heyApiClient).get({
12707
13470
  security: [
@@ -12718,7 +13481,11 @@ export const marketplaceProviderOfferingsListCustomerUsersList = (options) => {
12718
13481
  ...options
12719
13482
  });
12720
13483
  };
12721
- export const marketplaceProviderOfferingsListProjectServiceAccountsRetrieve = (options) => {
13484
+ /**
13485
+ * List project service accounts for an offering
13486
+ * Returns a paginated list of project-level service accounts for projects that have resources of this offering.
13487
+ */
13488
+ export const marketplaceProviderOfferingsListProjectServiceAccountsList = (options) => {
12722
13489
  return (options.client ?? _heyApiClient).get({
12723
13490
  security: [
12724
13491
  {
@@ -12754,6 +13521,10 @@ export const marketplaceProviderOfferingsListUsersList = (options) => {
12754
13521
  ...options
12755
13522
  });
12756
13523
  };
13524
+ /**
13525
+ * Move an offering
13526
+ * Moves an offering to a different service provider. Requires staff permissions.
13527
+ */
12757
13528
  export const marketplaceProviderOfferingsMoveOffering = (options) => {
12758
13529
  return (options.client ?? _heyApiClient).post({
12759
13530
  security: [
@@ -12774,6 +13545,10 @@ export const marketplaceProviderOfferingsMoveOffering = (options) => {
12774
13545
  }
12775
13546
  });
12776
13547
  };
13548
+ /**
13549
+ * List orders for an offering
13550
+ * Returns a paginated list of orders associated with a specific offering.
13551
+ */
12777
13552
  export const marketplaceProviderOfferingsOrdersList = (options) => {
12778
13553
  return (options.client ?? _heyApiClient).get({
12779
13554
  security: [
@@ -12790,6 +13565,10 @@ export const marketplaceProviderOfferingsOrdersList = (options) => {
12790
13565
  ...options
12791
13566
  });
12792
13567
  };
13568
+ /**
13569
+ * Retrieve a specific order for an offering
13570
+ * Returns details of a specific order associated with an offering.
13571
+ */
12793
13572
  export const marketplaceProviderOfferingsOrdersRetrieve = (options) => {
12794
13573
  return (options.client ?? _heyApiClient).get({
12795
13574
  security: [
@@ -12806,6 +13585,10 @@ export const marketplaceProviderOfferingsOrdersRetrieve = (options) => {
12806
13585
  ...options
12807
13586
  });
12808
13587
  };
13588
+ /**
13589
+ * Pause an offering
13590
+ * Pauses an active offering, preventing new orders from being created.
13591
+ */
12809
13592
  export const marketplaceProviderOfferingsPause = (options) => {
12810
13593
  return (options.client ?? _heyApiClient).post({
12811
13594
  security: [
@@ -12827,7 +13610,8 @@ export const marketplaceProviderOfferingsPause = (options) => {
12827
13610
  });
12828
13611
  };
12829
13612
  /**
12830
- * Refresh offering user usernames.
13613
+ * Refresh offering user usernames
13614
+ * Triggers a refresh of usernames for all non-restricted users associated with this offering, based on the current username generation policy.
12831
13615
  */
12832
13616
  export const marketplaceProviderOfferingsRefreshOfferingUsernames = (options) => {
12833
13617
  return (options.client ?? _heyApiClient).post({
@@ -12845,6 +13629,10 @@ export const marketplaceProviderOfferingsRefreshOfferingUsernames = (options) =>
12845
13629
  ...options
12846
13630
  });
12847
13631
  };
13632
+ /**
13633
+ * Remove an offering component
13634
+ * Removes a custom component from an offering. Built-in components cannot be removed.
13635
+ */
12848
13636
  export const marketplaceProviderOfferingsRemoveOfferingComponent = (options) => {
12849
13637
  return (options.client ?? _heyApiClient).post({
12850
13638
  security: [
@@ -12866,7 +13654,8 @@ export const marketplaceProviderOfferingsRemoveOfferingComponent = (options) =>
12866
13654
  });
12867
13655
  };
12868
13656
  /**
12869
- * Remove partition from offering.
13657
+ * Remove a partition from an offering
13658
+ * Removes a partition configuration from an offering.
12870
13659
  */
12871
13660
  export const marketplaceProviderOfferingsRemovePartition = (options) => {
12872
13661
  return (options.client ?? _heyApiClient).post({
@@ -12889,7 +13678,8 @@ export const marketplaceProviderOfferingsRemovePartition = (options) => {
12889
13678
  });
12890
13679
  };
12891
13680
  /**
12892
- * Remove software catalog from offering.
13681
+ * Remove a software catalog from an offering
13682
+ * Disassociates a software catalog from an offering.
12893
13683
  */
12894
13684
  export const marketplaceProviderOfferingsRemoveSoftwareCatalog = (options) => {
12895
13685
  return (options.client ?? _heyApiClient).post({
@@ -12911,6 +13701,10 @@ export const marketplaceProviderOfferingsRemoveSoftwareCatalog = (options) => {
12911
13701
  }
12912
13702
  });
12913
13703
  };
13704
+ /**
13705
+ * Set offering backend metadata
13706
+ * Updates the backend-specific metadata for an offering.
13707
+ */
12914
13708
  export const marketplaceProviderOfferingsSetBackendMetadata = (options) => {
12915
13709
  return (options.client ?? _heyApiClient).post({
12916
13710
  security: [
@@ -12931,6 +13725,10 @@ export const marketplaceProviderOfferingsSetBackendMetadata = (options) => {
12931
13725
  }
12932
13726
  });
12933
13727
  };
13728
+ /**
13729
+ * Get offering statistics
13730
+ * Returns basic statistics for an offering, such as the number of active resources and customers.
13731
+ */
12934
13732
  export const marketplaceProviderOfferingsStatsRetrieve = (options) => {
12935
13733
  return (options.client ?? _heyApiClient).get({
12936
13734
  security: [
@@ -12947,6 +13745,10 @@ export const marketplaceProviderOfferingsStatsRetrieve = (options) => {
12947
13745
  ...options
12948
13746
  });
12949
13747
  };
13748
+ /**
13749
+ * Synchronize offering service settings
13750
+ * Schedules a synchronization task to pull the latest data for the offering's service settings from the backend.
13751
+ */
12950
13752
  export const marketplaceProviderOfferingsSync = (options) => {
12951
13753
  return (options.client ?? _heyApiClient).post({
12952
13754
  security: [
@@ -12964,7 +13766,8 @@ export const marketplaceProviderOfferingsSync = (options) => {
12964
13766
  });
12965
13767
  };
12966
13768
  /**
12967
- * Return comprehensive ToS consent statistics for this offering.
13769
+ * Get Terms of Service consent statistics
13770
+ * Returns comprehensive Terms of Service consent statistics for this offering, including user counts, consent rates, and historical data.
12968
13771
  */
12969
13772
  export const marketplaceProviderOfferingsTosStatsRetrieve = (options) => {
12970
13773
  return (options.client ?? _heyApiClient).get({
@@ -12982,6 +13785,10 @@ export const marketplaceProviderOfferingsTosStatsRetrieve = (options) => {
12982
13785
  ...options
12983
13786
  });
12984
13787
  };
13788
+ /**
13789
+ * Unpause an offering
13790
+ * Resumes a paused offering, making it available for ordering again.
13791
+ */
12985
13792
  export const marketplaceProviderOfferingsUnpause = (options) => {
12986
13793
  return (options.client ?? _heyApiClient).post({
12987
13794
  security: [
@@ -12999,7 +13806,8 @@ export const marketplaceProviderOfferingsUnpause = (options) => {
12999
13806
  });
13000
13807
  };
13001
13808
  /**
13002
- * Update offering attributes.
13809
+ * Update offering attributes
13810
+ * Updates the attributes of an offering.
13003
13811
  */
13004
13812
  export const marketplaceProviderOfferingsUpdateAttributes = (options) => {
13005
13813
  return (options.client ?? _heyApiClient).post({
@@ -13021,6 +13829,10 @@ export const marketplaceProviderOfferingsUpdateAttributes = (options) => {
13021
13829
  }
13022
13830
  });
13023
13831
  };
13832
+ /**
13833
+ * Update offering compliance checklist
13834
+ * Associates a compliance checklist with an offering.
13835
+ */
13024
13836
  export const marketplaceProviderOfferingsUpdateComplianceChecklist = (options) => {
13025
13837
  return (options.client ?? _heyApiClient).post({
13026
13838
  security: [
@@ -13041,6 +13853,10 @@ export const marketplaceProviderOfferingsUpdateComplianceChecklist = (options) =
13041
13853
  }
13042
13854
  });
13043
13855
  };
13856
+ /**
13857
+ * Update offering category
13858
+ * Updates the category of an offering.
13859
+ */
13044
13860
  export const marketplaceProviderOfferingsUpdateDescription = (options) => {
13045
13861
  return (options.client ?? _heyApiClient).post({
13046
13862
  security: [
@@ -13062,7 +13878,8 @@ export const marketplaceProviderOfferingsUpdateDescription = (options) => {
13062
13878
  });
13063
13879
  };
13064
13880
  /**
13065
- * Update offering image.
13881
+ * Update offering image
13882
+ * Uploads or replaces the main image for an offering.
13066
13883
  */
13067
13884
  export const marketplaceProviderOfferingsUpdateImage = (options) => {
13068
13885
  return (options.client ?? _heyApiClient).post({
@@ -13084,6 +13901,10 @@ export const marketplaceProviderOfferingsUpdateImage = (options) => {
13084
13901
  }
13085
13902
  });
13086
13903
  };
13904
+ /**
13905
+ * Update offering integration settings
13906
+ * Updates the backend integration settings for an offering, including plugin options, secret options, and service attributes.
13907
+ */
13087
13908
  export const marketplaceProviderOfferingsUpdateIntegration = (options) => {
13088
13909
  return (options.client ?? _heyApiClient).post({
13089
13910
  security: [
@@ -13104,6 +13925,10 @@ export const marketplaceProviderOfferingsUpdateIntegration = (options) => {
13104
13925
  }
13105
13926
  });
13106
13927
  };
13928
+ /**
13929
+ * Update offering location
13930
+ * Updates the geographical location (latitude and longitude) of an offering.
13931
+ */
13107
13932
  export const marketplaceProviderOfferingsUpdateLocation = (options) => {
13108
13933
  return (options.client ?? _heyApiClient).post({
13109
13934
  security: [
@@ -13124,6 +13949,10 @@ export const marketplaceProviderOfferingsUpdateLocation = (options) => {
13124
13949
  }
13125
13950
  });
13126
13951
  };
13952
+ /**
13953
+ * Update an offering component
13954
+ * Updates the properties of a specific component within an offering.
13955
+ */
13127
13956
  export const marketplaceProviderOfferingsUpdateOfferingComponent = (options) => {
13128
13957
  return (options.client ?? _heyApiClient).post({
13129
13958
  security: [
@@ -13144,6 +13973,10 @@ export const marketplaceProviderOfferingsUpdateOfferingComponent = (options) =>
13144
13973
  }
13145
13974
  });
13146
13975
  };
13976
+ /**
13977
+ * Update offering options
13978
+ * Updates the order form options for an offering.
13979
+ */
13147
13980
  export const marketplaceProviderOfferingsUpdateOptions = (options) => {
13148
13981
  return (options.client ?? _heyApiClient).post({
13149
13982
  security: [
@@ -13165,7 +13998,8 @@ export const marketplaceProviderOfferingsUpdateOptions = (options) => {
13165
13998
  });
13166
13999
  };
13167
14000
  /**
13168
- * Update organization groups for offering.
14001
+ * Update organization groups for offering
14002
+ * Sets the list of organization groups that can access this offering.
13169
14003
  */
13170
14004
  export const marketplaceProviderOfferingsUpdateOrganizationGroups = (options) => {
13171
14005
  return (options.client ?? _heyApiClient).post({
@@ -13187,6 +14021,10 @@ export const marketplaceProviderOfferingsUpdateOrganizationGroups = (options) =>
13187
14021
  }
13188
14022
  });
13189
14023
  };
14024
+ /**
14025
+ * Update offering overview
14026
+ * Updates the overview fields of an offering, such as name, description, and getting started guide.
14027
+ */
13190
14028
  export const marketplaceProviderOfferingsUpdateOverview = (options) => {
13191
14029
  return (options.client ?? _heyApiClient).post({
13192
14030
  security: [
@@ -13208,7 +14046,8 @@ export const marketplaceProviderOfferingsUpdateOverview = (options) => {
13208
14046
  });
13209
14047
  };
13210
14048
  /**
13211
- * Update partition configuration for offering.
14049
+ * Update a partition of an offering
14050
+ * Updates the configuration of an existing partition associated with an offering.
13212
14051
  */
13213
14052
  export const marketplaceProviderOfferingsUpdatePartitionPartialUpdate = (options) => {
13214
14053
  return (options.client ?? _heyApiClient).patch({
@@ -13230,6 +14069,10 @@ export const marketplaceProviderOfferingsUpdatePartitionPartialUpdate = (options
13230
14069
  }
13231
14070
  });
13232
14071
  };
14072
+ /**
14073
+ * Update offering resource options
14074
+ * Updates the resource report form options for an offering.
14075
+ */
13233
14076
  export const marketplaceProviderOfferingsUpdateResourceOptions = (options) => {
13234
14077
  return (options.client ?? _heyApiClient).post({
13235
14078
  security: [
@@ -13251,7 +14094,8 @@ export const marketplaceProviderOfferingsUpdateResourceOptions = (options) => {
13251
14094
  });
13252
14095
  };
13253
14096
  /**
13254
- * Update software catalog configuration for offering.
14097
+ * Update software catalog configuration
14098
+ * Updates the configuration of a software catalog associated with an offering, such as enabled architectures or partition.
13255
14099
  */
13256
14100
  export const marketplaceProviderOfferingsUpdateSoftwareCatalogPartialUpdate = (options) => {
13257
14101
  return (options.client ?? _heyApiClient).patch({
@@ -13274,7 +14118,8 @@ export const marketplaceProviderOfferingsUpdateSoftwareCatalogPartialUpdate = (o
13274
14118
  });
13275
14119
  };
13276
14120
  /**
13277
- * Update offering thumbnail.
14121
+ * Update offering thumbnail
14122
+ * Uploads or replaces the thumbnail image for an offering.
13278
14123
  */
13279
14124
  export const marketplaceProviderOfferingsUpdateThumbnail = (options) => {
13280
14125
  return (options.client ?? _heyApiClient).post({
@@ -13321,7 +14166,8 @@ export const marketplaceProviderOfferingsUpdateUser = (options) => {
13321
14166
  });
13322
14167
  };
13323
14168
  /**
13324
- * Check if user has access to offering.
14169
+ * Check user access to offering resources
14170
+ * Checks if a specified user has access to any non-terminated resource of this offering.
13325
14171
  */
13326
14172
  export const marketplaceProviderOfferingsUserHasResourceAccessRetrieve = (options) => {
13327
14173
  return (options.client ?? _heyApiClient).get({
@@ -13339,6 +14185,10 @@ export const marketplaceProviderOfferingsUserHasResourceAccessRetrieve = (option
13339
14185
  ...options
13340
14186
  });
13341
14187
  };
14188
+ /**
14189
+ * List offerings grouped by provider
14190
+ * Returns a paginated list of active, shared offerings grouped by their service provider.
14191
+ */
13342
14192
  export const marketplaceProviderOfferingsGroupsList = (options) => {
13343
14193
  return (options?.client ?? _heyApiClient).get({
13344
14194
  security: [
@@ -13356,6 +14206,7 @@ export const marketplaceProviderOfferingsGroupsList = (options) => {
13356
14206
  });
13357
14207
  };
13358
14208
  /**
14209
+ * List offerings grouped by provider
13359
14210
  * Get number of items in the collection matching the request parameters.
13360
14211
  */
13361
14212
  export const marketplaceProviderOfferingsGroupsCount = (options) => {
@@ -13374,6 +14225,10 @@ export const marketplaceProviderOfferingsGroupsCount = (options) => {
13374
14225
  ...options
13375
14226
  });
13376
14227
  };
14228
+ /**
14229
+ * List provider resources
14230
+ * Returns a paginated list of resources for offerings managed by the current user as a service provider.
14231
+ */
13377
14232
  export const marketplaceProviderResourcesList = (options) => {
13378
14233
  return (options?.client ?? _heyApiClient).get({
13379
14234
  security: [
@@ -13391,6 +14246,7 @@ export const marketplaceProviderResourcesList = (options) => {
13391
14246
  });
13392
14247
  };
13393
14248
  /**
14249
+ * List provider resources
13394
14250
  * Get number of items in the collection matching the request parameters.
13395
14251
  */
13396
14252
  export const marketplaceProviderResourcesCount = (options) => {
@@ -13409,6 +14265,10 @@ export const marketplaceProviderResourcesCount = (options) => {
13409
14265
  ...options
13410
14266
  });
13411
14267
  };
14268
+ /**
14269
+ * Retrieve a provider resource
14270
+ * Returns details of a specific resource from a provider's perspective.
14271
+ */
13412
14272
  export const marketplaceProviderResourcesRetrieve = (options) => {
13413
14273
  return (options.client ?? _heyApiClient).get({
13414
14274
  security: [
@@ -13425,6 +14285,10 @@ export const marketplaceProviderResourcesRetrieve = (options) => {
13425
14285
  ...options
13426
14286
  });
13427
14287
  };
14288
+ /**
14289
+ * Partially update a provider resource
14290
+ * Partially updates the name or description of a resource. Requires provider permissions.
14291
+ */
13428
14292
  export const marketplaceProviderResourcesPartialUpdate = (options) => {
13429
14293
  return (options.client ?? _heyApiClient).patch({
13430
14294
  security: [
@@ -13445,6 +14309,10 @@ export const marketplaceProviderResourcesPartialUpdate = (options) => {
13445
14309
  }
13446
14310
  });
13447
14311
  };
14312
+ /**
14313
+ * Update a provider resource
14314
+ * Updates the name or description of a resource. Requires provider permissions.
14315
+ */
13448
14316
  export const marketplaceProviderResourcesUpdate = (options) => {
13449
14317
  return (options.client ?? _heyApiClient).put({
13450
14318
  security: [
@@ -13465,6 +14333,10 @@ export const marketplaceProviderResourcesUpdate = (options) => {
13465
14333
  }
13466
14334
  });
13467
14335
  };
14336
+ /**
14337
+ * Get resource details
14338
+ * Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.
14339
+ */
13468
14340
  export const marketplaceProviderResourcesDetailsRetrieve = (options) => {
13469
14341
  return (options.client ?? _heyApiClient).get({
13470
14342
  security: [
@@ -13482,11 +14354,10 @@ export const marketplaceProviderResourcesDetailsRetrieve = (options) => {
13482
14354
  });
13483
14355
  };
13484
14356
  /**
14357
+ * Get GLauth user configuration for a resource
13485
14358
  *
13486
- * This endpoint provides a config file for GLauth.
13487
- * Example: https://github.com/glauth/glauth/blob/master/v2/sample-simple.cfg
13488
- * It is assumed that the config is used by an external agent,
13489
- * which synchronizes data from Waldur to GLauth.
14359
+ * This endpoint provides a GLauth configuration file for the users associated with the project of this resource.
14360
+ * It is intended for use by an external agent to synchronize user data from Waldur to GLauth.
13490
14361
  *
13491
14362
  */
13492
14363
  export const marketplaceProviderResourcesGlauthUsersConfigRetrieve = (options) => {
@@ -13506,7 +14377,8 @@ export const marketplaceProviderResourcesGlauthUsersConfigRetrieve = (options) =
13506
14377
  });
13507
14378
  };
13508
14379
  /**
13509
- * Move resource to another project.
14380
+ * Move a resource to another project
14381
+ * Moves a resource and its associated data to a different project. Requires staff permissions.
13510
14382
  */
13511
14383
  export const marketplaceProviderResourcesMoveResource = (options) => {
13512
14384
  return (options.client ?? _heyApiClient).post({
@@ -13528,6 +14400,10 @@ export const marketplaceProviderResourcesMoveResource = (options) => {
13528
14400
  }
13529
14401
  });
13530
14402
  };
14403
+ /**
14404
+ * Get offering details
14405
+ * Returns details of the offering connected to the requested object.
14406
+ */
13531
14407
  export const marketplaceProviderResourcesOfferingRetrieve = (options) => {
13532
14408
  return (options.client ?? _heyApiClient).get({
13533
14409
  security: [
@@ -13544,6 +14420,10 @@ export const marketplaceProviderResourcesOfferingRetrieve = (options) => {
13544
14420
  ...options
13545
14421
  });
13546
14422
  };
14423
+ /**
14424
+ * List offerings for sub-resources
14425
+ * Returns a list of offerings that can be provisioned as sub-resources of the current resource.
14426
+ */
13547
14427
  export const marketplaceProviderResourcesOfferingForSubresourcesList = (options) => {
13548
14428
  return (options.client ?? _heyApiClient).get({
13549
14429
  security: [
@@ -13560,6 +14440,10 @@ export const marketplaceProviderResourcesOfferingForSubresourcesList = (options)
13560
14440
  ...options
13561
14441
  });
13562
14442
  };
14443
+ /**
14444
+ * List resource plan periods
14445
+ * Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.
14446
+ */
13563
14447
  export const marketplaceProviderResourcesPlanPeriodsList = (options) => {
13564
14448
  return (options.client ?? _heyApiClient).get({
13565
14449
  security: [
@@ -13577,7 +14461,8 @@ export const marketplaceProviderResourcesPlanPeriodsList = (options) => {
13577
14461
  });
13578
14462
  };
13579
14463
  /**
13580
- * Starts process of pulling a resource
14464
+ * Pull resource data
14465
+ * Schedules a task to pull the latest data for the resource from its backend.
13581
14466
  */
13582
14467
  export const marketplaceProviderResourcesPull = (options) => {
13583
14468
  return (options.client ?? _heyApiClient).post({
@@ -13596,7 +14481,8 @@ export const marketplaceProviderResourcesPull = (options) => {
13596
14481
  });
13597
14482
  };
13598
14483
  /**
13599
- * Refresh the last sync time for a resource.
14484
+ * Refresh last sync time
14485
+ * Updates the 'last_sync' timestamp for a resource to the current time. This is useful for backend agents to signal that a resource is being actively monitored.
13600
14486
  */
13601
14487
  export const marketplaceProviderResourcesRefreshLastSync = (options) => {
13602
14488
  return (options.client ?? _heyApiClient).post({
@@ -13615,7 +14501,8 @@ export const marketplaceProviderResourcesRefreshLastSync = (options) => {
13615
14501
  });
13616
14502
  };
13617
14503
  /**
13618
- * Set the resource as erred.
14504
+ * Set resource state to erred
14505
+ * Allows a service provider to manually set the state of a resource to 'erred'. An error message and traceback can be provided.
13619
14506
  */
13620
14507
  export const marketplaceProviderResourcesSetAsErred = (options) => {
13621
14508
  return (options.client ?? _heyApiClient).post({
@@ -13638,7 +14525,8 @@ export const marketplaceProviderResourcesSetAsErred = (options) => {
13638
14525
  });
13639
14526
  };
13640
14527
  /**
13641
- * Set the resource as OK.
14528
+ * Set resource state to OK
14529
+ * Allows a service provider to manually set the state of a resource to 'OK', clearing any previous error messages.
13642
14530
  */
13643
14531
  export const marketplaceProviderResourcesSetAsOk = (options) => {
13644
14532
  return (options.client ?? _heyApiClient).post({
@@ -13657,7 +14545,8 @@ export const marketplaceProviderResourcesSetAsOk = (options) => {
13657
14545
  });
13658
14546
  };
13659
14547
  /**
13660
- * Set resource backend ID.
14548
+ * Set resource backend ID
14549
+ * Allows a service provider to set or update the backend ID for a resource, linking it to an external system's identifier.
13661
14550
  */
13662
14551
  export const marketplaceProviderResourcesSetBackendId = (options) => {
13663
14552
  return (options.client ?? _heyApiClient).post({
@@ -13679,6 +14568,10 @@ export const marketplaceProviderResourcesSetBackendId = (options) => {
13679
14568
  }
13680
14569
  });
13681
14570
  };
14571
+ /**
14572
+ * Set resource backend metadata
14573
+ * Allows a service provider to set or update the backend-specific metadata for a resource.
14574
+ */
13682
14575
  export const marketplaceProviderResourcesSetBackendMetadata = (options) => {
13683
14576
  return (options.client ?? _heyApiClient).post({
13684
14577
  security: [
@@ -13700,7 +14593,8 @@ export const marketplaceProviderResourcesSetBackendMetadata = (options) => {
13700
14593
  });
13701
14594
  };
13702
14595
  /**
13703
- * Set downscaled flag for resource.
14596
+ * Set downscaled flag for resource
14597
+ * Sets the 'downscaled' flag for a resource. Requires staff permissions.
13704
14598
  */
13705
14599
  export const marketplaceProviderResourcesSetDownscaled = (options) => {
13706
14600
  return (options.client ?? _heyApiClient).post({
@@ -13722,6 +14616,10 @@ export const marketplaceProviderResourcesSetDownscaled = (options) => {
13722
14616
  }
13723
14617
  });
13724
14618
  };
14619
+ /**
14620
+ * Set end date by provider
14621
+ * Allows a service provider to set or update the end date for a resource, scheduling it for termination. A notification is sent to the consumer.
14622
+ */
13725
14623
  export const marketplaceProviderResourcesSetEndDateByProvider = (options) => {
13726
14624
  return (options.client ?? _heyApiClient).post({
13727
14625
  security: [
@@ -13743,7 +14641,8 @@ export const marketplaceProviderResourcesSetEndDateByProvider = (options) => {
13743
14641
  });
13744
14642
  };
13745
14643
  /**
13746
- * Set end date of the resource by staff.
14644
+ * Set end date of the resource by staff
14645
+ * Allows a staff user to set or update the end date for a resource, which will schedule it for termination.
13747
14646
  */
13748
14647
  export const marketplaceProviderResourcesSetEndDateByStaff = (options) => {
13749
14648
  return (options.client ?? _heyApiClient).post({
@@ -13765,6 +14664,10 @@ export const marketplaceProviderResourcesSetEndDateByStaff = (options) => {
13765
14664
  }
13766
14665
  });
13767
14666
  };
14667
+ /**
14668
+ * Set resource limits
14669
+ * Allows a service provider to directly set the limits for a resource. This is typically used for administrative changes or backend synchronization, bypassing the normal order process.
14670
+ */
13768
14671
  export const marketplaceProviderResourcesSetLimits = (options) => {
13769
14672
  return (options.client ?? _heyApiClient).post({
13770
14673
  security: [
@@ -13786,7 +14689,8 @@ export const marketplaceProviderResourcesSetLimits = (options) => {
13786
14689
  });
13787
14690
  };
13788
14691
  /**
13789
- * Set paused flag for resource.
14692
+ * Set paused flag for resource
14693
+ * Sets the 'paused' flag for a resource. Requires staff permissions.
13790
14694
  */
13791
14695
  export const marketplaceProviderResourcesSetPaused = (options) => {
13792
14696
  return (options.client ?? _heyApiClient).post({
@@ -13809,7 +14713,8 @@ export const marketplaceProviderResourcesSetPaused = (options) => {
13809
14713
  });
13810
14714
  };
13811
14715
  /**
13812
- * Set restrict_member_access flag for resource.
14716
+ * Set restrict member access flag
14717
+ * Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.
13813
14718
  */
13814
14719
  export const marketplaceProviderResourcesSetRestrictMemberAccess = (options) => {
13815
14720
  return (options.client ?? _heyApiClient).post({
@@ -13832,7 +14737,8 @@ export const marketplaceProviderResourcesSetRestrictMemberAccess = (options) =>
13832
14737
  });
13833
14738
  };
13834
14739
  /**
13835
- * Set slug for resource.
14740
+ * Set resource slug
14741
+ * Updates the slug for a resource. Requires staff permissions.
13836
14742
  */
13837
14743
  export const marketplaceProviderResourcesSetSlug = (options) => {
13838
14744
  return (options.client ?? _heyApiClient).post({
@@ -13855,7 +14761,8 @@ export const marketplaceProviderResourcesSetSlug = (options) => {
13855
14761
  });
13856
14762
  };
13857
14763
  /**
13858
- * Submit resource report.
14764
+ * Submit a report for a resource
14765
+ * Allows a service provider to submit a report (e.g., usage or status report) for a resource.
13859
14766
  */
13860
14767
  export const marketplaceProviderResourcesSubmitReport = (options) => {
13861
14768
  return (options.client ?? _heyApiClient).post({
@@ -13878,7 +14785,8 @@ export const marketplaceProviderResourcesSubmitReport = (options) => {
13878
14785
  });
13879
14786
  };
13880
14787
  /**
13881
- * Return users connected to the project.
14788
+ * Get resource team
14789
+ * Returns a list of users connected to the project of this resource, including their project roles and offering-specific usernames.
13882
14790
  */
13883
14791
  export const marketplaceProviderResourcesTeamList = (options) => {
13884
14792
  return (options.client ?? _heyApiClient).get({
@@ -13897,7 +14805,8 @@ export const marketplaceProviderResourcesTeamList = (options) => {
13897
14805
  });
13898
14806
  };
13899
14807
  /**
13900
- * Create marketplace order for resource termination.
14808
+ * Terminate a resource
14809
+ * Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.
13901
14810
  */
13902
14811
  export const marketplaceProviderResourcesTerminate = (options) => {
13903
14812
  return (options.client ?? _heyApiClient).post({
@@ -13920,9 +14829,8 @@ export const marketplaceProviderResourcesTerminate = (options) => {
13920
14829
  });
13921
14830
  };
13922
14831
  /**
13923
- * Delete marketplace resource and related plugin resource from the database without scheduling operations on backend
13924
- * and without checking current state of the resource. It is intended to be used
13925
- * for removing resource stuck in transitioning state.
14832
+ * Unlink a resource (staff only)
14833
+ * Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.
13926
14834
  */
13927
14835
  export const marketplaceProviderResourcesUnlink = (options) => {
13928
14836
  return (options.client ?? _heyApiClient).post({
@@ -13941,7 +14849,8 @@ export const marketplaceProviderResourcesUnlink = (options) => {
13941
14849
  });
13942
14850
  };
13943
14851
  /**
13944
- * Update resource options.
14852
+ * Update resource options
14853
+ * Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.
13945
14854
  */
13946
14855
  export const marketplaceProviderResourcesUpdateOptions = (options) => {
13947
14856
  return (options.client ?? _heyApiClient).post({
@@ -13964,7 +14873,8 @@ export const marketplaceProviderResourcesUpdateOptions = (options) => {
13964
14873
  });
13965
14874
  };
13966
14875
  /**
13967
- * Update resource options directly without creating orders.
14876
+ * Update resource options directly
14877
+ * Allows a service provider to directly update the options of a resource without creating an order. This is typically used for administrative changes or backend synchronization.
13968
14878
  */
13969
14879
  export const marketplaceProviderResourcesUpdateOptionsDirect = (options) => {
13970
14880
  return (options.client ?? _heyApiClient).post({
@@ -13986,6 +14896,16 @@ export const marketplaceProviderResourcesUpdateOptionsDirect = (options) => {
13986
14896
  }
13987
14897
  });
13988
14898
  };
14899
+ /**
14900
+ * Check service provider signature
14901
+ *
14902
+ * Validates a signed payload from a service provider. The payload is a JWT token
14903
+ * signed with the provider's API secret code. This endpoint is used to verify the
14904
+ * authenticity of a request before processing it.
14905
+ *
14906
+ * The `data` field should contain the JWT token.
14907
+ *
14908
+ */
13989
14909
  export const marketplacePublicApiCheckSignature = (options) => {
13990
14910
  return (options.client ?? _heyApiClient).post({
13991
14911
  security: [
@@ -14006,6 +14926,16 @@ export const marketplacePublicApiCheckSignature = (options) => {
14006
14926
  }
14007
14927
  });
14008
14928
  };
14929
+ /**
14930
+ * Set component usage with signature
14931
+ *
14932
+ * Allows a service provider to report usage for resource components using a signed JWT payload.
14933
+ * This provides a secure way for external systems to submit billing data.
14934
+ *
14935
+ * The `data` field must contain a JWT token that, when decoded, matches the structure of the
14936
+ * `ComponentUsageCreateSerializer`.
14937
+ *
14938
+ */
14009
14939
  export const marketplacePublicApiSetUsage = (options) => {
14010
14940
  return (options.client ?? _heyApiClient).post({
14011
14941
  security: [
@@ -14026,6 +14956,10 @@ export const marketplacePublicApiSetUsage = (options) => {
14026
14956
  }
14027
14957
  });
14028
14958
  };
14959
+ /**
14960
+ * List public offerings
14961
+ * Returns a paginated list of public offerings. The list is filtered to show only offerings that are active or paused and available for ordering by the current user. If anonymous access is enabled, it shows shared offerings available to unauthenticated users.
14962
+ */
14029
14963
  export const marketplacePublicOfferingsList = (options) => {
14030
14964
  return (options?.client ?? _heyApiClient).get({
14031
14965
  security: [
@@ -14043,6 +14977,7 @@ export const marketplacePublicOfferingsList = (options) => {
14043
14977
  });
14044
14978
  };
14045
14979
  /**
14980
+ * List public offerings
14046
14981
  * Get number of items in the collection matching the request parameters.
14047
14982
  */
14048
14983
  export const marketplacePublicOfferingsCount = (options) => {
@@ -14061,6 +14996,10 @@ export const marketplacePublicOfferingsCount = (options) => {
14061
14996
  ...options
14062
14997
  });
14063
14998
  };
14999
+ /**
15000
+ * Retrieve a public offering
15001
+ * Returns the details of a specific public offering. Access is granted if the offering is available for ordering by the current user or if anonymous access is enabled.
15002
+ */
14064
15003
  export const marketplacePublicOfferingsRetrieve = (options) => {
14065
15004
  return (options.client ?? _heyApiClient).get({
14066
15005
  security: [
@@ -14077,6 +15016,10 @@ export const marketplacePublicOfferingsRetrieve = (options) => {
14077
15016
  ...options
14078
15017
  });
14079
15018
  };
15019
+ /**
15020
+ * List plans for an offering
15021
+ * Returns a list of plans available for a specific offering. The plans are filtered based on the current user's permissions and organization group memberships.
15022
+ */
14080
15023
  export const marketplacePublicOfferingsPlansList = (options) => {
14081
15024
  return (options.client ?? _heyApiClient).get({
14082
15025
  security: [
@@ -14093,6 +15036,10 @@ export const marketplacePublicOfferingsPlansList = (options) => {
14093
15036
  ...options
14094
15037
  });
14095
15038
  };
15039
+ /**
15040
+ * Retrieve a specific plan for an offering
15041
+ * Returns the details of a specific plan if it is available to the current user for the given offering.
15042
+ */
14096
15043
  export const marketplacePublicOfferingsPlansRetrieve = (options) => {
14097
15044
  return (options.client ?? _heyApiClient).get({
14098
15045
  security: [
@@ -14284,6 +15231,10 @@ export const marketplaceResourceOfferingsList = (options) => {
14284
15231
  ...options
14285
15232
  });
14286
15233
  };
15234
+ /**
15235
+ * List resource users
15236
+ * Returns a paginated list of users associated with resources, including their roles. The list is filtered based on the permissions of the current user. Staff and support users can see all resource-user links. Other users can only see links for resources they have access to.
15237
+ */
14287
15238
  export const marketplaceResourceUsersList = (options) => {
14288
15239
  return (options?.client ?? _heyApiClient).get({
14289
15240
  security: [
@@ -14301,6 +15252,7 @@ export const marketplaceResourceUsersList = (options) => {
14301
15252
  });
14302
15253
  };
14303
15254
  /**
15255
+ * List resource users
14304
15256
  * Get number of items in the collection matching the request parameters.
14305
15257
  */
14306
15258
  export const marketplaceResourceUsersCount = (options) => {
@@ -14319,6 +15271,10 @@ export const marketplaceResourceUsersCount = (options) => {
14319
15271
  ...options
14320
15272
  });
14321
15273
  };
15274
+ /**
15275
+ * Link a user to a resource
15276
+ * Creates a new association between a user and a resource with a specific role. The user must have permission to manage users for the resource (typically service provider staff or owners).
15277
+ */
14322
15278
  export const marketplaceResourceUsersCreate = (options) => {
14323
15279
  return (options.client ?? _heyApiClient).post({
14324
15280
  security: [
@@ -14339,6 +15295,10 @@ export const marketplaceResourceUsersCreate = (options) => {
14339
15295
  }
14340
15296
  });
14341
15297
  };
15298
+ /**
15299
+ * Unlink a user from a resource
15300
+ * Removes the association between a user and a resource, effectively revoking their role on that resource. The user must have permission to manage users for the resource.
15301
+ */
14342
15302
  export const marketplaceResourceUsersDestroy = (options) => {
14343
15303
  return (options.client ?? _heyApiClient).delete({
14344
15304
  security: [
@@ -14355,6 +15315,10 @@ export const marketplaceResourceUsersDestroy = (options) => {
14355
15315
  ...options
14356
15316
  });
14357
15317
  };
15318
+ /**
15319
+ * Retrieve a resource-user link
15320
+ * Returns details of a specific link between a user and a resource, including their role.
15321
+ */
14358
15322
  export const marketplaceResourceUsersRetrieve = (options) => {
14359
15323
  return (options.client ?? _heyApiClient).get({
14360
15324
  security: [
@@ -14371,6 +15335,10 @@ export const marketplaceResourceUsersRetrieve = (options) => {
14371
15335
  ...options
14372
15336
  });
14373
15337
  };
15338
+ /**
15339
+ * List consumer resources
15340
+ * Returns a paginated list of resources accessible to the current user as a service consumer.
15341
+ */
14374
15342
  export const marketplaceResourcesList = (options) => {
14375
15343
  return (options?.client ?? _heyApiClient).get({
14376
15344
  security: [
@@ -14388,6 +15356,7 @@ export const marketplaceResourcesList = (options) => {
14388
15356
  });
14389
15357
  };
14390
15358
  /**
15359
+ * List consumer resources
14391
15360
  * Get number of items in the collection matching the request parameters.
14392
15361
  */
14393
15362
  export const marketplaceResourcesCount = (options) => {
@@ -14406,6 +15375,10 @@ export const marketplaceResourcesCount = (options) => {
14406
15375
  ...options
14407
15376
  });
14408
15377
  };
15378
+ /**
15379
+ * Retrieve a consumer resource
15380
+ * Returns details of a specific resource accessible to the consumer.
15381
+ */
14409
15382
  export const marketplaceResourcesRetrieve = (options) => {
14410
15383
  return (options.client ?? _heyApiClient).get({
14411
15384
  security: [
@@ -14422,6 +15395,10 @@ export const marketplaceResourcesRetrieve = (options) => {
14422
15395
  ...options
14423
15396
  });
14424
15397
  };
15398
+ /**
15399
+ * Partially update a consumer resource
15400
+ * Partially updates the name, description, or end date of a resource.
15401
+ */
14425
15402
  export const marketplaceResourcesPartialUpdate = (options) => {
14426
15403
  return (options.client ?? _heyApiClient).patch({
14427
15404
  security: [
@@ -14442,6 +15419,10 @@ export const marketplaceResourcesPartialUpdate = (options) => {
14442
15419
  }
14443
15420
  });
14444
15421
  };
15422
+ /**
15423
+ * Update a consumer resource
15424
+ * Updates the name, description, or end date of a resource.
15425
+ */
14445
15426
  export const marketplaceResourcesUpdate = (options) => {
14446
15427
  return (options.client ?? _heyApiClient).put({
14447
15428
  security: [
@@ -14462,6 +15443,10 @@ export const marketplaceResourcesUpdate = (options) => {
14462
15443
  }
14463
15444
  });
14464
15445
  };
15446
+ /**
15447
+ * Get resource details
15448
+ * Returns the detailed representation of the backend resource associated with the marketplace resource. The format of the response depends on the resource type.
15449
+ */
14465
15450
  export const marketplaceResourcesDetailsRetrieve = (options) => {
14466
15451
  return (options.client ?? _heyApiClient).get({
14467
15452
  security: [
@@ -14479,11 +15464,10 @@ export const marketplaceResourcesDetailsRetrieve = (options) => {
14479
15464
  });
14480
15465
  };
14481
15466
  /**
15467
+ * Get GLauth user configuration for a resource
14482
15468
  *
14483
- * This endpoint provides a config file for GLauth.
14484
- * Example: https://github.com/glauth/glauth/blob/master/v2/sample-simple.cfg
14485
- * It is assumed that the config is used by an external agent,
14486
- * which synchronizes data from Waldur to GLauth.
15469
+ * This endpoint provides a GLauth configuration file for the users associated with the project of this resource.
15470
+ * It is intended for use by an external agent to synchronize user data from Waldur to GLauth.
14487
15471
  *
14488
15472
  */
14489
15473
  export const marketplaceResourcesGlauthUsersConfigRetrieve = (options) => {
@@ -14503,7 +15487,8 @@ export const marketplaceResourcesGlauthUsersConfigRetrieve = (options) => {
14503
15487
  });
14504
15488
  };
14505
15489
  /**
14506
- * Move resource to another project.
15490
+ * Move a resource to another project
15491
+ * Moves a resource and its associated data to a different project. Requires staff permissions.
14507
15492
  */
14508
15493
  export const marketplaceResourcesMoveResource = (options) => {
14509
15494
  return (options.client ?? _heyApiClient).post({
@@ -14525,6 +15510,10 @@ export const marketplaceResourcesMoveResource = (options) => {
14525
15510
  }
14526
15511
  });
14527
15512
  };
15513
+ /**
15514
+ * Get offering details
15515
+ * Returns details of the offering connected to the requested object.
15516
+ */
14528
15517
  export const marketplaceResourcesOfferingRetrieve = (options) => {
14529
15518
  return (options.client ?? _heyApiClient).get({
14530
15519
  security: [
@@ -14541,6 +15530,10 @@ export const marketplaceResourcesOfferingRetrieve = (options) => {
14541
15530
  ...options
14542
15531
  });
14543
15532
  };
15533
+ /**
15534
+ * List offerings for sub-resources
15535
+ * Returns a list of offerings that can be provisioned as sub-resources of the current resource.
15536
+ */
14544
15537
  export const marketplaceResourcesOfferingForSubresourcesList = (options) => {
14545
15538
  return (options.client ?? _heyApiClient).get({
14546
15539
  security: [
@@ -14557,6 +15550,10 @@ export const marketplaceResourcesOfferingForSubresourcesList = (options) => {
14557
15550
  ...options
14558
15551
  });
14559
15552
  };
15553
+ /**
15554
+ * List resource plan periods
15555
+ * Returns a list of active and future plan periods for the resource. Each period includes the plan details and current component usage.
15556
+ */
14560
15557
  export const marketplaceResourcesPlanPeriodsList = (options) => {
14561
15558
  return (options.client ?? _heyApiClient).get({
14562
15559
  security: [
@@ -14574,7 +15571,8 @@ export const marketplaceResourcesPlanPeriodsList = (options) => {
14574
15571
  });
14575
15572
  };
14576
15573
  /**
14577
- * Starts process of pulling a resource
15574
+ * Pull resource data
15575
+ * Schedules a task to pull the latest data for the resource from its backend.
14578
15576
  */
14579
15577
  export const marketplaceResourcesPull = (options) => {
14580
15578
  return (options.client ?? _heyApiClient).post({
@@ -14593,7 +15591,8 @@ export const marketplaceResourcesPull = (options) => {
14593
15591
  });
14594
15592
  };
14595
15593
  /**
14596
- * Create a renewal order for a prepaid resource.
15594
+ * Renew a prepaid resource
15595
+ * Creates a renewal order to extend the subscription period of a prepaid resource. Optionally, limits can be upgraded at the same time.
14597
15596
  */
14598
15597
  export const marketplaceResourcesRenew = (options) => {
14599
15598
  return (options.client ?? _heyApiClient).post({
@@ -14616,7 +15615,8 @@ export const marketplaceResourcesRenew = (options) => {
14616
15615
  });
14617
15616
  };
14618
15617
  /**
14619
- * Set downscaled flag for resource.
15618
+ * Set downscaled flag for resource
15619
+ * Sets the 'downscaled' flag for a resource. Requires staff permissions.
14620
15620
  */
14621
15621
  export const marketplaceResourcesSetDownscaled = (options) => {
14622
15622
  return (options.client ?? _heyApiClient).post({
@@ -14639,7 +15639,8 @@ export const marketplaceResourcesSetDownscaled = (options) => {
14639
15639
  });
14640
15640
  };
14641
15641
  /**
14642
- * Set end date of the resource by staff.
15642
+ * Set end date of the resource by staff
15643
+ * Allows a staff user to set or update the end date for a resource, which will schedule it for termination.
14643
15644
  */
14644
15645
  export const marketplaceResourcesSetEndDateByStaff = (options) => {
14645
15646
  return (options.client ?? _heyApiClient).post({
@@ -14662,7 +15663,8 @@ export const marketplaceResourcesSetEndDateByStaff = (options) => {
14662
15663
  });
14663
15664
  };
14664
15665
  /**
14665
- * Set paused flag for resource.
15666
+ * Set paused flag for resource
15667
+ * Sets the 'paused' flag for a resource. Requires staff permissions.
14666
15668
  */
14667
15669
  export const marketplaceResourcesSetPaused = (options) => {
14668
15670
  return (options.client ?? _heyApiClient).post({
@@ -14685,7 +15687,8 @@ export const marketplaceResourcesSetPaused = (options) => {
14685
15687
  });
14686
15688
  };
14687
15689
  /**
14688
- * Set restrict_member_access flag for resource.
15690
+ * Set restrict member access flag
15691
+ * Sets the 'restrict_member_access' flag for a resource. Requires staff permissions.
14689
15692
  */
14690
15693
  export const marketplaceResourcesSetRestrictMemberAccess = (options) => {
14691
15694
  return (options.client ?? _heyApiClient).post({
@@ -14708,7 +15711,8 @@ export const marketplaceResourcesSetRestrictMemberAccess = (options) => {
14708
15711
  });
14709
15712
  };
14710
15713
  /**
14711
- * Set slug for resource.
15714
+ * Set resource slug
15715
+ * Updates the slug for a resource. Requires staff permissions.
14712
15716
  */
14713
15717
  export const marketplaceResourcesSetSlug = (options) => {
14714
15718
  return (options.client ?? _heyApiClient).post({
@@ -14731,7 +15735,8 @@ export const marketplaceResourcesSetSlug = (options) => {
14731
15735
  });
14732
15736
  };
14733
15737
  /**
14734
- * Create marketplace order for resource plan switch.
15738
+ * Switch resource plan
15739
+ * Creates a marketplace order to switch the billing plan for a resource. This action is asynchronous and may require approval.
14735
15740
  */
14736
15741
  export const marketplaceResourcesSwitchPlan = (options) => {
14737
15742
  return (options.client ?? _heyApiClient).post({
@@ -14754,7 +15759,8 @@ export const marketplaceResourcesSwitchPlan = (options) => {
14754
15759
  });
14755
15760
  };
14756
15761
  /**
14757
- * Return users connected to the project.
15762
+ * Get resource team
15763
+ * Returns a list of users connected to the project of this resource, including their project roles and offering-specific usernames.
14758
15764
  */
14759
15765
  export const marketplaceResourcesTeamList = (options) => {
14760
15766
  return (options.client ?? _heyApiClient).get({
@@ -14773,7 +15779,8 @@ export const marketplaceResourcesTeamList = (options) => {
14773
15779
  });
14774
15780
  };
14775
15781
  /**
14776
- * Create marketplace order for resource termination.
15782
+ * Terminate a resource
15783
+ * Creates a marketplace order to terminate the resource. This action is asynchronous and may require approval.
14777
15784
  */
14778
15785
  export const marketplaceResourcesTerminate = (options) => {
14779
15786
  return (options.client ?? _heyApiClient).post({
@@ -14796,9 +15803,8 @@ export const marketplaceResourcesTerminate = (options) => {
14796
15803
  });
14797
15804
  };
14798
15805
  /**
14799
- * Delete marketplace resource and related plugin resource from the database without scheduling operations on backend
14800
- * and without checking current state of the resource. It is intended to be used
14801
- * for removing resource stuck in transitioning state.
15806
+ * Unlink a resource (staff only)
15807
+ * Forcefully deletes a marketplace resource and its related plugin resource from the database. This action does not schedule operations on the backend and is intended for cleaning up resources stuck in transitioning states. Requires staff permissions.
14802
15808
  */
14803
15809
  export const marketplaceResourcesUnlink = (options) => {
14804
15810
  return (options.client ?? _heyApiClient).post({
@@ -14817,7 +15823,8 @@ export const marketplaceResourcesUnlink = (options) => {
14817
15823
  });
14818
15824
  };
14819
15825
  /**
14820
- * Create marketplace order for resource limits update.
15826
+ * Update resource limits
15827
+ * Creates a marketplace order to update the limits (e.g., CPU, RAM) for a resource. This action is asynchronous and may require approval.
14821
15828
  */
14822
15829
  export const marketplaceResourcesUpdateLimits = (options) => {
14823
15830
  return (options.client ?? _heyApiClient).post({
@@ -14840,7 +15847,8 @@ export const marketplaceResourcesUpdateLimits = (options) => {
14840
15847
  });
14841
15848
  };
14842
15849
  /**
14843
- * Update resource options.
15850
+ * Update resource options
15851
+ * Updates the options of a resource. If the offering is configured to create orders for option changes, a new UPDATE order will be created. Otherwise, the options are updated directly.
14844
15852
  */
14845
15853
  export const marketplaceResourcesUpdateOptions = (options) => {
14846
15854
  return (options.client ?? _heyApiClient).post({
@@ -14862,6 +15870,10 @@ export const marketplaceResourcesUpdateOptions = (options) => {
14862
15870
  }
14863
15871
  });
14864
15872
  };
15873
+ /**
15874
+ * Suggest a resource name
15875
+ * Generates a suggested name for a new resource based on the project and offering.
15876
+ */
14865
15877
  export const marketplaceResourcesSuggestName = (options) => {
14866
15878
  return (options.client ?? _heyApiClient).post({
14867
15879
  security: [
@@ -14882,6 +15894,10 @@ export const marketplaceResourcesSuggestName = (options) => {
14882
15894
  }
14883
15895
  });
14884
15896
  };
15897
+ /**
15898
+ * List robot accounts
15899
+ * Returns a paginated list of robot accounts accessible to the current user.
15900
+ */
14885
15901
  export const marketplaceRobotAccountsList = (options) => {
14886
15902
  return (options?.client ?? _heyApiClient).get({
14887
15903
  security: [
@@ -14899,6 +15915,7 @@ export const marketplaceRobotAccountsList = (options) => {
14899
15915
  });
14900
15916
  };
14901
15917
  /**
15918
+ * List robot accounts
14902
15919
  * Get number of items in the collection matching the request parameters.
14903
15920
  */
14904
15921
  export const marketplaceRobotAccountsCount = (options) => {
@@ -14917,6 +15934,10 @@ export const marketplaceRobotAccountsCount = (options) => {
14917
15934
  ...options
14918
15935
  });
14919
15936
  };
15937
+ /**
15938
+ * Create a robot account
15939
+ * Creates a new robot account for a specific resource. This is typically used for automated access to a resource, e.g., for CI/CD pipelines.
15940
+ */
14920
15941
  export const marketplaceRobotAccountsCreate = (options) => {
14921
15942
  return (options.client ?? _heyApiClient).post({
14922
15943
  security: [
@@ -14937,6 +15958,10 @@ export const marketplaceRobotAccountsCreate = (options) => {
14937
15958
  }
14938
15959
  });
14939
15960
  };
15961
+ /**
15962
+ * Delete a robot account
15963
+ * Deletes a robot account. This is a hard delete and should be used with caution.
15964
+ */
14940
15965
  export const marketplaceRobotAccountsDestroy = (options) => {
14941
15966
  return (options.client ?? _heyApiClient).delete({
14942
15967
  security: [
@@ -14953,6 +15978,10 @@ export const marketplaceRobotAccountsDestroy = (options) => {
14953
15978
  ...options
14954
15979
  });
14955
15980
  };
15981
+ /**
15982
+ * Retrieve a robot account
15983
+ * Returns the details of a specific robot account.
15984
+ */
14956
15985
  export const marketplaceRobotAccountsRetrieve = (options) => {
14957
15986
  return (options.client ?? _heyApiClient).get({
14958
15987
  security: [
@@ -14969,6 +15998,10 @@ export const marketplaceRobotAccountsRetrieve = (options) => {
14969
15998
  ...options
14970
15999
  });
14971
16000
  };
16001
+ /**
16002
+ * Partially update a robot account
16003
+ * Partially updates the properties of a robot account. Not allowed for synchronized remote accounts.
16004
+ */
14972
16005
  export const marketplaceRobotAccountsPartialUpdate = (options) => {
14973
16006
  return (options.client ?? _heyApiClient).patch({
14974
16007
  security: [
@@ -14989,6 +16022,10 @@ export const marketplaceRobotAccountsPartialUpdate = (options) => {
14989
16022
  }
14990
16023
  });
14991
16024
  };
16025
+ /**
16026
+ * Update a robot account
16027
+ * Updates the properties of a robot account, such as its username or associated users. Not allowed for synchronized remote accounts.
16028
+ */
14992
16029
  export const marketplaceRobotAccountsUpdate = (options) => {
14993
16030
  return (options.client ?? _heyApiClient).put({
14994
16031
  security: [
@@ -15009,6 +16046,10 @@ export const marketplaceRobotAccountsUpdate = (options) => {
15009
16046
  }
15010
16047
  });
15011
16048
  };
16049
+ /**
16050
+ * Set robot account state to creating
16051
+ * Transitions the robot account state from 'Requested' to 'Creating'. This is typically used by an agent to signal that the creation process has started.
16052
+ */
15012
16053
  export const marketplaceRobotAccountsSetStateCreating = (options) => {
15013
16054
  return (options.client ?? _heyApiClient).post({
15014
16055
  security: [
@@ -15025,6 +16066,10 @@ export const marketplaceRobotAccountsSetStateCreating = (options) => {
15025
16066
  ...options
15026
16067
  });
15027
16068
  };
16069
+ /**
16070
+ * Set robot account state to deleted
16071
+ * Transitions the robot account state from 'Requested deletion' to 'Deleted', marking the successful completion of the deletion process.
16072
+ */
15028
16073
  export const marketplaceRobotAccountsSetStateDeleted = (options) => {
15029
16074
  return (options.client ?? _heyApiClient).post({
15030
16075
  security: [
@@ -15041,6 +16086,10 @@ export const marketplaceRobotAccountsSetStateDeleted = (options) => {
15041
16086
  ...options
15042
16087
  });
15043
16088
  };
16089
+ /**
16090
+ * Set robot account state to erred
16091
+ * Manually moves the robot account into the 'Error' state. An optional error message can be provided.
16092
+ */
15044
16093
  export const marketplaceRobotAccountsSetStateErred = (options) => {
15045
16094
  return (options.client ?? _heyApiClient).post({
15046
16095
  security: [
@@ -15061,6 +16110,10 @@ export const marketplaceRobotAccountsSetStateErred = (options) => {
15061
16110
  }
15062
16111
  });
15063
16112
  };
16113
+ /**
16114
+ * Set robot account state to OK
16115
+ * Manually sets the robot account state to 'OK', indicating that it is fully operational. This can be used to recover from an error state.
16116
+ */
15064
16117
  export const marketplaceRobotAccountsSetStateOk = (options) => {
15065
16118
  return (options.client ?? _heyApiClient).post({
15066
16119
  security: [
@@ -15077,6 +16130,10 @@ export const marketplaceRobotAccountsSetStateOk = (options) => {
15077
16130
  ...options
15078
16131
  });
15079
16132
  };
16133
+ /**
16134
+ * Request deletion of a robot account
16135
+ * Transitions the robot account state from 'OK' to 'Requested deletion', initiating the deletion process.
16136
+ */
15080
16137
  export const marketplaceRobotAccountsSetStateRequestDeletion = (options) => {
15081
16138
  return (options.client ?? _heyApiClient).post({
15082
16139
  security: [
@@ -15094,7 +16151,13 @@ export const marketplaceRobotAccountsSetStateRequestDeletion = (options) => {
15094
16151
  });
15095
16152
  };
15096
16153
  /**
15097
- * Retrieve available runtime states for resources, optionally filtered by project and category.
16154
+ * List available runtime states for resources
16155
+ *
16156
+ * Returns a unique, sorted list of runtime states for all resources accessible to the current user.
16157
+ * The runtime state is a backend-specific state of a resource (e.g., 'ACTIVE', 'SHUTOFF' for a VM).
16158
+ * This endpoint is useful for building dynamic filters in a user interface.
16159
+ * The list can be optionally filtered by project or category.
16160
+ *
15098
16161
  */
15099
16162
  export const marketplaceRuntimeStatesList = (options) => {
15100
16163
  return (options?.client ?? _heyApiClient).get({
@@ -15356,6 +16419,10 @@ export const marketplaceScriptSyncResource = (options) => {
15356
16419
  }
15357
16420
  });
15358
16421
  };
16422
+ /**
16423
+ * List sections
16424
+ * Returns a paginated list of all sections. Sections are used to group attributes within a category.
16425
+ */
15359
16426
  export const marketplaceSectionsList = (options) => {
15360
16427
  return (options?.client ?? _heyApiClient).get({
15361
16428
  security: [
@@ -15373,6 +16440,7 @@ export const marketplaceSectionsList = (options) => {
15373
16440
  });
15374
16441
  };
15375
16442
  /**
16443
+ * List sections
15376
16444
  * Get number of items in the collection matching the request parameters.
15377
16445
  */
15378
16446
  export const marketplaceSectionsCount = (options) => {
@@ -15391,6 +16459,10 @@ export const marketplaceSectionsCount = (options) => {
15391
16459
  ...options
15392
16460
  });
15393
16461
  };
16462
+ /**
16463
+ * Create a section
16464
+ * Creates a new section within a category. Requires staff permissions.
16465
+ */
15394
16466
  export const marketplaceSectionsCreate = (options) => {
15395
16467
  return (options.client ?? _heyApiClient).post({
15396
16468
  security: [
@@ -15411,6 +16483,10 @@ export const marketplaceSectionsCreate = (options) => {
15411
16483
  }
15412
16484
  });
15413
16485
  };
16486
+ /**
16487
+ * Delete a section
16488
+ * Deletes a section. Requires staff permissions.
16489
+ */
15414
16490
  export const marketplaceSectionsDestroy = (options) => {
15415
16491
  return (options.client ?? _heyApiClient).delete({
15416
16492
  security: [
@@ -15427,6 +16503,10 @@ export const marketplaceSectionsDestroy = (options) => {
15427
16503
  ...options
15428
16504
  });
15429
16505
  };
16506
+ /**
16507
+ * Retrieve a section
16508
+ * Returns the details of a specific section, identified by its key.
16509
+ */
15430
16510
  export const marketplaceSectionsRetrieve = (options) => {
15431
16511
  return (options.client ?? _heyApiClient).get({
15432
16512
  security: [
@@ -15443,6 +16523,10 @@ export const marketplaceSectionsRetrieve = (options) => {
15443
16523
  ...options
15444
16524
  });
15445
16525
  };
16526
+ /**
16527
+ * Partially update a section
16528
+ * Partially updates an existing section. Requires staff permissions.
16529
+ */
15446
16530
  export const marketplaceSectionsPartialUpdate = (options) => {
15447
16531
  return (options.client ?? _heyApiClient).patch({
15448
16532
  security: [
@@ -15463,6 +16547,10 @@ export const marketplaceSectionsPartialUpdate = (options) => {
15463
16547
  }
15464
16548
  });
15465
16549
  };
16550
+ /**
16551
+ * Update a section
16552
+ * Updates an existing section. Requires staff permissions.
16553
+ */
15466
16554
  export const marketplaceSectionsUpdate = (options) => {
15467
16555
  return (options.client ?? _heyApiClient).put({
15468
16556
  security: [
@@ -15483,6 +16571,10 @@ export const marketplaceSectionsUpdate = (options) => {
15483
16571
  }
15484
16572
  });
15485
16573
  };
16574
+ /**
16575
+ * List service providers
16576
+ * Returns a paginated list of service providers.
16577
+ */
15486
16578
  export const marketplaceServiceProvidersList = (options) => {
15487
16579
  return (options?.client ?? _heyApiClient).get({
15488
16580
  security: [
@@ -15500,6 +16592,7 @@ export const marketplaceServiceProvidersList = (options) => {
15500
16592
  });
15501
16593
  };
15502
16594
  /**
16595
+ * List service providers
15503
16596
  * Get number of items in the collection matching the request parameters.
15504
16597
  */
15505
16598
  export const marketplaceServiceProvidersCount = (options) => {
@@ -15518,6 +16611,10 @@ export const marketplaceServiceProvidersCount = (options) => {
15518
16611
  ...options
15519
16612
  });
15520
16613
  };
16614
+ /**
16615
+ * Create a service provider
16616
+ * Creates a new service provider profile for a customer.
16617
+ */
15521
16618
  export const marketplaceServiceProvidersCreate = (options) => {
15522
16619
  return (options.client ?? _heyApiClient).post({
15523
16620
  security: [
@@ -15539,7 +16636,8 @@ export const marketplaceServiceProvidersCreate = (options) => {
15539
16636
  });
15540
16637
  };
15541
16638
  /**
15542
- * Get summary of all compliance checklists used by this service provider with usage counts.
16639
+ * Get summary of compliance checklists
16640
+ * Returns a summary of all compliance checklists used by this service provider with usage counts.
15543
16641
  */
15544
16642
  export const serviceProviderChecklistsSummary = (options) => {
15545
16643
  return (options.client ?? _heyApiClient).get({
@@ -15558,7 +16656,8 @@ export const serviceProviderChecklistsSummary = (options) => {
15558
16656
  });
15559
16657
  };
15560
16658
  /**
15561
- * Get compliance overview statistics for all offerings managed by this service provider.
16659
+ * Get compliance overview for a service provider
16660
+ * Returns compliance overview statistics for all offerings managed by this service provider.
15562
16661
  */
15563
16662
  export const serviceProviderComplianceOverview = (options) => {
15564
16663
  return (options.client ?? _heyApiClient).get({
@@ -15577,7 +16676,8 @@ export const serviceProviderComplianceOverview = (options) => {
15577
16676
  });
15578
16677
  };
15579
16678
  /**
15580
- * List offering users with their compliance status for this service provider.
16679
+ * List offering users' compliance status
16680
+ * Returns a list of offering users with their compliance status for this service provider. Can be filtered by offering and compliance status.
15581
16681
  */
15582
16682
  export const serviceProviderOfferingUsersCompliance = (options) => {
15583
16683
  return (options.client ?? _heyApiClient).get({
@@ -15596,12 +16696,12 @@ export const serviceProviderOfferingUsersCompliance = (options) => {
15596
16696
  });
15597
16697
  };
15598
16698
  /**
15599
- * Return course project accounts that have access to resources managed by the provider.
15600
- *
15601
- * Checks for:
15602
- * - Projects with active service provider's resources
15603
- * - Course accounts with non-blank users
16699
+ * List course project accounts for a service provider
16700
+ * Returns a paginated list of course project accounts that have access to resources managed by the provider.
15604
16701
  *
16702
+ * This includes:
16703
+ * - Projects with active resources of the service provider.
16704
+ * - Course accounts with non-blank users.
15605
16705
  *
15606
16706
  */
15607
16707
  export const marketplaceServiceProvidersCourseAccountsList = (options) => {
@@ -15621,7 +16721,8 @@ export const marketplaceServiceProvidersCourseAccountsList = (options) => {
15621
16721
  });
15622
16722
  };
15623
16723
  /**
15624
- * Return customer projects of service provider.
16724
+ * List customer projects of a service provider
16725
+ * Returns a paginated list of projects belonging to a specific customer that have consumed resources from the specified service provider.
15625
16726
  */
15626
16727
  export const marketplaceServiceProvidersCustomerProjectsList = (options) => {
15627
16728
  return (options.client ?? _heyApiClient).get({
@@ -15640,7 +16741,8 @@ export const marketplaceServiceProvidersCustomerProjectsList = (options) => {
15640
16741
  });
15641
16742
  };
15642
16743
  /**
15643
- * Return customers of service provider.
16744
+ * List customers of a service provider
16745
+ * Returns a paginated list of customers who have consumed resources from the specified service provider.
15644
16746
  */
15645
16747
  export const marketplaceServiceProvidersCustomersList = (options) => {
15646
16748
  return (options.client ?? _heyApiClient).get({
@@ -15659,7 +16761,8 @@ export const marketplaceServiceProvidersCustomersList = (options) => {
15659
16761
  });
15660
16762
  };
15661
16763
  /**
15662
- * Return SSH keys of service provider.
16764
+ * List SSH keys of a service provider
16765
+ * Returns a paginated list of SSH public keys for all users who have consumed resources from the specified service provider.
15663
16766
  */
15664
16767
  export const marketplaceServiceProvidersKeysList = (options) => {
15665
16768
  return (options.client ?? _heyApiClient).get({
@@ -15678,7 +16781,8 @@ export const marketplaceServiceProvidersKeysList = (options) => {
15678
16781
  });
15679
16782
  };
15680
16783
  /**
15681
- * Return offerings of service provider.
16784
+ * List offerings of a service provider
16785
+ * Returns a paginated list of all billable, shared offerings provided by the specified service provider.
15682
16786
  */
15683
16787
  export const marketplaceServiceProvidersOfferingsList = (options) => {
15684
16788
  return (options.client ?? _heyApiClient).get({
@@ -15697,7 +16801,8 @@ export const marketplaceServiceProvidersOfferingsList = (options) => {
15697
16801
  });
15698
16802
  };
15699
16803
  /**
15700
- * Return project permissions of service provider.
16804
+ * List project permissions of a service provider
16805
+ * Returns a paginated list of project permissions for all projects that have consumed resources from the specified service provider.
15701
16806
  */
15702
16807
  export const marketplaceServiceProvidersProjectPermissionsList = (options) => {
15703
16808
  return (options.client ?? _heyApiClient).get({
@@ -15716,12 +16821,12 @@ export const marketplaceServiceProvidersProjectPermissionsList = (options) => {
15716
16821
  });
15717
16822
  };
15718
16823
  /**
15719
- * Return project service accounts that have access to resources managed by the provider.
15720
- *
15721
- * Checks for:
15722
- * - Projects with active service provider's resources
15723
- * - Service accounts with non-blank usernames
16824
+ * List project service accounts for a service provider
16825
+ * Returns a paginated list of project service accounts that have access to resources managed by the provider.
15724
16826
  *
16827
+ * This includes:
16828
+ * - Projects with active resources of the service provider.
16829
+ * - Service accounts with non-blank usernames.
15725
16830
  *
15726
16831
  */
15727
16832
  export const marketplaceServiceProvidersProjectServiceAccountsList = (options) => {
@@ -15741,7 +16846,8 @@ export const marketplaceServiceProvidersProjectServiceAccountsList = (options) =
15741
16846
  });
15742
16847
  };
15743
16848
  /**
15744
- * Return projects of service provider.
16849
+ * List projects of a service provider
16850
+ * Returns a paginated list of all projects that have consumed resources from the specified service provider.
15745
16851
  */
15746
16852
  export const marketplaceServiceProvidersProjectsList = (options) => {
15747
16853
  return (options.client ?? _heyApiClient).get({
@@ -15760,14 +16866,14 @@ export const marketplaceServiceProvidersProjectsList = (options) => {
15760
16866
  });
15761
16867
  };
15762
16868
  /**
15763
- * Return customers that have access role for a specified user within service provider's scope.
16869
+ * List customers of a specific user within a service provider's scope
16870
+ * Returns a paginated list of customers that a specified user has access to within the scope of a service provider.
15764
16871
  *
15765
- * Checks for:
15766
- * - Customers where user has direct permissions
15767
- * - Customers with projects where user has project roles
15768
- * - Customers related to service provider's resources
16872
+ * This includes:
16873
+ * - Customers where the user has direct permissions.
16874
+ * - Customers with projects where the user has project roles.
16875
+ * - Customers related to the service provider's resources that the user can access.
15769
16876
  *
15770
- * If user UUID is invalid or missing, returns empty list.
15771
16877
  */
15772
16878
  export const marketplaceServiceProvidersUserCustomersList = (options) => {
15773
16879
  return (options.client ?? _heyApiClient).get({
@@ -15786,7 +16892,8 @@ export const marketplaceServiceProvidersUserCustomersList = (options) => {
15786
16892
  });
15787
16893
  };
15788
16894
  /**
15789
- * Return users of service provider.
16895
+ * List users of a service provider
16896
+ * Returns a paginated list of all users who have consumed resources from the specified service provider.
15790
16897
  */
15791
16898
  export const marketplaceServiceProvidersUsersList = (options) => {
15792
16899
  return (options.client ?? _heyApiClient).get({
@@ -15804,6 +16911,10 @@ export const marketplaceServiceProvidersUsersList = (options) => {
15804
16911
  ...options
15805
16912
  });
15806
16913
  };
16914
+ /**
16915
+ * Delete a service provider
16916
+ * Deletes a service provider profile. Only possible if there are no active offerings.
16917
+ */
15807
16918
  export const marketplaceServiceProvidersDestroy = (options) => {
15808
16919
  return (options.client ?? _heyApiClient).delete({
15809
16920
  security: [
@@ -15820,6 +16931,10 @@ export const marketplaceServiceProvidersDestroy = (options) => {
15820
16931
  ...options
15821
16932
  });
15822
16933
  };
16934
+ /**
16935
+ * Retrieve a service provider
16936
+ * Returns details of a specific service provider.
16937
+ */
15823
16938
  export const marketplaceServiceProvidersRetrieve = (options) => {
15824
16939
  return (options.client ?? _heyApiClient).get({
15825
16940
  security: [
@@ -15836,6 +16951,10 @@ export const marketplaceServiceProvidersRetrieve = (options) => {
15836
16951
  ...options
15837
16952
  });
15838
16953
  };
16954
+ /**
16955
+ * Partially update a service provider
16956
+ * Partially updates an existing service provider profile.
16957
+ */
15839
16958
  export const marketplaceServiceProvidersPartialUpdate = (options) => {
15840
16959
  return (options.client ?? _heyApiClient).patch({
15841
16960
  security: [
@@ -15856,6 +16975,10 @@ export const marketplaceServiceProvidersPartialUpdate = (options) => {
15856
16975
  }
15857
16976
  });
15858
16977
  };
16978
+ /**
16979
+ * Update a service provider
16980
+ * Updates an existing service provider profile.
16981
+ */
15859
16982
  export const marketplaceServiceProvidersUpdate = (options) => {
15860
16983
  return (options.client ?? _heyApiClient).put({
15861
16984
  security: [
@@ -15901,7 +17024,8 @@ export const marketplaceServiceProvidersAddUser = (options) => {
15901
17024
  });
15902
17025
  };
15903
17026
  /**
15904
- * Return service provider API secret code.
17027
+ * Get service provider API secret code
17028
+ * Returns the API secret code for a service provider. Requires service provider owner permission.
15905
17029
  */
15906
17030
  export const serviceProviderApiSecretCodeRetrieve = (options) => {
15907
17031
  return (options.client ?? _heyApiClient).get({
@@ -15920,7 +17044,8 @@ export const serviceProviderApiSecretCodeRetrieve = (options) => {
15920
17044
  });
15921
17045
  };
15922
17046
  /**
15923
- * Generate new service provider API secret code.
17047
+ * Generate new service provider API secret code
17048
+ * Generates a new API secret code for a service provider, invalidating the old one. Requires service provider owner permission.
15924
17049
  */
15925
17050
  export const serviceProviderApiSecretCodeGenerate = (options) => {
15926
17051
  return (options.client ?? _heyApiClient).post({
@@ -15982,6 +17107,10 @@ export const marketplaceServiceProvidersListUsersList = (options) => {
15982
17107
  ...options
15983
17108
  });
15984
17109
  };
17110
+ /**
17111
+ * Get service provider revenue
17112
+ * Returns monthly revenue data for the last year for the service provider.
17113
+ */
15985
17114
  export const marketplaceServiceProvidersRevenueList = (options) => {
15986
17115
  return (options.client ?? _heyApiClient).get({
15987
17116
  security: [
@@ -15998,6 +17127,10 @@ export const marketplaceServiceProvidersRevenueList = (options) => {
15998
17127
  ...options
15999
17128
  });
16000
17129
  };
17130
+ /**
17131
+ * List customers with robot accounts
17132
+ * Returns a paginated list of customers who have robot accounts for resources managed by this service provider.
17133
+ */
16001
17134
  export const marketplaceServiceProvidersRobotAccountCustomersList = (options) => {
16002
17135
  return (options.client ?? _heyApiClient).get({
16003
17136
  security: [
@@ -16014,6 +17147,10 @@ export const marketplaceServiceProvidersRobotAccountCustomersList = (options) =>
16014
17147
  ...options
16015
17148
  });
16016
17149
  };
17150
+ /**
17151
+ * List projects with robot accounts
17152
+ * Returns a paginated list of projects which have robot accounts for resources managed by this service provider.
17153
+ */
16017
17154
  export const marketplaceServiceProvidersRobotAccountProjectsList = (options) => {
16018
17155
  return (options.client ?? _heyApiClient).get({
16019
17156
  security: [
@@ -16030,6 +17167,10 @@ export const marketplaceServiceProvidersRobotAccountProjectsList = (options) =>
16030
17167
  ...options
16031
17168
  });
16032
17169
  };
17170
+ /**
17171
+ * Set offering username for a user
17172
+ * Sets or updates the offering-specific username for a user across all offerings managed by the service provider that the user has access to.
17173
+ */
16033
17174
  export const marketplaceServiceProvidersSetOfferingsUsername = (options) => {
16034
17175
  return (options.client ?? _heyApiClient).post({
16035
17176
  security: [
@@ -16050,6 +17191,10 @@ export const marketplaceServiceProvidersSetOfferingsUsername = (options) => {
16050
17191
  }
16051
17192
  });
16052
17193
  };
17194
+ /**
17195
+ * Get service provider statistics
17196
+ * Returns various statistics for the service provider, such as number of active campaigns, customers, and resources.
17197
+ */
16053
17198
  export const marketplaceServiceProvidersStatRetrieve = (options) => {
16054
17199
  return (options.client ?? _heyApiClient).get({
16055
17200
  security: [
@@ -16553,6 +17698,10 @@ export const marketplaceSlurmPeriodicUsagePoliciesActionsCount = (options) => {
16553
17698
  ...options
16554
17699
  });
16555
17700
  };
17701
+ /**
17702
+ * List software catalogs
17703
+ * Returns a paginated list of available software catalogs, such as EESSI or Spack.
17704
+ */
16556
17705
  export const marketplaceSoftwareCatalogsList = (options) => {
16557
17706
  return (options?.client ?? _heyApiClient).get({
16558
17707
  security: [
@@ -16570,6 +17719,7 @@ export const marketplaceSoftwareCatalogsList = (options) => {
16570
17719
  });
16571
17720
  };
16572
17721
  /**
17722
+ * List software catalogs
16573
17723
  * Get number of items in the collection matching the request parameters.
16574
17724
  */
16575
17725
  export const marketplaceSoftwareCatalogsCount = (options) => {
@@ -16588,6 +17738,10 @@ export const marketplaceSoftwareCatalogsCount = (options) => {
16588
17738
  ...options
16589
17739
  });
16590
17740
  };
17741
+ /**
17742
+ * Create a software catalog
17743
+ * Creates a new software catalog. Requires staff permissions.
17744
+ */
16591
17745
  export const marketplaceSoftwareCatalogsCreate = (options) => {
16592
17746
  return (options.client ?? _heyApiClient).post({
16593
17747
  security: [
@@ -16608,6 +17762,10 @@ export const marketplaceSoftwareCatalogsCreate = (options) => {
16608
17762
  }
16609
17763
  });
16610
17764
  };
17765
+ /**
17766
+ * Delete a software catalog
17767
+ * Deletes a software catalog. Requires staff permissions.
17768
+ */
16611
17769
  export const marketplaceSoftwareCatalogsDestroy = (options) => {
16612
17770
  return (options.client ?? _heyApiClient).delete({
16613
17771
  security: [
@@ -16624,6 +17782,10 @@ export const marketplaceSoftwareCatalogsDestroy = (options) => {
16624
17782
  ...options
16625
17783
  });
16626
17784
  };
17785
+ /**
17786
+ * Retrieve a software catalog
17787
+ * Returns the details of a specific software catalog, including its name, version, and the number of packages it contains.
17788
+ */
16627
17789
  export const marketplaceSoftwareCatalogsRetrieve = (options) => {
16628
17790
  return (options.client ?? _heyApiClient).get({
16629
17791
  security: [
@@ -16640,6 +17802,10 @@ export const marketplaceSoftwareCatalogsRetrieve = (options) => {
16640
17802
  ...options
16641
17803
  });
16642
17804
  };
17805
+ /**
17806
+ * Partially update a software catalog
17807
+ * Partially updates an existing software catalog. Requires staff permissions.
17808
+ */
16643
17809
  export const marketplaceSoftwareCatalogsPartialUpdate = (options) => {
16644
17810
  return (options.client ?? _heyApiClient).patch({
16645
17811
  security: [
@@ -16660,6 +17826,10 @@ export const marketplaceSoftwareCatalogsPartialUpdate = (options) => {
16660
17826
  }
16661
17827
  });
16662
17828
  };
17829
+ /**
17830
+ * Update a software catalog
17831
+ * Updates an existing software catalog. Requires staff permissions.
17832
+ */
16663
17833
  export const marketplaceSoftwareCatalogsUpdate = (options) => {
16664
17834
  return (options.client ?? _heyApiClient).put({
16665
17835
  security: [
@@ -16680,6 +17850,10 @@ export const marketplaceSoftwareCatalogsUpdate = (options) => {
16680
17850
  }
16681
17851
  });
16682
17852
  };
17853
+ /**
17854
+ * List software packages
17855
+ * Returns a paginated list of software packages available in the catalogs. Can be filtered by catalog, offering, or various package attributes.
17856
+ */
16683
17857
  export const marketplaceSoftwarePackagesList = (options) => {
16684
17858
  return (options?.client ?? _heyApiClient).get({
16685
17859
  security: [
@@ -16697,6 +17871,7 @@ export const marketplaceSoftwarePackagesList = (options) => {
16697
17871
  });
16698
17872
  };
16699
17873
  /**
17874
+ * List software packages
16700
17875
  * Get number of items in the collection matching the request parameters.
16701
17876
  */
16702
17877
  export const marketplaceSoftwarePackagesCount = (options) => {
@@ -16715,6 +17890,10 @@ export const marketplaceSoftwarePackagesCount = (options) => {
16715
17890
  ...options
16716
17891
  });
16717
17892
  };
17893
+ /**
17894
+ * Create a software package
17895
+ * Creates a new software package within a catalog. Requires staff permissions.
17896
+ */
16718
17897
  export const marketplaceSoftwarePackagesCreate = (options) => {
16719
17898
  return (options.client ?? _heyApiClient).post({
16720
17899
  security: [
@@ -16735,6 +17914,10 @@ export const marketplaceSoftwarePackagesCreate = (options) => {
16735
17914
  }
16736
17915
  });
16737
17916
  };
17917
+ /**
17918
+ * Delete a software package
17919
+ * Deletes a software package. Requires staff permissions.
17920
+ */
16738
17921
  export const marketplaceSoftwarePackagesDestroy = (options) => {
16739
17922
  return (options.client ?? _heyApiClient).delete({
16740
17923
  security: [
@@ -16751,6 +17934,10 @@ export const marketplaceSoftwarePackagesDestroy = (options) => {
16751
17934
  ...options
16752
17935
  });
16753
17936
  };
17937
+ /**
17938
+ * Retrieve a software package
17939
+ * Returns the details of a specific software package, including its description, homepage, and available versions.
17940
+ */
16754
17941
  export const marketplaceSoftwarePackagesRetrieve = (options) => {
16755
17942
  return (options.client ?? _heyApiClient).get({
16756
17943
  security: [
@@ -16767,6 +17954,10 @@ export const marketplaceSoftwarePackagesRetrieve = (options) => {
16767
17954
  ...options
16768
17955
  });
16769
17956
  };
17957
+ /**
17958
+ * Partially update a software package
17959
+ * Partially updates an existing software package. Requires staff permissions.
17960
+ */
16770
17961
  export const marketplaceSoftwarePackagesPartialUpdate = (options) => {
16771
17962
  return (options.client ?? _heyApiClient).patch({
16772
17963
  security: [
@@ -16787,6 +17978,10 @@ export const marketplaceSoftwarePackagesPartialUpdate = (options) => {
16787
17978
  }
16788
17979
  });
16789
17980
  };
17981
+ /**
17982
+ * Update a software package
17983
+ * Updates an existing software package. Requires staff permissions.
17984
+ */
16790
17985
  export const marketplaceSoftwarePackagesUpdate = (options) => {
16791
17986
  return (options.client ?? _heyApiClient).put({
16792
17987
  security: [
@@ -16807,6 +18002,10 @@ export const marketplaceSoftwarePackagesUpdate = (options) => {
16807
18002
  }
16808
18003
  });
16809
18004
  };
18005
+ /**
18006
+ * List software targets
18007
+ * Returns a paginated list of software targets, which represent specific builds of a software version for a given CPU architecture.
18008
+ */
16810
18009
  export const marketplaceSoftwareTargetsList = (options) => {
16811
18010
  return (options?.client ?? _heyApiClient).get({
16812
18011
  security: [
@@ -16824,6 +18023,7 @@ export const marketplaceSoftwareTargetsList = (options) => {
16824
18023
  });
16825
18024
  };
16826
18025
  /**
18026
+ * List software targets
16827
18027
  * Get number of items in the collection matching the request parameters.
16828
18028
  */
16829
18029
  export const marketplaceSoftwareTargetsCount = (options) => {
@@ -16842,6 +18042,10 @@ export const marketplaceSoftwareTargetsCount = (options) => {
16842
18042
  ...options
16843
18043
  });
16844
18044
  };
18045
+ /**
18046
+ * Create a software target
18047
+ * Creates a new target for a software version. Requires staff permissions.
18048
+ */
16845
18049
  export const marketplaceSoftwareTargetsCreate = (options) => {
16846
18050
  return (options?.client ?? _heyApiClient).post({
16847
18051
  security: [
@@ -16858,6 +18062,10 @@ export const marketplaceSoftwareTargetsCreate = (options) => {
16858
18062
  ...options
16859
18063
  });
16860
18064
  };
18065
+ /**
18066
+ * Delete a software target
18067
+ * Deletes a software target. Requires staff permissions.
18068
+ */
16861
18069
  export const marketplaceSoftwareTargetsDestroy = (options) => {
16862
18070
  return (options.client ?? _heyApiClient).delete({
16863
18071
  security: [
@@ -16874,6 +18082,10 @@ export const marketplaceSoftwareTargetsDestroy = (options) => {
16874
18082
  ...options
16875
18083
  });
16876
18084
  };
18085
+ /**
18086
+ * Retrieve a software target
18087
+ * Returns the details of a specific software target, including its CPU family, microarchitecture, and path.
18088
+ */
16877
18089
  export const marketplaceSoftwareTargetsRetrieve = (options) => {
16878
18090
  return (options.client ?? _heyApiClient).get({
16879
18091
  security: [
@@ -16890,6 +18102,10 @@ export const marketplaceSoftwareTargetsRetrieve = (options) => {
16890
18102
  ...options
16891
18103
  });
16892
18104
  };
18105
+ /**
18106
+ * Partially update a software target
18107
+ * Partially updates an existing software target. Requires staff permissions.
18108
+ */
16893
18109
  export const marketplaceSoftwareTargetsPartialUpdate = (options) => {
16894
18110
  return (options.client ?? _heyApiClient).patch({
16895
18111
  security: [
@@ -16906,6 +18122,10 @@ export const marketplaceSoftwareTargetsPartialUpdate = (options) => {
16906
18122
  ...options
16907
18123
  });
16908
18124
  };
18125
+ /**
18126
+ * Update a software target
18127
+ * Updates an existing software target. Requires staff permissions.
18128
+ */
16909
18129
  export const marketplaceSoftwareTargetsUpdate = (options) => {
16910
18130
  return (options.client ?? _heyApiClient).put({
16911
18131
  security: [
@@ -16922,6 +18142,10 @@ export const marketplaceSoftwareTargetsUpdate = (options) => {
16922
18142
  ...options
16923
18143
  });
16924
18144
  };
18145
+ /**
18146
+ * List software versions
18147
+ * Returns a paginated list of software versions. Can be filtered by package, catalog, offering, or CPU architecture.
18148
+ */
16925
18149
  export const marketplaceSoftwareVersionsList = (options) => {
16926
18150
  return (options?.client ?? _heyApiClient).get({
16927
18151
  security: [
@@ -16939,6 +18163,7 @@ export const marketplaceSoftwareVersionsList = (options) => {
16939
18163
  });
16940
18164
  };
16941
18165
  /**
18166
+ * List software versions
16942
18167
  * Get number of items in the collection matching the request parameters.
16943
18168
  */
16944
18169
  export const marketplaceSoftwareVersionsCount = (options) => {
@@ -16957,6 +18182,10 @@ export const marketplaceSoftwareVersionsCount = (options) => {
16957
18182
  ...options
16958
18183
  });
16959
18184
  };
18185
+ /**
18186
+ * Create a software version
18187
+ * Creates a new version for a software package. Requires staff permissions.
18188
+ */
16960
18189
  export const marketplaceSoftwareVersionsCreate = (options) => {
16961
18190
  return (options?.client ?? _heyApiClient).post({
16962
18191
  security: [
@@ -16973,6 +18202,10 @@ export const marketplaceSoftwareVersionsCreate = (options) => {
16973
18202
  ...options
16974
18203
  });
16975
18204
  };
18205
+ /**
18206
+ * Delete a software version
18207
+ * Deletes a software version. Requires staff permissions.
18208
+ */
16976
18209
  export const marketplaceSoftwareVersionsDestroy = (options) => {
16977
18210
  return (options.client ?? _heyApiClient).delete({
16978
18211
  security: [
@@ -16989,6 +18222,10 @@ export const marketplaceSoftwareVersionsDestroy = (options) => {
16989
18222
  ...options
16990
18223
  });
16991
18224
  };
18225
+ /**
18226
+ * Retrieve a software version
18227
+ * Returns the details of a specific software version, including its release date and target count.
18228
+ */
16992
18229
  export const marketplaceSoftwareVersionsRetrieve = (options) => {
16993
18230
  return (options.client ?? _heyApiClient).get({
16994
18231
  security: [
@@ -17005,6 +18242,10 @@ export const marketplaceSoftwareVersionsRetrieve = (options) => {
17005
18242
  ...options
17006
18243
  });
17007
18244
  };
18245
+ /**
18246
+ * Partially update a software version
18247
+ * Partially updates an existing software version. Requires staff permissions.
18248
+ */
17008
18249
  export const marketplaceSoftwareVersionsPartialUpdate = (options) => {
17009
18250
  return (options.client ?? _heyApiClient).patch({
17010
18251
  security: [
@@ -17021,6 +18262,10 @@ export const marketplaceSoftwareVersionsPartialUpdate = (options) => {
17021
18262
  ...options
17022
18263
  });
17023
18264
  };
18265
+ /**
18266
+ * Update a software version
18267
+ * Updates an existing software version. Requires staff permissions.
18268
+ */
17024
18269
  export const marketplaceSoftwareVersionsUpdate = (options) => {
17025
18270
  return (options.client ?? _heyApiClient).put({
17026
18271
  security: [
@@ -17873,6 +19118,10 @@ export const marketplaceStatsTotalCostOfActiveResourcesPerOfferingCount = (optio
17873
19118
  ...options
17874
19119
  });
17875
19120
  };
19121
+ /**
19122
+ * List user offering consents
19123
+ * Returns a paginated list of Terms of Service consents for the current user. Staff and support users can see all consents.
19124
+ */
17876
19125
  export const marketplaceUserOfferingConsentsList = (options) => {
17877
19126
  return (options?.client ?? _heyApiClient).get({
17878
19127
  security: [
@@ -17890,6 +19139,7 @@ export const marketplaceUserOfferingConsentsList = (options) => {
17890
19139
  });
17891
19140
  };
17892
19141
  /**
19142
+ * List user offering consents
17893
19143
  * Get number of items in the collection matching the request parameters.
17894
19144
  */
17895
19145
  export const marketplaceUserOfferingConsentsCount = (options) => {
@@ -17908,6 +19158,10 @@ export const marketplaceUserOfferingConsentsCount = (options) => {
17908
19158
  ...options
17909
19159
  });
17910
19160
  };
19161
+ /**
19162
+ * Grant consent to an offering's Terms of Service
19163
+ * Creates a consent record for the current user and a specific offering. This indicates that the user has accepted the active Terms of Service for that offering. If a consent already exists (even if revoked), it will be reactivated and updated with the current ToS version.
19164
+ */
17911
19165
  export const marketplaceUserOfferingConsentsCreate = (options) => {
17912
19166
  return (options.client ?? _heyApiClient).post({
17913
19167
  security: [
@@ -17944,6 +19198,10 @@ export const marketplaceUserOfferingConsentsDestroy = (options) => {
17944
19198
  ...options
17945
19199
  });
17946
19200
  };
19201
+ /**
19202
+ * Retrieve a user offering consent
19203
+ * Returns the details of a specific consent record.
19204
+ */
17947
19205
  export const marketplaceUserOfferingConsentsRetrieve = (options) => {
17948
19206
  return (options.client ?? _heyApiClient).get({
17949
19207
  security: [
@@ -18001,7 +19259,8 @@ export const marketplaceUserOfferingConsentsUpdate = (options) => {
18001
19259
  });
18002
19260
  };
18003
19261
  /**
18004
- * Revoke consent to Terms of Service for an offering.
19262
+ * Revoke consent to Terms of Service
19263
+ * Revokes a user's consent to the Terms of Service for an offering. The consent record is marked with a revocation date, and the user may lose access to related resources if consent is required.
18005
19264
  */
18006
19265
  export const marketplaceUserOfferingConsentsRevoke = (options) => {
18007
19266
  return (options.client ?? _heyApiClient).post({
@@ -27813,6 +29072,10 @@ export const providerInvoiceItemsRetrieve = (options) => {
27813
29072
  ...options
27814
29073
  });
27815
29074
  };
29075
+ /**
29076
+ * List public maintenance announcements
29077
+ * Returns a paginated list of public maintenance announcements. Only announcements that are 'Scheduled', 'In progress', or 'Completed' are visible. This endpoint is accessible to unauthenticated users.
29078
+ */
27816
29079
  export const publicMaintenanceAnnouncementsList = (options) => {
27817
29080
  return (options?.client ?? _heyApiClient).get({
27818
29081
  security: [
@@ -27830,6 +29093,7 @@ export const publicMaintenanceAnnouncementsList = (options) => {
27830
29093
  });
27831
29094
  };
27832
29095
  /**
29096
+ * List public maintenance announcements
27833
29097
  * Get number of items in the collection matching the request parameters.
27834
29098
  */
27835
29099
  export const publicMaintenanceAnnouncementsCount = (options) => {
@@ -27848,6 +29112,10 @@ export const publicMaintenanceAnnouncementsCount = (options) => {
27848
29112
  ...options
27849
29113
  });
27850
29114
  };
29115
+ /**
29116
+ * Retrieve a public maintenance announcement
29117
+ * Returns the details of a specific public maintenance announcement.
29118
+ */
27851
29119
  export const publicMaintenanceAnnouncementsRetrieve = (options) => {
27852
29120
  return (options.client ?? _heyApiClient).get({
27853
29121
  security: [