waldur-js-client 7.9.3-dev.0 → 7.9.3-dev.10

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.
@@ -830,9 +830,21 @@ export type BackendIdRequest = {
830
830
  backend_id?: string;
831
831
  };
832
832
  export type BackendMetadata = {
833
+ /**
834
+ * Backend resource state
835
+ */
833
836
  readonly state?: string;
837
+ /**
838
+ * Runtime state of the backend resource
839
+ */
834
840
  readonly runtime_state?: string;
841
+ /**
842
+ * Current action being performed
843
+ */
835
844
  readonly action?: string;
845
+ /**
846
+ * Name of the backend instance
847
+ */
836
848
  readonly instance_name?: string | null;
837
849
  };
838
850
  export type BackendResource = {
@@ -1110,6 +1122,9 @@ export type BookingResource = {
1110
1122
  readonly is_usage_based?: boolean;
1111
1123
  readonly is_limit_based?: boolean;
1112
1124
  name?: string;
1125
+ /**
1126
+ * URL-friendly identifier. Only editable by staff users.
1127
+ */
1113
1128
  slug?: string;
1114
1129
  readonly current_usages?: {
1115
1130
  [key: string]: number;
@@ -1146,6 +1161,8 @@ export type BookingResource = {
1146
1161
  readonly renewal_date?: {
1147
1162
  [key: string]: string;
1148
1163
  } | null;
1164
+ offering_state?: ResourceState;
1165
+ readonly offering_components?: Array<OfferingComponent>;
1149
1166
  readonly created_by?: string;
1150
1167
  /**
1151
1168
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
@@ -1183,6 +1200,11 @@ export type BroadcastMessageRequest = {
1183
1200
  send_at?: string | null;
1184
1201
  };
1185
1202
  export type BroadcastMessageStateEnum = 'DRAFT' | 'SCHEDULED' | 'SENT';
1203
+ export type BulkSilenceResponse = {
1204
+ status: string;
1205
+ count: number;
1206
+ duration_days?: number | null;
1207
+ };
1186
1208
  export type CallAttachDocumentsRequest = {
1187
1209
  documents: Array<Blob | File>;
1188
1210
  description?: string;
@@ -1509,6 +1531,7 @@ export type CategoryComponentsRequest = {
1509
1531
  measured_unit?: string;
1510
1532
  category: CategorySerializerForForNestedFieldsRequest;
1511
1533
  };
1534
+ export type CategoryEnum = 'view' | 'approve' | 'reject' | 'extend' | 'terminate' | 'backup' | 'migrate' | 'contact' | 'escalate' | 'configure' | 'repair' | 'monitor';
1512
1535
  export type CategoryGroup = {
1513
1536
  readonly url?: string;
1514
1537
  readonly uuid?: string;
@@ -1548,10 +1571,19 @@ export type CategorySerializerForForNestedFieldsRequest = {
1548
1571
  title: string;
1549
1572
  };
1550
1573
  export type CheckUniqueBackendIdRequest = {
1574
+ /**
1575
+ * Backend identifier to check
1576
+ */
1551
1577
  backend_id: string;
1578
+ /**
1579
+ * Check across all offerings
1580
+ */
1552
1581
  check_all_offerings?: boolean;
1553
1582
  };
1554
1583
  export type CheckUniqueBackendIdResponse = {
1584
+ /**
1585
+ * Whether the backend ID is unique
1586
+ */
1555
1587
  is_unique: boolean;
1556
1588
  };
1557
1589
  export type Checklist = {
@@ -1763,41 +1795,113 @@ export type ComponentUsage = {
1763
1795
  modified_by?: number | null;
1764
1796
  };
1765
1797
  export type ComponentUsageCreateRequest = {
1798
+ /**
1799
+ * List of component usage items to report
1800
+ */
1766
1801
  usages: Array<ComponentUsageItemRequest>;
1802
+ /**
1803
+ * UUID of the specific resource plan period for usage reporting
1804
+ */
1767
1805
  plan_period?: string;
1806
+ /**
1807
+ * UUID of the resource for usage reporting (required if plan_period not provided)
1808
+ */
1768
1809
  resource?: string;
1769
1810
  /**
1770
- * Date for usage reporting (staff only). If not provided, current date is used.
1811
+ * Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used.
1771
1812
  */
1772
1813
  date?: string;
1773
1814
  };
1774
1815
  export type ComponentUsageItemRequest = {
1816
+ /**
1817
+ * Type of the component
1818
+ */
1775
1819
  type: string;
1820
+ /**
1821
+ * Usage amount
1822
+ */
1776
1823
  amount: string;
1824
+ /**
1825
+ * Optional description of usage
1826
+ */
1777
1827
  description?: string;
1828
+ /**
1829
+ * Whether this usage is recurring
1830
+ */
1778
1831
  recurring?: boolean;
1779
1832
  };
1780
1833
  export type ComponentUsagesPerMonthStats = {
1834
+ /**
1835
+ * Total usage amount
1836
+ */
1781
1837
  usage: string;
1838
+ /**
1839
+ * UUID of the offering
1840
+ */
1782
1841
  offering_uuid: string;
1842
+ /**
1843
+ * Type of the component
1844
+ */
1783
1845
  component_type: string;
1846
+ /**
1847
+ * Country of the offering
1848
+ */
1784
1849
  readonly offering_country: string;
1850
+ /**
1851
+ * Name of the organization group
1852
+ */
1785
1853
  readonly organization_group_name: string;
1854
+ /**
1855
+ * UUID of the organization group
1856
+ */
1786
1857
  readonly organization_group_uuid: string;
1858
+ /**
1859
+ * Month of the billing period
1860
+ */
1787
1861
  month: number;
1862
+ /**
1863
+ * Year of the billing period
1864
+ */
1788
1865
  year: number;
1789
1866
  };
1790
1867
  export type ComponentUsagesPerProject = {
1868
+ /**
1869
+ * UUID of the project
1870
+ */
1791
1871
  project_uuid: string;
1872
+ /**
1873
+ * Type of the component
1874
+ */
1792
1875
  component_type: string;
1876
+ /**
1877
+ * Total usage for the component
1878
+ */
1793
1879
  readonly usage: number;
1794
1880
  };
1795
1881
  export type ComponentUsagesStats = {
1882
+ /**
1883
+ * Total usage amount
1884
+ */
1796
1885
  usage: string;
1886
+ /**
1887
+ * UUID of the offering
1888
+ */
1797
1889
  offering_uuid: string;
1890
+ /**
1891
+ * Type of the component
1892
+ */
1798
1893
  component_type: string;
1894
+ /**
1895
+ * Country of the offering
1896
+ */
1799
1897
  readonly offering_country: string;
1898
+ /**
1899
+ * Name of the organization group
1900
+ */
1800
1901
  readonly organization_group_name: string;
1902
+ /**
1903
+ * UUID of the organization group
1904
+ */
1801
1905
  readonly organization_group_uuid: string;
1802
1906
  };
1803
1907
  export type ComponentUserUsage = {
@@ -1834,7 +1938,7 @@ export type ComponentUserUsageCreateRequest = {
1834
1938
  username: string;
1835
1939
  user?: string;
1836
1940
  /**
1837
- * Date for usage reporting (staff only). If not provided, current date is used.
1941
+ * Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used.
1838
1942
  */
1839
1943
  date?: string;
1840
1944
  };
@@ -2209,47 +2313,135 @@ export type ConstanceSettingsRequest = {
2209
2313
  };
2210
2314
  export type ContainerFormatEnum = 'bare' | 'ovf' | 'aki' | 'ami' | 'ari';
2211
2315
  export type CoreAuthToken = {
2316
+ /**
2317
+ * Authentication token for API access
2318
+ */
2212
2319
  readonly token: string;
2213
2320
  };
2214
2321
  export type CoreStates = 'CREATION_SCHEDULED' | 'CREATING' | 'UPDATE_SCHEDULED' | 'UPDATING' | 'DELETION_SCHEDULED' | 'DELETING' | 'OK' | 'ERRED';
2322
+ export type CorrectiveAction = {
2323
+ label: string;
2324
+ url: string;
2325
+ category: CategoryEnum;
2326
+ severity: SeverityEnum;
2327
+ method?: string;
2328
+ api_endpoint?: boolean;
2329
+ confirmation_required?: boolean;
2330
+ permissions_required?: Array<string>;
2331
+ metadata?: {
2332
+ [key: string]: unknown;
2333
+ };
2334
+ };
2215
2335
  export type CostsForPeriod = {
2216
2336
  readonly total_price: string;
2217
2337
  readonly start_date: string;
2218
2338
  readonly end_date: string;
2219
2339
  };
2220
2340
  export type CountProjectsOfServiceProviders = {
2341
+ /**
2342
+ * UUID of the service provider
2343
+ */
2221
2344
  readonly service_provider_uuid: string;
2345
+ /**
2346
+ * UUID of the customer
2347
+ */
2222
2348
  readonly customer_uuid: string;
2349
+ /**
2350
+ * Name of the customer
2351
+ */
2223
2352
  readonly customer_name: string;
2353
+ /**
2354
+ * UUID of the customer's organization group
2355
+ */
2224
2356
  readonly customer_organization_group_uuid: string;
2357
+ /**
2358
+ * Name of the customer's organization group
2359
+ */
2225
2360
  readonly customer_organization_group_name: string;
2361
+ /**
2362
+ * Count value
2363
+ */
2226
2364
  readonly count: number;
2227
2365
  };
2228
2366
  export type CountProjectsOfServiceProvidersGroupedByOecd = {
2367
+ /**
2368
+ * UUID of the service provider
2369
+ */
2229
2370
  readonly service_provider_uuid: string;
2371
+ /**
2372
+ * UUID of the customer
2373
+ */
2230
2374
  readonly customer_uuid: string;
2375
+ /**
2376
+ * Name of the customer
2377
+ */
2231
2378
  readonly customer_name: string;
2379
+ /**
2380
+ * UUID of the customer's organization group
2381
+ */
2232
2382
  readonly customer_organization_group_uuid: string;
2383
+ /**
2384
+ * Name of the customer's organization group
2385
+ */
2233
2386
  readonly customer_organization_group_name: string;
2387
+ /**
2388
+ * Count value
2389
+ */
2234
2390
  readonly count: number;
2235
2391
  readonly oecd_fos_2007_name: string;
2236
2392
  };
2237
2393
  export type CountStats = {
2394
+ /**
2395
+ * Name from the record
2396
+ */
2238
2397
  readonly name: string;
2398
+ /**
2399
+ * UUID from the record
2400
+ */
2239
2401
  readonly uuid: string;
2402
+ /**
2403
+ * Count value from the record
2404
+ */
2240
2405
  readonly count: number;
2241
2406
  };
2242
2407
  export type CountUniqueUsersConnectedWithActiveResourcesOfServiceProvider = {
2408
+ /**
2409
+ * UUID of the customer
2410
+ */
2243
2411
  readonly customer_uuid: string;
2412
+ /**
2413
+ * Name of the customer
2414
+ */
2244
2415
  readonly customer_name: string;
2416
+ /**
2417
+ * Number of unique users
2418
+ */
2245
2419
  readonly count_users: number;
2246
2420
  };
2247
2421
  export type CountUsersOfServiceProviders = {
2422
+ /**
2423
+ * UUID of the service provider
2424
+ */
2248
2425
  readonly service_provider_uuid: string;
2426
+ /**
2427
+ * UUID of the customer
2428
+ */
2249
2429
  readonly customer_uuid: string;
2430
+ /**
2431
+ * Name of the customer
2432
+ */
2250
2433
  readonly customer_name: string;
2434
+ /**
2435
+ * UUID of the customer's organization group
2436
+ */
2251
2437
  readonly customer_organization_group_uuid: string;
2438
+ /**
2439
+ * Name of the customer's organization group
2440
+ */
2252
2441
  readonly customer_organization_group_name: string;
2442
+ /**
2443
+ * Count value
2444
+ */
2253
2445
  readonly count: number;
2254
2446
  };
2255
2447
  export type Country = {
@@ -2292,6 +2484,9 @@ export type CourseAccountsBulkCreateRequest = {
2292
2484
  project: string;
2293
2485
  };
2294
2486
  export type CreateAttachmentsRequest = {
2487
+ /**
2488
+ * List of files to attach
2489
+ */
2295
2490
  attachments: Array<Blob | File>;
2296
2491
  };
2297
2492
  export type CreateCustomerCredit = {
@@ -2355,9 +2550,14 @@ export type Customer = {
2355
2550
  readonly url?: string;
2356
2551
  readonly uuid?: string;
2357
2552
  readonly created?: string;
2553
+ /**
2554
+ * Organization groups this customer belongs to
2555
+ */
2358
2556
  readonly organization_groups?: Array<OrganizationGroup>;
2557
+ /**
2558
+ * Display name of the organization (includes native name if available)
2559
+ */
2359
2560
  readonly display_name?: string;
2360
- readonly projects?: Array<PermissionProject>;
2361
2561
  /**
2362
2562
  * Organization identifier in another application.
2363
2563
  */
@@ -2371,23 +2571,38 @@ export type Customer = {
2371
2571
  * Start date of accounting
2372
2572
  */
2373
2573
  accounting_start_date?: string;
2574
+ /**
2575
+ * Number of projects in this organization
2576
+ */
2374
2577
  readonly projects_count?: number;
2578
+ /**
2579
+ * Number of users with access to this organization
2580
+ */
2375
2581
  readonly users_count?: number;
2376
2582
  /**
2377
2583
  * External ID of the sponsor covering the costs
2378
2584
  */
2379
2585
  sponsor_number?: number | null;
2586
+ /**
2587
+ * Human-readable country name
2588
+ */
2380
2589
  readonly country_name?: string;
2381
2590
  /**
2382
2591
  * Maximum number of service accounts allowed
2383
2592
  */
2384
2593
  max_service_accounts?: number | null;
2594
+ /**
2595
+ * Checklist to be used for project metadata validation in this organization
2596
+ */
2385
2597
  project_metadata_checklist?: string | null;
2386
2598
  /**
2387
2599
  * Number of extra days after project end date before resources are terminated
2388
2600
  */
2389
2601
  grace_period_days?: number | null;
2390
2602
  name?: string;
2603
+ /**
2604
+ * URL-friendly identifier. Only editable by staff users.
2605
+ */
2391
2606
  slug?: string;
2392
2607
  native_name?: string;
2393
2608
  abbreviation?: string;
@@ -2416,6 +2631,9 @@ export type Customer = {
2416
2631
  latitude?: number | null;
2417
2632
  longitude?: number | null;
2418
2633
  bank_account?: string;
2634
+ /**
2635
+ * Country code (ISO 3166-1 alpha-2)
2636
+ */
2419
2637
  country?: CountryEnum | BlankEnum;
2420
2638
  /**
2421
2639
  * Comma-separated list of notification email addresses
@@ -2539,23 +2757,65 @@ export type CustomerEstimatedCostPolicyRequest = {
2539
2757
  period?: PeriodEnum;
2540
2758
  };
2541
2759
  export type CustomerIndustryFlagStats = {
2760
+ /**
2761
+ * Name from the record
2762
+ */
2542
2763
  readonly name: string;
2764
+ /**
2765
+ * UUID from the record
2766
+ */
2543
2767
  readonly uuid: string;
2768
+ /**
2769
+ * Count value from the record
2770
+ */
2544
2771
  readonly count: number;
2772
+ /**
2773
+ * Customer abbreviation from the record
2774
+ */
2545
2775
  readonly abbreviation: string;
2776
+ /**
2777
+ * Industry classification flag
2778
+ */
2546
2779
  is_industry: string;
2547
2780
  };
2548
2781
  export type CustomerMemberCount = {
2782
+ /**
2783
+ * UUID of the customer
2784
+ */
2549
2785
  readonly uuid: string;
2786
+ /**
2787
+ * Name of the customer
2788
+ */
2550
2789
  readonly name: string;
2790
+ /**
2791
+ * Abbreviation of the customer
2792
+ */
2551
2793
  readonly abbreviation: string;
2794
+ /**
2795
+ * Number of members
2796
+ */
2552
2797
  readonly count: number;
2798
+ /**
2799
+ * Whether the customer has resources
2800
+ */
2553
2801
  readonly has_resources: boolean;
2554
2802
  };
2555
2803
  export type CustomerOecdCodeStats = {
2804
+ /**
2805
+ * Name from the record
2806
+ */
2556
2807
  readonly name: string;
2808
+ /**
2809
+ * UUID from the record
2810
+ */
2557
2811
  readonly uuid: string;
2812
+ /**
2813
+ * Count value from the record
2814
+ */
2558
2815
  readonly count: number;
2816
+ /**
2817
+ * Customer abbreviation from the record
2818
+ */
2559
2819
  readonly abbreviation: string;
2560
2820
  oecd: string;
2561
2821
  };
@@ -2597,12 +2857,18 @@ export type CustomerRequest = {
2597
2857
  * Maximum number of service accounts allowed
2598
2858
  */
2599
2859
  max_service_accounts?: number | null;
2860
+ /**
2861
+ * Checklist to be used for project metadata validation in this organization
2862
+ */
2600
2863
  project_metadata_checklist?: string | null;
2601
2864
  /**
2602
2865
  * Number of extra days after project end date before resources are terminated
2603
2866
  */
2604
2867
  grace_period_days?: number | null;
2605
2868
  name: string;
2869
+ /**
2870
+ * URL-friendly identifier. Only editable by staff users.
2871
+ */
2606
2872
  slug?: string;
2607
2873
  native_name?: string;
2608
2874
  abbreviation?: string;
@@ -2631,6 +2897,9 @@ export type CustomerRequest = {
2631
2897
  latitude?: number | null;
2632
2898
  longitude?: number | null;
2633
2899
  bank_account?: string;
2900
+ /**
2901
+ * Country code (ISO 3166-1 alpha-2)
2902
+ */
2634
2903
  country?: CountryEnum | BlankEnum;
2635
2904
  /**
2636
2905
  * Comma-separated list of notification email addresses
@@ -2931,9 +3200,15 @@ export type EmailLog = {
2931
3200
  emails: Array<string>;
2932
3201
  };
2933
3202
  export type EndpointUuid = {
3203
+ /**
3204
+ * UUID of the access endpoint
3205
+ */
2934
3206
  uuid: string;
2935
3207
  };
2936
3208
  export type EndpointUuidRequest = {
3209
+ /**
3210
+ * UUID of the access endpoint
3211
+ */
2937
3212
  uuid: string;
2938
3213
  };
2939
3214
  export type EthertypeEnum = 'IPv4' | 'IPv6';
@@ -2982,6 +3257,23 @@ export type EventSubscriptionRequest = {
2982
3257
  observable_objects?: unknown;
2983
3258
  };
2984
3259
  export type EventTypesEnum = 'access_subnet_creation_succeeded' | 'access_subnet_deletion_succeeded' | 'access_subnet_update_succeeded' | 'allowed_offerings_have_been_updated' | 'attachment_created' | 'attachment_deleted' | 'attachment_updated' | 'auth_logged_in_with_saml2' | 'auth_logged_in_with_username' | 'auth_logged_in_with_oauth' | 'auth_logged_out' | 'auth_logged_out_with_saml2' | 'auth_login_failed_with_username' | 'block_creation_of_new_resources' | 'block_modification_of_existing_resources' | 'call_document_added' | 'call_document_removed' | 'create_of_credit_by_staff' | 'custom_notification' | 'customer_creation_succeeded' | 'customer_deletion_succeeded' | 'customer_update_succeeded' | 'customer_permission_review_created' | 'customer_permission_review_closed' | 'droplet_resize_scheduled' | 'droplet_resize_succeeded' | 'freeipa_profile_created' | 'freeipa_profile_deleted' | 'freeipa_profile_disabled' | 'freeipa_profile_enabled' | 'invoice_canceled' | 'invoice_created' | 'invoice_item_created' | 'invoice_item_deleted' | 'invoice_item_updated' | 'invoice_paid' | 'issue_creation_succeeded' | 'issue_deletion_succeeded' | 'issue_update_succeeded' | 'marketplace_offering_component_created' | 'marketplace_offering_component_deleted' | 'marketplace_offering_component_updated' | 'marketplace_offering_created' | 'marketplace_offering_role_created' | 'marketplace_offering_role_deleted' | 'marketplace_offering_role_updated' | 'marketplace_offering_updated' | 'marketplace_offering_user_created' | 'marketplace_offering_user_updated' | 'marketplace_offering_user_deleted' | 'marketplace_offering_user_restriction_updated' | 'marketplace_order_approved' | 'marketplace_order_completed' | 'marketplace_order_created' | 'marketplace_order_failed' | 'marketplace_order_rejected' | 'marketplace_order_terminated' | 'marketplace_order_unlinked' | 'marketplace_plan_archived' | 'marketplace_plan_component_current_price_updated' | 'marketplace_plan_component_future_price_updated' | 'marketplace_plan_component_quota_updated' | 'marketplace_plan_created' | 'marketplace_plan_updated' | 'marketplace_plan_deleted' | 'marketplace_resource_create_canceled' | 'marketplace_resource_create_failed' | 'marketplace_resource_create_requested' | 'marketplace_resource_create_succeeded' | 'marketplace_resource_downscaled' | 'marketplace_resource_erred_on_backend' | 'marketplace_resource_paused' | 'marketplace_resource_terminate_canceled' | 'marketplace_resource_terminate_failed' | 'marketplace_resource_terminate_requested' | 'marketplace_resource_terminate_succeeded' | 'marketplace_resource_unlinked' | 'marketplace_resource_update_canceled' | 'marketplace_resource_update_end_date_succeeded' | 'marketplace_resource_update_failed' | 'marketplace_resource_update_limits_failed' | 'marketplace_resource_update_limits_succeeded' | 'marketplace_resource_update_requested' | 'marketplace_resource_update_succeeded' | 'marketplace_resource_user_created' | 'marketplace_resource_user_deleted' | 'notify_external_user' | 'notify_organization_owners' | 'notify_project_team' | 'openstack_floating_ip_attached' | 'openstack_floating_ip_connected' | 'openstack_floating_ip_description_updated' | 'openstack_floating_ip_detached' | 'openstack_floating_ip_disconnected' | 'openstack_network_cleaned' | 'openstack_network_created' | 'openstack_network_deleted' | 'openstack_network_imported' | 'openstack_network_pulled' | 'openstack_network_updated' | 'openstack_port_cleaned' | 'openstack_port_created' | 'openstack_port_deleted' | 'openstack_port_imported' | 'openstack_port_pulled' | 'openstack_port_updated' | 'openstack_router_updated' | 'openstack_security_group_cleaned' | 'openstack_security_group_created' | 'openstack_security_group_deleted' | 'openstack_security_group_imported' | 'openstack_security_group_pulled' | 'openstack_security_group_rule_cleaned' | 'openstack_security_group_rule_created' | 'openstack_security_group_rule_deleted' | 'openstack_security_group_rule_imported' | 'openstack_security_group_rule_updated' | 'openstack_security_group_updated' | 'openstack_security_group_added_remotely' | 'openstack_security_group_removed_remotely' | 'openstack_security_group_added_locally' | 'openstack_security_group_removed_locally' | 'openstack_server_group_cleaned' | 'openstack_server_group_created' | 'openstack_server_group_deleted' | 'openstack_server_group_imported' | 'openstack_server_group_pulled' | 'openstack_subnet_cleaned' | 'openstack_subnet_created' | 'openstack_subnet_deleted' | 'openstack_subnet_imported' | 'openstack_subnet_pulled' | 'openstack_subnet_updated' | 'openstack_tenant_quota_limit_updated' | 'payment_added' | 'payment_created' | 'payment_removed' | 'policy_notification' | 'project_creation_succeeded' | 'project_deletion_succeeded' | 'project_deletion_triggered' | 'project_update_request_approved' | 'project_update_request_created' | 'project_update_request_rejected' | 'project_update_succeeded' | 'project_permission_review_created' | 'project_permission_review_closed' | 'proposal_canceled' | 'proposal_document_added' | 'proposal_document_removed' | 'query_executed' | 'reduction_of_customer_credit' | 'reduction_of_customer_credit_due_to_minimal_consumption' | 'reduction_of_customer_expected_consumption' | 'reduction_of_project_credit' | 'reduction_of_project_credit_due_to_minimal_consumption' | 'reduction_of_project_expected_consumption' | 'request_downscaling' | 'request_pausing' | 'resource_assign_floating_ip_failed' | 'resource_assign_floating_ip_scheduled' | 'resource_assign_floating_ip_succeeded' | 'resource_attach_failed' | 'resource_attach_scheduled' | 'resource_attach_succeeded' | 'resource_backup_creation_failed' | 'resource_backup_creation_scheduled' | 'resource_backup_creation_succeeded' | 'resource_backup_deletion_failed' | 'resource_backup_deletion_scheduled' | 'resource_backup_deletion_succeeded' | 'resource_backup_restoration_failed' | 'resource_backup_restoration_scheduled' | 'resource_backup_restoration_succeeded' | 'resource_change_flavor_failed' | 'resource_change_flavor_scheduled' | 'resource_change_flavor_succeeded' | 'resource_creation_failed' | 'resource_creation_scheduled' | 'resource_creation_succeeded' | 'resource_deletion_failed' | 'resource_deletion_scheduled' | 'resource_deletion_succeeded' | 'resource_detach_failed' | 'resource_detach_scheduled' | 'resource_detach_succeeded' | 'resource_extend_failed' | 'resource_extend_scheduled' | 'resource_extend_succeeded' | 'resource_extend_volume_failed' | 'resource_extend_volume_scheduled' | 'resource_extend_volume_succeeded' | 'resource_import_succeeded' | 'resource_pull_failed' | 'resource_pull_scheduled' | 'resource_pull_succeeded' | 'resource_restart_failed' | 'resource_restart_scheduled' | 'resource_restart_succeeded' | 'resource_retype_failed' | 'resource_retype_scheduled' | 'resource_retype_succeeded' | 'resource_robot_account_created' | 'resource_robot_account_deleted' | 'resource_robot_account_state_changed' | 'resource_robot_account_updated' | 'resource_start_failed' | 'resource_start_scheduled' | 'resource_start_succeeded' | 'resource_stop_failed' | 'resource_stop_scheduled' | 'resource_stop_succeeded' | 'resource_unassign_floating_ip_failed' | 'resource_unassign_floating_ip_scheduled' | 'resource_unassign_floating_ip_succeeded' | 'resource_update_allowed_address_pairs_failed' | 'resource_update_allowed_address_pairs_scheduled' | 'resource_update_allowed_address_pairs_succeeded' | 'resource_update_floating_ips_failed' | 'resource_update_floating_ips_scheduled' | 'resource_update_floating_ips_succeeded' | 'resource_update_ports_failed' | 'resource_update_ports_scheduled' | 'resource_update_ports_succeeded' | 'resource_update_security_groups_failed' | 'resource_update_security_groups_scheduled' | 'resource_update_security_groups_succeeded' | 'resource_update_succeeded' | 'restrict_members' | 'review_canceled' | 'role_granted' | 'role_revoked' | 'role_updated' | 'roll_back_customer_credit' | 'roll_back_project_credit' | 'service_account_created' | 'service_account_deleted' | 'service_account_updated' | 'set_to_zero_overdue_credit' | 'ssh_key_creation_succeeded' | 'ssh_key_deletion_succeeded' | 'terminate_resources' | 'token_created' | 'token_lifetime_updated' | 'update_of_credit_by_staff' | 'automatic_credit_adjustment' | 'user_activated' | 'user_creation_succeeded' | 'user_deactivated' | 'user_deactivated_no_roles' | 'user_deletion_succeeded' | 'user_details_update_succeeded' | 'user_has_been_created_by_staff' | 'user_password_updated' | 'user_password_updated_by_staff' | 'user_update_succeeded' | 'user_invitation_updated' | 'user_invitation_deleted' | 'terms_of_service_consent_granted' | 'terms_of_service_consent_revoked';
3260
+ export type ExecuteActionErrorResponse = {
3261
+ error: string;
3262
+ };
3263
+ export type ExecuteActionRequest = {
3264
+ /**
3265
+ * Label of the corrective action to execute
3266
+ */
3267
+ action_label: string;
3268
+ };
3269
+ export type ExecuteActionResponse = {
3270
+ action: string;
3271
+ message?: string;
3272
+ redirect_url?: string;
3273
+ metadata?: {
3274
+ [key: string]: unknown;
3275
+ };
3276
+ };
2985
3277
  export type ExecutionStateEnum = 'Scheduled' | 'Processing' | 'OK' | 'Erred';
2986
3278
  export type ExportComponentData = {
2987
3279
  type: string;
@@ -3203,8 +3495,17 @@ export type FinancialReportEmailRequest = {
3203
3495
  month: number;
3204
3496
  };
3205
3497
  export type Fingerprint = {
3498
+ /**
3499
+ * MD5 fingerprint of SSH key
3500
+ */
3206
3501
  readonly md5?: string;
3502
+ /**
3503
+ * SHA256 fingerprint of SSH key
3504
+ */
3207
3505
  readonly sha256?: string;
3506
+ /**
3507
+ * SHA512 fingerprint of SSH key
3508
+ */
3208
3509
  readonly sha512?: string;
3209
3510
  };
3210
3511
  export type FirecrestJob = {
@@ -3322,25 +3623,60 @@ export type GoogleCredentials = {
3322
3623
  readonly google_auth_url?: string;
3323
3624
  };
3324
3625
  export type GroupInvitation = {
3626
+ /**
3627
+ * UUID of the invitation scope (Customer or Project)
3628
+ */
3325
3629
  readonly scope_uuid: string;
3630
+ /**
3631
+ * Name of the invitation scope
3632
+ */
3326
3633
  readonly scope_name: string;
3327
3634
  /**
3328
- * Get the description field from the scope if it exists.
3329
- * Returns empty string if scope doesn't have a description field.
3635
+ * Description of the invitation scope
3330
3636
  */
3331
3637
  readonly scope_description: string;
3638
+ /**
3639
+ * Type of the invitation scope (e.g., 'customer', 'project')
3640
+ */
3332
3641
  readonly scope_type: string | null;
3642
+ /**
3643
+ * UUID of the customer organization
3644
+ */
3333
3645
  readonly customer_uuid: string;
3646
+ /**
3647
+ * Name of the customer organization
3648
+ */
3334
3649
  readonly customer_name: string;
3650
+ /**
3651
+ * Name of the role being granted (e.g., 'PROJECT.ADMIN')
3652
+ */
3335
3653
  readonly role_name: string;
3654
+ /**
3655
+ * Description of the role being granted
3656
+ */
3336
3657
  readonly role_description: string;
3658
+ /**
3659
+ * Full name of the user who created this invitation
3660
+ */
3337
3661
  readonly created_by_full_name: string;
3662
+ /**
3663
+ * Username of the user who created this invitation
3664
+ */
3338
3665
  readonly created_by_username: string;
3666
+ /**
3667
+ * Profile image of the user who created this invitation
3668
+ */
3339
3669
  readonly created_by_image: string;
3340
3670
  readonly url: string;
3341
3671
  readonly uuid: string;
3672
+ /**
3673
+ * UUID of the role to grant to the invited user
3674
+ */
3342
3675
  role: string;
3343
3676
  readonly created: string;
3677
+ /**
3678
+ * Expiration date and time of the invitation
3679
+ */
3344
3680
  readonly expires: string;
3345
3681
  readonly is_active: boolean;
3346
3682
  /**
@@ -3355,13 +3691,25 @@ export type GroupInvitation = {
3355
3691
  * Template for project name. Supports {username}, {email}, {full_name} variables
3356
3692
  */
3357
3693
  project_name_template?: string | null;
3694
+ /**
3695
+ * UUID of the project role to grant if auto_create_project is enabled
3696
+ */
3358
3697
  project_role?: string | null;
3359
3698
  user_affiliations?: unknown;
3360
3699
  user_email_patterns?: unknown;
3700
+ /**
3701
+ * Image URL of the invitation scope (Customer or Project)
3702
+ */
3361
3703
  readonly scope_image: string | null;
3362
3704
  };
3363
3705
  export type GroupInvitationRequest = {
3706
+ /**
3707
+ * UUID of the role to grant to the invited user
3708
+ */
3364
3709
  role: string;
3710
+ /**
3711
+ * URL of the scope (Customer or Project) for this invitation
3712
+ */
3365
3713
  scope: string;
3366
3714
  /**
3367
3715
  * Allow non-authenticated users to see and accept this invitation. Only staff can create public invitations.
@@ -3375,6 +3723,9 @@ export type GroupInvitationRequest = {
3375
3723
  * Template for project name. Supports {username}, {email}, {full_name} variables
3376
3724
  */
3377
3725
  project_name_template?: string | null;
3726
+ /**
3727
+ * UUID of the project role to grant if auto_create_project is enabled
3728
+ */
3378
3729
  project_role?: string | null;
3379
3730
  user_affiliations?: unknown;
3380
3731
  user_email_patterns?: unknown;
@@ -3534,15 +3885,33 @@ export type ImageUploadResponse = {
3534
3885
  export type ImpactLevelDisplayEnum = 'No impact' | 'Degraded performance' | 'Partial outage' | 'Full outage';
3535
3886
  export type ImpactLevelEnum = 1 | 2 | 3 | 4;
3536
3887
  export type ImportResourceRequest = {
3888
+ /**
3889
+ * Backend identifier of the resource
3890
+ */
3537
3891
  backend_id: string;
3892
+ /**
3893
+ * Target project for the resource
3894
+ */
3538
3895
  project: string;
3539
3896
  plan?: string;
3540
3897
  additional_details?: unknown;
3541
3898
  };
3542
3899
  export type ImportableResource = {
3900
+ /**
3901
+ * Backend identifier of the resource
3902
+ */
3543
3903
  backend_id: string;
3904
+ /**
3905
+ * Name of the resource
3906
+ */
3544
3907
  name: string;
3908
+ /**
3909
+ * Type of the resource
3910
+ */
3545
3911
  type: string;
3912
+ /**
3913
+ * Description of the resource
3914
+ */
3546
3915
  description: string;
3547
3916
  };
3548
3917
  export type InstanceFlavorChangeRequest = {
@@ -3570,25 +3939,60 @@ export type IntegrationStatusDetails = {
3570
3939
  readonly url: string;
3571
3940
  };
3572
3941
  export type Invitation = {
3942
+ /**
3943
+ * UUID of the invitation scope (Customer or Project)
3944
+ */
3573
3945
  readonly scope_uuid: string;
3946
+ /**
3947
+ * Name of the invitation scope
3948
+ */
3574
3949
  readonly scope_name: string;
3575
3950
  /**
3576
- * Get the description field from the scope if it exists.
3577
- * Returns empty string if scope doesn't have a description field.
3951
+ * Description of the invitation scope
3578
3952
  */
3579
3953
  readonly scope_description: string;
3954
+ /**
3955
+ * Type of the invitation scope (e.g., 'customer', 'project')
3956
+ */
3580
3957
  readonly scope_type: string | null;
3958
+ /**
3959
+ * UUID of the customer organization
3960
+ */
3581
3961
  readonly customer_uuid: string;
3962
+ /**
3963
+ * Name of the customer organization
3964
+ */
3582
3965
  readonly customer_name: string;
3966
+ /**
3967
+ * Name of the role being granted (e.g., 'PROJECT.ADMIN')
3968
+ */
3583
3969
  readonly role_name: string;
3970
+ /**
3971
+ * Description of the role being granted
3972
+ */
3584
3973
  readonly role_description: string;
3974
+ /**
3975
+ * Full name of the user who created this invitation
3976
+ */
3585
3977
  readonly created_by_full_name: string;
3978
+ /**
3979
+ * Username of the user who created this invitation
3980
+ */
3586
3981
  readonly created_by_username: string;
3982
+ /**
3983
+ * Profile image of the user who created this invitation
3984
+ */
3587
3985
  readonly created_by_image: string;
3588
3986
  readonly url: string;
3589
3987
  readonly uuid: string;
3988
+ /**
3989
+ * UUID of the role to grant to the invited user
3990
+ */
3590
3991
  role: string;
3591
3992
  readonly created: string;
3993
+ /**
3994
+ * Expiration date and time of the invitation
3995
+ */
3592
3996
  readonly expires: string;
3593
3997
  full_name?: string;
3594
3998
  native_name?: string;
@@ -3609,11 +4013,23 @@ export type Invitation = {
3609
4013
  execution_state: ExecutionStateEnum;
3610
4014
  };
3611
4015
  export type InvitationCheck = {
4016
+ /**
4017
+ * Email address to check for existing invitations
4018
+ */
3612
4019
  email: string;
4020
+ /**
4021
+ * Whether civil number verification is required
4022
+ */
3613
4023
  civil_number_required?: boolean;
3614
4024
  };
3615
4025
  export type InvitationRequest = {
4026
+ /**
4027
+ * UUID of the role to grant to the invited user
4028
+ */
3616
4029
  role: string;
4030
+ /**
4031
+ * URL of the scope (Customer or Project) for this invitation
4032
+ */
3617
4033
  scope: string;
3618
4034
  full_name?: string;
3619
4035
  native_name?: string;
@@ -3637,6 +4053,9 @@ export type InvitationUpdate = {
3637
4053
  * Invitation link will be sent to this email. Note that user can accept invitation with different email.
3638
4054
  */
3639
4055
  email: string;
4056
+ /**
4057
+ * UUID of the new role to assign. Must be compatible with the invitation scope.
4058
+ */
3640
4059
  role?: string;
3641
4060
  };
3642
4061
  export type InvitationUpdateRequest = {
@@ -3644,6 +4063,9 @@ export type InvitationUpdateRequest = {
3644
4063
  * Invitation link will be sent to this email. Note that user can accept invitation with different email.
3645
4064
  */
3646
4065
  email: string;
4066
+ /**
4067
+ * UUID of the new role to assign. Must be compatible with the invitation scope.
4068
+ */
3647
4069
  role?: string;
3648
4070
  };
3649
4071
  export type Invoice = {
@@ -3727,9 +4149,15 @@ export type InvoiceItem = {
3727
4149
  readonly credit?: boolean;
3728
4150
  };
3729
4151
  export type InvoiceItemCompensation = {
4152
+ /**
4153
+ * Name of the offering component for compensation
4154
+ */
3730
4155
  offering_component_name: string;
3731
4156
  };
3732
4157
  export type InvoiceItemCompensationRequest = {
4158
+ /**
4159
+ * Name of the offering component for compensation
4160
+ */
3733
4161
  offering_component_name: string;
3734
4162
  };
3735
4163
  export type InvoiceItemDetail = {
@@ -3761,18 +4189,57 @@ export type InvoiceItemDetail = {
3761
4189
  readonly offering_component_type: string | null;
3762
4190
  };
3763
4191
  export type InvoiceItemDetails = {
4192
+ /**
4193
+ * Name of the marketplace resource
4194
+ */
3764
4195
  resource_name?: string;
4196
+ /**
4197
+ * UUID of the marketplace resource
4198
+ */
3765
4199
  resource_uuid?: string;
4200
+ /**
4201
+ * Name of the pricing plan
4202
+ */
3766
4203
  plan_name?: string;
4204
+ /**
4205
+ * UUID of the pricing plan
4206
+ */
3767
4207
  plan_uuid?: string;
4208
+ /**
4209
+ * Type of the offering
4210
+ */
3768
4211
  offering_type?: string;
4212
+ /**
4213
+ * Name of the offering
4214
+ */
3769
4215
  offering_name?: string;
4216
+ /**
4217
+ * UUID of the offering
4218
+ */
3770
4219
  offering_uuid?: string;
4220
+ /**
4221
+ * Name of the service provider
4222
+ */
3771
4223
  service_provider_name?: string;
4224
+ /**
4225
+ * UUID of the service provider
4226
+ */
3772
4227
  service_provider_uuid?: string;
4228
+ /**
4229
+ * ID of the plan component
4230
+ */
3773
4231
  plan_component_id?: number;
4232
+ /**
4233
+ * Type of the offering component
4234
+ */
3774
4235
  offering_component_type?: string;
4236
+ /**
4237
+ * Name of the offering component
4238
+ */
3775
4239
  offering_component_name?: string;
4240
+ /**
4241
+ * List of resource limit periods for this invoice item
4242
+ */
3776
4243
  resource_limit_periods?: Array<ResourceLimitPeriod>;
3777
4244
  };
3778
4245
  export type InvoiceItemMigrateTo = {
@@ -3782,6 +4249,9 @@ export type InvoiceItemMigrateToRequest = {
3782
4249
  invoice: string;
3783
4250
  };
3784
4251
  export type InvoiceItemTotalPrice = {
4252
+ /**
4253
+ * Total price for the invoice item
4254
+ */
3785
4255
  total_price: string;
3786
4256
  };
3787
4257
  export type InvoiceItemUpdate = {
@@ -3912,18 +4382,33 @@ export type IssueStatusRequest = {
3912
4382
  export type IssueStatusTypeEnum = 0 | 1;
3913
4383
  export type IssueTypeEnum = 'INFORMATIONAL' | 'SERVICE_REQUEST' | 'CHANGE_REQUEST' | 'INCIDENT';
3914
4384
  export type JiraChangelog = {
4385
+ /**
4386
+ * List of changelog items
4387
+ */
3915
4388
  items: Array<unknown>;
3916
4389
  };
3917
4390
  export type JiraChangelogRequest = {
4391
+ /**
4392
+ * List of changelog items
4393
+ */
3918
4394
  items: Array<unknown>;
3919
4395
  };
3920
4396
  export type JiraComment = {
4397
+ /**
4398
+ * Jira comment ID
4399
+ */
3921
4400
  id: string;
3922
4401
  };
3923
4402
  export type JiraCommentRequest = {
4403
+ /**
4404
+ * Jira comment ID
4405
+ */
3924
4406
  id: string;
3925
4407
  };
3926
4408
  export type JiraIssue = {
4409
+ /**
4410
+ * Jira issue key
4411
+ */
3927
4412
  key: string;
3928
4413
  fields: JiraIssueFields;
3929
4414
  };
@@ -3940,19 +4425,78 @@ export type JiraIssueFieldsRequest = {
3940
4425
  };
3941
4426
  };
3942
4427
  export type JiraIssueProject = {
4428
+ /**
4429
+ * Jira field ID
4430
+ */
3943
4431
  id: string;
4432
+ /**
4433
+ * Jira field name
4434
+ */
3944
4435
  name: string;
4436
+ /**
4437
+ * Jira project key
4438
+ */
3945
4439
  key: string;
3946
4440
  };
3947
4441
  export type JiraIssueProjectRequest = {
4442
+ /**
4443
+ * Jira field ID
4444
+ */
3948
4445
  id: string;
4446
+ /**
4447
+ * Jira field name
4448
+ */
3949
4449
  name: string;
4450
+ /**
4451
+ * Jira project key
4452
+ */
3950
4453
  key: string;
3951
4454
  };
3952
4455
  export type JiraIssueRequest = {
4456
+ /**
4457
+ * Jira issue key
4458
+ */
3953
4459
  key: string;
3954
4460
  fields: JiraIssueFieldsRequest;
3955
4461
  };
4462
+ export type K8sDefaultConfiguration = {
4463
+ default_controller_vcpus?: number;
4464
+ default_controller_ram_gb?: number;
4465
+ default_controller_system_disk_gb?: number;
4466
+ default_controller_etcd_disk_gb?: number;
4467
+ default_lb_vcpus?: number;
4468
+ default_lb_ram_gb?: number;
4469
+ default_lb_system_disk_gb?: number;
4470
+ default_lb_logs_disk_gb?: number;
4471
+ minimal_worker_vcpus?: number;
4472
+ minimal_worker_ram_gb?: number;
4473
+ default_worker_data_disk_gb?: number;
4474
+ default_storage_data_disk_gb?: number;
4475
+ default_storage_san_disk_gb?: number;
4476
+ /**
4477
+ * Comma-separated list of Kubernetes versions (e.g., 1.32.0,1.33.0,1.34.0)
4478
+ */
4479
+ available_kubernetes_versions?: string;
4480
+ };
4481
+ export type K8sDefaultConfigurationRequest = {
4482
+ default_controller_vcpus?: number;
4483
+ default_controller_ram_gb?: number;
4484
+ default_controller_system_disk_gb?: number;
4485
+ default_controller_etcd_disk_gb?: number;
4486
+ default_lb_vcpus?: number;
4487
+ default_lb_ram_gb?: number;
4488
+ default_lb_system_disk_gb?: number;
4489
+ default_lb_logs_disk_gb?: number;
4490
+ minimal_worker_vcpus?: number;
4491
+ minimal_worker_ram_gb?: number;
4492
+ default_worker_data_disk_gb?: number;
4493
+ default_storage_data_disk_gb?: number;
4494
+ default_storage_san_disk_gb?: number;
4495
+ /**
4496
+ * Comma-separated list of Kubernetes versions (e.g., 1.32.0,1.33.0,1.34.0)
4497
+ */
4498
+ available_kubernetes_versions?: string;
4499
+ };
3956
4500
  export type KeycloakGroup = {
3957
4501
  readonly uuid: string;
3958
4502
  readonly url: string;
@@ -4057,6 +4601,9 @@ export type LinkToInvoiceRequest = {
4057
4601
  invoice: string;
4058
4602
  };
4059
4603
  export type Logout = {
4604
+ /**
4605
+ * URL to redirect to after logout
4606
+ */
4060
4607
  readonly logout_url: string;
4061
4608
  };
4062
4609
  export type MaintenanceActionResponse = {
@@ -4321,9 +4868,21 @@ export type MarketplaceCategoryRequest = {
4321
4868
  group?: string | null;
4322
4869
  };
4323
4870
  export type MarketplaceCustomerStats = {
4871
+ /**
4872
+ * Name from the record
4873
+ */
4324
4874
  readonly name: string;
4875
+ /**
4876
+ * UUID from the record
4877
+ */
4325
4878
  readonly uuid: string;
4879
+ /**
4880
+ * Count value from the record
4881
+ */
4326
4882
  readonly count: number;
4883
+ /**
4884
+ * Customer abbreviation from the record
4885
+ */
4327
4886
  readonly abbreviation: string;
4328
4887
  };
4329
4888
  export type MarketplaceProviderCustomer = {
@@ -4542,17 +5101,53 @@ export type MergedPluginOptions = {
4542
5101
  * List of UUID of OpenStack offerings where tenant can be created
4543
5102
  */
4544
5103
  openstack_offering_uuid_list?: Array<string>;
5104
+ /**
5105
+ * Flavor name for managed Rancher server instances
5106
+ */
4545
5107
  managed_rancher_server_flavor_name?: string;
5108
+ /**
5109
+ * System volume size in GB for managed Rancher server
5110
+ */
4546
5111
  managed_rancher_server_system_volume_size_gb?: number;
5112
+ /**
5113
+ * System volume type name for managed Rancher server
5114
+ */
4547
5115
  managed_rancher_server_system_volume_type_name?: string;
5116
+ /**
5117
+ * Data volume size in GB for managed Rancher server
5118
+ */
4548
5119
  managed_rancher_server_data_volume_size_gb?: number;
5120
+ /**
5121
+ * Data volume type name for managed Rancher server
5122
+ */
4549
5123
  managed_rancher_server_data_volume_type_name?: string;
5124
+ /**
5125
+ * System volume size in GB for managed Rancher worker nodes
5126
+ */
4550
5127
  managed_rancher_worker_system_volume_size_gb?: number;
5128
+ /**
5129
+ * System volume type name for managed Rancher worker nodes
5130
+ */
4551
5131
  managed_rancher_worker_system_volume_type_name?: string;
5132
+ /**
5133
+ * Flavor name for managed Rancher load balancer
5134
+ */
4552
5135
  managed_rancher_load_balancer_flavor_name?: string;
5136
+ /**
5137
+ * System volume size in GB for managed Rancher load balancer
5138
+ */
4553
5139
  managed_rancher_load_balancer_system_volume_size_gb?: number;
5140
+ /**
5141
+ * System volume type name for managed Rancher load balancer
5142
+ */
4554
5143
  managed_rancher_load_balancer_system_volume_type_name?: string;
5144
+ /**
5145
+ * Data volume size in GB for managed Rancher load balancer
5146
+ */
4555
5147
  managed_rancher_load_balancer_data_volume_size_gb?: number;
5148
+ /**
5149
+ * Data volume type name for managed Rancher load balancer
5150
+ */
4556
5151
  managed_rancher_load_balancer_data_volume_type_name?: string;
4557
5152
  /**
4558
5153
  * Max number of vCPUs for tenants
@@ -4740,17 +5335,53 @@ export type MergedPluginOptionsRequest = {
4740
5335
  * List of UUID of OpenStack offerings where tenant can be created
4741
5336
  */
4742
5337
  openstack_offering_uuid_list?: Array<string>;
5338
+ /**
5339
+ * Flavor name for managed Rancher server instances
5340
+ */
4743
5341
  managed_rancher_server_flavor_name?: string;
5342
+ /**
5343
+ * System volume size in GB for managed Rancher server
5344
+ */
4744
5345
  managed_rancher_server_system_volume_size_gb?: number;
5346
+ /**
5347
+ * System volume type name for managed Rancher server
5348
+ */
4745
5349
  managed_rancher_server_system_volume_type_name?: string;
5350
+ /**
5351
+ * Data volume size in GB for managed Rancher server
5352
+ */
4746
5353
  managed_rancher_server_data_volume_size_gb?: number;
5354
+ /**
5355
+ * Data volume type name for managed Rancher server
5356
+ */
4747
5357
  managed_rancher_server_data_volume_type_name?: string;
5358
+ /**
5359
+ * System volume size in GB for managed Rancher worker nodes
5360
+ */
4748
5361
  managed_rancher_worker_system_volume_size_gb?: number;
5362
+ /**
5363
+ * System volume type name for managed Rancher worker nodes
5364
+ */
4749
5365
  managed_rancher_worker_system_volume_type_name?: string;
5366
+ /**
5367
+ * Flavor name for managed Rancher load balancer
5368
+ */
4750
5369
  managed_rancher_load_balancer_flavor_name?: string;
5370
+ /**
5371
+ * System volume size in GB for managed Rancher load balancer
5372
+ */
4751
5373
  managed_rancher_load_balancer_system_volume_size_gb?: number;
5374
+ /**
5375
+ * System volume type name for managed Rancher load balancer
5376
+ */
4752
5377
  managed_rancher_load_balancer_system_volume_type_name?: string;
5378
+ /**
5379
+ * Data volume size in GB for managed Rancher load balancer
5380
+ */
4753
5381
  managed_rancher_load_balancer_data_volume_size_gb?: number;
5382
+ /**
5383
+ * Data volume type name for managed Rancher load balancer
5384
+ */
4754
5385
  managed_rancher_load_balancer_data_volume_type_name?: string;
4755
5386
  /**
4756
5387
  * Max number of vCPUs for tenants
@@ -4794,6 +5425,9 @@ export type MergedSecretOptions = {
4794
5425
  * OpenStack IPv4 external IP mapping
4795
5426
  */
4796
5427
  ipv4_external_ip_mapping?: Array<IpMapping>;
5428
+ /**
5429
+ * TLS certificate for OpenStack API connection verification
5430
+ */
4797
5431
  openstack_api_tls_certificate?: string;
4798
5432
  /**
4799
5433
  * Default value for new subnets DNS name servers. Should be defined as list.
@@ -4855,7 +5489,13 @@ export type MergedSecretOptions = {
4855
5489
  * Rancher secret key
4856
5490
  */
4857
5491
  password?: string;
5492
+ /**
5493
+ * Cloud-init template for Rancher cluster node initialization
5494
+ */
4858
5495
  cloud_init_template?: string;
5496
+ /**
5497
+ * Cloud-init template for managed Rancher load balancer initialization
5498
+ */
4859
5499
  managed_rancher_load_balancer_cloud_init_template?: string;
4860
5500
  /**
4861
5501
  * Host of the Vault server
@@ -4947,6 +5587,9 @@ export type MergedSecretOptionsRequest = {
4947
5587
  * OpenStack IPv4 external IP mapping
4948
5588
  */
4949
5589
  ipv4_external_ip_mapping?: Array<IpMappingRequest>;
5590
+ /**
5591
+ * TLS certificate for OpenStack API connection verification
5592
+ */
4950
5593
  openstack_api_tls_certificate?: string;
4951
5594
  /**
4952
5595
  * Default value for new subnets DNS name servers. Should be defined as list.
@@ -5008,7 +5651,13 @@ export type MergedSecretOptionsRequest = {
5008
5651
  * Rancher secret key
5009
5652
  */
5010
5653
  password?: string;
5654
+ /**
5655
+ * Cloud-init template for Rancher cluster node initialization
5656
+ */
5011
5657
  cloud_init_template?: string;
5658
+ /**
5659
+ * Cloud-init template for managed Rancher load balancer initialization
5660
+ */
5012
5661
  managed_rancher_load_balancer_cloud_init_template?: string;
5013
5662
  /**
5014
5663
  * Host of the Vault server
@@ -5138,7 +5787,13 @@ export type MigrationDetailsRequest = {
5138
5787
  };
5139
5788
  export type MinimalConsumptionLogicEnum = 'fixed' | 'linear';
5140
5789
  export type MoveOfferingRequest = {
5790
+ /**
5791
+ * Target customer URL with service provider profile where the offering should be moved
5792
+ */
5141
5793
  customer: string;
5794
+ /**
5795
+ * Whether to preserve existing permissions when moving the offering
5796
+ */
5142
5797
  preserve_permissions: boolean;
5143
5798
  };
5144
5799
  export type MoveProjectRequest = {
@@ -5146,10 +5801,19 @@ export type MoveProjectRequest = {
5146
5801
  preserve_permissions: boolean;
5147
5802
  };
5148
5803
  export type MoveResourceRequest = {
5804
+ /**
5805
+ * Target project URL where the resource should be moved
5806
+ */
5149
5807
  project: ProjectHyperlinkRequest;
5150
5808
  };
5151
5809
  export type NameUuid = {
5810
+ /**
5811
+ * Name of the entity
5812
+ */
5152
5813
  readonly name: string;
5814
+ /**
5815
+ * UUID of the entity
5816
+ */
5153
5817
  readonly uuid: string;
5154
5818
  };
5155
5819
  export type NestedAgentProcessor = {
@@ -5284,16 +5948,31 @@ export type NestedCustomerUsagePolicyComponentRequest = {
5284
5948
  export type NestedEndpoint = {
5285
5949
  readonly uuid?: string;
5286
5950
  name?: string;
5951
+ /**
5952
+ * URL of the access endpoint
5953
+ */
5287
5954
  url?: string;
5288
5955
  };
5289
5956
  export type NestedEndpointRequest = {
5290
5957
  name: string;
5958
+ /**
5959
+ * URL of the access endpoint
5960
+ */
5291
5961
  url: string;
5292
5962
  };
5293
5963
  export type NestedFeedback = {
5964
+ /**
5965
+ * Customer satisfaction rating (1-5 stars)
5966
+ */
5294
5967
  readonly evaluation: number;
5968
+ /**
5969
+ * Numeric value of the rating
5970
+ */
5295
5971
  readonly evaluation_number: number;
5296
5972
  comment?: string;
5973
+ /**
5974
+ * Current state of the feedback
5975
+ */
5297
5976
  readonly state: string;
5298
5977
  };
5299
5978
  export type NestedFeedbackRequest = {
@@ -5884,7 +6563,13 @@ export type NotificationTemplateUpdateSerializersRequest = {
5884
6563
  export type NullEnum = unknown;
5885
6564
  export type ObservableObjectTypeEnum = 'order' | 'user_role' | 'resource' | 'offering_user' | 'importable_resources' | 'service_account' | 'course_account' | 'resource_periodic_limits';
5886
6565
  export type ObtainAuthTokenRequest = {
6566
+ /**
6567
+ * Username for authentication
6568
+ */
5887
6569
  username: string;
6570
+ /**
6571
+ * Password for authentication
6572
+ */
5888
6573
  password: string;
5889
6574
  };
5890
6575
  export type OecdFos2007CodeEnum = '1.1' | '1.2' | '1.3' | '1.4' | '1.5' | '1.6' | '1.7' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '3.1' | '3.2' | '3.3' | '3.4' | '3.5' | '4.1' | '4.2' | '4.3' | '4.4' | '4.5' | '5.1' | '5.2' | '5.3' | '5.4' | '5.5' | '5.6' | '5.7' | '5.8' | '5.9' | '6.1' | '6.2' | '6.3' | '6.4' | '6.5';
@@ -5893,6 +6578,9 @@ export type Offering = {
5893
6578
  readonly uuid?: string;
5894
6579
  readonly created?: string;
5895
6580
  name?: string;
6581
+ /**
6582
+ * URL-friendly identifier. Only editable by staff users.
6583
+ */
5896
6584
  slug?: string;
5897
6585
  description?: string;
5898
6586
  full_description?: string;
@@ -5941,7 +6629,7 @@ export type Offering = {
5941
6629
  readonly scope?: string;
5942
6630
  readonly scope_uuid?: string | null;
5943
6631
  readonly scope_name?: string | null;
5944
- scope_state?: CoreStates | null;
6632
+ scope_state?: CoreStates | NullEnum | null;
5945
6633
  readonly scope_error_message?: string | null;
5946
6634
  readonly files?: Array<NestedOfferingFile>;
5947
6635
  readonly quotas?: Array<Quota>;
@@ -5953,6 +6641,9 @@ export type Offering = {
5953
6641
  readonly citation_count?: number;
5954
6642
  latitude?: number | null;
5955
6643
  longitude?: number | null;
6644
+ /**
6645
+ * Country code (ISO 3166-1 alpha-2)
6646
+ */
5956
6647
  country?: CountryEnum | BlankEnum;
5957
6648
  backend_id?: string;
5958
6649
  readonly organization_groups?: Array<OrganizationGroup>;
@@ -6016,8 +6707,17 @@ export type OfferingComponent = {
6016
6707
  max_prepaid_duration?: number | null;
6017
6708
  };
6018
6709
  export type OfferingComponentLimitRequest = {
6710
+ /**
6711
+ * Minimum allowed value
6712
+ */
6019
6713
  min: number;
6714
+ /**
6715
+ * Maximum allowed value
6716
+ */
6020
6717
  max: number;
6718
+ /**
6719
+ * Maximum available limit across all resources
6720
+ */
6021
6721
  max_available_limit: number;
6022
6722
  };
6023
6723
  export type OfferingComponentRequest = {
@@ -6063,15 +6763,30 @@ export type OfferingComponentStat = {
6063
6763
  readonly name: string;
6064
6764
  };
6065
6765
  export type OfferingCost = {
6766
+ /**
6767
+ * UUID of the offering
6768
+ */
6066
6769
  offering_uuid: string;
6770
+ /**
6771
+ * Total cost for the offering
6772
+ */
6067
6773
  cost: number;
6068
6774
  };
6069
6775
  export type OfferingCountryStats = {
6776
+ /**
6777
+ * Country code of the offering
6778
+ */
6070
6779
  country: string;
6780
+ /**
6781
+ * Number of offerings in this country
6782
+ */
6071
6783
  count: number;
6072
6784
  };
6073
6785
  export type OfferingCreateRequest = {
6074
6786
  name: string;
6787
+ /**
6788
+ * URL-friendly identifier. Only editable by staff users.
6789
+ */
6075
6790
  slug?: string;
6076
6791
  description?: string;
6077
6792
  full_description?: string;
@@ -6103,6 +6818,9 @@ export type OfferingCreateRequest = {
6103
6818
  datacite_doi?: string;
6104
6819
  latitude?: number | null;
6105
6820
  longitude?: number | null;
6821
+ /**
6822
+ * Country code (ISO 3166-1 alpha-2)
6823
+ */
6106
6824
  country?: CountryEnum | BlankEnum;
6107
6825
  backend_id?: string;
6108
6826
  image?: (Blob | File) | null;
@@ -6232,7 +6950,13 @@ export type OfferingExportParametersRequest = {
6232
6950
  include_resource_options?: boolean;
6233
6951
  };
6234
6952
  export type OfferingExportResponse = {
6953
+ /**
6954
+ * UUID of the exported offering
6955
+ */
6235
6956
  offering_uuid: string;
6957
+ /**
6958
+ * Name of the exported offering
6959
+ */
6236
6960
  offering_name: string;
6237
6961
  /**
6238
6962
  * Complete export data containing the offering structure
@@ -6242,6 +6966,9 @@ export type OfferingExportResponse = {
6242
6966
  * List of exported component types
6243
6967
  */
6244
6968
  exported_components: Array<string>;
6969
+ /**
6970
+ * Timestamp when the export was completed
6971
+ */
6245
6972
  export_timestamp: string;
6246
6973
  };
6247
6974
  export type OfferingFile = {
@@ -6318,17 +7045,19 @@ export type OfferingImportParametersRequest = {
6318
7045
  * Overwrite existing offering if one with the same name exists
6319
7046
  */
6320
7047
  overwrite_existing?: boolean;
6321
- /**
6322
- * Preserve offering state from export, otherwise set to 'Draft'
6323
- */
6324
- preserve_state?: boolean;
6325
7048
  /**
6326
7049
  * The exported offering data to import
6327
7050
  */
6328
7051
  offering_data: OfferingExportDataRequest;
6329
7052
  };
6330
7053
  export type OfferingImportResponse = {
7054
+ /**
7055
+ * UUID of the imported offering
7056
+ */
6331
7057
  imported_offering_uuid: string;
7058
+ /**
7059
+ * Name of the imported offering
7060
+ */
6332
7061
  imported_offering_name: string;
6333
7062
  /**
6334
7063
  * List of imported component types
@@ -6338,6 +7067,9 @@ export type OfferingImportResponse = {
6338
7067
  * List of warnings encountered during import
6339
7068
  */
6340
7069
  warnings?: Array<string>;
7070
+ /**
7071
+ * Timestamp when the import was completed
7072
+ */
6341
7073
  import_timestamp: string;
6342
7074
  };
6343
7075
  export type OfferingIntegrationUpdateRequest = {
@@ -6376,6 +7108,9 @@ export type OfferingOverviewUpdateRequest = {
6376
7108
  access_url?: string;
6377
7109
  getting_started?: string;
6378
7110
  integration_guide?: string;
7111
+ /**
7112
+ * URL-friendly identifier. Only editable by staff users.
7113
+ */
6379
7114
  slug?: string;
6380
7115
  };
6381
7116
  export type OfferingPartition = {
@@ -6580,7 +7315,13 @@ export type OfferingPermission = {
6580
7315
  readonly user_email: string;
6581
7316
  };
6582
7317
  export type OfferingReference = {
7318
+ /**
7319
+ * Name of the offering
7320
+ */
6583
7321
  readonly offering_name: string;
7322
+ /**
7323
+ * UUID of the offering
7324
+ */
6584
7325
  readonly offering_uuid: string;
6585
7326
  };
6586
7327
  export type OfferingReferral = {
@@ -6635,16 +7376,43 @@ export type OfferingSoftwareCatalogRequest = {
6635
7376
  };
6636
7377
  export type OfferingState = 'Draft' | 'Active' | 'Paused' | 'Archived' | 'Unavailable';
6637
7378
  export type OfferingStats = {
7379
+ /**
7380
+ * Number of resources for the offering
7381
+ */
6638
7382
  count: number;
7383
+ /**
7384
+ * Name of the offering
7385
+ */
6639
7386
  name: string;
7387
+ /**
7388
+ * UUID of the offering
7389
+ */
6640
7390
  uuid: string;
7391
+ /**
7392
+ * Country of the offering
7393
+ */
6641
7394
  country: string;
6642
7395
  };
6643
7396
  export type OfferingStatsCounter = {
7397
+ /**
7398
+ * UUID of the category
7399
+ */
6644
7400
  category_uuid: string;
7401
+ /**
7402
+ * Title of the category
7403
+ */
6645
7404
  category_title: string;
7405
+ /**
7406
+ * Name of the service provider
7407
+ */
6646
7408
  service_provider_name: string;
7409
+ /**
7410
+ * UUID of the service provider
7411
+ */
6647
7412
  service_provider_uuid: string;
7413
+ /**
7414
+ * Number of offerings
7415
+ */
6648
7416
  count: number;
6649
7417
  };
6650
7418
  export type OfferingTermsOfService = {
@@ -6825,10 +7593,19 @@ export type OfferingUserServiceProviderComment = {
6825
7593
  };
6826
7594
  export type OfferingUserState = 'Requested' | 'Creating' | 'Pending account linking' | 'Pending additional validation' | 'OK' | 'Requested deletion' | 'Deleting' | 'Deleted' | 'Error creating' | 'Error deleting';
6827
7595
  export type OfferingUserStateTransitionRequest = {
7596
+ /**
7597
+ * Comment explaining the state transition
7598
+ */
6828
7599
  comment?: string;
7600
+ /**
7601
+ * URL reference related to the state transition comment
7602
+ */
6829
7603
  comment_url?: string;
6830
7604
  };
6831
7605
  export type OfferingUserUpdateRestrictionRequest = {
7606
+ /**
7607
+ * Whether the offering user should be restricted from accessing resources
7608
+ */
6832
7609
  is_restricted: boolean;
6833
7610
  };
6834
7611
  export type OnboardingCompanyValidationRequestRequest = {
@@ -7056,6 +7833,14 @@ export type OnboardingVerification = {
7056
7833
  readonly user_submitted_customer_data: {
7057
7834
  [key: string]: unknown;
7058
7835
  };
7836
+ /**
7837
+ * Boolean indicating if a customer can be created from this verification
7838
+ */
7839
+ readonly can_customer_be_created: boolean;
7840
+ /**
7841
+ * Reason why customer cannot be created (null if can be created)
7842
+ */
7843
+ readonly customer_creation_error_message: string | null;
7059
7844
  readonly created: string;
7060
7845
  readonly modified: string;
7061
7846
  };
@@ -8554,21 +9339,10 @@ export type OpenStackTenantQuotaRequest = {
8554
9339
  export type OpenStackTenantRequest = {
8555
9340
  name: string;
8556
9341
  description?: string;
8557
- service_settings: string;
8558
- project: string;
8559
9342
  /**
8560
9343
  * Optional availability group. Will be used for all instances provisioned in this tenant
8561
9344
  */
8562
9345
  availability_zone?: string;
8563
- /**
8564
- * Username of the tenant user
8565
- */
8566
- user_username?: string;
8567
- /**
8568
- * Password of the tenant user
8569
- */
8570
- user_password?: string;
8571
- subnet_cidr?: string;
8572
9346
  /**
8573
9347
  * Volume type name to use when creating volumes.
8574
9348
  */
@@ -8717,6 +9491,7 @@ export type OptionField = {
8717
9491
  max?: number;
8718
9492
  cascade_config?: CascadeConfig;
8719
9493
  component_multiplier_config?: ComponentMultiplierConfig;
9494
+ default_configs?: K8sDefaultConfiguration;
8720
9495
  };
8721
9496
  export type OptionFieldRequest = {
8722
9497
  type: OptionFieldTypeEnum;
@@ -8729,8 +9504,9 @@ export type OptionFieldRequest = {
8729
9504
  max?: number;
8730
9505
  cascade_config?: CascadeConfigRequest;
8731
9506
  component_multiplier_config?: ComponentMultiplierConfigRequest;
9507
+ default_configs?: K8sDefaultConfigurationRequest;
8732
9508
  };
8733
- export type OptionFieldTypeEnum = 'boolean' | 'integer' | 'money' | 'string' | 'text' | 'html_text' | 'select_string' | 'select_string_multi' | 'select_openstack_tenant' | 'select_multiple_openstack_tenants' | 'select_openstack_instance' | 'select_multiple_openstack_instances' | 'date' | 'time' | 'conditional_cascade' | 'component_multiplier';
9509
+ export type OptionFieldTypeEnum = 'boolean' | 'integer' | 'money' | 'string' | 'text' | 'html_text' | 'select_string' | 'select_string_multi' | 'select_openstack_tenant' | 'select_multiple_openstack_tenants' | 'select_openstack_instance' | 'select_multiple_openstack_instances' | 'date' | 'time' | 'conditional_cascade' | 'component_multiplier' | 'single_datacenter_k8s_config' | 'multi_datacenter_k8s_config';
8734
9510
  export type OrderAttachment = {
8735
9511
  attachment?: string | null;
8736
9512
  };
@@ -8758,6 +9534,9 @@ export type OrderCreateRequest = {
8758
9534
  * Enables delayed processing of resource provisioning order.
8759
9535
  */
8760
9536
  start_date?: string | null;
9537
+ /**
9538
+ * URL-friendly identifier. Only editable by staff users.
9539
+ */
8761
9540
  slug?: string;
8762
9541
  project: string;
8763
9542
  };
@@ -8875,15 +9654,27 @@ export type OrderSetStateErredRequest = {
8875
9654
  };
8876
9655
  export type OrderState = 'pending-consumer' | 'pending-provider' | 'pending-project' | 'pending-start-date' | 'executing' | 'done' | 'erred' | 'canceled' | 'rejected';
8877
9656
  export type OrderUuid = {
9657
+ /**
9658
+ * UUID of the created or updated order
9659
+ */
8878
9660
  readonly order_uuid: string;
8879
9661
  };
8880
9662
  export type OrganizationGroup = {
8881
9663
  readonly uuid?: string;
8882
9664
  readonly url?: string;
8883
9665
  name?: string;
9666
+ /**
9667
+ * UUID of the parent organization group
9668
+ */
8884
9669
  readonly parent_uuid?: string;
9670
+ /**
9671
+ * Name of the parent organization group
9672
+ */
8885
9673
  readonly parent_name?: string;
8886
9674
  parent?: string | null;
9675
+ /**
9676
+ * Number of customers in this organization group
9677
+ */
8887
9678
  readonly customers_count?: number;
8888
9679
  };
8889
9680
  export type OrganizationGroupRequest = {
@@ -9087,12 +9878,18 @@ export type PatchedCustomerRequest = {
9087
9878
  * Maximum number of service accounts allowed
9088
9879
  */
9089
9880
  max_service_accounts?: number | null;
9881
+ /**
9882
+ * Checklist to be used for project metadata validation in this organization
9883
+ */
9090
9884
  project_metadata_checklist?: string | null;
9091
9885
  /**
9092
9886
  * Number of extra days after project end date before resources are terminated
9093
9887
  */
9094
9888
  grace_period_days?: number | null;
9095
9889
  name?: string;
9890
+ /**
9891
+ * URL-friendly identifier. Only editable by staff users.
9892
+ */
9096
9893
  slug?: string;
9097
9894
  native_name?: string;
9098
9895
  abbreviation?: string;
@@ -9121,6 +9918,9 @@ export type PatchedCustomerRequest = {
9121
9918
  latitude?: number | null;
9122
9919
  longitude?: number | null;
9123
9920
  bank_account?: string;
9921
+ /**
9922
+ * Country code (ISO 3166-1 alpha-2)
9923
+ */
9124
9924
  country?: CountryEnum | BlankEnum;
9125
9925
  /**
9126
9926
  * Comma-separated list of notification email addresses
@@ -9209,6 +10009,9 @@ export type PatchedInvitationUpdateRequest = {
9209
10009
  * Invitation link will be sent to this email. Note that user can accept invitation with different email.
9210
10010
  */
9211
10011
  email?: string;
10012
+ /**
10013
+ * UUID of the new role to assign. Must be compatible with the invitation scope.
10014
+ */
9212
10015
  role?: string;
9213
10016
  };
9214
10017
  export type PatchedInvoiceItemUpdateRequest = {
@@ -9709,18 +10512,30 @@ export type PatchedProjectInfoRequest = {
9709
10512
  };
9710
10513
  export type PatchedProjectRequest = {
9711
10514
  name?: string;
10515
+ /**
10516
+ * URL-friendly identifier. Only editable by staff users.
10517
+ */
9712
10518
  slug?: string;
9713
10519
  /**
9714
10520
  * Organization
9715
10521
  */
9716
10522
  customer?: string;
10523
+ /**
10524
+ * Project description (HTML content will be sanitized)
10525
+ */
9717
10526
  description?: string;
9718
10527
  /**
9719
10528
  * Project type
9720
10529
  */
9721
10530
  type?: string | null;
9722
10531
  backend_id?: string;
10532
+ /**
10533
+ * Project start date. Cannot be edited after the start date has arrived.
10534
+ */
9723
10535
  start_date?: string | null;
10536
+ /**
10537
+ * Project end date. Setting this field requires DELETE_PROJECT permission.
10538
+ */
9724
10539
  end_date?: string | null;
9725
10540
  oecd_fos_2007_code?: OecdFos2007CodeEnum | BlankEnum | NullEnum | null;
9726
10541
  is_industry?: boolean;
@@ -9729,6 +10544,9 @@ export type PatchedProjectRequest = {
9729
10544
  * Project type
9730
10545
  */
9731
10546
  kind?: KindEnum;
10547
+ /**
10548
+ * Internal notes visible only to staff and support users (HTML content will be sanitized)
10549
+ */
9732
10550
  staff_notes?: string;
9733
10551
  /**
9734
10552
  * Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
@@ -9796,6 +10614,9 @@ export type PatchedProposalReviewRequest = {
9796
10614
  comment_team?: string | null;
9797
10615
  };
9798
10616
  export type PatchedProtectedCallRequest = {
10617
+ /**
10618
+ * URL-friendly identifier. Only editable by staff users.
10619
+ */
9799
10620
  slug?: string;
9800
10621
  name?: string;
9801
10622
  description?: string;
@@ -10277,6 +11098,9 @@ export type PatchedUserRequest = {
10277
11098
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
10278
11099
  */
10279
11100
  username?: string;
11101
+ /**
11102
+ * URL-friendly identifier. Only editable by staff users.
11103
+ */
10280
11104
  slug?: string;
10281
11105
  native_name?: string;
10282
11106
  job_title?: string;
@@ -10435,17 +11259,6 @@ export type PermissionMetadataResponse = {
10435
11259
  [key: string]: unknown;
10436
11260
  }>;
10437
11261
  };
10438
- export type PermissionProject = {
10439
- readonly url?: string;
10440
- readonly uuid?: string;
10441
- name?: string;
10442
- image?: string | null;
10443
- readonly resource_count?: number;
10444
- /**
10445
- * The date is inclusive. Once reached, all project resource will be scheduled for termination.
10446
- */
10447
- end_date?: string | null;
10448
- };
10449
11262
  export type PermissionRequest = {
10450
11263
  readonly url: string;
10451
11264
  readonly uuid: string;
@@ -10505,10 +11318,25 @@ export type PlanComponent = {
10505
11318
  discount_rate?: number | null;
10506
11319
  };
10507
11320
  export type PlanUsageResponse = {
11321
+ /**
11322
+ * UUID of the plan
11323
+ */
10508
11324
  readonly plan_uuid: string;
11325
+ /**
11326
+ * Name of the plan
11327
+ */
10509
11328
  readonly plan_name: string;
11329
+ /**
11330
+ * Usage limit
11331
+ */
10510
11332
  readonly limit: number;
11333
+ /**
11334
+ * Current usage count
11335
+ */
10511
11336
  readonly usage: number;
11337
+ /**
11338
+ * Remaining usage
11339
+ */
10512
11340
  readonly remaining: number;
10513
11341
  readonly offering_uuid: string;
10514
11342
  readonly offering_name: string;
@@ -10516,9 +11344,21 @@ export type PlanUsageResponse = {
10516
11344
  readonly customer_provider_name: string;
10517
11345
  };
10518
11346
  export type PluginComponent = {
11347
+ /**
11348
+ * Type identifier of the component
11349
+ */
10519
11350
  type: string;
11351
+ /**
11352
+ * Display name of the component
11353
+ */
10520
11354
  name: string;
11355
+ /**
11356
+ * Unit of measurement for the component
11357
+ */
10521
11358
  measured_unit: string;
11359
+ /**
11360
+ * Billing type for the component
11361
+ */
10522
11362
  billing_type: BillingTypeEnum;
10523
11363
  };
10524
11364
  export type PluginOfferingType = {
@@ -10544,6 +11384,9 @@ export type Project = {
10544
11384
  readonly url?: string;
10545
11385
  readonly uuid?: string;
10546
11386
  name?: string;
11387
+ /**
11388
+ * URL-friendly identifier. Only editable by staff users.
11389
+ */
10547
11390
  slug?: string;
10548
11391
  /**
10549
11392
  * Organization
@@ -10554,6 +11397,9 @@ export type Project = {
10554
11397
  readonly customer_slug?: string;
10555
11398
  readonly customer_native_name?: string;
10556
11399
  readonly customer_abbreviation?: string;
11400
+ /**
11401
+ * Project description (HTML content will be sanitized)
11402
+ */
10557
11403
  description?: string;
10558
11404
  readonly customer_display_billing_info_in_projects?: boolean;
10559
11405
  readonly created?: string;
@@ -10564,13 +11410,25 @@ export type Project = {
10564
11410
  readonly type_name?: string | null;
10565
11411
  readonly type_uuid?: string | null;
10566
11412
  backend_id?: string;
11413
+ /**
11414
+ * Project start date. Cannot be edited after the start date has arrived.
11415
+ */
10567
11416
  start_date?: string | null;
11417
+ /**
11418
+ * Project end date. Setting this field requires DELETE_PROJECT permission.
11419
+ */
10568
11420
  end_date?: string | null;
10569
11421
  readonly end_date_requested_by?: string | null;
10570
11422
  oecd_fos_2007_code?: OecdFos2007CodeEnum | BlankEnum | NullEnum | null;
11423
+ /**
11424
+ * Human-readable label for the OECD FOS 2007 classification code
11425
+ */
10571
11426
  readonly oecd_fos_2007_label?: string;
10572
11427
  is_industry?: boolean;
10573
11428
  image?: string | null;
11429
+ /**
11430
+ * Number of active resources in this project
11431
+ */
10574
11432
  readonly resources_count?: number;
10575
11433
  /**
10576
11434
  * Maximum number of service accounts allowed
@@ -10581,7 +11439,13 @@ export type Project = {
10581
11439
  */
10582
11440
  kind?: KindEnum;
10583
11441
  readonly is_removed?: boolean;
11442
+ /**
11443
+ * Metadata about project termination (read-only)
11444
+ */
10584
11445
  readonly termination_metadata?: unknown;
11446
+ /**
11447
+ * Internal notes visible only to staff and support users (HTML content will be sanitized)
11448
+ */
10585
11449
  staff_notes?: string;
10586
11450
  /**
10587
11451
  * Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
@@ -10800,18 +11664,30 @@ export type ProjectRecoveryRequest = {
10800
11664
  };
10801
11665
  export type ProjectRequest = {
10802
11666
  name: string;
11667
+ /**
11668
+ * URL-friendly identifier. Only editable by staff users.
11669
+ */
10803
11670
  slug?: string;
10804
11671
  /**
10805
11672
  * Organization
10806
11673
  */
10807
11674
  customer: string;
11675
+ /**
11676
+ * Project description (HTML content will be sanitized)
11677
+ */
10808
11678
  description?: string;
10809
11679
  /**
10810
11680
  * Project type
10811
11681
  */
10812
11682
  type?: string | null;
10813
11683
  backend_id?: string;
11684
+ /**
11685
+ * Project start date. Cannot be edited after the start date has arrived.
11686
+ */
10814
11687
  start_date?: string | null;
11688
+ /**
11689
+ * Project end date. Setting this field requires DELETE_PROJECT permission.
11690
+ */
10815
11691
  end_date?: string | null;
10816
11692
  oecd_fos_2007_code?: OecdFos2007CodeEnum | BlankEnum | NullEnum | null;
10817
11693
  is_industry?: boolean;
@@ -10820,6 +11696,9 @@ export type ProjectRequest = {
10820
11696
  * Project type
10821
11697
  */
10822
11698
  kind?: KindEnum;
11699
+ /**
11700
+ * Internal notes visible only to staff and support users (HTML content will be sanitized)
11701
+ */
10823
11702
  staff_notes?: string;
10824
11703
  /**
10825
11704
  * Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
@@ -10957,6 +11836,9 @@ export type ProjectUser = {
10957
11836
  offering_user_state: OfferingUserState | NullEnum | null;
10958
11837
  };
10959
11838
  export type ProjectsLimitsGroupedByIndustryFlag = {
11839
+ /**
11840
+ * Nested dictionary of resource limits by category and component type
11841
+ */
10960
11842
  limits: {
10961
11843
  [key: string]: {
10962
11844
  [key: string]: string;
@@ -10964,6 +11846,9 @@ export type ProjectsLimitsGroupedByIndustryFlag = {
10964
11846
  };
10965
11847
  };
10966
11848
  export type ProjectsLimitsGroupedByOecd = {
11849
+ /**
11850
+ * Nested dictionary of resource limits by category and component type
11851
+ */
10967
11852
  limits: {
10968
11853
  [key: string]: {
10969
11854
  [key: string]: string;
@@ -10971,6 +11856,9 @@ export type ProjectsLimitsGroupedByOecd = {
10971
11856
  };
10972
11857
  };
10973
11858
  export type ProjectsUsagesGroupedByIndustryFlag = {
11859
+ /**
11860
+ * Nested dictionary of usage values by category and component type
11861
+ */
10974
11862
  usages: {
10975
11863
  [key: string]: {
10976
11864
  [key: string]: string;
@@ -10978,6 +11866,9 @@ export type ProjectsUsagesGroupedByIndustryFlag = {
10978
11866
  };
10979
11867
  };
10980
11868
  export type ProjectsUsagesGroupedByOecd = {
11869
+ /**
11870
+ * Nested dictionary of usage values by category and component type
11871
+ */
10981
11872
  usages: {
10982
11873
  [key: string]: {
10983
11874
  [key: string]: string;
@@ -11146,6 +12037,9 @@ export type ProtectedCall = {
11146
12037
  readonly created?: string;
11147
12038
  readonly start_date?: string;
11148
12039
  readonly end_date?: string;
12040
+ /**
12041
+ * URL-friendly identifier. Only editable by staff users.
12042
+ */
11149
12043
  slug?: string;
11150
12044
  name?: string;
11151
12045
  description?: string;
@@ -11178,6 +12072,9 @@ export type ProtectedCall = {
11178
12072
  readonly compliance_checklist_name?: string;
11179
12073
  };
11180
12074
  export type ProtectedCallRequest = {
12075
+ /**
12076
+ * URL-friendly identifier. Only editable by staff users.
12077
+ */
11181
12078
  slug?: string;
11182
12079
  name: string;
11183
12080
  description?: string;
@@ -11252,6 +12149,9 @@ export type ProviderOffering = {
11252
12149
  readonly uuid?: string;
11253
12150
  readonly customer_uuid?: string;
11254
12151
  name?: string;
12152
+ /**
12153
+ * URL-friendly identifier. Only editable by staff users.
12154
+ */
11255
12155
  slug?: string;
11256
12156
  readonly category_title?: string;
11257
12157
  type?: string;
@@ -11272,9 +12172,21 @@ export type ProviderOffering = {
11272
12172
  thumbnail?: string | null;
11273
12173
  };
11274
12174
  export type ProviderOfferingCosts = {
12175
+ /**
12176
+ * Billing period (YYYY-MM)
12177
+ */
11275
12178
  readonly period: string;
12179
+ /**
12180
+ * Price amount excluding tax
12181
+ */
11276
12182
  readonly price: number;
12183
+ /**
12184
+ * Tax amount
12185
+ */
11277
12186
  readonly tax: number;
12187
+ /**
12188
+ * Total amount including tax
12189
+ */
11278
12190
  readonly total: number;
11279
12191
  };
11280
12192
  export type ProviderOfferingCustomer = {
@@ -11293,6 +12205,9 @@ export type ProviderOfferingDetails = {
11293
12205
  readonly uuid?: string;
11294
12206
  readonly created?: string;
11295
12207
  name?: string;
12208
+ /**
12209
+ * URL-friendly identifier. Only editable by staff users.
12210
+ */
11296
12211
  slug?: string;
11297
12212
  description?: string;
11298
12213
  full_description?: string;
@@ -11345,7 +12260,7 @@ export type ProviderOfferingDetails = {
11345
12260
  readonly scope?: string;
11346
12261
  readonly scope_uuid?: string | null;
11347
12262
  readonly scope_name?: string | null;
11348
- scope_state?: CoreStates | null;
12263
+ scope_state?: CoreStates | NullEnum | null;
11349
12264
  readonly scope_error_message?: string | null;
11350
12265
  readonly files?: Array<NestedOfferingFile>;
11351
12266
  readonly quotas?: Array<Quota>;
@@ -11357,6 +12272,9 @@ export type ProviderOfferingDetails = {
11357
12272
  readonly citation_count?: number;
11358
12273
  latitude?: number | null;
11359
12274
  longitude?: number | null;
12275
+ /**
12276
+ * Country code (ISO 3166-1 alpha-2)
12277
+ */
11360
12278
  country?: CountryEnum | BlankEnum;
11361
12279
  backend_id?: string;
11362
12280
  readonly organization_groups?: Array<OrganizationGroup>;
@@ -11384,6 +12302,9 @@ export type ProviderOfferingDetails = {
11384
12302
  };
11385
12303
  export type ProviderOfferingDetailsRequest = {
11386
12304
  name: string;
12305
+ /**
12306
+ * URL-friendly identifier. Only editable by staff users.
12307
+ */
11387
12308
  slug?: string;
11388
12309
  description?: string;
11389
12310
  full_description?: string;
@@ -11413,6 +12334,9 @@ export type ProviderOfferingDetailsRequest = {
11413
12334
  datacite_doi?: string;
11414
12335
  latitude?: number | null;
11415
12336
  longitude?: number | null;
12337
+ /**
12338
+ * Country code (ISO 3166-1 alpha-2)
12339
+ */
11416
12340
  country?: CountryEnum | BlankEnum;
11417
12341
  backend_id?: string;
11418
12342
  image?: (Blob | File) | null;
@@ -11534,6 +12458,9 @@ export type PublicCall = {
11534
12458
  readonly created?: string;
11535
12459
  readonly start_date?: string;
11536
12460
  readonly end_date?: string;
12461
+ /**
12462
+ * URL-friendly identifier. Only editable by staff users.
12463
+ */
11537
12464
  slug?: string;
11538
12465
  name?: string;
11539
12466
  description?: string;
@@ -11601,6 +12528,9 @@ export type PublicOfferingDetails = {
11601
12528
  readonly uuid?: string;
11602
12529
  readonly created?: string;
11603
12530
  name?: string;
12531
+ /**
12532
+ * URL-friendly identifier. Only editable by staff users.
12533
+ */
11604
12534
  slug?: string;
11605
12535
  description?: string;
11606
12536
  full_description?: string;
@@ -11649,7 +12579,7 @@ export type PublicOfferingDetails = {
11649
12579
  readonly scope?: string;
11650
12580
  readonly scope_uuid?: string | null;
11651
12581
  readonly scope_name?: string | null;
11652
- scope_state?: CoreStates | null;
12582
+ scope_state?: CoreStates | NullEnum | null;
11653
12583
  readonly scope_error_message?: string | null;
11654
12584
  readonly files?: Array<NestedOfferingFile>;
11655
12585
  readonly quotas?: Array<Quota>;
@@ -11661,6 +12591,9 @@ export type PublicOfferingDetails = {
11661
12591
  readonly citation_count?: number;
11662
12592
  latitude?: number | null;
11663
12593
  longitude?: number | null;
12594
+ /**
12595
+ * Country code (ISO 3166-1 alpha-2)
12596
+ */
11664
12597
  country?: CountryEnum | BlankEnum;
11665
12598
  backend_id?: string;
11666
12599
  readonly organization_groups?: Array<OrganizationGroup>;
@@ -11692,6 +12625,9 @@ export type PullMarketplaceScriptResourceRequest = {
11692
12625
  };
11693
12626
  export type QosStrategyEnum = 'threshold' | 'progressive';
11694
12627
  export type QueryRequest = {
12628
+ /**
12629
+ * Search query string
12630
+ */
11695
12631
  query: string;
11696
12632
  };
11697
12633
  export type Question = {
@@ -12057,6 +12993,9 @@ export type QuotaRequest = {
12057
12993
  limit: number;
12058
12994
  };
12059
12995
  export type QuotasUpdateRequest = {
12996
+ /**
12997
+ * Dictionary of quotas to update
12998
+ */
12060
12999
  quotas: {
12061
13000
  [key: string]: number;
12062
13001
  };
@@ -13065,20 +14004,38 @@ export type RemoteSynchronisationRequest = {
13065
14004
  remotelocalcategory_set: Array<NestedRemoteLocalCategoryRequest>;
13066
14005
  };
13067
14006
  export type RemoveOfferingComponentRequest = {
14007
+ /**
14008
+ * UUID of the component to remove
14009
+ */
13068
14010
  uuid: string;
13069
14011
  };
13070
14012
  export type RemovePartitionRequest = {
13071
14013
  partition_uuid: string;
13072
14014
  };
13073
14015
  export type RemoveSoftwareCatalogRequest = {
14016
+ /**
14017
+ * UUID of the offering catalog to remove
14018
+ */
13074
14019
  offering_catalog_uuid: string;
13075
14020
  };
13076
14021
  export type ReportSection = {
14022
+ /**
14023
+ * Section header text
14024
+ */
13077
14025
  header?: string;
14026
+ /**
14027
+ * Section body content
14028
+ */
13078
14029
  body?: string;
13079
14030
  };
13080
14031
  export type ReportSectionRequest = {
14032
+ /**
14033
+ * Section header text
14034
+ */
13081
14035
  header: string;
14036
+ /**
14037
+ * Section body content
14038
+ */
13082
14039
  body: string;
13083
14040
  };
13084
14041
  export type RequestTypes = 'Create' | 'Update' | 'Terminate' | 'Restore';
@@ -13202,6 +14159,9 @@ export type Resource = {
13202
14159
  readonly is_usage_based?: boolean;
13203
14160
  readonly is_limit_based?: boolean;
13204
14161
  name?: string;
14162
+ /**
14163
+ * URL-friendly identifier. Only editable by staff users.
14164
+ */
13205
14165
  slug?: string;
13206
14166
  readonly current_usages?: {
13207
14167
  [key: string]: number;
@@ -13238,6 +14198,8 @@ export type Resource = {
13238
14198
  readonly renewal_date?: {
13239
14199
  [key: string]: string;
13240
14200
  } | null;
14201
+ offering_state?: ResourceState;
14202
+ readonly offering_components?: Array<OfferingComponent>;
13241
14203
  };
13242
14204
  export type ResourceBackendIdRequest = {
13243
14205
  backend_id?: string;
@@ -13255,10 +14217,25 @@ export type ResourceEndDateByProviderRequest = {
13255
14217
  end_date?: string | null;
13256
14218
  };
13257
14219
  export type ResourceLimitPeriod = {
14220
+ /**
14221
+ * Start date of the resource limit period
14222
+ */
13258
14223
  start?: string;
14224
+ /**
14225
+ * End date of the resource limit period
14226
+ */
13259
14227
  end?: string;
14228
+ /**
14229
+ * Quantity of resources consumed during this period
14230
+ */
13260
14231
  quantity?: number;
14232
+ /**
14233
+ * Number of billing periods
14234
+ */
13261
14235
  billing_periods?: number;
14236
+ /**
14237
+ * Total amount for this period
14238
+ */
13262
14239
  total?: string;
13263
14240
  };
13264
14241
  export type ResourceOffering = {
@@ -13286,7 +14263,13 @@ export type ResourceReallocateLimitsRequest = {
13286
14263
  targets: Array<ResourceReallocateTargetRequest>;
13287
14264
  };
13288
14265
  export type ResourceReallocateLimitsResponse = {
14266
+ /**
14267
+ * UUID of the source order for limit reallocation
14268
+ */
13289
14269
  readonly source_order_uuid: string;
14270
+ /**
14271
+ * List of UUIDs for target orders receiving the reallocated limits
14272
+ */
13290
14273
  readonly target_order_uuids: Array<string>;
13291
14274
  };
13292
14275
  export type ResourceReallocateTargetRequest = {
@@ -13322,6 +14305,9 @@ export type ResourceRequest = {
13322
14305
  offering: string;
13323
14306
  plan?: string;
13324
14307
  name: string;
14308
+ /**
14309
+ * URL-friendly identifier. Only editable by staff users.
14310
+ */
13325
14311
  slug?: string;
13326
14312
  /**
13327
14313
  * The date is inclusive. Once reached, a resource will be scheduled for termination.
@@ -13331,12 +14317,18 @@ export type ResourceRequest = {
13331
14317
  paused?: boolean;
13332
14318
  };
13333
14319
  export type ResourceResponseStatus = {
14320
+ /**
14321
+ * Status of the resource response
14322
+ */
13334
14323
  readonly status: string;
13335
14324
  };
13336
14325
  export type ResourceRestrictMemberAccessRequest = {
13337
14326
  restrict_member_access?: boolean;
13338
14327
  };
13339
14328
  export type ResourceSetLimitsRequest = {
14329
+ /**
14330
+ * Dictionary mapping component types to their new limit values
14331
+ */
13340
14332
  limits: unknown;
13341
14333
  };
13342
14334
  export type ResourceSetStateErredRequest = {
@@ -13357,6 +14349,7 @@ export type ResourceSwitchPlanRequest = {
13357
14349
  export type ResourceTerminateRequest = {
13358
14350
  /**
13359
14351
  * Termination attributes
14352
+ * Optional attributes/parameters to pass to the termination operation
13360
14353
  */
13361
14354
  attributes?: unknown;
13362
14355
  };
@@ -13404,14 +14397,35 @@ export type ResourceUserRequest = {
13404
14397
  user: string;
13405
14398
  };
13406
14399
  export type ResourcesLimits = {
14400
+ /**
14401
+ * UUID of the offering
14402
+ */
13407
14403
  readonly offering_uuid: string;
14404
+ /**
14405
+ * Name of the limit
14406
+ */
13408
14407
  readonly name: string;
14408
+ /**
14409
+ * Limit value
14410
+ */
13409
14411
  readonly value: number;
14412
+ /**
14413
+ * Country of the offering
14414
+ */
13410
14415
  readonly offering_country: string;
14416
+ /**
14417
+ * Name of the organization group
14418
+ */
13411
14419
  readonly organization_group_name: string;
14420
+ /**
14421
+ * UUID of the organization group
14422
+ */
13412
14423
  readonly organization_group_uuid: string;
13413
14424
  };
13414
14425
  export type ReviewCommentRequest = {
14426
+ /**
14427
+ * Optional comment for review
14428
+ */
13415
14429
  comment?: string;
13416
14430
  };
13417
14431
  export type ReviewStrategyEnum = 'after_round' | 'after_proposal';
@@ -13839,7 +14853,13 @@ export type RuleRequest = {
13839
14853
  };
13840
14854
  };
13841
14855
  export type RuntimeStates = {
14856
+ /**
14857
+ * Value of the runtime state
14858
+ */
13842
14859
  readonly value: string;
14860
+ /**
14861
+ * Human-readable label for the runtime state
14862
+ */
13843
14863
  readonly label: string;
13844
14864
  };
13845
14865
  export type Saml2Login = {
@@ -13924,6 +14944,9 @@ export type ServiceProvider = {
13924
14944
  readonly offering_count?: number;
13925
14945
  };
13926
14946
  export type ServiceProviderApiSecretCode = {
14947
+ /**
14948
+ * API secret code for authenticating service provider requests
14949
+ */
13927
14950
  readonly api_secret_code: string;
13928
14951
  };
13929
14952
  export type ServiceProviderChecklistSummary = {
@@ -13964,24 +14987,69 @@ export type ServiceProviderRequest = {
13964
14987
  image?: (Blob | File) | null;
13965
14988
  };
13966
14989
  export type ServiceProviderRevenues = {
14990
+ /**
14991
+ * Total revenue amount
14992
+ */
13967
14993
  readonly total: number;
14994
+ /**
14995
+ * Invoice year
14996
+ */
13968
14997
  readonly year: number;
14998
+ /**
14999
+ * Invoice month
15000
+ */
13969
15001
  readonly month: number;
13970
15002
  };
13971
15003
  export type ServiceProviderSignatureRequest = {
15004
+ /**
15005
+ * Service provider customer UUID
15006
+ */
13972
15007
  customer: string;
15008
+ /**
15009
+ * JWT-encoded data signed with the service provider's API secret code
15010
+ */
13973
15011
  data: string;
15012
+ /**
15013
+ * If true, validates the signature without executing the operation
15014
+ */
13974
15015
  dry_run?: boolean;
13975
15016
  };
13976
15017
  export type ServiceProviderStatistics = {
15018
+ /**
15019
+ * Number of active campaigns
15020
+ */
13977
15021
  readonly active_campaigns: number;
15022
+ /**
15023
+ * Number of current customers
15024
+ */
13978
15025
  readonly current_customers: number;
15026
+ /**
15027
+ * Change in number of customers
15028
+ */
13979
15029
  readonly customers_number_change: number;
15030
+ /**
15031
+ * Number of active resources
15032
+ */
13980
15033
  readonly active_resources: number;
15034
+ /**
15035
+ * Change in number of resources
15036
+ */
13981
15037
  readonly resources_number_change: number;
15038
+ /**
15039
+ * Number of active and paused offerings
15040
+ */
13982
15041
  readonly active_and_paused_offerings: number;
15042
+ /**
15043
+ * Number of unresolved support tickets
15044
+ */
13983
15045
  readonly unresolved_tickets: number;
15046
+ /**
15047
+ * Number of pending orders
15048
+ */
13984
15049
  readonly pending_orders: number;
15050
+ /**
15051
+ * Number of resources in error state
15052
+ */
13985
15053
  readonly erred_resources: number;
13986
15054
  };
13987
15055
  export type ServiceSettings = {
@@ -14016,7 +15084,13 @@ export type SetMtuRequest = {
14016
15084
  mtu: number;
14017
15085
  };
14018
15086
  export type SetOfferingsUsernameRequest = {
15087
+ /**
15088
+ * UUID of the user
15089
+ */
14019
15090
  user_uuid: string;
15091
+ /**
15092
+ * Username for offering access
15093
+ */
14020
15094
  username: string;
14021
15095
  };
14022
15096
  export type SettingsMetadataResponse = {
@@ -14027,6 +15101,17 @@ export type SettingsMetadataResponse = {
14027
15101
  [key: string]: unknown;
14028
15102
  }>;
14029
15103
  };
15104
+ export type SeverityEnum = 'safe' | 'low' | 'medium' | 'high' | 'critical';
15105
+ export type SilenceActionRequest = {
15106
+ /**
15107
+ * Duration in days to silence the action. If not provided, silences permanently.
15108
+ */
15109
+ duration_days?: number;
15110
+ };
15111
+ export type SilenceActionResponse = {
15112
+ status: string;
15113
+ duration_days?: number | null;
15114
+ };
14030
15115
  export type SlurmAllocation = {
14031
15116
  readonly url?: string;
14032
15117
  readonly uuid?: string;
@@ -14282,6 +15367,9 @@ export type SoftwareCatalogRequest = {
14282
15367
  update_errors?: string;
14283
15368
  };
14284
15369
  export type SoftwareCatalogUuid = {
15370
+ /**
15371
+ * UUID of the software catalog
15372
+ */
14285
15373
  uuid: string;
14286
15374
  };
14287
15375
  export type SoftwarePackage = {
@@ -14438,7 +15526,13 @@ export type SubmitRequestResponse = {
14438
15526
  scope_uuid: string;
14439
15527
  };
14440
15528
  export type SubresourceOffering = {
15529
+ /**
15530
+ * UUID of the offering
15531
+ */
14441
15532
  readonly uuid: string;
15533
+ /**
15534
+ * Type of the offering
15535
+ */
14442
15536
  readonly type: string;
14443
15537
  };
14444
15538
  export type SupportStats = {
@@ -14459,9 +15553,21 @@ export type SupportedCountriesResponse = {
14459
15553
  };
14460
15554
  export type SyncStatusEnum = 'in_sync' | 'out_of_sync' | 'sync_failed';
14461
15555
  export type TableSize = {
15556
+ /**
15557
+ * Name of the database table
15558
+ */
14462
15559
  readonly table_name: string;
15560
+ /**
15561
+ * Total size of the table in bytes
15562
+ */
14463
15563
  readonly total_size: number;
15564
+ /**
15565
+ * Size of the actual data in bytes
15566
+ */
14464
15567
  readonly data_size: number;
15568
+ /**
15569
+ * Size of external data (e.g., TOAST) in bytes
15570
+ */
14465
15571
  readonly external_size: number;
14466
15572
  };
14467
15573
  export type Template = {
@@ -14506,27 +15612,68 @@ export type TenantSecurityGroupUpdateRequest = {
14506
15612
  rules?: Array<OpenStackSecurityGroupRuleUpdateByNameRequest>;
14507
15613
  };
14508
15614
  export type TimeSeriesToSData = {
15615
+ /**
15616
+ * Date of the data point
15617
+ */
14509
15618
  readonly date: string;
15619
+ /**
15620
+ * Count for the date
15621
+ */
14510
15622
  readonly count: number;
14511
15623
  };
14512
15624
  export type ToSConsentDashboard = {
15625
+ /**
15626
+ * Number of active users
15627
+ */
14513
15628
  readonly active_users_count: number;
15629
+ /**
15630
+ * Total number of users
15631
+ */
14514
15632
  readonly total_users_count: number;
15633
+ /**
15634
+ * Percentage of active users
15635
+ */
14515
15636
  readonly active_users_percentage: number;
15637
+ /**
15638
+ * Number of accepted consents
15639
+ */
14516
15640
  readonly accepted_consents_count: number;
15641
+ /**
15642
+ * Number of revoked consents
15643
+ */
14517
15644
  readonly revoked_consents_count: number;
15645
+ /**
15646
+ * Total number of consents
15647
+ */
14518
15648
  readonly total_consents_count: number;
14519
15649
  readonly revoked_consents_over_time: Array<TimeSeriesToSData>;
14520
15650
  readonly tos_version_adoption: Array<VersionAdoption>;
14521
15651
  readonly active_users_over_time: Array<TimeSeriesToSData>;
14522
15652
  };
14523
15653
  export type TokenRequest = {
15654
+ /**
15655
+ * Authentication token for invitation acceptance
15656
+ */
14524
15657
  token: string;
14525
15658
  };
14526
15659
  export type TotalCustomerCost = {
14527
15660
  readonly total: number;
14528
15661
  readonly price: number;
14529
15662
  };
15663
+ export type UnsilenceActionResponse = {
15664
+ status: string;
15665
+ };
15666
+ export type UpdateActionsRequest = {
15667
+ /**
15668
+ * Optional provider action type to update. If not provided, updates all providers.
15669
+ */
15670
+ provider_action_type?: string | null;
15671
+ };
15672
+ export type UpdateActionsResponse = {
15673
+ status: string;
15674
+ message: string;
15675
+ provider_action_type?: string | null;
15676
+ };
14530
15677
  export type UpdateOfferingComponentRequest = {
14531
15678
  uuid: string;
14532
15679
  billing_type: BillingTypeEnum;
@@ -14560,6 +15707,7 @@ export type UpdateOfferingComponentRequest = {
14560
15707
  min_prepaid_duration?: number | null;
14561
15708
  max_prepaid_duration?: number | null;
14562
15709
  };
15710
+ export type UrgencyEnum = 'low' | 'medium' | 'high';
14563
15711
  export type User = {
14564
15712
  readonly url?: string;
14565
15713
  readonly uuid?: string;
@@ -14567,6 +15715,9 @@ export type User = {
14567
15715
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
14568
15716
  */
14569
15717
  username?: string;
15718
+ /**
15719
+ * URL-friendly identifier. Only editable by staff users.
15720
+ */
14570
15721
  slug?: string;
14571
15722
  readonly full_name?: string;
14572
15723
  native_name?: string;
@@ -14633,6 +15784,57 @@ export type User = {
14633
15784
  readonly has_active_session?: boolean;
14634
15785
  readonly ip_address?: string | null;
14635
15786
  };
15787
+ export type UserAction = {
15788
+ readonly uuid: string;
15789
+ /**
15790
+ * Type of action, e.g. 'pending_order', 'expiring_resource'
15791
+ */
15792
+ action_type: string;
15793
+ title: string;
15794
+ description: string;
15795
+ urgency: UrgencyEnum;
15796
+ due_date?: string | null;
15797
+ action_url?: string;
15798
+ metadata?: string;
15799
+ is_silenced?: boolean;
15800
+ silenced_until?: string | null;
15801
+ readonly is_temporarily_silenced: boolean;
15802
+ readonly is_effectively_silenced: boolean;
15803
+ readonly created: string;
15804
+ readonly modified: string;
15805
+ readonly related_object_name: string;
15806
+ readonly related_object_type: string;
15807
+ readonly corrective_actions: Array<CorrectiveAction>;
15808
+ readonly days_until_due: number | null;
15809
+ };
15810
+ export type UserActionExecution = {
15811
+ readonly id: number;
15812
+ corrective_action_label: string;
15813
+ readonly executed_at: string;
15814
+ success?: boolean;
15815
+ error_message?: string;
15816
+ execution_metadata?: string;
15817
+ };
15818
+ export type UserActionProvider = {
15819
+ readonly id: number;
15820
+ app_name: string;
15821
+ provider_class: string;
15822
+ action_type: string;
15823
+ is_enabled?: boolean;
15824
+ schedule?: string;
15825
+ readonly last_execution: string | null;
15826
+ readonly last_execution_status: string;
15827
+ };
15828
+ export type UserActionSummary = {
15829
+ total: number;
15830
+ by_urgency: {
15831
+ [key: string]: unknown;
15832
+ };
15833
+ by_type: {
15834
+ [key: string]: unknown;
15835
+ };
15836
+ overdue: number;
15837
+ };
14636
15838
  export type UserAgreement = {
14637
15839
  readonly url: string;
14638
15840
  readonly uuid: string;
@@ -14758,6 +15960,9 @@ export type UserRequest = {
14758
15960
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
14759
15961
  */
14760
15962
  username: string;
15963
+ /**
15964
+ * URL-friendly identifier. Only editable by staff users.
15965
+ */
14761
15966
  slug?: string;
14762
15967
  native_name?: string;
14763
15968
  job_title?: string;
@@ -14850,25 +16055,60 @@ export type Version = {
14850
16055
  latest_version?: string;
14851
16056
  };
14852
16057
  export type VersionAdoption = {
16058
+ /**
16059
+ * Version identifier
16060
+ */
14853
16061
  readonly version: string;
16062
+ /**
16063
+ * Number of users on this version
16064
+ */
14854
16065
  readonly users_count: number;
14855
16066
  };
14856
16067
  export type VisibilityEnum = 'private' | 'public';
14857
16068
  export type VisibleInvitationDetails = {
16069
+ /**
16070
+ * UUID of the invitation scope (Customer or Project)
16071
+ */
14858
16072
  readonly scope_uuid: string;
16073
+ /**
16074
+ * Name of the invitation scope
16075
+ */
14859
16076
  readonly scope_name: string;
14860
16077
  /**
14861
- * Get the description field from the scope if it exists.
14862
- * Returns empty string if scope doesn't have a description field.
16078
+ * Description of the invitation scope
14863
16079
  */
14864
16080
  readonly scope_description: string;
16081
+ /**
16082
+ * Type of the invitation scope (e.g., 'customer', 'project')
16083
+ */
14865
16084
  readonly scope_type: string | null;
16085
+ /**
16086
+ * UUID of the customer organization
16087
+ */
14866
16088
  readonly customer_uuid: string;
16089
+ /**
16090
+ * Name of the customer organization
16091
+ */
14867
16092
  readonly customer_name: string;
16093
+ /**
16094
+ * Name of the role being granted (e.g., 'PROJECT.ADMIN')
16095
+ */
14868
16096
  readonly role_name: string;
16097
+ /**
16098
+ * Description of the role being granted
16099
+ */
14869
16100
  readonly role_description: string;
16101
+ /**
16102
+ * Full name of the user who created this invitation
16103
+ */
14870
16104
  readonly created_by_full_name: string;
16105
+ /**
16106
+ * Username of the user who created this invitation
16107
+ */
14871
16108
  readonly created_by_username: string;
16109
+ /**
16110
+ * Profile image of the user who created this invitation
16111
+ */
14872
16112
  readonly created_by_image: string;
14873
16113
  /**
14874
16114
  * Invitation link will be sent to this email. Note that user can accept invitation with different email.
@@ -14876,6 +16116,9 @@ export type VisibleInvitationDetails = {
14876
16116
  email: string;
14877
16117
  readonly error_message: string;
14878
16118
  execution_state: ExecutionStateEnum;
16119
+ /**
16120
+ * Current state of the invitation (e.g., 'pending', 'accepted', 'rejected')
16121
+ */
14879
16122
  state: InvitationState;
14880
16123
  };
14881
16124
  export type VmwareCluster = {
@@ -15456,12 +16699,18 @@ export type CustomerRequestForm = {
15456
16699
  * Maximum number of service accounts allowed
15457
16700
  */
15458
16701
  max_service_accounts?: number | null;
16702
+ /**
16703
+ * Checklist to be used for project metadata validation in this organization
16704
+ */
15459
16705
  project_metadata_checklist?: string | null;
15460
16706
  /**
15461
16707
  * Number of extra days after project end date before resources are terminated
15462
16708
  */
15463
16709
  grace_period_days?: number | null;
15464
16710
  name: string;
16711
+ /**
16712
+ * URL-friendly identifier. Only editable by staff users.
16713
+ */
15465
16714
  slug?: string;
15466
16715
  native_name?: string;
15467
16716
  abbreviation?: string;
@@ -15490,6 +16739,9 @@ export type CustomerRequestForm = {
15490
16739
  latitude?: number | null;
15491
16740
  longitude?: number | null;
15492
16741
  bank_account?: string;
16742
+ /**
16743
+ * Country code (ISO 3166-1 alpha-2)
16744
+ */
15493
16745
  country?: CountryEnum | BlankEnum;
15494
16746
  /**
15495
16747
  * Comma-separated list of notification email addresses
@@ -15518,12 +16770,18 @@ export type CustomerRequestMultipart = {
15518
16770
  * Maximum number of service accounts allowed
15519
16771
  */
15520
16772
  max_service_accounts?: number | null;
16773
+ /**
16774
+ * Checklist to be used for project metadata validation in this organization
16775
+ */
15521
16776
  project_metadata_checklist?: string | null;
15522
16777
  /**
15523
16778
  * Number of extra days after project end date before resources are terminated
15524
16779
  */
15525
16780
  grace_period_days?: number | null;
15526
16781
  name: string;
16782
+ /**
16783
+ * URL-friendly identifier. Only editable by staff users.
16784
+ */
15527
16785
  slug?: string;
15528
16786
  native_name?: string;
15529
16787
  abbreviation?: string;
@@ -15552,6 +16810,9 @@ export type CustomerRequestMultipart = {
15552
16810
  latitude?: number | null;
15553
16811
  longitude?: number | null;
15554
16812
  bank_account?: string;
16813
+ /**
16814
+ * Country code (ISO 3166-1 alpha-2)
16815
+ */
15555
16816
  country?: CountryEnum | BlankEnum;
15556
16817
  /**
15557
16818
  * Comma-separated list of notification email addresses
@@ -15580,12 +16841,18 @@ export type PatchedCustomerRequestForm = {
15580
16841
  * Maximum number of service accounts allowed
15581
16842
  */
15582
16843
  max_service_accounts?: number | null;
16844
+ /**
16845
+ * Checklist to be used for project metadata validation in this organization
16846
+ */
15583
16847
  project_metadata_checklist?: string | null;
15584
16848
  /**
15585
16849
  * Number of extra days after project end date before resources are terminated
15586
16850
  */
15587
16851
  grace_period_days?: number | null;
15588
16852
  name?: string;
16853
+ /**
16854
+ * URL-friendly identifier. Only editable by staff users.
16855
+ */
15589
16856
  slug?: string;
15590
16857
  native_name?: string;
15591
16858
  abbreviation?: string;
@@ -15614,6 +16881,9 @@ export type PatchedCustomerRequestForm = {
15614
16881
  latitude?: number | null;
15615
16882
  longitude?: number | null;
15616
16883
  bank_account?: string;
16884
+ /**
16885
+ * Country code (ISO 3166-1 alpha-2)
16886
+ */
15617
16887
  country?: CountryEnum | BlankEnum;
15618
16888
  /**
15619
16889
  * Comma-separated list of notification email addresses
@@ -15642,12 +16912,18 @@ export type PatchedCustomerRequestMultipart = {
15642
16912
  * Maximum number of service accounts allowed
15643
16913
  */
15644
16914
  max_service_accounts?: number | null;
16915
+ /**
16916
+ * Checklist to be used for project metadata validation in this organization
16917
+ */
15645
16918
  project_metadata_checklist?: string | null;
15646
16919
  /**
15647
16920
  * Number of extra days after project end date before resources are terminated
15648
16921
  */
15649
16922
  grace_period_days?: number | null;
15650
16923
  name?: string;
16924
+ /**
16925
+ * URL-friendly identifier. Only editable by staff users.
16926
+ */
15651
16927
  slug?: string;
15652
16928
  native_name?: string;
15653
16929
  abbreviation?: string;
@@ -15676,6 +16952,9 @@ export type PatchedCustomerRequestMultipart = {
15676
16952
  latitude?: number | null;
15677
16953
  longitude?: number | null;
15678
16954
  bank_account?: string;
16955
+ /**
16956
+ * Country code (ISO 3166-1 alpha-2)
16957
+ */
15679
16958
  country?: CountryEnum | BlankEnum;
15680
16959
  /**
15681
16960
  * Comma-separated list of notification email addresses
@@ -15824,6 +17103,9 @@ export type OrderAttachmentRequestMultipart = {
15824
17103
  };
15825
17104
  export type OfferingCreateRequestForm = {
15826
17105
  name: string;
17106
+ /**
17107
+ * URL-friendly identifier. Only editable by staff users.
17108
+ */
15827
17109
  slug?: string;
15828
17110
  description?: string;
15829
17111
  full_description?: string;
@@ -15855,6 +17137,9 @@ export type OfferingCreateRequestForm = {
15855
17137
  datacite_doi?: string;
15856
17138
  latitude?: number | null;
15857
17139
  longitude?: number | null;
17140
+ /**
17141
+ * Country code (ISO 3166-1 alpha-2)
17142
+ */
15858
17143
  country?: CountryEnum | BlankEnum;
15859
17144
  backend_id?: string;
15860
17145
  image?: (Blob | File) | null;
@@ -15866,6 +17151,9 @@ export type OfferingCreateRequestForm = {
15866
17151
  };
15867
17152
  export type OfferingCreateRequestMultipart = {
15868
17153
  name: string;
17154
+ /**
17155
+ * URL-friendly identifier. Only editable by staff users.
17156
+ */
15869
17157
  slug?: string;
15870
17158
  description?: string;
15871
17159
  full_description?: string;
@@ -15897,6 +17185,9 @@ export type OfferingCreateRequestMultipart = {
15897
17185
  datacite_doi?: string;
15898
17186
  latitude?: number | null;
15899
17187
  longitude?: number | null;
17188
+ /**
17189
+ * Country code (ISO 3166-1 alpha-2)
17190
+ */
15900
17191
  country?: CountryEnum | BlankEnum;
15901
17192
  backend_id?: string;
15902
17193
  image?: (Blob | File) | null;
@@ -16006,18 +17297,30 @@ export type OnboardingJustificationDocumentationRequestMultipart = {
16006
17297
  };
16007
17298
  export type ProjectRequestForm = {
16008
17299
  name: string;
17300
+ /**
17301
+ * URL-friendly identifier. Only editable by staff users.
17302
+ */
16009
17303
  slug?: string;
16010
17304
  /**
16011
17305
  * Organization
16012
17306
  */
16013
17307
  customer: string;
17308
+ /**
17309
+ * Project description (HTML content will be sanitized)
17310
+ */
16014
17311
  description?: string;
16015
17312
  /**
16016
17313
  * Project type
16017
17314
  */
16018
17315
  type?: string | null;
16019
17316
  backend_id?: string;
17317
+ /**
17318
+ * Project start date. Cannot be edited after the start date has arrived.
17319
+ */
16020
17320
  start_date?: string | null;
17321
+ /**
17322
+ * Project end date. Setting this field requires DELETE_PROJECT permission.
17323
+ */
16021
17324
  end_date?: string | null;
16022
17325
  oecd_fos_2007_code?: OecdFos2007CodeEnum | BlankEnum | NullEnum | null;
16023
17326
  is_industry?: boolean;
@@ -16026,6 +17329,9 @@ export type ProjectRequestForm = {
16026
17329
  * Project type
16027
17330
  */
16028
17331
  kind?: KindEnum;
17332
+ /**
17333
+ * Internal notes visible only to staff and support users (HTML content will be sanitized)
17334
+ */
16029
17335
  staff_notes?: string;
16030
17336
  /**
16031
17337
  * Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
@@ -16034,18 +17340,30 @@ export type ProjectRequestForm = {
16034
17340
  };
16035
17341
  export type ProjectRequestMultipart = {
16036
17342
  name: string;
17343
+ /**
17344
+ * URL-friendly identifier. Only editable by staff users.
17345
+ */
16037
17346
  slug?: string;
16038
17347
  /**
16039
17348
  * Organization
16040
17349
  */
16041
17350
  customer: string;
17351
+ /**
17352
+ * Project description (HTML content will be sanitized)
17353
+ */
16042
17354
  description?: string;
16043
17355
  /**
16044
17356
  * Project type
16045
17357
  */
16046
17358
  type?: string | null;
16047
17359
  backend_id?: string;
17360
+ /**
17361
+ * Project start date. Cannot be edited after the start date has arrived.
17362
+ */
16048
17363
  start_date?: string | null;
17364
+ /**
17365
+ * Project end date. Setting this field requires DELETE_PROJECT permission.
17366
+ */
16049
17367
  end_date?: string | null;
16050
17368
  oecd_fos_2007_code?: OecdFos2007CodeEnum | BlankEnum | NullEnum | null;
16051
17369
  is_industry?: boolean;
@@ -16054,6 +17372,9 @@ export type ProjectRequestMultipart = {
16054
17372
  * Project type
16055
17373
  */
16056
17374
  kind?: KindEnum;
17375
+ /**
17376
+ * Internal notes visible only to staff and support users (HTML content will be sanitized)
17377
+ */
16057
17378
  staff_notes?: string;
16058
17379
  /**
16059
17380
  * Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
@@ -16062,18 +17383,30 @@ export type ProjectRequestMultipart = {
16062
17383
  };
16063
17384
  export type PatchedProjectRequestForm = {
16064
17385
  name?: string;
17386
+ /**
17387
+ * URL-friendly identifier. Only editable by staff users.
17388
+ */
16065
17389
  slug?: string;
16066
17390
  /**
16067
17391
  * Organization
16068
17392
  */
16069
17393
  customer?: string;
17394
+ /**
17395
+ * Project description (HTML content will be sanitized)
17396
+ */
16070
17397
  description?: string;
16071
17398
  /**
16072
17399
  * Project type
16073
17400
  */
16074
17401
  type?: string | null;
16075
17402
  backend_id?: string;
17403
+ /**
17404
+ * Project start date. Cannot be edited after the start date has arrived.
17405
+ */
16076
17406
  start_date?: string | null;
17407
+ /**
17408
+ * Project end date. Setting this field requires DELETE_PROJECT permission.
17409
+ */
16077
17410
  end_date?: string | null;
16078
17411
  oecd_fos_2007_code?: OecdFos2007CodeEnum | BlankEnum | NullEnum | null;
16079
17412
  is_industry?: boolean;
@@ -16082,6 +17415,9 @@ export type PatchedProjectRequestForm = {
16082
17415
  * Project type
16083
17416
  */
16084
17417
  kind?: KindEnum;
17418
+ /**
17419
+ * Internal notes visible only to staff and support users (HTML content will be sanitized)
17420
+ */
16085
17421
  staff_notes?: string;
16086
17422
  /**
16087
17423
  * Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
@@ -16090,18 +17426,30 @@ export type PatchedProjectRequestForm = {
16090
17426
  };
16091
17427
  export type PatchedProjectRequestMultipart = {
16092
17428
  name?: string;
17429
+ /**
17430
+ * URL-friendly identifier. Only editable by staff users.
17431
+ */
16093
17432
  slug?: string;
16094
17433
  /**
16095
17434
  * Organization
16096
17435
  */
16097
17436
  customer?: string;
17437
+ /**
17438
+ * Project description (HTML content will be sanitized)
17439
+ */
16098
17440
  description?: string;
16099
17441
  /**
16100
17442
  * Project type
16101
17443
  */
16102
17444
  type?: string | null;
16103
17445
  backend_id?: string;
17446
+ /**
17447
+ * Project start date. Cannot be edited after the start date has arrived.
17448
+ */
16104
17449
  start_date?: string | null;
17450
+ /**
17451
+ * Project end date. Setting this field requires DELETE_PROJECT permission.
17452
+ */
16105
17453
  end_date?: string | null;
16106
17454
  oecd_fos_2007_code?: OecdFos2007CodeEnum | BlankEnum | NullEnum | null;
16107
17455
  is_industry?: boolean;
@@ -16110,6 +17458,9 @@ export type PatchedProjectRequestMultipart = {
16110
17458
  * Project type
16111
17459
  */
16112
17460
  kind?: KindEnum;
17461
+ /**
17462
+ * Internal notes visible only to staff and support users (HTML content will be sanitized)
17463
+ */
16113
17464
  staff_notes?: string;
16114
17465
  /**
16115
17466
  * Number of extra days after project end date before resources are terminated. Overrides customer-level setting.
@@ -16529,6 +17880,9 @@ export type UserRequestForm = {
16529
17880
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
16530
17881
  */
16531
17882
  username: string;
17883
+ /**
17884
+ * URL-friendly identifier. Only editable by staff users.
17885
+ */
16532
17886
  slug?: string;
16533
17887
  native_name?: string;
16534
17888
  job_title?: string;
@@ -16574,6 +17928,9 @@ export type UserRequestMultipart = {
16574
17928
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
16575
17929
  */
16576
17930
  username: string;
17931
+ /**
17932
+ * URL-friendly identifier. Only editable by staff users.
17933
+ */
16577
17934
  slug?: string;
16578
17935
  native_name?: string;
16579
17936
  job_title?: string;
@@ -16619,6 +17976,9 @@ export type PatchedUserRequestForm = {
16619
17976
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
16620
17977
  */
16621
17978
  username?: string;
17979
+ /**
17980
+ * URL-friendly identifier. Only editable by staff users.
17981
+ */
16622
17982
  slug?: string;
16623
17983
  native_name?: string;
16624
17984
  job_title?: string;
@@ -16663,6 +18023,9 @@ export type PatchedUserRequestMultipart = {
16663
18023
  * Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
16664
18024
  */
16665
18025
  username?: string;
18026
+ /**
18027
+ * URL-friendly identifier. Only editable by staff users.
18028
+ */
16666
18029
  slug?: string;
16667
18030
  native_name?: string;
16668
18031
  job_title?: string;
@@ -20060,7 +21423,7 @@ export type BookingResourcesListData = {
20060
21423
  * Exclude transitional resources with early pending orders
20061
21424
  */
20062
21425
  exclude_pending_transitional?: boolean;
20063
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'consumer_reviewed_by' | 'consumer_reviewed_by_full_name' | 'consumer_reviewed_by_username' | 'created' | 'created_by' | 'created_by_full_name' | 'created_by_username' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slots' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
21426
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'consumer_reviewed_by' | 'consumer_reviewed_by_full_name' | 'consumer_reviewed_by_username' | 'created' | 'created_by' | 'created_by_full_name' | 'created_by_username' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slots' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
20064
21427
  /**
20065
21428
  * Has termination date
20066
21429
  */
@@ -20376,7 +21739,7 @@ export type BookingResourcesRetrieveData = {
20376
21739
  uuid: string;
20377
21740
  };
20378
21741
  query?: {
20379
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'consumer_reviewed_by' | 'consumer_reviewed_by_full_name' | 'consumer_reviewed_by_username' | 'created' | 'created_by' | 'created_by_full_name' | 'created_by_username' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slots' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
21742
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'consumer_reviewed_by' | 'consumer_reviewed_by_full_name' | 'consumer_reviewed_by_username' | 'created' | 'created_by' | 'created_by_full_name' | 'created_by_username' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slots' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
20380
21743
  };
20381
21744
  url: '/api/booking-resources/{uuid}/';
20382
21745
  };
@@ -22181,7 +23544,7 @@ export type CustomersListData = {
22181
23544
  * Contact details
22182
23545
  */
22183
23546
  contact_details?: string;
22184
- field?: Array<'abbreviation' | 'access_subnets' | 'accounting_start_date' | 'address' | 'agreement_number' | 'archived' | 'backend_id' | 'bank_account' | 'bank_name' | 'billing_price_estimate' | 'blocked' | 'call_managing_organization_uuid' | 'contact_details' | 'country' | 'country_name' | 'created' | 'customer_credit' | 'customer_unallocated_credit' | 'default_tax_percent' | 'description' | 'display_billing_info_in_projects' | 'display_name' | 'domain' | 'email' | 'grace_period_days' | 'homepage' | 'image' | 'is_service_provider' | 'latitude' | 'longitude' | 'max_service_accounts' | 'name' | 'native_name' | 'notification_emails' | 'organization_groups' | 'payment_profiles' | 'phone_number' | 'postal' | 'project_metadata_checklist' | 'projects' | 'projects_count' | 'registration_code' | 'service_provider' | 'service_provider_uuid' | 'slug' | 'sponsor_number' | 'url' | 'users_count' | 'uuid' | 'vat_code'>;
23547
+ field?: Array<'abbreviation' | 'access_subnets' | 'accounting_start_date' | 'address' | 'agreement_number' | 'archived' | 'backend_id' | 'bank_account' | 'bank_name' | 'billing_price_estimate' | 'blocked' | 'call_managing_organization_uuid' | 'contact_details' | 'country' | 'country_name' | 'created' | 'customer_credit' | 'customer_unallocated_credit' | 'default_tax_percent' | 'description' | 'display_billing_info_in_projects' | 'display_name' | 'domain' | 'email' | 'grace_period_days' | 'homepage' | 'image' | 'is_service_provider' | 'latitude' | 'longitude' | 'max_service_accounts' | 'name' | 'native_name' | 'notification_emails' | 'organization_groups' | 'payment_profiles' | 'phone_number' | 'postal' | 'project_metadata_checklist' | 'projects_count' | 'registration_code' | 'service_provider' | 'service_provider_uuid' | 'slug' | 'sponsor_number' | 'url' | 'users_count' | 'uuid' | 'vat_code'>;
22185
23548
  /**
22186
23549
  * Name
22187
23550
  */
@@ -22507,7 +23870,7 @@ export type CustomersRetrieveData = {
22507
23870
  uuid: string;
22508
23871
  };
22509
23872
  query?: {
22510
- field?: Array<'abbreviation' | 'access_subnets' | 'accounting_start_date' | 'address' | 'agreement_number' | 'archived' | 'backend_id' | 'bank_account' | 'bank_name' | 'billing_price_estimate' | 'blocked' | 'call_managing_organization_uuid' | 'contact_details' | 'country' | 'country_name' | 'created' | 'customer_credit' | 'customer_unallocated_credit' | 'default_tax_percent' | 'description' | 'display_billing_info_in_projects' | 'display_name' | 'domain' | 'email' | 'grace_period_days' | 'homepage' | 'image' | 'is_service_provider' | 'latitude' | 'longitude' | 'max_service_accounts' | 'name' | 'native_name' | 'notification_emails' | 'organization_groups' | 'payment_profiles' | 'phone_number' | 'postal' | 'project_metadata_checklist' | 'projects' | 'projects_count' | 'registration_code' | 'service_provider' | 'service_provider_uuid' | 'slug' | 'sponsor_number' | 'url' | 'users_count' | 'uuid' | 'vat_code'>;
23873
+ field?: Array<'abbreviation' | 'access_subnets' | 'accounting_start_date' | 'address' | 'agreement_number' | 'archived' | 'backend_id' | 'bank_account' | 'bank_name' | 'billing_price_estimate' | 'blocked' | 'call_managing_organization_uuid' | 'contact_details' | 'country' | 'country_name' | 'created' | 'customer_credit' | 'customer_unallocated_credit' | 'default_tax_percent' | 'description' | 'display_billing_info_in_projects' | 'display_name' | 'domain' | 'email' | 'grace_period_days' | 'homepage' | 'image' | 'is_service_provider' | 'latitude' | 'longitude' | 'max_service_accounts' | 'name' | 'native_name' | 'notification_emails' | 'organization_groups' | 'payment_profiles' | 'phone_number' | 'postal' | 'project_metadata_checklist' | 'projects_count' | 'registration_code' | 'service_provider' | 'service_provider_uuid' | 'slug' | 'sponsor_number' | 'url' | 'users_count' | 'uuid' | 'vat_code'>;
22511
23874
  };
22512
23875
  url: '/api/customers/{uuid}/';
22513
23876
  };
@@ -26330,7 +27693,7 @@ export type ManagedRancherClusterResourcesListData = {
26330
27693
  body?: never;
26331
27694
  path?: never;
26332
27695
  query?: {
26333
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
27696
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
26334
27697
  /**
26335
27698
  * A page number within the paginated result set.
26336
27699
  */
@@ -26373,7 +27736,7 @@ export type ManagedRancherClusterResourcesRetrieveData = {
26373
27736
  uuid: string;
26374
27737
  };
26375
27738
  query?: {
26376
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
27739
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
26377
27740
  };
26378
27741
  url: '/api/managed-rancher-cluster-resources/{uuid}/';
26379
27742
  };
@@ -33402,7 +34765,7 @@ export type MarketplaceProviderResourcesListData = {
33402
34765
  * Exclude transitional resources with early pending orders
33403
34766
  */
33404
34767
  exclude_pending_transitional?: boolean;
33405
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
34768
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
33406
34769
  /**
33407
34770
  * Has termination date
33408
34771
  */
@@ -33717,7 +35080,7 @@ export type MarketplaceProviderResourcesRetrieveData = {
33717
35080
  uuid: string;
33718
35081
  };
33719
35082
  query?: {
33720
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
35083
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
33721
35084
  };
33722
35085
  url: '/api/marketplace-provider-resources/{uuid}/';
33723
35086
  };
@@ -34783,7 +36146,7 @@ export type MarketplaceResourcesListData = {
34783
36146
  * Exclude transitional resources with early pending orders
34784
36147
  */
34785
36148
  exclude_pending_transitional?: boolean;
34786
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
36149
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
34787
36150
  /**
34788
36151
  * Has termination date
34789
36152
  */
@@ -35098,7 +36461,7 @@ export type MarketplaceResourcesRetrieveData = {
35098
36461
  uuid: string;
35099
36462
  };
35100
36463
  query?: {
35101
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
36464
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
35102
36465
  };
35103
36466
  url: '/api/marketplace-resources/{uuid}/';
35104
36467
  };
@@ -46507,31 +47870,6 @@ export type OpenstackTenantsCountResponses = {
46507
47870
  */
46508
47871
  200: unknown;
46509
47872
  };
46510
- export type OpenstackTenantsCreateData = {
46511
- body: OpenStackTenantRequest;
46512
- path?: never;
46513
- query?: never;
46514
- url: '/api/openstack-tenants/';
46515
- };
46516
- export type OpenstackTenantsCreateResponses = {
46517
- 201: OpenStackTenant;
46518
- };
46519
- export type OpenstackTenantsCreateResponse = OpenstackTenantsCreateResponses[keyof OpenstackTenantsCreateResponses];
46520
- export type OpenstackTenantsDestroyData = {
46521
- body?: never;
46522
- path: {
46523
- uuid: string;
46524
- };
46525
- query?: never;
46526
- url: '/api/openstack-tenants/{uuid}/';
46527
- };
46528
- export type OpenstackTenantsDestroyResponses = {
46529
- /**
46530
- * No response body
46531
- */
46532
- 204: void;
46533
- };
46534
- export type OpenstackTenantsDestroyResponse = OpenstackTenantsDestroyResponses[keyof OpenstackTenantsDestroyResponses];
46535
47873
  export type OpenstackTenantsRetrieveData = {
46536
47874
  body?: never;
46537
47875
  path: {
@@ -49097,7 +50435,7 @@ export type PromotionsCampaignsResourcesListData = {
49097
50435
  uuid: string;
49098
50436
  };
49099
50437
  query?: {
49100
- field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
50438
+ field?: Array<'attributes' | 'available_actions' | 'backend_id' | 'backend_metadata' | 'can_terminate' | 'category_icon' | 'category_title' | 'category_uuid' | 'created' | 'creation_order' | 'current_usages' | 'customer_name' | 'customer_slug' | 'customer_uuid' | 'description' | 'downscaled' | 'effective_id' | 'end_date' | 'end_date_requested_by' | 'endpoints' | 'error_message' | 'error_traceback' | 'is_limit_based' | 'is_usage_based' | 'last_sync' | 'limit_usage' | 'limits' | 'modified' | 'name' | 'offering' | 'offering_billable' | 'offering_components' | 'offering_description' | 'offering_image' | 'offering_name' | 'offering_plugin_options' | 'offering_shared' | 'offering_slug' | 'offering_state' | 'offering_thumbnail' | 'offering_type' | 'offering_uuid' | 'options' | 'order_in_progress' | 'parent_name' | 'parent_offering_name' | 'parent_offering_slug' | 'parent_offering_uuid' | 'parent_uuid' | 'paused' | 'plan' | 'plan_description' | 'plan_name' | 'plan_unit' | 'plan_uuid' | 'project' | 'project_description' | 'project_end_date' | 'project_end_date_requested_by' | 'project_name' | 'project_slug' | 'project_uuid' | 'provider_name' | 'provider_slug' | 'provider_uuid' | 'renewal_date' | 'report' | 'resource_type' | 'resource_uuid' | 'restrict_member_access' | 'scope' | 'service_settings_uuid' | 'slug' | 'state' | 'url' | 'user_requires_reconsent' | 'username' | 'uuid'>;
49101
50439
  /**
49102
50440
  * A page number within the paginated result set.
49103
50441
  */
@@ -55711,6 +57049,295 @@ export type SyncIssuesResponses = {
55711
57049
  */
55712
57050
  202: unknown;
55713
57051
  };
57052
+ export type UserActionExecutionsListData = {
57053
+ body?: never;
57054
+ path?: never;
57055
+ query?: {
57056
+ /**
57057
+ * Which field to use when ordering the results.
57058
+ */
57059
+ o?: string;
57060
+ /**
57061
+ * A page number within the paginated result set.
57062
+ */
57063
+ page?: number;
57064
+ /**
57065
+ * Number of results to return per page.
57066
+ */
57067
+ page_size?: number;
57068
+ };
57069
+ url: '/api/user-action-executions/';
57070
+ };
57071
+ export type UserActionExecutionsListResponses = {
57072
+ 200: Array<UserActionExecution>;
57073
+ };
57074
+ export type UserActionExecutionsListResponse = UserActionExecutionsListResponses[keyof UserActionExecutionsListResponses];
57075
+ export type UserActionExecutionsCountData = {
57076
+ body?: never;
57077
+ path?: never;
57078
+ query?: {
57079
+ /**
57080
+ * Which field to use when ordering the results.
57081
+ */
57082
+ o?: string;
57083
+ /**
57084
+ * A page number within the paginated result set.
57085
+ */
57086
+ page?: number;
57087
+ /**
57088
+ * Number of results to return per page.
57089
+ */
57090
+ page_size?: number;
57091
+ };
57092
+ url: '/api/user-action-executions/';
57093
+ };
57094
+ export type UserActionExecutionsCountResponses = {
57095
+ /**
57096
+ * No response body
57097
+ */
57098
+ 200: unknown;
57099
+ };
57100
+ export type UserActionExecutionsRetrieveData = {
57101
+ body?: never;
57102
+ path: {
57103
+ /**
57104
+ * A unique integer value identifying this user action execution.
57105
+ */
57106
+ id: number;
57107
+ };
57108
+ query?: never;
57109
+ url: '/api/user-action-executions/{id}/';
57110
+ };
57111
+ export type UserActionExecutionsRetrieveResponses = {
57112
+ 200: UserActionExecution;
57113
+ };
57114
+ export type UserActionExecutionsRetrieveResponse = UserActionExecutionsRetrieveResponses[keyof UserActionExecutionsRetrieveResponses];
57115
+ export type UserActionProvidersListData = {
57116
+ body?: never;
57117
+ path?: never;
57118
+ query?: {
57119
+ /**
57120
+ * A page number within the paginated result set.
57121
+ */
57122
+ page?: number;
57123
+ /**
57124
+ * Number of results to return per page.
57125
+ */
57126
+ page_size?: number;
57127
+ };
57128
+ url: '/api/user-action-providers/';
57129
+ };
57130
+ export type UserActionProvidersListResponses = {
57131
+ 200: Array<UserActionProvider>;
57132
+ };
57133
+ export type UserActionProvidersListResponse = UserActionProvidersListResponses[keyof UserActionProvidersListResponses];
57134
+ export type UserActionProvidersCountData = {
57135
+ body?: never;
57136
+ path?: never;
57137
+ query?: {
57138
+ /**
57139
+ * A page number within the paginated result set.
57140
+ */
57141
+ page?: number;
57142
+ /**
57143
+ * Number of results to return per page.
57144
+ */
57145
+ page_size?: number;
57146
+ };
57147
+ url: '/api/user-action-providers/';
57148
+ };
57149
+ export type UserActionProvidersCountResponses = {
57150
+ /**
57151
+ * No response body
57152
+ */
57153
+ 200: unknown;
57154
+ };
57155
+ export type UserActionProvidersRetrieveData = {
57156
+ body?: never;
57157
+ path: {
57158
+ /**
57159
+ * A unique integer value identifying this user action provider.
57160
+ */
57161
+ id: number;
57162
+ };
57163
+ query?: never;
57164
+ url: '/api/user-action-providers/{id}/';
57165
+ };
57166
+ export type UserActionProvidersRetrieveResponses = {
57167
+ 200: UserActionProvider;
57168
+ };
57169
+ export type UserActionProvidersRetrieveResponse = UserActionProvidersRetrieveResponses[keyof UserActionProvidersRetrieveResponses];
57170
+ export type UserActionsListData = {
57171
+ body?: never;
57172
+ path?: never;
57173
+ query?: {
57174
+ action_type?: string;
57175
+ created_after?: string;
57176
+ created_before?: string;
57177
+ due_within_days?: number;
57178
+ include_silenced?: boolean;
57179
+ is_silenced?: boolean;
57180
+ /**
57181
+ * Which field to use when ordering the results.
57182
+ */
57183
+ o?: string;
57184
+ overdue?: boolean;
57185
+ /**
57186
+ * A page number within the paginated result set.
57187
+ */
57188
+ page?: number;
57189
+ /**
57190
+ * Number of results to return per page.
57191
+ */
57192
+ page_size?: number;
57193
+ urgency?: 'high' | 'low' | 'medium';
57194
+ };
57195
+ url: '/api/user-actions/';
57196
+ };
57197
+ export type UserActionsListResponses = {
57198
+ 200: Array<UserAction>;
57199
+ };
57200
+ export type UserActionsListResponse = UserActionsListResponses[keyof UserActionsListResponses];
57201
+ export type UserActionsCountData = {
57202
+ body?: never;
57203
+ path?: never;
57204
+ query?: {
57205
+ action_type?: string;
57206
+ created_after?: string;
57207
+ created_before?: string;
57208
+ due_within_days?: number;
57209
+ include_silenced?: boolean;
57210
+ is_silenced?: boolean;
57211
+ /**
57212
+ * Which field to use when ordering the results.
57213
+ */
57214
+ o?: string;
57215
+ overdue?: boolean;
57216
+ /**
57217
+ * A page number within the paginated result set.
57218
+ */
57219
+ page?: number;
57220
+ /**
57221
+ * Number of results to return per page.
57222
+ */
57223
+ page_size?: number;
57224
+ urgency?: 'high' | 'low' | 'medium';
57225
+ };
57226
+ url: '/api/user-actions/';
57227
+ };
57228
+ export type UserActionsCountResponses = {
57229
+ /**
57230
+ * No response body
57231
+ */
57232
+ 200: unknown;
57233
+ };
57234
+ export type UserActionsRetrieveData = {
57235
+ body?: never;
57236
+ path: {
57237
+ /**
57238
+ * A unique integer value identifying this user action.
57239
+ */
57240
+ id: number;
57241
+ };
57242
+ query?: never;
57243
+ url: '/api/user-actions/{id}/';
57244
+ };
57245
+ export type UserActionsRetrieveResponses = {
57246
+ 200: UserAction;
57247
+ };
57248
+ export type UserActionsRetrieveResponse = UserActionsRetrieveResponses[keyof UserActionsRetrieveResponses];
57249
+ export type UserActionsExecuteActionData = {
57250
+ body: ExecuteActionRequest;
57251
+ path: {
57252
+ /**
57253
+ * A unique integer value identifying this user action.
57254
+ */
57255
+ id: number;
57256
+ };
57257
+ query?: never;
57258
+ url: '/api/user-actions/{id}/execute_action/';
57259
+ };
57260
+ export type UserActionsExecuteActionErrors = {
57261
+ 404: ExecuteActionErrorResponse;
57262
+ 500: ExecuteActionErrorResponse;
57263
+ };
57264
+ export type UserActionsExecuteActionError = UserActionsExecuteActionErrors[keyof UserActionsExecuteActionErrors];
57265
+ export type UserActionsExecuteActionResponses = {
57266
+ 200: ExecuteActionResponse;
57267
+ };
57268
+ export type UserActionsExecuteActionResponse = UserActionsExecuteActionResponses[keyof UserActionsExecuteActionResponses];
57269
+ export type UserActionsSilenceData = {
57270
+ body?: SilenceActionRequest;
57271
+ path: {
57272
+ /**
57273
+ * A unique integer value identifying this user action.
57274
+ */
57275
+ id: number;
57276
+ };
57277
+ query?: never;
57278
+ url: '/api/user-actions/{id}/silence/';
57279
+ };
57280
+ export type UserActionsSilenceResponses = {
57281
+ 200: SilenceActionResponse;
57282
+ };
57283
+ export type UserActionsSilenceResponse = UserActionsSilenceResponses[keyof UserActionsSilenceResponses];
57284
+ export type UserActionsUnsilenceData = {
57285
+ body?: never;
57286
+ path: {
57287
+ /**
57288
+ * A unique integer value identifying this user action.
57289
+ */
57290
+ id: number;
57291
+ };
57292
+ query?: never;
57293
+ url: '/api/user-actions/{id}/unsilence/';
57294
+ };
57295
+ export type UserActionsUnsilenceResponses = {
57296
+ 200: UnsilenceActionResponse;
57297
+ };
57298
+ export type UserActionsUnsilenceResponse = UserActionsUnsilenceResponses[keyof UserActionsUnsilenceResponses];
57299
+ export type UserActionsBulkSilenceData = {
57300
+ body?: SilenceActionRequest;
57301
+ path?: never;
57302
+ query?: never;
57303
+ url: '/api/user-actions/bulk_silence/';
57304
+ };
57305
+ export type UserActionsBulkSilenceResponses = {
57306
+ 200: BulkSilenceResponse;
57307
+ };
57308
+ export type UserActionsBulkSilenceResponse = UserActionsBulkSilenceResponses[keyof UserActionsBulkSilenceResponses];
57309
+ export type UserActionsSummaryRetrieveData = {
57310
+ body?: never;
57311
+ path?: never;
57312
+ query?: never;
57313
+ url: '/api/user-actions/summary/';
57314
+ };
57315
+ export type UserActionsSummaryRetrieveResponses = {
57316
+ 200: UserActionSummary;
57317
+ };
57318
+ export type UserActionsSummaryRetrieveResponse = UserActionsSummaryRetrieveResponses[keyof UserActionsSummaryRetrieveResponses];
57319
+ export type UserActionsSummaryCountData = {
57320
+ body?: never;
57321
+ path?: never;
57322
+ query?: never;
57323
+ url: '/api/user-actions/summary/';
57324
+ };
57325
+ export type UserActionsSummaryCountResponses = {
57326
+ /**
57327
+ * No response body
57328
+ */
57329
+ 200: unknown;
57330
+ };
57331
+ export type UserActionsUpdateActionsData = {
57332
+ body?: UpdateActionsRequest;
57333
+ path?: never;
57334
+ query?: never;
57335
+ url: '/api/user-actions/update_actions/';
57336
+ };
57337
+ export type UserActionsUpdateActionsResponses = {
57338
+ 202: UpdateActionsResponse;
57339
+ };
57340
+ export type UserActionsUpdateActionsResponse = UserActionsUpdateActionsResponses[keyof UserActionsUpdateActionsResponses];
55714
57341
  export type UserAgreementsListData = {
55715
57342
  body?: never;
55716
57343
  path?: never;