waldur-js-client 7.9.3-dev.8 → 7.9.3

package/dist/sdk.gen.d.ts

@@ -2505,7 +2505,8 @@ export declare const marketplaceProviderOfferingsGroupsList: <ThrowOnError exten
  */
 export declare const marketplaceProviderOfferingsGroupsCount: <ThrowOnError extends boolean = false>(options?: Options<MarketplaceProviderOfferingsGroupsCountData, ThrowOnError>) => import("./client").RequestResult<MarketplaceProviderOfferingsGroupsCountResponses, unknown, ThrowOnError, "fields">;
 /**
- * Import offering data with configurable parameters.
+ * Import offering data
+ * Imports an offering and all its connected parts from YAML format. Allows configuration of which components to import and how to handle conflicts. Imported offerings are always created in DRAFT state for security.
  */
 export declare const marketplaceProviderOfferingsImportOffering: <ThrowOnError extends boolean = false>(options: Options<MarketplaceProviderOfferingsImportOfferingData, ThrowOnError>) => import("./client").RequestResult<MarketplaceProviderOfferingsImportOfferingResponses, unknown, ThrowOnError, "fields">;
 /**

package/dist/sdk.gen.js

@@ -14314,7 +14314,8 @@ export const marketplaceProviderOfferingsGroupsCount = (options) => {
     });
 };
 /**
- * Import offering data with configurable parameters.
+ * Import offering data
+ * Imports an offering and all its connected parts from YAML format. Allows configuration of which components to import and how to handle conflicts. Imported offerings are always created in DRAFT state for security.
  */
 export const marketplaceProviderOfferingsImportOffering = (options) => {
     return (options.client ?? _heyApiClient).post({

package/dist/types.gen.d.ts

@@ -1571,10 +1571,19 @@ export type CategorySerializerForForNestedFieldsRequest = {
     title: string;
 };
 export type CheckUniqueBackendIdRequest = {
+    /**
+     * Backend identifier to check
+     */
     backend_id: string;
+    /**
+     * Check across all offerings
+     */
     check_all_offerings?: boolean;
 };
 export type CheckUniqueBackendIdResponse = {
+    /**
+     * Whether the backend ID is unique
+     */
     is_unique: boolean;
 };
 export type Checklist = {
@@ -1786,8 +1795,17 @@ export type ComponentUsage = {
     modified_by?: number | null;
 };
 export type ComponentUsageCreateRequest = {
+    /**
+     * List of component usage items to report
+     */
     usages: Array<ComponentUsageItemRequest>;
+    /**
+     * UUID of the specific resource plan period for usage reporting
+     */
     plan_period?: string;
+    /**
+     * UUID of the resource for usage reporting (required if plan_period not provided)
+     */
     resource?: string;
     /**
      * Date for usage reporting (staff and service providers for limit-based components). If not provided, current date is used.
@@ -2373,8 +2391,17 @@ export type CountProjectsOfServiceProvidersGroupedByOecd = {
     readonly oecd_fos_2007_name: string;
 };
 export type CountStats = {
+    /**
+     * Name from the record
+     */
     readonly name: string;
+    /**
+     * UUID from the record
+     */
     readonly uuid: string;
+    /**
+     * Count value from the record
+     */
     readonly count: number;
 };
 export type CountUniqueUsersConnectedWithActiveResourcesOfServiceProvider = {
@@ -2730,10 +2757,25 @@ export type CustomerEstimatedCostPolicyRequest = {
     period?: PeriodEnum;
 };
 export type CustomerIndustryFlagStats = {
+    /**
+     * Name from the record
+     */
     readonly name: string;
+    /**
+     * UUID from the record
+     */
     readonly uuid: string;
+    /**
+     * Count value from the record
+     */
     readonly count: number;
+    /**
+     * Customer abbreviation from the record
+     */
     readonly abbreviation: string;
+    /**
+     * Industry classification flag
+     */
     is_industry: string;
 };
 export type CustomerMemberCount = {
@@ -2759,9 +2801,21 @@ export type CustomerMemberCount = {
     readonly has_resources: boolean;
 };
 export type CustomerOecdCodeStats = {
+    /**
+     * Name from the record
+     */
     readonly name: string;
+    /**
+     * UUID from the record
+     */
     readonly uuid: string;
+    /**
+     * Count value from the record
+     */
     readonly count: number;
+    /**
+     * Customer abbreviation from the record
+     */
     readonly abbreviation: string;
     oecd: string;
 };
@@ -3831,7 +3885,13 @@ export type ImageUploadResponse = {
 export type ImpactLevelDisplayEnum = 'No impact' | 'Degraded performance' | 'Partial outage' | 'Full outage';
 export type ImpactLevelEnum = 1 | 2 | 3 | 4;
 export type ImportResourceRequest = {
+    /**
+     * Backend identifier of the resource
+     */
     backend_id: string;
+    /**
+     * Target project for the resource
+     */
     project: string;
     plan?: string;
     additional_details?: unknown;
@@ -4808,9 +4868,21 @@ export type MarketplaceCategoryRequest = {
     group?: string | null;
 };
 export type MarketplaceCustomerStats = {
+    /**
+     * Name from the record
+     */
     readonly name: string;
+    /**
+     * UUID from the record
+     */
     readonly uuid: string;
+    /**
+     * Count value from the record
+     */
     readonly count: number;
+    /**
+     * Customer abbreviation from the record
+     */
     readonly abbreviation: string;
 };
 export type MarketplaceProviderCustomer = {
@@ -5029,17 +5101,53 @@ export type MergedPluginOptions = {
      * List of UUID of OpenStack offerings where tenant can be created
      */
     openstack_offering_uuid_list?: Array<string>;
+    /**
+     * Flavor name for managed Rancher server instances
+     */
     managed_rancher_server_flavor_name?: string;
+    /**
+     * System volume size in GB for managed Rancher server
+     */
     managed_rancher_server_system_volume_size_gb?: number;
+    /**
+     * System volume type name for managed Rancher server
+     */
     managed_rancher_server_system_volume_type_name?: string;
+    /**
+     * Data volume size in GB for managed Rancher server
+     */
     managed_rancher_server_data_volume_size_gb?: number;
+    /**
+     * Data volume type name for managed Rancher server
+     */
     managed_rancher_server_data_volume_type_name?: string;
+    /**
+     * System volume size in GB for managed Rancher worker nodes
+     */
     managed_rancher_worker_system_volume_size_gb?: number;
+    /**
+     * System volume type name for managed Rancher worker nodes
+     */
     managed_rancher_worker_system_volume_type_name?: string;
+    /**
+     * Flavor name for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_flavor_name?: string;
+    /**
+     * System volume size in GB for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_system_volume_size_gb?: number;
+    /**
+     * System volume type name for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_system_volume_type_name?: string;
+    /**
+     * Data volume size in GB for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_data_volume_size_gb?: number;
+    /**
+     * Data volume type name for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_data_volume_type_name?: string;
     /**
      * Max number of vCPUs for tenants
@@ -5227,17 +5335,53 @@ export type MergedPluginOptionsRequest = {
      * List of UUID of OpenStack offerings where tenant can be created
      */
     openstack_offering_uuid_list?: Array<string>;
+    /**
+     * Flavor name for managed Rancher server instances
+     */
     managed_rancher_server_flavor_name?: string;
+    /**
+     * System volume size in GB for managed Rancher server
+     */
     managed_rancher_server_system_volume_size_gb?: number;
+    /**
+     * System volume type name for managed Rancher server
+     */
     managed_rancher_server_system_volume_type_name?: string;
+    /**
+     * Data volume size in GB for managed Rancher server
+     */
     managed_rancher_server_data_volume_size_gb?: number;
+    /**
+     * Data volume type name for managed Rancher server
+     */
     managed_rancher_server_data_volume_type_name?: string;
+    /**
+     * System volume size in GB for managed Rancher worker nodes
+     */
     managed_rancher_worker_system_volume_size_gb?: number;
+    /**
+     * System volume type name for managed Rancher worker nodes
+     */
     managed_rancher_worker_system_volume_type_name?: string;
+    /**
+     * Flavor name for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_flavor_name?: string;
+    /**
+     * System volume size in GB for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_system_volume_size_gb?: number;
+    /**
+     * System volume type name for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_system_volume_type_name?: string;
+    /**
+     * Data volume size in GB for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_data_volume_size_gb?: number;
+    /**
+     * Data volume type name for managed Rancher load balancer
+     */
     managed_rancher_load_balancer_data_volume_type_name?: string;
     /**
      * Max number of vCPUs for tenants
@@ -5281,6 +5425,9 @@ export type MergedSecretOptions = {
      * OpenStack IPv4 external IP mapping
      */
     ipv4_external_ip_mapping?: Array<IpMapping>;
+    /**
+     * TLS certificate for OpenStack API connection verification
+     */
     openstack_api_tls_certificate?: string;
     /**
      * Default value for new subnets DNS name servers. Should be defined as list.
@@ -5342,7 +5489,13 @@ export type MergedSecretOptions = {
      * Rancher secret key
      */
     password?: string;
+    /**
+     * Cloud-init template for Rancher cluster node initialization
+     */
     cloud_init_template?: string;
+    /**
+     * Cloud-init template for managed Rancher load balancer initialization
+     */
     managed_rancher_load_balancer_cloud_init_template?: string;
     /**
      * Host of the Vault server
@@ -5434,6 +5587,9 @@ export type MergedSecretOptionsRequest = {
      * OpenStack IPv4 external IP mapping
      */
     ipv4_external_ip_mapping?: Array<IpMappingRequest>;
+    /**
+     * TLS certificate for OpenStack API connection verification
+     */
     openstack_api_tls_certificate?: string;
     /**
      * Default value for new subnets DNS name servers. Should be defined as list.
@@ -5495,7 +5651,13 @@ export type MergedSecretOptionsRequest = {
      * Rancher secret key
      */
     password?: string;
+    /**
+     * Cloud-init template for Rancher cluster node initialization
+     */
     cloud_init_template?: string;
+    /**
+     * Cloud-init template for managed Rancher load balancer initialization
+     */
     managed_rancher_load_balancer_cloud_init_template?: string;
     /**
      * Host of the Vault server
@@ -5625,7 +5787,13 @@ export type MigrationDetailsRequest = {
 };
 export type MinimalConsumptionLogicEnum = 'fixed' | 'linear';
 export type MoveOfferingRequest = {
+    /**
+     * Target customer URL with service provider profile where the offering should be moved
+     */
     customer: string;
+    /**
+     * Whether to preserve existing permissions when moving the offering
+     */
     preserve_permissions: boolean;
 };
 export type MoveProjectRequest = {
@@ -5633,6 +5801,9 @@ export type MoveProjectRequest = {
     preserve_permissions: boolean;
 };
 export type MoveResourceRequest = {
+    /**
+     * Target project URL where the resource should be moved
+     */
     project: ProjectHyperlinkRequest;
 };
 export type NameUuid = {
@@ -6821,7 +6992,7 @@ export type OfferingGroups = {
 export type OfferingImageRequest = {
     image: Blob | File;
 };
-export type OfferingImportParameters = {
+export type OfferingImportParametersRequest = {
     /**
      * Target customer for imported offering. If not provided, uses current user's customer
      */
@@ -6877,65 +7048,29 @@ export type OfferingImportParameters = {
     /**
      * The exported offering data to import
      */
-    offering_data: OfferingExportData;
+    offering_data: OfferingExportDataRequest;
 };
-export type OfferingImportParametersRequest = {
-    /**
-     * Target customer for imported offering. If not provided, uses current user's customer
-     */
-    customer?: string | null;
-    /**
-     * Target category name for imported offering. If not provided, uses category from export data
-     */
-    category?: string | null;
-    /**
-     * Target project for imported offering (optional)
-     */
-    project?: string | null;
-    /**
-     * Import offering components
-     */
-    import_components?: boolean;
-    /**
-     * Import offering plans
-     */
-    import_plans?: boolean;
-    /**
-     * Import offering screenshots
-     */
-    import_screenshots?: boolean;
-    /**
-     * Import offering files
-     */
-    import_files?: boolean;
-    /**
-     * Import offering access endpoints
-     */
-    import_endpoints?: boolean;
+export type OfferingImportResponse = {
     /**
-     * Import organization groups associations (may fail if groups don't exist)
+     * UUID of the imported offering
      */
-    import_organization_groups?: boolean;
+    imported_offering_uuid: string;
     /**
-     * Import terms of service configurations
+     * Name of the imported offering
      */
-    import_terms_of_service?: boolean;
+    imported_offering_name: string;
     /**
-     * Import plugin options
+     * List of imported component types
      */
-    import_plugin_options?: boolean;
+    imported_components: Array<string>;
     /**
-     * Import secret options (WARNING: will overwrite existing secrets)
+     * List of warnings encountered during import
      */
-    import_secret_options?: boolean;
+    warnings?: Array<string>;
     /**
-     * Overwrite existing offering if one with the same name exists
+     * Timestamp when the import was completed
      */
-    overwrite_existing?: boolean;
-    /**
-     * The exported offering data to import
-     */
-    offering_data: OfferingExportDataRequest;
+    import_timestamp: string;
 };
 export type OfferingIntegrationUpdateRequest = {
     secret_options?: MergedSecretOptionsRequest;
@@ -7458,10 +7593,19 @@ export type OfferingUserServiceProviderComment = {
 };
 export type OfferingUserState = 'Requested' | 'Creating' | 'Pending account linking' | 'Pending additional validation' | 'OK' | 'Requested deletion' | 'Deleting' | 'Deleted' | 'Error creating' | 'Error deleting';
 export type OfferingUserStateTransitionRequest = {
+    /**
+     * Comment explaining the state transition
+     */
     comment?: string;
+    /**
+     * URL reference related to the state transition comment
+     */
     comment_url?: string;
 };
 export type OfferingUserUpdateRestrictionRequest = {
+    /**
+     * Whether the offering user should be restricted from accessing resources
+     */
     is_restricted: boolean;
 };
 export type OnboardingCompanyValidationRequestRequest = {
@@ -11174,10 +11318,25 @@ export type PlanComponent = {
     discount_rate?: number | null;
 };
 export type PlanUsageResponse = {
+    /**
+     * UUID of the plan
+     */
     readonly plan_uuid: string;
+    /**
+     * Name of the plan
+     */
     readonly plan_name: string;
+    /**
+     * Usage limit
+     */
     readonly limit: number;
+    /**
+     * Current usage count
+     */
     readonly usage: number;
+    /**
+     * Remaining usage
+     */
     readonly remaining: number;
     readonly offering_uuid: string;
     readonly offering_name: string;
@@ -11677,6 +11836,9 @@ export type ProjectUser = {
     offering_user_state: OfferingUserState | NullEnum | null;
 };
 export type ProjectsLimitsGroupedByIndustryFlag = {
+    /**
+     * Nested dictionary of resource limits by category and component type
+     */
     limits: {
         [key: string]: {
             [key: string]: string;
@@ -11684,6 +11846,9 @@ export type ProjectsLimitsGroupedByIndustryFlag = {
     };
 };
 export type ProjectsLimitsGroupedByOecd = {
+    /**
+     * Nested dictionary of resource limits by category and component type
+     */
     limits: {
         [key: string]: {
             [key: string]: string;
@@ -11691,6 +11856,9 @@ export type ProjectsLimitsGroupedByOecd = {
     };
 };
 export type ProjectsUsagesGroupedByIndustryFlag = {
+    /**
+     * Nested dictionary of usage values by category and component type
+     */
     usages: {
         [key: string]: {
             [key: string]: string;
@@ -11698,6 +11866,9 @@ export type ProjectsUsagesGroupedByIndustryFlag = {
     };
 };
 export type ProjectsUsagesGroupedByOecd = {
+    /**
+     * Nested dictionary of usage values by category and component type
+     */
     usages: {
         [key: string]: {
             [key: string]: string;
@@ -12822,6 +12993,9 @@ export type QuotaRequest = {
     limit: number;
 };
 export type QuotasUpdateRequest = {
+    /**
+     * Dictionary of quotas to update
+     */
     quotas: {
         [key: string]: number;
     };
@@ -14143,12 +14317,18 @@ export type ResourceRequest = {
     paused?: boolean;
 };
 export type ResourceResponseStatus = {
+    /**
+     * Status of the resource response
+     */
     readonly status: string;
 };
 export type ResourceRestrictMemberAccessRequest = {
     restrict_member_access?: boolean;
 };
 export type ResourceSetLimitsRequest = {
+    /**
+     * Dictionary mapping component types to their new limit values
+     */
     limits: unknown;
 };
 export type ResourceSetStateErredRequest = {
@@ -14169,6 +14349,7 @@ export type ResourceSwitchPlanRequest = {
 export type ResourceTerminateRequest = {
     /**
      * Termination attributes
+     * Optional attributes/parameters to pass to the termination operation
      */
     attributes?: unknown;
 };
@@ -14216,11 +14397,29 @@ export type ResourceUserRequest = {
     user: string;
 };
 export type ResourcesLimits = {
+    /**
+     * UUID of the offering
+     */
     readonly offering_uuid: string;
+    /**
+     * Name of the limit
+     */
     readonly name: string;
+    /**
+     * Limit value
+     */
     readonly value: number;
+    /**
+     * Country of the offering
+     */
     readonly offering_country: string;
+    /**
+     * Name of the organization group
+     */
     readonly organization_group_name: string;
+    /**
+     * UUID of the organization group
+     */
     readonly organization_group_uuid: string;
 };
 export type ReviewCommentRequest = {
@@ -14802,8 +15001,17 @@ export type ServiceProviderRevenues = {
     readonly month: number;
 };
 export type ServiceProviderSignatureRequest = {
+    /**
+     * Service provider customer UUID
+     */
     customer: string;
+    /**
+     * JWT-encoded data signed with the service provider's API secret code
+     */
     data: string;
+    /**
+     * If true, validates the signature without executing the operation
+     */
     dry_run?: boolean;
 };
 export type ServiceProviderStatistics = {
@@ -15318,7 +15526,13 @@ export type SubmitRequestResponse = {
     scope_uuid: string;
 };
 export type SubresourceOffering = {
+    /**
+     * UUID of the offering
+     */
     readonly uuid: string;
+    /**
+     * Type of the offering
+     */
     readonly type: string;
 };
 export type SupportStats = {
@@ -15408,11 +15622,29 @@ export type TimeSeriesToSData = {
     readonly count: number;
 };
 export type ToSConsentDashboard = {
+    /**
+     * Number of active users
+     */
     readonly active_users_count: number;
+    /**
+     * Total number of users
+     */
     readonly total_users_count: number;
+    /**
+     * Percentage of active users
+     */
     readonly active_users_percentage: number;
+    /**
+     * Number of accepted consents
+     */
     readonly accepted_consents_count: number;
+    /**
+     * Number of revoked consents
+     */
     readonly revoked_consents_count: number;
+    /**
+     * Total number of consents
+     */
     readonly total_consents_count: number;
     readonly revoked_consents_over_time: Array<TimeSeriesToSData>;
     readonly tos_version_adoption: Array<VersionAdoption>;
@@ -15823,7 +16055,13 @@ export type Version = {
     latest_version?: string;
 };
 export type VersionAdoption = {
+    /**
+     * Version identifier
+     */
     readonly version: string;
+    /**
+     * Number of users on this version
+     */
     readonly users_count: number;
 };
 export type VisibilityEnum = 'private' | 'public';
@@ -34488,7 +34726,7 @@ export type MarketplaceProviderOfferingsImportOfferingData = {
     url: '/api/marketplace-provider-offerings/import_offering/';
 };
 export type MarketplaceProviderOfferingsImportOfferingResponses = {
-    200: OfferingImportParameters;
+    200: OfferingImportResponse;
 };
 export type MarketplaceProviderOfferingsImportOfferingResponse = MarketplaceProviderOfferingsImportOfferingResponses[keyof MarketplaceProviderOfferingsImportOfferingResponses];
 export type MarketplaceProviderResourcesListData = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "waldur-js-client",
-  "version": "7.9.3-dev.8",
+  "version": "7.9.3",
   "description": "JavaScript client for Waldur MasterMind generated from OpenAPI schema",
   "author": "Waldur Platform",
   "license": "MIT",