diff --git a/packages/clients/src/api/account/v3/api.gen.ts b/packages/clients/src/api/account/v3/api.gen.ts index 23e2c2a14..35cd2a496 100644 --- a/packages/clients/src/api/account/v3/api.gen.ts +++ b/packages/clients/src/api/account/v3/api.gen.ts @@ -45,15 +45,14 @@ const jsonContentHeaders = { /** * Contract API. - * - * The Contract API allows you to manage contracts. + +The Contract API allows you to manage contracts. */ export class ContractAPI extends ParentAPI { /** * Download a contract content. * - * @param request - The request - * {@link ContractApiDownloadContractSignatureRequest} + * @param request - The request {@link ContractApiDownloadContractSignatureRequest} * @returns A Promise of Blob */ downloadContractSignature = ( @@ -67,11 +66,9 @@ export class ContractAPI extends ParentAPI { }) /** - * Create a signature for your Organization for the latest version of the - * requested contract. + * Create a signature for your Organization for the latest version of the requested contract. * - * @param request - The request - * {@link ContractApiCreateContractSignatureRequest} + * @param request - The request {@link ContractApiCreateContractSignatureRequest} * @returns A Promise of ContractSignature */ createContractSignature = ( @@ -95,8 +92,7 @@ export class ContractAPI extends ParentAPI { /** * Sign a contract for your Organization. * - * @param request - The request - * {@link ContractApiValidateContractSignatureRequest} + * @param request - The request {@link ContractApiValidateContractSignatureRequest} * @returns A Promise of ContractSignature */ validateContractSignature = ( @@ -115,8 +111,7 @@ export class ContractAPI extends ParentAPI { /** * Check if a contract is signed for your Organization. * - * @param request - The request - * {@link ContractApiCheckContractSignatureRequest} + * @param request - The request {@link ContractApiCheckContractSignatureRequest} * @returns A Promise of CheckContractSignatureResponse */ checkContractSignature = ( @@ -164,8 +159,7 @@ export class ContractAPI extends ParentAPI { /** * List contract signatures for an Organization. * - * @param request - The request - * {@link ContractApiListContractSignaturesRequest} + * @param request - The request {@link ContractApiListContractSignaturesRequest} * @returns A Promise of ListContractSignaturesResponse */ listContractSignatures = ( @@ -180,13 +174,12 @@ export class ContractAPI extends ParentAPI { /** * Account API. - * - * This API allows you to manage your Scaleway Projects. + +This API allows you to manage your Scaleway Projects. */ export class ProjectAPI extends ParentAPI { /** - * Create a new Project for an Organization. Generate a new Project for an - * Organization, specifying its configuration including name and description. + * Create a new Project for an Organization. Generate a new Project for an Organization, specifying its configuration including name and description. * * @param request - The request {@link ProjectApiCreateProjectRequest} * @returns A Promise of Project @@ -231,10 +224,7 @@ export class ProjectAPI extends ParentAPI { ) /** - * List all Projects of an Organization. List all Projects of an Organization. - * The response will include the total number of Projects as well as their - * associated Organizations, names, and IDs. Other information includes the - * creation and update date of the Project. + * List all Projects of an Organization. List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names, and IDs. Other information includes the creation and update date of the Project. * * @param request - The request {@link ProjectApiListProjectsRequest} * @returns A Promise of ListProjectsResponse @@ -243,9 +233,7 @@ export class ProjectAPI extends ParentAPI { enrichForPagination('projects', this.pageOfListProjects, request) /** - * Get an existing Project. Retrieve information about an existing Project, - * specified by its Project ID. Its full details, including ID, name and - * description, are returned in the response object. + * Get an existing Project. Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object. * * @param request - The request {@link ProjectApiGetProjectRequest} * @returns A Promise of Project @@ -260,10 +248,7 @@ export class ProjectAPI extends ParentAPI { ) /** - * Delete an existing Project. Delete an existing Project, specified by its - * Project ID. The Project needs to be empty (meaning there are no resources - * left in it) to be deleted effectively. Note that deleting a Project is - * permanent, and cannot be undone. + * Delete an existing Project. Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone. * * @param request - The request {@link ProjectApiDeleteProjectRequest} */ @@ -274,8 +259,7 @@ export class ProjectAPI extends ParentAPI { }) /** - * Update Project. Update the parameters of an existing Project, specified by - * its Project ID. These parameters include the name and description. + * Update Project. Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description. * * @param request - The request {@link ProjectApiUpdateProjectRequest} * @returns A Promise of Project @@ -294,12 +278,9 @@ export class ProjectAPI extends ParentAPI { ) /** - * Set project use case. Set the project use case for a new or existing - * Project, specified by its Project ID. You can customize the use case, sub - * use case, and architecture type you want to use in the Project. + * Set project use case. Set the project use case for a new or existing Project, specified by its Project ID. You can customize the use case, sub use case, and architecture type you want to use in the Project. * - * @param request - The request - * {@link ProjectApiSetProjectQualificationRequest} + * @param request - The request {@link ProjectApiSetProjectQualificationRequest} * @returns A Promise of ProjectQualification */ setProjectQualification = ( diff --git a/packages/clients/src/api/account/v3/types.gen.ts b/packages/clients/src/api/account/v3/types.gen.ts index f42c0248b..9d0c146b9 100644 --- a/packages/clients/src/api/account/v3/types.gen.ts +++ b/packages/clients/src/api/account/v3/types.gen.ts @@ -48,17 +48,29 @@ export type QualificationHostWebsiteSubUseCase = | 'other_sub_use_case' export interface Contract { - /** ID of the contract. */ + /** + * ID of the contract. + */ id: string - /** The type of the contract. */ + /** + * The type of the contract. + */ type: ContractType - /** The name of the contract. */ + /** + * The name of the contract. + */ name: string - /** The version of the contract. */ + /** + * The version of the contract. + */ version: number - /** The creation date of the contract. */ + /** + * The creation date of the contract. + */ createdAt?: Date - /** The last modification date of the contract. */ + /** + * The last modification date of the contract. + */ updatedAt?: Date } @@ -85,214 +97,304 @@ export interface QualificationSetScalewayEnvironment {} export interface QualificationShareData {} export interface ContractSignature { - /** ID of the contract signature. */ + /** + * ID of the contract signature. + */ id: string - /** The Organization ID which signed the contract. */ + /** + * The Organization ID which signed the contract. + */ organizationId: string - /** The creation date of the contract signature. */ + /** + * The creation date of the contract signature. + */ createdAt?: Date - /** The signing date of the contract signature. */ + /** + * The signing date of the contract signature. + */ signedAt?: Date - /** The expiration date of the contract signature. */ + /** + * The expiration date of the contract signature. + */ expiresAt?: Date - /** The contract signed. */ + /** + * The contract signed. + */ contract?: Contract } export interface Project { - /** ID of the Project. */ + /** + * ID of the Project. + */ id: string - /** Name of the Project. */ + /** + * Name of the Project. + */ name: string - /** Organization ID of the Project. */ + /** + * Organization ID of the Project. + */ organizationId: string - /** Creation date of the Project. */ + /** + * Creation date of the Project. + */ createdAt?: Date - /** Update date of the Project. */ + /** + * Update date of the Project. + */ updatedAt?: Date - /** Description of the Project. */ + /** + * Description of the Project. + */ description: string } export interface Qualification { - /** Architecture type of the qualification. */ + /** + * Architecture type of the qualification. + */ architectureType: QualificationArchitectureType /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ hostWebsite?: QualificationHostWebsite /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ hostApplication?: QualificationHostApplication /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ deploySoftware?: QualificationDeploySoftware /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ setScalewayEnvironment?: QualificationSetScalewayEnvironment /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ aiMachine?: QualificationAiMachine /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ container?: QualificationContainer /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ archiveData?: QualificationArchiveData /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ shareData?: QualificationShareData /** - * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', - * 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', - * 'archiveData', 'shareData', 'otherUseCase' could be set. + * + * One-of ('useCase'): at most one of 'hostWebsite', 'hostApplication', 'deploySoftware', 'setScalewayEnvironment', 'aiMachine', 'container', 'archiveData', 'shareData', 'otherUseCase' could be set. */ otherUseCase?: QualificationOtherUseCase } export interface CheckContractSignatureResponse { - /** Whether a signature has been requested for this contract. */ + /** + * Whether a signature has been requested for this contract. + */ created: boolean - /** Whether the signature for this contract has been validated. */ + /** + * Whether the signature for this contract has been validated. + */ validated: boolean } export type ContractApiCheckContractSignatureRequest = { - /** ID of the Organization to check the contract signature for. */ + /** + * ID of the Organization to check the contract signature for. + */ organizationId?: string - /** Filter on contract type. */ + /** + * Filter on contract type. + */ contractType?: ContractType - /** Filter on contract name. */ + /** + * Filter on contract name. + */ contractName: string } export type ContractApiCreateContractSignatureRequest = { - /** The type of the contract. */ + /** + * The type of the contract. + */ contractType?: ContractType - /** The name of the contract. */ + /** + * The name of the contract. + */ contractName: string - /** Whether the contract is validated at creation. */ + /** + * Whether the contract is validated at creation. + */ validated: boolean - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId?: string } export type ContractApiDownloadContractSignatureRequest = { - /** The contract signature ID. */ + /** + * The contract signature ID. + */ contractSignatureId: string - /** The locale requested for the content of the contract. */ + /** + * The locale requested for the content of the contract. + */ locale?: StdLanguageCode } export type ContractApiListContractSignaturesRequest = { - /** The page number for the returned contracts. */ + /** + * The page number for the returned contracts. + */ page?: number - /** The maximum number of contracts per page. */ + /** + * The maximum number of contracts per page. + */ pageSize?: number - /** How the contracts are ordered in the response. */ + /** + * How the contracts are ordered in the response. + */ orderBy?: ListContractSignaturesRequestOrderBy - /** Filter on Organization ID. */ + /** + * Filter on Organization ID. + */ organizationId?: string } export type ContractApiValidateContractSignatureRequest = { - /** The contract linked to your Organization you want to sign. */ + /** + * The contract linked to your Organization you want to sign. + */ contractSignatureId: string } export interface ListContractSignaturesResponse { - /** The total number of contract signatures. */ + /** + * The total number of contract signatures. + */ totalCount: number - /** The paginated returned contract signatures. */ + /** + * The paginated returned contract signatures. + */ contractSignatures: ContractSignature[] } export interface ListProjectsResponse { - /** Total number of Projects. */ + /** + * Total number of Projects. + */ totalCount: number - /** Paginated returned Projects. */ + /** + * Paginated returned Projects. + */ projects: Project[] } export type ProjectApiCreateProjectRequest = { - /** Name of the Project. */ + /** + * Name of the Project. + */ name?: string - /** Organization ID of the Project. */ + /** + * Organization ID of the Project. + */ organizationId?: string - /** Description of the Project. */ + /** + * Description of the Project. + */ description: string } export type ProjectApiDeleteProjectRequest = { - /** Project ID of the Project. */ + /** + * Project ID of the Project. + */ projectId?: string } export type ProjectApiGetProjectRequest = { - /** Project ID of the Project. */ + /** + * Project ID of the Project. + */ projectId?: string } export type ProjectApiListProjectsRequest = { - /** Organization ID of the Project. */ + /** + * Organization ID of the Project. + */ organizationId?: string - /** Name of the Project. */ + /** + * Name of the Project. + */ name?: string - /** Page number for the returned Projects. */ + /** + * Page number for the returned Projects. + */ page?: number - /** Maximum number of Project per page. */ + /** + * Maximum number of Project per page. + */ pageSize?: number - /** Sort order of the returned Projects. */ + /** + * Sort order of the returned Projects. + */ orderBy?: ListProjectsRequestOrderBy /** - * Project IDs to filter for. The results will be limited to any Projects with - * an ID in this array. + * Project IDs to filter for. The results will be limited to any Projects with an ID in this array. */ projectIds?: string[] } export type ProjectApiSetProjectQualificationRequest = { - /** Project ID. */ + /** + * Project ID. + */ projectId?: string - /** Use case chosen for the Project. */ + /** + * Use case chosen for the Project. + */ qualification?: Qualification } export type ProjectApiUpdateProjectRequest = { - /** Project ID of the Project. */ + /** + * Project ID of the Project. + */ projectId?: string - /** Name of the Project. */ + /** + * Name of the Project. + */ name?: string - /** Description of the Project. */ + /** + * Description of the Project. + */ description?: string } export interface ProjectQualification { - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** Qualification of the Project. */ + /** + * Qualification of the Project. + */ qualification?: Qualification } diff --git a/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts b/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts index bbe740d17..44e13d811 100644 --- a/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/applesilicon/v1alpha1/api.gen.ts @@ -69,17 +69,15 @@ const jsonContentHeaders = { /** * Apple silicon API. - * - * This API allows you to manage your Apple silicon machines. + +This API allows you to manage your Apple silicon machines. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ public static readonly LOCALITIES: ScwZone[] = ['fr-par-3'] /** - * List server types. List all technical details about Apple silicon server - * types available in the specified zone. Since there is only one Availability - * Zone for Apple silicon servers, the targeted value is `fr-par-3`. + * List server types. List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`. * * @param request - The request {@link ListServerTypesRequest} * @returns A Promise of ListServerTypesResponse @@ -94,8 +92,7 @@ export class API extends ParentAPI { ) /** - * Get a server type. Get technical details (CPU, disk size etc.) of a server - * type. + * Get a server type. Get technical details (CPU, disk size etc.) of a server type. * * @param request - The request {@link GetServerTypeRequest} * @returns A Promise of ServerType @@ -110,8 +107,7 @@ export class API extends ParentAPI { ) /** - * Create a server. Create a new server in the targeted zone, specifying its - * configuration including name and type. + * Create a server. Create a new server in the targeted zone, specifying its configuration including name and type. * * @param request - The request {@link CreateServerRequest} * @returns A Promise of Server @@ -149,9 +145,7 @@ export class API extends ParentAPI { ) /** - * List all servers. List all servers in the specified zone. By default, - * returned servers in the list are ordered by creation date in ascending - * order, though this can be modified via the `order_by` field. + * List all servers. List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListServersRequest} * @returns A Promise of ListServersResponse @@ -178,9 +172,7 @@ export class API extends ParentAPI { ) /** - * List all Operating Systems (OS). List all Operating Systems (OS). The - * response will include the total number of OS as well as their associated - * IDs, names and labels. + * List all Operating Systems (OS). List all Operating Systems (OS). The response will include the total number of OS as well as their associated IDs, names and labels. * * @param request - The request {@link ListOSRequest} * @returns A Promise of ListOSResponse @@ -189,8 +181,7 @@ export class API extends ParentAPI { enrichForPagination('os', this.pageOfListOS, request) /** - * Get an Operating System (OS). Get an Operating System (OS). The response - * will include the OS's unique ID as well as its name and label. + * Get an Operating System (OS). Get an Operating System (OS). The response will include the OS's unique ID as well as its name and label. * * @param request - The request {@link GetOSRequest} * @returns A Promise of OS @@ -205,9 +196,7 @@ export class API extends ParentAPI { ) /** - * Get a server. Retrieve information about an existing Apple silicon server, - * specified by its server ID. Its full details, including name, status and IP - * address, are returned in the response object. + * Get a server. Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object. * * @param request - The request {@link GetServerRequest} * @returns A Promise of Server @@ -244,8 +233,7 @@ export class API extends ParentAPI { ) /** - * Update a server. Update the parameters of an existing Apple silicon server, - * specified by its server ID. + * Update a server. Update the parameters of an existing Apple silicon server, specified by its server ID. * * @param request - The request {@link UpdateServerRequest} * @returns A Promise of Server @@ -264,10 +252,7 @@ export class API extends ParentAPI { ) /** - * Delete a server. Delete an existing Apple silicon server, specified by its - * server ID. Deleting a server is permanent, and cannot be undone. Note that - * the minimum allocation period for Apple silicon-as-a-service is 24 hours, - * meaning you cannot delete your server prior to that. + * Delete a server. Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that. * * @param request - The request {@link DeleteServerRequest} */ @@ -278,8 +263,7 @@ export class API extends ParentAPI { }) /** - * Reboot a server. Reboot an existing Apple silicon server, specified by its - * server ID. + * Reboot a server. Reboot an existing Apple silicon server, specified by its server ID. * * @param request - The request {@link RebootServerRequest} * @returns A Promise of Server @@ -296,10 +280,7 @@ export class API extends ParentAPI { ) /** - * Reinstall a server. Reinstall an existing Apple silicon server (specified - * by its server ID) from a new image (OS). All the data on the disk is - * deleted and all configuration is reset to the defailt configuration values - * of the image (OS). + * Reinstall a server. Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS). * * @param request - The request {@link ReinstallServerRequest} * @returns A Promise of Server @@ -347,7 +328,9 @@ export class API extends ParentAPI { ) } -/** Apple silicon - Private Networks API. */ +/** + * Apple silicon - Private Networks API. + */ export class PrivateNetworkAPI extends ParentAPI { /** Lists the available zones of the API. */ public static readonly LOCALITIES: ScwZone[] = ['fr-par-1', 'fr-par-3'] @@ -366,8 +349,7 @@ export class PrivateNetworkAPI extends ParentAPI { /** * Waits for {@link ServerPrivateNetwork} to be in a final state. * - * @param request - The request - * {@link PrivateNetworkApiGetServerPrivateNetworkRequest} + * @param request - The request {@link PrivateNetworkApiGetServerPrivateNetworkRequest} * @param options - The waiting options * @returns A Promise of ServerPrivateNetwork */ @@ -389,11 +371,9 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * Add a server to a Private Network. Add an Apple silicon server to a Private - * Network. + * Add a server to a Private Network. Add an Apple silicon server to a Private Network. * - * @param request - The request - * {@link PrivateNetworkApiAddServerPrivateNetworkRequest} + * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest} * @returns A Promise of ServerPrivateNetwork */ addServerPrivateNetwork = ( @@ -415,11 +395,9 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * Set multiple Private Networks on a server. Configure multiple Private - * Networks on an Apple silicon server. + * Set multiple Private Networks on a server. Configure multiple Private Networks on an Apple silicon server. * - * @param request - The request - * {@link PrivateNetworkApiSetServerPrivateNetworksRequest} + * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest} * @returns A Promise of SetServerPrivateNetworksResponse */ setServerPrivateNetworks = ( @@ -465,11 +443,9 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * List the Private Networks of a server. List the Private Networks of an - * Apple silicon server. + * List the Private Networks of a server. List the Private Networks of an Apple silicon server. * - * @param request - The request - * {@link PrivateNetworkApiListServerPrivateNetworksRequest} + * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest} * @returns A Promise of ListServerPrivateNetworksResponse */ listServerPrivateNetworks = ( @@ -484,8 +460,7 @@ export class PrivateNetworkAPI extends ParentAPI { /** * Delete a Private Network. * - * @param request - The request - * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest} + * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest} */ deleteServerPrivateNetwork = ( request: Readonly, diff --git a/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts b/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts index f08081660..596d61f67 100644 --- a/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts @@ -56,23 +56,41 @@ export type ServerTypeStock = | 'high_stock' export interface OS { - /** Unique ID of the OS. */ + /** + * Unique ID of the OS. + */ id: string - /** OS name. */ + /** + * OS name. + */ name: string - /** OS name as it should be displayed. */ + /** + * OS name as it should be displayed. + */ label: string - /** URL of the image. */ + /** + * URL of the image. + */ imageUrl: string - /** The OS family to which this OS belongs, eg. 13 or 14. */ + /** + * The OS family to which this OS belongs, eg. 13 or 14. + */ family: string - /** Describes if the OS is in beta. */ + /** + * Describes if the OS is in beta. + */ isBeta: boolean - /** The OS version number, eg. Sonoma has version number 14.3. */ + /** + * The OS version number, eg. Sonoma has version number 14.3. + */ version: string - /** The current xcode version for this OS. */ + /** + * The current xcode version for this OS. + */ xcodeVersion: string - /** List of compatible server types. */ + /** + * List of compatible server types. + */ compatibleServerTypes: string[] } @@ -115,103 +133,163 @@ export interface ConnectivityDiagnosticServerHealth { } export interface ServerPrivateNetwork { - /** ID of the Server-to-Private Network mapping. */ + /** + * ID of the Server-to-Private Network mapping. + */ id: string - /** Private Network Project ID. */ + /** + * Private Network Project ID. + */ projectId: string - /** Apple silicon server ID. */ + /** + * Apple silicon server ID. + */ serverId: string - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string - /** ID of the VLAN associated with the Private Network. */ + /** + * ID of the VLAN associated with the Private Network. + */ vlan?: number - /** Configuration status of the Private Network. */ + /** + * Configuration status of the Private Network. + */ status: ServerPrivateNetworkServerStatus - /** Private Network creation date. */ + /** + * Private Network creation date. + */ createdAt?: Date - /** Date the Private Network was last modified. */ + /** + * Date the Private Network was last modified. + */ updatedAt?: Date - /** IPAM IP IDs of the server, if it has any. */ + /** + * IPAM IP IDs of the server, if it has any. + */ ipamIpIds: string[] } export interface ServerType { - /** CPU description. */ + /** + * CPU description. + */ cpu?: ServerTypeCPU - /** Size of the local disk of the server. */ + /** + * Size of the local disk of the server. + */ disk?: ServerTypeDisk - /** Name of the type. */ + /** + * Name of the type. + */ name: string - /** Size of memory available. */ + /** + * Size of memory available. + */ memory?: ServerTypeMemory - /** Current stock. */ + /** + * Current stock. + */ stock: ServerTypeStock - /** Minimum duration of the lease in seconds (example. 3.4s). */ + /** + * Minimum duration of the lease in seconds (example. 3.4s). + */ minimumLeaseDuration?: string - /** GPU description. */ + /** + * GPU description. + */ gpu?: ServerTypeGPU - /** Network description. */ + /** + * Network description. + */ network?: ServerTypeNetwork - /** The default OS for this server type. */ + /** + * The default OS for this server type. + */ defaultOs?: OS } export interface Server { - /** UUID of the server. */ + /** + * UUID of the server. + */ id: string - /** Type of the server. */ + /** + * Type of the server. + */ type: string - /** Name of the server. */ + /** + * Name of the server. + */ name: string - /** Project this server is associated with. */ + /** + * Project this server is associated with. + */ projectId: string - /** Organization this server is associated with. */ + /** + * Organization this server is associated with. + */ organizationId: string - /** IPv4 address of the server. */ + /** + * IPv4 address of the server. + */ ip: string - /** Vnc:// URL to access Apple Remote Desktop. */ + /** + * Vnc:// URL to access Apple Remote Desktop. + */ vncUrl: string - /** SSH Username for remote shell. */ + /** + * SSH Username for remote shell. + */ sshUsername: string - /** Admin password required to execute commands. */ + /** + * Admin password required to execute commands. + */ sudoPassword: string - /** VNC port to use for remote desktop connection. */ + /** + * VNC port to use for remote desktop connection. + */ vncPort: number /** - * Initially installed OS, this does not necessarily reflect the current OS - * version. + * Initially installed OS, this does not necessarily reflect the current OS version. */ os?: OS - /** Current status of the server. */ + /** + * Current status of the server. + */ status: ServerStatus - /** Date on which the server was created. */ + /** + * Date on which the server was created. + */ createdAt?: Date - /** Date on which the server was last updated. */ + /** + * Date on which the server was last updated. + */ updatedAt?: Date - /** Date from which the server can be deleted. */ + /** + * Date from which the server can be deleted. + */ deletableAt?: Date /** - * Set to true to mark the server for automatic deletion depending on - * `deletable_at` date. Set to false to cancel an existing deletion schedule. - * Leave unset otherwise. + * Set to true to mark the server for automatic deletion depending on `deletable_at` date. Set to false to cancel an existing deletion schedule. Leave unset otherwise. */ deletionScheduled: boolean - /** Zone of the server. */ + /** + * Zone of the server. + */ zone: ScwZone /** - * Set to true once the server has completed its provisioning steps and is - * ready to use. Some OS configurations might require a reinstallation of the - * server before delivery depending on the available stock. A reinstallation - * after the initial delivery will not change this flag and can be tracked - * using the server status. + * Set to true once the server has completed its provisioning steps and is ready to use. Some OS configurations might require a reinstallation of the server before delivery depending on the available stock. A reinstallation after the initial delivery will not change this flag and can be tracked using the server status. */ delivered: boolean /** - * Activation status of optional Private Network feature support for this - * server. + * Activation status of optional Private Network feature support for this server. */ vpcStatus: ServerPrivateNetworkStatus - /** Commitment scheme applied to this server. */ + /** + * Commitment scheme applied to this server. + */ commitment?: Commitment } @@ -229,91 +307,119 @@ export interface ConnectivityDiagnostic { } export type CreateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Create a server with this given name. */ + /** + * Create a server with this given name. + */ name?: string - /** Create a server in the given project ID. */ + /** + * Create a server in the given project ID. + */ projectId?: string - /** Create a server of the given type. */ + /** + * Create a server of the given type. + */ type: string /** - * Create a server & install the given os_id, when no os_id provided the - * default OS for this server type is chosen. Requesting a non-default OS will - * induce an extended delivery time. + * Create a server & install the given os_id, when no os_id provided the default OS for this server type is chosen. Requesting a non-default OS will induce an extended delivery time. */ osId?: string /** - * Activate the Private Network feature for this server. This feature is - * configured through the Apple Silicon - Private Networks API. + * Activate the Private Network feature for this server. This feature is configured through the Apple Silicon - Private Networks API. */ enableVpc: boolean /** - * Activate commitment for this server. If not specified, there is a 24h - * commitment due to Apple licensing (commitment_type `duration_24h`). It can - * be updated with the Update Server request. Available commitment depends on - * server type. + * Activate commitment for this server. If not specified, there is a 24h commitment due to Apple licensing (commitment_type `duration_24h`). It can be updated with the Update Server request. Available commitment depends on server type. */ commitmentType?: CommitmentType } export type DeleteServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server you want to delete. */ + /** + * UUID of the server you want to delete. + */ serverId: string } export type GetConnectivityDiagnosticRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone diagnosticId: string } export type GetOSRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the OS you want to get. */ + /** + * UUID of the OS you want to get. + */ osId: string } export type GetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server you want to get. */ + /** + * UUID of the server you want to get. + */ serverId: string } export type GetServerTypeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server type identifier. */ + /** + * Server type identifier. + */ serverType: string } export type ListOSRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Positive integer to choose the page to return. */ + /** + * Positive integer to choose the page to return. + */ page?: number /** - * Positive integer lower or equal to 100 to select the number of items to - * return. + * Positive integer lower or equal to 100 to select the number of items to return. */ pageSize?: number - /** List of compatible server types. */ + /** + * List of compatible server types. + */ serverType?: string /** - * Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not - * "12")). + * Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12")). */ name?: string } export interface ListOSResponse { - /** Total number of OS. */ + /** + * Total number of OS. + */ totalCount: number - /** List of OS. */ + /** + * List of OS. + */ os: OS[] } @@ -323,118 +429,176 @@ export interface ListServerPrivateNetworksResponse { } export type ListServerTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone } export interface ListServerTypesResponse { - /** Available server types. */ + /** + * Available server types. + */ serverTypes: ServerType[] } export type ListServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Sort order of the returned servers. */ + /** + * Sort order of the returned servers. + */ orderBy?: ListServersRequestOrderBy - /** Only list servers of this project ID. */ + /** + * Only list servers of this project ID. + */ projectId?: string - /** Only list servers of this Organization ID. */ + /** + * Only list servers of this Organization ID. + */ organizationId?: string - /** Positive integer to choose the page to return. */ + /** + * Positive integer to choose the page to return. + */ page?: number /** - * Positive integer lower or equal to 100 to select the number of items to - * return. + * Positive integer lower or equal to 100 to select the number of items to return. */ pageSize?: number } export interface ListServersResponse { - /** Total number of servers. */ + /** + * Total number of servers. + */ totalCount: number - /** Paginated returned servers. */ + /** + * Paginated returned servers. + */ servers: Server[] } export type PrivateNetworkApiAddServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string - /** ID of the Private Network. */ + /** + * ID of the Private Network. + */ privateNetworkId: string - /** IPAM IDs of IPs to attach to the server. */ + /** + * IPAM IDs of IPs to attach to the server. + */ ipamIpIds?: string[] } export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string - /** ID of the Private Network. */ + /** + * ID of the Private Network. + */ privateNetworkId: string } export type PrivateNetworkApiGetServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone serverId: string privateNetworkId: string } export type PrivateNetworkApiListServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Sort order for the returned Private Networks. */ + /** + * Sort order for the returned Private Networks. + */ orderBy?: ListServerPrivateNetworksRequestOrderBy - /** Page number for the returned Private Networks. */ + /** + * Page number for the returned Private Networks. + */ page?: number - /** Maximum number of Private Networks per page. */ + /** + * Maximum number of Private Networks per page. + */ pageSize?: number - /** Filter Private Networks by server ID. */ + /** + * Filter Private Networks by server ID. + */ serverId?: string - /** Filter Private Networks by Private Network ID. */ + /** + * Filter Private Networks by Private Network ID. + */ privateNetworkId?: string - /** Filter Private Networks by Organization ID. */ + /** + * Filter Private Networks by Organization ID. + */ organizationId?: string - /** Filter Private Networks by Project ID. */ + /** + * Filter Private Networks by Project ID. + */ projectId?: string - /** Filter Private Networks by IPAM IP IDs. */ + /** + * Filter Private Networks by IPAM IP IDs. + */ ipamIpIds?: string[] } export type PrivateNetworkApiSetServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string /** - * Object where the keys are the IDs of Private Networks and the values are - * arrays of IPAM IDs representing the IPs to assign to this Apple silicon - * server on the Private Network. If the array supplied for a Private Network - * is empty, the next available IP from the Private Network's CIDR block will - * automatically be used for attachment. + * Object where the keys are the IDs of Private Networks and the values are arrays of IPAM IDs representing the IPs to assign to this Apple silicon server on the Private Network. If the array supplied for a Private Network is empty, the next available IP from the Private Network's CIDR block will automatically be used for attachment. */ perPrivateNetworkIpamIpIds: Record } export type RebootServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server you want to reboot. */ + /** + * UUID of the server you want to reboot. + */ serverId: string } export type ReinstallServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server you want to reinstall. */ + /** + * UUID of the server you want to reinstall. + */ serverId: string /** - * Reinstall the server with the target OS, when no os_id provided the default - * OS for the server type is used. + * Reinstall the server with the target OS, when no os_id provided the default OS for the server type is used. */ osId?: string } @@ -444,7 +608,9 @@ export interface SetServerPrivateNetworksResponse { } export type StartConnectivityDiagnosticRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone serverId: string } @@ -454,19 +620,28 @@ export interface StartConnectivityDiagnosticResponse { } export type UpdateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server you want to update. */ + /** + * UUID of the server you want to update. + */ serverId: string - /** Updated name for your server. */ + /** + * Updated name for your server. + */ name?: string - /** Specify whether the server should be flagged for automatic deletion. */ + /** + * Specify whether the server should be flagged for automatic deletion. + */ scheduleDeletion?: boolean - /** Activate or deactivate Private Network support for this server. */ + /** + * Activate or deactivate Private Network support for this server. + */ enableVpc?: boolean /** - * Change commitment. Use 'none' to automatically cancel a renewing - * commitment. + * Change commitment. Use 'none' to automatically cancel a renewing commitment. */ commitmentType?: CommitmentTypeValue } diff --git a/packages/clients/src/api/audit_trail/v1alpha1/api.gen.ts b/packages/clients/src/api/audit_trail/v1alpha1/api.gen.ts index 38cf552cb..b8001301b 100644 --- a/packages/clients/src/api/audit_trail/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/audit_trail/v1alpha1/api.gen.ts @@ -19,18 +19,15 @@ import type { /** * Audit Trail API. - * - * This API allows you to ensure accountability and security by recording events - * and changes performed within your Scaleway Organization. + +This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: ScwRegion[] = ['fr-par', 'nl-ams'] /** - * List events. Retrieve the list of Audit Trail events for a Scaleway - * Organization and/or Project. You must specify the `organization_id` and - * optionally, the `project_id`. + * List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the `organization_id` and optionally, the `project_id`. * * @param request - The request {@link ListEventsRequest} * @returns A Promise of ListEventsResponse @@ -66,8 +63,7 @@ export class API extends ParentAPI { ) /** - * Retrieve the list of Scaleway resources for which you have Audit Trail - * events. + * Retrieve the list of Scaleway resources for which you have Audit Trail events. * * @param request - The request {@link ListProductsRequest} * @returns A Promise of ListProductsResponse diff --git a/packages/clients/src/api/audit_trail/v1alpha1/types.gen.ts b/packages/clients/src/api/audit_trail/v1alpha1/types.gen.ts index 196f3d8f4..abf15d69b 100644 --- a/packages/clients/src/api/audit_trail/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/audit_trail/v1alpha1/types.gen.ts @@ -62,77 +62,54 @@ export interface Resource { /** * @deprecated * - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ secmSecretInfo?: SecretManagerSecretInfo /** * @deprecated * - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ secmSecretVersionInfo?: SecretManagerSecretVersionInfo /** - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ kubeClusterInfo?: KubernetesClusterInfo /** - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ kubePoolInfo?: KubernetesPoolInfo /** - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ kubeNodeInfo?: KubernetesNodeInfo /** - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ kubeAclInfo?: KubernetesACLInfo /** * @deprecated * - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ keymKeyInfo?: KeyManagerKeyInfo /** - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ secretManagerSecretInfo?: SecretManagerSecretInfo /** - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ secretManagerVersionInfo?: SecretManagerSecretVersionInfo /** - * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', - * 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', - * 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', - * 'keyManagerKeyInfo' could be set. + * + * One-of ('info'): at most one of 'secmSecretInfo', 'secmSecretVersionInfo', 'kubeClusterInfo', 'kubePoolInfo', 'kubeNodeInfo', 'kubeAclInfo', 'keymKeyInfo', 'secretManagerSecretInfo', 'secretManagerVersionInfo', 'keyManagerKeyInfo' could be set. */ keyManagerKeyInfo?: KeyManagerKeyInfo } @@ -143,111 +120,162 @@ export interface ProductService { } export interface Event { - /** ID of the event. */ + /** + * ID of the event. + */ id: string - /** Timestamp of the event. */ + /** + * Timestamp of the event. + */ recordedAt?: Date - /** Locality of the resource attached to the event. */ + /** + * Locality of the resource attached to the event. + */ locality: string - /** User or IAM application at the origin of the event. */ + /** + * User or IAM application at the origin of the event. + */ principal?: EventPrincipal - /** Organization ID containing the event. */ + /** + * Organization ID containing the event. + */ organizationId: string - /** (Optional) Project of the resource attached to the event. */ + /** + * (Optional) Project of the resource attached to the event. + */ projectId?: string - /** IP address at the origin of the event. */ + /** + * IP address at the origin of the event. + */ sourceIp: string - /** User Agent at the origin of the event. */ + /** + * User Agent at the origin of the event. + */ userAgent?: string - /** Product name of the resource attached to the event. */ + /** + * Product name of the resource attached to the event. + */ productName: string - /** API name called to trigger the event. */ + /** + * API name called to trigger the event. + */ serviceName: string - /** API method called to trigger the event. */ + /** + * API method called to trigger the event. + */ methodName: string - /** @deprecated Resource attached to the event. */ + /** + * @deprecated Resource attached to the event. + */ resource?: Resource - /** Resources attached to the event. */ + /** + * Resources attached to the event. + */ resources: Resource[] - /** Unique identifier of the request at the origin of the event. */ + /** + * Unique identifier of the request at the origin of the event. + */ requestId: string - /** Request at the origin of the event. */ + /** + * Request at the origin of the event. + */ requestBody?: Record - /** HTTP status code resulting of the API call. */ + /** + * HTTP status code resulting of the API call. + */ statusCode: number } export interface Product { - /** Product title. */ + /** + * Product title. + */ title: string - /** Product name. */ + /** + * Product name. + */ name: string /** - * Specifies the API versions of the products integrated with Audit Trail. - * Each version defines the methods logged by Audit Trail. + * Specifies the API versions of the products integrated with Audit Trail. Each version defines the methods logged by Audit Trail. */ services: ProductService[] } export type ListEventsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** (Optional) ID of the Project containing the Audit Trail events. */ + /** + * (Optional) ID of the Project containing the Audit Trail events. + */ projectId?: string - /** ID of the Organization containing the Audit Trail events. */ + /** + * ID of the Organization containing the Audit Trail events. + */ organizationId?: string - /** (Optional) Returns a paginated list of Scaleway resources' features. */ + /** + * (Optional) Returns a paginated list of Scaleway resources' features. + */ resourceType?: ResourceType - /** (Optional) Name of the method of the API call performed. */ + /** + * (Optional) Name of the method of the API call performed. + */ methodName?: string /** - * (Optional) HTTP status code of the request. Returns either `200` if the - * request was successful or `403` if the permission was denied. + * (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied. */ status?: number /** - * (Optional) The `recorded_after` parameter defines the earliest timestamp - * from which Audit Trail events are retrieved. Returns `one hour ago` by - * default. + * (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default. */ recordedAfter?: Date /** - * (Optional) The `recorded_before` parameter defines the latest timestamp up - * to which Audit Trail events are retrieved. Returns `now` by default. + * (Optional) The `recorded_before` parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns `now` by default. */ recordedBefore?: Date orderBy?: ListEventsRequestOrderBy pageSize?: number pageToken?: string - /** (Optional) Name of the Scaleway resource in a hyphenated format. */ + /** + * (Optional) Name of the Scaleway resource in a hyphenated format. + */ productName?: string - /** (Optional) Name of the service of the API call performed. */ + /** + * (Optional) Name of the service of the API call performed. + */ serviceName?: string } export interface ListEventsResponse { - /** Single page of events matching the requested criteria. */ + /** + * Single page of events matching the requested criteria. + */ events: Event[] - /** Page token to use in following calls to keep listing. */ + /** + * Page token to use in following calls to keep listing. + */ nextPageToken?: string } export type ListProductsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Organization containing the Audit Trail events. */ + /** + * ID of the Organization containing the Audit Trail events. + */ organizationId?: string } export interface ListProductsResponse { - /** List of all products integrated with Audit Trail. */ + /** + * List of all products integrated with Audit Trail. + */ products: Product[] - /** Number of integrated products. */ + /** + * Number of integrated products. + */ totalCount: number } diff --git a/packages/clients/src/api/baremetal/v1/api.gen.ts b/packages/clients/src/api/baremetal/v1/api.gen.ts index 690cd015a..063922a81 100644 --- a/packages/clients/src/api/baremetal/v1/api.gen.ts +++ b/packages/clients/src/api/baremetal/v1/api.gen.ts @@ -100,8 +100,8 @@ const jsonContentHeaders = { /** * Elastic Metal API. - * - * This API allows you to manage your Elastic Metal servers. + +This API allows you to manage your Elastic Metal servers. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -138,8 +138,7 @@ export class API extends ParentAPI { ) /** - * List Elastic Metal servers for an Organization. List Elastic Metal servers - * for a specific Organization. + * List Elastic Metal servers for an Organization. List Elastic Metal servers for a specific Organization. * * @param request - The request {@link ListServersRequest} * @returns A Promise of ListServersResponse @@ -148,8 +147,7 @@ export class API extends ParentAPI { enrichForPagination('servers', this.pageOfListServers, request) /** - * Get a specific Elastic Metal server. Get full details of an existing - * Elastic Metal server associated with the ID. + * Get a specific Elastic Metal server. Get full details of an existing Elastic Metal server associated with the ID. * * @param request - The request {@link GetServerRequest} * @returns A Promise of Server @@ -186,8 +184,7 @@ export class API extends ParentAPI { ) /** - * Create an Elastic Metal server. Create a new Elastic Metal server. Once the - * server is created, proceed with the [installation of an OS](#post-3e949e). + * Create an Elastic Metal server. Create a new Elastic Metal server. Once the server is created, proceed with the [installation of an OS](#post-3e949e). * * @param request - The request {@link CreateServerRequest} * @returns A Promise of Server @@ -206,9 +203,7 @@ export class API extends ParentAPI { ) /** - * Update an Elastic Metal server. Update the server associated with the ID. - * You can update parameters such as the server's name, tags and description. - * Any parameters left null in the request body are not updated. + * Update an Elastic Metal server. Update the server associated with the ID. You can update parameters such as the server's name, tags and description. Any parameters left null in the request body are not updated. * * @param request - The request {@link UpdateServerRequest} * @returns A Promise of Server @@ -227,8 +222,7 @@ export class API extends ParentAPI { ) /** - * Install an Elastic Metal server. Install an Operating System (OS) on the - * Elastic Metal server with a specific ID. + * Install an Elastic Metal server. Install an Operating System (OS) on the Elastic Metal server with a specific ID. * * @param request - The request {@link InstallServerRequest} * @returns A Promise of Server @@ -247,8 +241,7 @@ export class API extends ParentAPI { ) /** - * Return server metrics. Get the ping status of the server associated with - * the ID. + * Return server metrics. Get the ping status of the server associated with the ID. * * @param request - The request {@link GetServerMetricsRequest} * @returns A Promise of GetServerMetricsResponse @@ -278,9 +271,7 @@ export class API extends ParentAPI { ) /** - * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated - * with the ID, use the `boot_type` `rescue` to reboot the server in rescue - * mode. + * Reboot an Elastic Metal server. Reboot the Elastic Metal server associated with the ID, use the `boot_type` `rescue` to reboot the server in rescue mode. * * @param request - The request {@link RebootServerRequest} * @returns A Promise of Server @@ -318,9 +309,7 @@ export class API extends ParentAPI { ) /** - * Stop an Elastic Metal server. Stop the server associated with the ID. The - * server remains allocated to your account and all data remains on the local - * storage of the server. + * Stop an Elastic Metal server. Stop the server associated with the ID. The server remains allocated to your account and all data remains on the local storage of the server. * * @param request - The request {@link StopServerRequest} * @returns A Promise of Server @@ -356,8 +345,7 @@ export class API extends ParentAPI { ) /** - * List server events. List event (i.e. start/stop/reboot) associated to the - * server ID. + * List server events. List event (i.e. start/stop/reboot) associated to the server ID. * * @param request - The request {@link ListServerEventsRequest} * @returns A Promise of ListServerEventsResponse @@ -366,8 +354,7 @@ export class API extends ParentAPI { enrichForPagination('events', this.pageOfListServerEvents, request) /** - * Get default partitioning schema. Get the default partitioning schema for - * the given offer ID and OS ID. + * Get default partitioning schema. Get the default partitioning schema for the given offer ID and OS ID. * * @param request - The request {@link GetDefaultPartitioningSchemaRequest} * @returns A Promise of Schema @@ -388,9 +375,7 @@ export class API extends ParentAPI { ) /** - * Validate client partitioning schema. Validate the incoming partitioning - * schema from a user before installing the server. Return default ErrorCode - * if invalid. + * Validate client partitioning schema. Validate the incoming partitioning schema from a user before installing the server. Return default ErrorCode if invalid. * * @param request - The request {@link ValidatePartitioningSchemaRequest} */ @@ -407,18 +392,10 @@ export class API extends ParentAPI { }) /** - * Start BMC access. Start BMC (Baseboard Management Controller) access - * associated with the ID. The BMC (Baseboard Management Controller) access is - * available one hour after the installation of the server. You need first to - * create an option Remote Access. You will find the ID and the price with a - * call to listOffers - * (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). - * Then add the option - * https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. - * After adding the BMC option, you need to Get Remote Access to get the - * login/password - * https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do - * not forget to delete the Option after use. + * Start BMC access. Start BMC (Baseboard Management Controller) access associated with the ID. +The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. +You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. +After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use. * * @param request - The request {@link StartBMCAccessRequest} * @returns A Promise of BMCAccess @@ -437,9 +414,7 @@ export class API extends ParentAPI { ) /** - * Get BMC access. Get the BMC (Baseboard Management Controller) access - * associated with the ID, including the URL and login information needed to - * connect. + * Get BMC access. Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect. * * @param request - The request {@link GetBMCAccessRequest} * @returns A Promise of BMCAccess @@ -454,8 +429,7 @@ export class API extends ParentAPI { ) /** - * Stop BMC access. Stop BMC (Baseboard Management Controller) access - * associated with the ID. + * Stop BMC access. Stop BMC (Baseboard Management Controller) access associated with the ID. * * @param request - The request {@link StopBMCAccessRequest} */ @@ -466,8 +440,7 @@ export class API extends ParentAPI { }) /** - * Update IP. Configure the IP address associated with the server ID and IP - * ID. You can use this method to set a reverse DNS for an IP address. + * Update IP. Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address. * * @param request - The request {@link UpdateIPRequest} * @returns A Promise of IP @@ -486,8 +459,7 @@ export class API extends ParentAPI { ) /** - * Add server option. Add an option, such as Private Networks, to a specific - * server. + * Add server option. Add an option, such as Private Networks, to a specific server. * * @param request - The request {@link AddOptionServerRequest} * @returns A Promise of Server @@ -690,8 +662,7 @@ export class API extends ParentAPI { ) /** - * List available OSes. List all OSes that are available for installation on - * Elastic Metal servers. + * List available OSes. List all OSes that are available for installation on Elastic Metal servers. * * @param request - The request {@link ListOSRequest} * @returns A Promise of ListOSResponse @@ -715,7 +686,9 @@ export class API extends ParentAPI { ) } -/** Elastic Metal - Private Network API. */ +/** + * Elastic Metal - Private Network API. + */ export class PrivateNetworkAPI extends ParentAPI { /** Lists the available zones of the API. */ public static readonly LOCALITIES: ScwZone[] = ['fr-par-2'] @@ -723,8 +696,7 @@ export class PrivateNetworkAPI extends ParentAPI { /** * Add a server to a Private Network. * - * @param request - The request - * {@link PrivateNetworkApiAddServerPrivateNetworkRequest} + * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest} * @returns A Promise of ServerPrivateNetwork */ addServerPrivateNetwork = ( @@ -748,8 +720,7 @@ export class PrivateNetworkAPI extends ParentAPI { /** * Set multiple Private Networks on a server. * - * @param request - The request - * {@link PrivateNetworkApiSetServerPrivateNetworksRequest} + * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest} * @returns A Promise of SetServerPrivateNetworksResponse */ setServerPrivateNetworks = ( @@ -796,8 +767,7 @@ export class PrivateNetworkAPI extends ParentAPI { /** * List the Private Networks of a server. * - * @param request - The request - * {@link PrivateNetworkApiListServerPrivateNetworksRequest} + * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest} * @returns A Promise of ListServerPrivateNetworksResponse */ listServerPrivateNetworks = ( @@ -812,8 +782,7 @@ export class PrivateNetworkAPI extends ParentAPI { /** * Delete a Private Network. * - * @param request - The request - * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest} + * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest} */ deleteServerPrivateNetwork = ( request: Readonly, diff --git a/packages/clients/src/api/baremetal/v1/types.gen.ts b/packages/clients/src/api/baremetal/v1/types.gen.ts index 7f75d2217..f3f55027c 100644 --- a/packages/clients/src/api/baremetal/v1/types.gen.ts +++ b/packages/clients/src/api/baremetal/v1/types.gen.ts @@ -174,104 +174,143 @@ export interface OSOSField { } export interface CPU { - /** Name of the CPU. */ + /** + * Name of the CPU. + */ name: string - /** Number of CPU cores. */ + /** + * Number of CPU cores. + */ coreCount: number - /** Number CPU threads. */ + /** + * Number CPU threads. + */ threadCount: number - /** Frequency of the CPU in MHz. */ + /** + * Frequency of the CPU in MHz. + */ frequency: number - /** Benchmark of the CPU. */ + /** + * Benchmark of the CPU. + */ benchmark: string } export interface Disk { - /** Capacity of the disk in bytes. */ + /** + * Capacity of the disk in bytes. + */ capacity: number - /** Type of the disk. */ + /** + * Type of the disk. + */ type: string } export interface GPU { - /** Name of the GPU. */ + /** + * Name of the GPU. + */ name: string - /** Capacity of the vram in bytes. */ + /** + * Capacity of the vram in bytes. + */ vram: number } export interface Memory { - /** Capacity of the memory in bytes. */ + /** + * Capacity of the memory in bytes. + */ capacity: number - /** Type of the memory. */ + /** + * Type of the memory. + */ type: string - /** Frequency of the memory in MHz. */ + /** + * Frequency of the memory in MHz. + */ frequency: number - /** True if the memory is an error-correcting code memory. */ + /** + * True if the memory is an error-correcting code memory. + */ isEcc: boolean } export interface OfferOptionOffer { - /** ID of the option. */ + /** + * ID of the option. + */ id: string - /** Name of the option. */ + /** + * Name of the option. + */ name: string /** - * If true the option is enabled and included by default in the offer If false - * the option is available for the offer but not included by default. + * If true the option is enabled and included by default in the offer +If false the option is available for the offer but not included by default. */ enabled: boolean - /** Period of subscription for the offer. */ + /** + * Period of subscription for the offer. + */ subscriptionPeriod: OfferSubscriptionPeriod - /** Price of the option. */ + /** + * Price of the option. + */ price?: Money - /** Boolean to know if option could be managed. */ + /** + * Boolean to know if option could be managed. + */ manageable: boolean - /** @deprecated Deprecated, use LicenseOptionVars.os_id instead. */ + /** + * @deprecated Deprecated, use LicenseOptionVars.os_id instead. + */ osId?: string /** * License option, contains the ID of the OS linked to the option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ license?: LicenseOption /** * Public_bandwidth option, contains the bandwidth_in_bps. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ publicBandwidth?: PublicBandwidthOption /** * Private_network option, contains the bandwidth_in_bps. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ privateNetwork?: PrivateNetworkOption /** * Remote_access option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ remoteAccess?: RemoteAccessOption /** * Certification option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ certification?: CertificationOption } export interface PersistentMemory { - /** Capacity of the memory in bytes. */ + /** + * Capacity of the memory in bytes. + */ capacity: number - /** Type of the memory. */ + /** + * Type of the memory. + */ type: string - /** Frequency of the memory in MHz. */ + /** + * Frequency of the memory in MHz. + */ frequency: number } @@ -281,571 +320,888 @@ export interface RaidController { } export interface IP { - /** ID of the IP. */ + /** + * ID of the IP. + */ id: string - /** Address of the IP. */ + /** + * Address of the IP. + */ address: string - /** Reverse IP value. */ + /** + * Reverse IP value. + */ reverse: string - /** Version of IP (v4 or v6). */ + /** + * Version of IP (v4 or v6). + */ version: IPVersion - /** Status of the reverse. */ + /** + * Status of the reverse. + */ reverseStatus: IPReverseStatus - /** A message related to the reverse status, e.g. in case of an error. */ + /** + * A message related to the reverse status, e.g. in case of an error. + */ reverseStatusMessage: string } export interface ServerInstall { - /** ID of the OS. */ + /** + * ID of the OS. + */ osId: string - /** Host defined during the server installation. */ + /** + * Host defined during the server installation. + */ hostname: string - /** SSH public key IDs defined during server installation. */ + /** + * SSH public key IDs defined during server installation. + */ sshKeyIds: string[] - /** Status of the server installation. */ + /** + * Status of the server installation. + */ status: ServerInstallStatus /** - * User defined in the server installation, or the default user if none were - * specified. + * User defined in the server installation, or the default user if none were specified. */ user: string /** - * Service user defined in the server installation, or the default user if - * none were specified. + * Service user defined in the server installation, or the default user if none were specified. */ serviceUser: string - /** Address of the installed service. */ + /** + * Address of the installed service. + */ serviceUrl: string - /** Partitioning schema. */ + /** + * Partitioning schema. + */ partitioningSchema?: Schema } export interface ServerOption { - /** ID of the option. */ + /** + * ID of the option. + */ id: string - /** Name of the option. */ + /** + * Name of the option. + */ name: string - /** Status of the option on this server. */ + /** + * Status of the option on this server. + */ status: ServerOptionOptionStatus - /** Defines whether the option can be managed (added or removed). */ + /** + * Defines whether the option can be managed (added or removed). + */ manageable: boolean - /** Auto expiration date for compatible options. */ + /** + * Auto expiration date for compatible options. + */ expiresAt?: Date /** * License option, contains the ID of the OS linked to the option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ license?: LicenseOption /** * Public_bandwidth option, contains the bandwidth_in_bps. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ publicBandwidth?: PublicBandwidthOption /** * Private_network option, contains the bandwidth_in_bps. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ privateNetwork?: PrivateNetworkOption /** * Remote_access option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ remoteAccess?: RemoteAccessOption /** * Certification option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ certification?: CertificationOption } export interface ServerRescueServer { - /** Rescue user name. */ + /** + * Rescue user name. + */ user: string - /** Rescue password. */ + /** + * Rescue password. + */ password: string } export interface CreateServerRequestInstall { - /** ID of the OS to installation on the server. */ + /** + * ID of the OS to installation on the server. + */ osId: string - /** Hostname of the server. */ + /** + * Hostname of the server. + */ hostname: string - /** SSH key IDs authorized on the server. */ + /** + * SSH key IDs authorized on the server. + */ sshKeyIds: string[] - /** User for the installation. */ + /** + * User for the installation. + */ user?: string - /** Password for the installation. */ + /** + * Password for the installation. + */ password?: string - /** Regular user that runs the service to be installed on the server. */ + /** + * Regular user that runs the service to be installed on the server. + */ serviceUser?: string - /** Password used for the service to install. */ + /** + * Password used for the service to install. + */ servicePassword?: string - /** Partitioning schema. */ + /** + * Partitioning schema. + */ partitioningSchema?: Schema } export interface OS { - /** ID of the OS. */ + /** + * ID of the OS. + */ id: string - /** Name of the OS. */ + /** + * Name of the OS. + */ name: string - /** Version of the OS. */ + /** + * Version of the OS. + */ version: string - /** URL of this OS's logo. */ + /** + * URL of this OS's logo. + */ logoUrl: string - /** Object defining the SSH requirements to install the OS. */ + /** + * Object defining the SSH requirements to install the OS. + */ ssh?: OSOSField - /** Object defining the username requirements to install the OS. */ + /** + * Object defining the username requirements to install the OS. + */ user?: OSOSField - /** Object defining the password requirements to install the OS. */ + /** + * Object defining the password requirements to install the OS. + */ password?: OSOSField - /** Object defining the username requirements to install the service. */ + /** + * Object defining the username requirements to install the service. + */ serviceUser?: OSOSField - /** Object defining the password requirements to install the service. */ + /** + * Object defining the password requirements to install the service. + */ servicePassword?: OSOSField - /** Defines if the operating system is enabled or not. */ + /** + * Defines if the operating system is enabled or not. + */ enabled: boolean - /** License required (check server options for pricing details). */ + /** + * License required (check server options for pricing details). + */ licenseRequired: boolean - /** Defines if a specific Organization is allowed to install this OS type. */ + /** + * Defines if a specific Organization is allowed to install this OS type. + */ allowed: boolean - /** Defines if custom partitioning is supported by this OS. */ + /** + * Defines if custom partitioning is supported by this OS. + */ customPartitioningSupported: boolean } export interface Offer { - /** ID of the offer. */ + /** + * ID of the offer. + */ id: string - /** Name of the offer. */ + /** + * Name of the offer. + */ name: string - /** Stock level. */ + /** + * Stock level. + */ stock: OfferStock - /** Public bandwidth available (in bits/s) with the offer. */ + /** + * Public bandwidth available (in bits/s) with the offer. + */ bandwidth: number /** - * Maximum public bandwidth available (in bits/s) depending on available - * options. + * Maximum public bandwidth available (in bits/s) depending on available options. */ maxBandwidth: number - /** Commercial range of the offer. */ + /** + * Commercial range of the offer. + */ commercialRange: string /** - * Price of the offer for the next 60 minutes (a server order at 11h32 will be - * payed until 12h32). + * Price of the offer for the next 60 minutes (a server order at 11h32 will be payed until 12h32). */ pricePerHour?: Money - /** Monthly price of the offer, if subscribing on a monthly basis. */ + /** + * Monthly price of the offer, if subscribing on a monthly basis. + */ pricePerMonth?: Money - /** Disks specifications of the offer. */ + /** + * Disks specifications of the offer. + */ disks: Disk[] - /** Defines whether the offer is currently available. */ + /** + * Defines whether the offer is currently available. + */ enable: boolean - /** CPU specifications of the offer. */ + /** + * CPU specifications of the offer. + */ cpus: CPU[] - /** Memory specifications of the offer. */ + /** + * Memory specifications of the offer. + */ memories: Memory[] - /** Name of the quota associated to the offer. */ + /** + * Name of the quota associated to the offer. + */ quotaName: string - /** Persistent memory specifications of the offer. */ + /** + * Persistent memory specifications of the offer. + */ persistentMemories: PersistentMemory[] - /** Raid controller specifications of the offer. */ + /** + * Raid controller specifications of the offer. + */ raidControllers: RaidController[] - /** Array of OS images IDs incompatible with the server. */ + /** + * Array of OS images IDs incompatible with the server. + */ incompatibleOsIds: string[] - /** Period of subscription for the offer. */ + /** + * Period of subscription for the offer. + */ subscriptionPeriod: OfferSubscriptionPeriod - /** Operation path of the service. */ + /** + * Operation path of the service. + */ operationPath: string /** - * One time fee invoiced by Scaleway for the setup and activation of the - * server. + * One time fee invoiced by Scaleway for the setup and activation of the server. */ fee?: Money - /** Available options for customization of the server. */ + /** + * Available options for customization of the server. + */ options: OfferOptionOffer[] - /** Private bandwidth available in bits/s with the offer. */ + /** + * Private bandwidth available in bits/s with the offer. + */ privateBandwidth: number - /** Defines whether the offer's bandwidth is shared or not. */ + /** + * Defines whether the offer's bandwidth is shared or not. + */ sharedBandwidth: boolean - /** Array of tags attached to the offer. */ + /** + * Array of tags attached to the offer. + */ tags: string[] - /** GPU specifications of the offer. */ + /** + * GPU specifications of the offer. + */ gpus: GPU[] - /** Exist only for hourly offers, to migrate to the monthly offer. */ + /** + * Exist only for hourly offers, to migrate to the monthly offer. + */ monthlyOfferId?: string } export interface Option { - /** ID of the option. */ + /** + * ID of the option. + */ id: string - /** Name of the option. */ + /** + * Name of the option. + */ name: string - /** Defines whether the option is manageable (could be added or removed). */ + /** + * Defines whether the option is manageable (could be added or removed). + */ manageable: boolean /** * License option, contains the ID of the OS linked to the option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ license?: LicenseOption /** * Public_bandwidth option, contains the bandwidth_in_bps. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ publicBandwidth?: PublicBandwidthOption /** * Private_network option, contains the bandwidth_in_bps. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ privateNetwork?: PrivateNetworkOption /** * Remote_access option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ remoteAccess?: RemoteAccessOption /** * Certification option. * - * One-of ('option'): at most one of 'license', 'publicBandwidth', - * 'privateNetwork', 'remoteAccess', 'certification' could be set. + * One-of ('option'): at most one of 'license', 'publicBandwidth', 'privateNetwork', 'remoteAccess', 'certification' could be set. */ certification?: CertificationOption } export interface ServerEvent { - /** ID of the server to which the action will be applied. */ + /** + * ID of the server to which the action will be applied. + */ id: string - /** The action that will be applied to the server. */ + /** + * The action that will be applied to the server. + */ action: string - /** Date of last modification of the action. */ + /** + * Date of last modification of the action. + */ updatedAt?: Date - /** Date of creation of the action. */ + /** + * Date of creation of the action. + */ createdAt?: Date } export interface ServerPrivateNetwork { - /** The Private Network ID. */ + /** + * The Private Network ID. + */ id: string - /** The Private Network Project ID. */ + /** + * The Private Network Project ID. + */ projectId: string - /** The server ID. */ + /** + * The server ID. + */ serverId: string - /** The Private Network ID. */ + /** + * The Private Network ID. + */ privateNetworkId: string - /** The VLAN ID associated to the Private Network. */ + /** + * The VLAN ID associated to the Private Network. + */ vlan?: number - /** The configuration status of the Private Network. */ + /** + * The configuration status of the Private Network. + */ status: ServerPrivateNetworkStatus - /** The Private Network creation date. */ + /** + * The Private Network creation date. + */ createdAt?: Date - /** The date the Private Network was last modified. */ + /** + * The date the Private Network was last modified. + */ updatedAt?: Date } export interface Server { - /** ID of the server. */ + /** + * ID of the server. + */ id: string - /** Organization ID the server is attached to. */ + /** + * Organization ID the server is attached to. + */ organizationId: string - /** Project ID the server is attached to. */ + /** + * Project ID the server is attached to. + */ projectId: string - /** Name of the server. */ + /** + * Name of the server. + */ name: string - /** Description of the server. */ + /** + * Description of the server. + */ description: string - /** Last modification date of the server. */ + /** + * Last modification date of the server. + */ updatedAt?: Date - /** Creation date of the server. */ + /** + * Creation date of the server. + */ createdAt?: Date - /** Status of the server. */ + /** + * Status of the server. + */ status: ServerStatus - /** Offer ID of the server. */ + /** + * Offer ID of the server. + */ offerId: string - /** Offer name of the server. */ + /** + * Offer name of the server. + */ offerName: string - /** Array of custom tags attached to the server. */ + /** + * Array of custom tags attached to the server. + */ tags: string[] - /** Array of IPs attached to the server. */ + /** + * Array of IPs attached to the server. + */ ips: IP[] - /** Domain of the server. */ + /** + * Domain of the server. + */ domain: string - /** Boot type of the server. */ + /** + * Boot type of the server. + */ bootType: ServerBootType - /** Zone in which is the server located. */ + /** + * Zone in which is the server located. + */ zone: ScwZone - /** Configuration of the installation. */ + /** + * Configuration of the installation. + */ install?: ServerInstall - /** Status of server ping. */ + /** + * Status of server ping. + */ pingStatus: ServerPingStatus - /** Options enabled on the server. */ + /** + * Options enabled on the server. + */ options: ServerOption[] - /** Configuration of rescue boot. */ + /** + * Configuration of rescue boot. + */ rescueServer?: ServerRescueServer } export interface Setting { - /** ID of the setting. */ + /** + * ID of the setting. + */ id: string - /** Type of the setting. */ + /** + * Type of the setting. + */ type: SettingType - /** ID of the Project ID. */ + /** + * ID of the Project ID. + */ projectId: string - /** Defines whether the setting is enabled. */ + /** + * Defines whether the setting is enabled. + */ enabled: boolean } export type AddOptionServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string - /** ID of the option to add. */ + /** + * ID of the option to add. + */ optionId: string - /** Auto expire the option after this date. */ + /** + * Auto expire the option after this date. + */ expiresAt?: Date } export interface BMCAccess { - /** URL to access to the server console. */ + /** + * URL to access to the server console. + */ url: string /** - * The login to use for the BMC (Baseboard Management Controller) access - * authentification. + * The login to use for the BMC (Baseboard Management Controller) access authentification. */ login: string /** - * The password to use for the BMC (Baseboard Management Controller) access - * authentification. + * The password to use for the BMC (Baseboard Management Controller) access authentification. */ password: string /** - * The date after which the BMC (Baseboard Management Controller) access will - * be closed. + * The date after which the BMC (Baseboard Management Controller) access will be closed. */ expiresAt?: Date } export type CreateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ - zone?: ScwZone - /** Offer ID of the new server. */ - offerId: string + /** + * Zone to target. If none is passed will use default zone from the config. + */ + zone?: ScwZone + /** + * Offer ID of the new server. + */ + offerId: string /** * @deprecated Organization ID with which the server will be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Project ID with which the server will be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string - /** Name of the server (≠hostname). */ + /** + * Name of the server (≠hostname). + */ name: string - /** Description associated with the server, max 255 characters. */ + /** + * Description associated with the server, max 255 characters. + */ description: string - /** Tags to associate to the server. */ + /** + * Tags to associate to the server. + */ tags?: string[] /** - * Object describing the configuration details of the OS installation on the - * server. + * Object describing the configuration details of the OS installation on the server. */ install?: CreateServerRequestInstall - /** IDs of options to enable on server. */ + /** + * IDs of options to enable on server. + */ optionIds?: string[] } export type DeleteOptionServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string - /** ID of the option to delete. */ + /** + * ID of the option to delete. + */ optionId: string } export type DeleteServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to delete. */ + /** + * ID of the server to delete. + */ serverId: string } export type GetBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string } export type GetDefaultPartitioningSchemaRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the offer. */ + /** + * ID of the offer. + */ offerId: string - /** ID of the OS. */ + /** + * ID of the OS. + */ osId: string } export type GetOSRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the OS. */ + /** + * ID of the OS. + */ osId: string } export type GetOfferRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the researched Offer. */ + /** + * ID of the researched Offer. + */ offerId: string } export type GetOptionRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the option. */ + /** + * ID of the option. + */ optionId: string } export type GetServerMetricsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to get the metrics. */ + /** + * Server ID to get the metrics. + */ serverId: string } export interface GetServerMetricsResponse { - /** Timeseries object representing pings on the server. */ + /** + * Timeseries object representing pings on the server. + */ pings?: TimeSeries } export type GetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string } export type InstallServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to install. */ + /** + * Server ID to install. + */ serverId: string - /** ID of the OS to installation on the server. */ + /** + * ID of the OS to installation on the server. + */ osId: string - /** Hostname of the server. */ + /** + * Hostname of the server. + */ hostname: string - /** SSH key IDs authorized on the server. */ + /** + * SSH key IDs authorized on the server. + */ sshKeyIds: string[] - /** User used for the installation. */ + /** + * User used for the installation. + */ user?: string - /** Password used for the installation. */ + /** + * Password used for the installation. + */ password?: string - /** User used for the service to install. */ + /** + * User used for the service to install. + */ serviceUser?: string - /** Password used for the service to install. */ + /** + * Password used for the service to install. + */ servicePassword?: string - /** Partitioning schema. */ + /** + * Partitioning schema. + */ partitioningSchema?: Schema } export type ListOSRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of OS per page. */ + /** + * Number of OS per page. + */ pageSize?: number - /** Offer IDs to filter OSes for. */ + /** + * Offer IDs to filter OSes for. + */ offerId?: string } export interface ListOSResponse { - /** Total count of matching OS. */ + /** + * Total count of matching OS. + */ totalCount: number - /** OS that match filters. */ + /** + * OS that match filters. + */ os: OS[] } export type ListOffersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of offers per page. */ + /** + * Number of offers per page. + */ pageSize?: number - /** Subscription period type to filter offers by. */ + /** + * Subscription period type to filter offers by. + */ subscriptionPeriod?: OfferSubscriptionPeriod - /** Offer name to filter offers by. */ + /** + * Offer name to filter offers by. + */ name?: string } export interface ListOffersResponse { - /** Total count of matching offers. */ + /** + * Total count of matching offers. + */ totalCount: number - /** Offers that match filters. */ + /** + * Offers that match filters. + */ offers: Offer[] } export type ListOptionsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of options per page. */ + /** + * Number of options per page. + */ pageSize?: number - /** Offer ID to filter options for. */ + /** + * Offer ID to filter options for. + */ offerId?: string - /** Name to filter options for. */ + /** + * Name to filter options for. + */ name?: string } export interface ListOptionsResponse { - /** Total count of matching options. */ + /** + * Total count of matching options. + */ totalCount: number - /** Options that match filters. */ + /** + * Options that match filters. + */ options: Option[] } export type ListServerEventsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server events searched. */ + /** + * ID of the server events searched. + */ serverId: string - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of server events per page. */ + /** + * Number of server events per page. + */ pageSize?: number - /** Order of the server events. */ + /** + * Order of the server events. + */ orderBy?: ListServerEventsRequestOrderBy } export interface ListServerEventsResponse { - /** Total count of matching events. */ + /** + * Total count of matching events. + */ totalCount: number - /** Server events that match filters. */ + /** + * Server events that match filters. + */ events: ServerEvent[] } @@ -855,114 +1211,196 @@ export interface ListServerPrivateNetworksResponse { } export type ListServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of servers per page. */ + /** + * Number of servers per page. + */ pageSize?: number - /** Order of the servers. */ + /** + * Order of the servers. + */ orderBy?: ListServersRequestOrderBy - /** Tags to filter for. */ + /** + * Tags to filter for. + */ tags?: string[] - /** Status to filter for. */ + /** + * Status to filter for. + */ status?: string[] - /** Names to filter for. */ + /** + * Names to filter for. + */ name?: string - /** Organization ID to filter for. */ + /** + * Organization ID to filter for. + */ organizationId?: string - /** Project ID to filter for. */ + /** + * Project ID to filter for. + */ projectId?: string - /** Option ID to filter for. */ + /** + * Option ID to filter for. + */ optionId?: string } export interface ListServersResponse { - /** Total count of matching servers. */ + /** + * Total count of matching servers. + */ totalCount: number - /** Array of Elastic Metal server objects matching the filters in the request. */ + /** + * Array of Elastic Metal server objects matching the filters in the request. + */ servers: Server[] } export type ListSettingsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Set the maximum list size. */ + /** + * Set the maximum list size. + */ pageSize?: number - /** Sort order for items in the response. */ + /** + * Sort order for items in the response. + */ orderBy?: ListSettingsRequestOrderBy - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } export interface ListSettingsResponse { - /** Total count of matching settings. */ + /** + * Total count of matching settings. + */ totalCount: number - /** Settings that match filters. */ + /** + * Settings that match filters. + */ settings: Setting[] } export type MigrateServerToMonthlyOfferRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string } export type PrivateNetworkApiAddServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** The ID of the server. */ + /** + * The ID of the server. + */ serverId: string - /** The ID of the Private Network. */ + /** + * The ID of the Private Network. + */ privateNetworkId: string } export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** The ID of the server. */ + /** + * The ID of the server. + */ serverId: string - /** The ID of the Private Network. */ + /** + * The ID of the Private Network. + */ privateNetworkId: string } export type PrivateNetworkApiListServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** The sort order for the returned Private Networks. */ + /** + * The sort order for the returned Private Networks. + */ orderBy?: ListServerPrivateNetworksRequestOrderBy - /** The page number for the returned Private Networks. */ + /** + * The page number for the returned Private Networks. + */ page?: number - /** The maximum number of Private Networks per page. */ + /** + * The maximum number of Private Networks per page. + */ pageSize?: number - /** Filter Private Networks by server ID. */ + /** + * Filter Private Networks by server ID. + */ serverId?: string - /** Filter Private Networks by Private Network ID. */ + /** + * Filter Private Networks by Private Network ID. + */ privateNetworkId?: string - /** Filter Private Networks by Organization ID. */ + /** + * Filter Private Networks by Organization ID. + */ organizationId?: string - /** Filter Private Networks by Project ID. */ + /** + * Filter Private Networks by Project ID. + */ projectId?: string } export type PrivateNetworkApiSetServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** The ID of the server. */ + /** + * The ID of the server. + */ serverId: string - /** The IDs of the Private Networks. */ + /** + * The IDs of the Private Networks. + */ privateNetworkIds: string[] } export type RebootServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to reboot. */ + /** + * ID of the server to reboot. + */ serverId: string - /** The type of boot. */ + /** + * The type of boot. + */ bootType?: ServerBootType } @@ -971,80 +1409,129 @@ export interface SetServerPrivateNetworksResponse { } export type StartBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string - /** The IP authorized to connect to the server. */ + /** + * The IP authorized to connect to the server. + */ ip: string } export type StartServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to start. */ + /** + * ID of the server to start. + */ serverId: string - /** The type of boot. */ + /** + * The type of boot. + */ bootType?: ServerBootType } export type StopBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string } export type StopServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to stop. */ + /** + * ID of the server to stop. + */ serverId: string } export type UpdateIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: string - /** ID of the IP to update. */ + /** + * ID of the IP to update. + */ ipId: string - /** New reverse IP to update, not updated if null. */ + /** + * New reverse IP to update, not updated if null. + */ reverse?: string } export type UpdateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to update. */ + /** + * ID of the server to update. + */ serverId: string - /** Name of the server (≠hostname), not updated if null. */ + /** + * Name of the server (≠hostname), not updated if null. + */ name?: string /** - * Description associated with the server, max 255 characters, not updated if - * null. + * Description associated with the server, max 255 characters, not updated if null. */ description?: string - /** Tags associated with the server, not updated if null. */ + /** + * Tags associated with the server, not updated if null. + */ tags?: string[] } export type UpdateSettingRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the setting. */ + /** + * ID of the setting. + */ settingId: string - /** Defines whether the setting is enabled. */ + /** + * Defines whether the setting is enabled. + */ enabled?: boolean } export type ValidatePartitioningSchemaRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Partitioning schema. */ + /** + * Partitioning schema. + */ partitioningSchema?: Schema - /** Offer ID of the server. */ + /** + * Offer ID of the server. + */ offerId: string - /** OS ID. */ + /** + * OS ID. + */ osId: string } diff --git a/packages/clients/src/api/baremetal/v3/api.gen.ts b/packages/clients/src/api/baremetal/v3/api.gen.ts index d4f83b37f..a55d42196 100644 --- a/packages/clients/src/api/baremetal/v3/api.gen.ts +++ b/packages/clients/src/api/baremetal/v3/api.gen.ts @@ -28,7 +28,9 @@ const jsonContentHeaders = { 'Content-Type': 'application/json; charset=utf-8', } -/** Elastic Metal - Private Networks API. */ +/** + * Elastic Metal - Private Networks API. + */ export class PrivateNetworkAPI extends ParentAPI { /** Lists the available zones of the API. */ public static readonly LOCALITIES: ScwZone[] = [ @@ -41,11 +43,9 @@ export class PrivateNetworkAPI extends ParentAPI { ] /** - * Add a server to a Private Network. Add an Elastic Metal server to a Private - * Network. + * Add a server to a Private Network. Add an Elastic Metal server to a Private Network. * - * @param request - The request - * {@link PrivateNetworkApiAddServerPrivateNetworkRequest} + * @param request - The request {@link PrivateNetworkApiAddServerPrivateNetworkRequest} * @returns A Promise of ServerPrivateNetwork */ addServerPrivateNetwork = ( @@ -67,11 +67,9 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * Set multiple Private Networks on a server. Configure multiple Private - * Networks on an Elastic Metal server. + * Set multiple Private Networks on a server. Configure multiple Private Networks on an Elastic Metal server. * - * @param request - The request - * {@link PrivateNetworkApiSetServerPrivateNetworksRequest} + * @param request - The request {@link PrivateNetworkApiSetServerPrivateNetworksRequest} * @returns A Promise of SetServerPrivateNetworksResponse */ setServerPrivateNetworks = ( @@ -117,11 +115,9 @@ export class PrivateNetworkAPI extends ParentAPI { ) /** - * List the Private Networks of a server. List the Private Networks of an - * Elastic Metal server. + * List the Private Networks of a server. List the Private Networks of an Elastic Metal server. * - * @param request - The request - * {@link PrivateNetworkApiListServerPrivateNetworksRequest} + * @param request - The request {@link PrivateNetworkApiListServerPrivateNetworksRequest} * @returns A Promise of ListServerPrivateNetworksResponse */ listServerPrivateNetworks = ( @@ -136,8 +132,7 @@ export class PrivateNetworkAPI extends ParentAPI { /** * Delete a Private Network. * - * @param request - The request - * {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest} + * @param request - The request {@link PrivateNetworkApiDeleteServerPrivateNetworkRequest} */ deleteServerPrivateNetwork = ( request: Readonly, diff --git a/packages/clients/src/api/baremetal/v3/types.gen.ts b/packages/clients/src/api/baremetal/v3/types.gen.ts index f50f80eb1..bfdd5f980 100644 --- a/packages/clients/src/api/baremetal/v3/types.gen.ts +++ b/packages/clients/src/api/baremetal/v3/types.gen.ts @@ -17,23 +17,41 @@ export type ServerPrivateNetworkStatus = | 'locked' export interface ServerPrivateNetwork { - /** UUID of the Server-to-Private Network mapping. */ + /** + * UUID of the Server-to-Private Network mapping. + */ id: string - /** Private Network Project UUID. */ + /** + * Private Network Project UUID. + */ projectId: string - /** Server UUID. */ + /** + * Server UUID. + */ serverId: string - /** Private Network UUID. */ + /** + * Private Network UUID. + */ privateNetworkId: string - /** VLAN UUID associated with the Private Network. */ + /** + * VLAN UUID associated with the Private Network. + */ vlan?: number - /** Configuration status of the Private Network. */ + /** + * Configuration status of the Private Network. + */ status: ServerPrivateNetworkStatus - /** Private Network creation date. */ + /** + * Private Network creation date. + */ createdAt?: Date - /** Date the Private Network was last modified. */ + /** + * Date the Private Network was last modified. + */ updatedAt?: Date - /** IPAM IP IDs of the server, if it has any. */ + /** + * IPAM IP IDs of the server, if it has any. + */ ipamIpIds: string[] } @@ -43,57 +61,89 @@ export interface ListServerPrivateNetworksResponse { } export type PrivateNetworkApiAddServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server. */ + /** + * UUID of the server. + */ serverId: string - /** UUID of the Private Network. */ + /** + * UUID of the Private Network. + */ privateNetworkId: string - /** IPAM IDs of an IPs to attach to the server. */ + /** + * IPAM IDs of an IPs to attach to the server. + */ ipamIpIds?: string[] } export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server. */ + /** + * UUID of the server. + */ serverId: string - /** UUID of the Private Network. */ + /** + * UUID of the Private Network. + */ privateNetworkId: string } export type PrivateNetworkApiListServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Sort order for the returned Private Networks. */ + /** + * Sort order for the returned Private Networks. + */ orderBy?: ListServerPrivateNetworksRequestOrderBy - /** Page number for the returned Private Networks. */ + /** + * Page number for the returned Private Networks. + */ page?: number - /** Maximum number of Private Networks per page. */ + /** + * Maximum number of Private Networks per page. + */ pageSize?: number - /** Filter Private Networks by server UUID. */ + /** + * Filter Private Networks by server UUID. + */ serverId?: string - /** Filter Private Networks by Private Network UUID. */ + /** + * Filter Private Networks by Private Network UUID. + */ privateNetworkId?: string - /** Filter Private Networks by organization UUID. */ + /** + * Filter Private Networks by organization UUID. + */ organizationId?: string - /** Filter Private Networks by project UUID. */ + /** + * Filter Private Networks by project UUID. + */ projectId?: string - /** Filter Private Networks by IPAM IP UUIDs. */ + /** + * Filter Private Networks by IPAM IP UUIDs. + */ ipamIpIds?: string[] } export type PrivateNetworkApiSetServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the server. */ + /** + * UUID of the server. + */ serverId: string /** - * Object where the keys are the UUIDs of Private Networks and the values are - * arrays of IPAM IDs representing the IPs to assign to this Elastic Metal - * server on the Private Network. If the array supplied for a Private Network - * is empty, the next available IP from the Private Network's CIDR block will - * automatically be used for attachment. + * Object where the keys are the UUIDs of Private Networks and the values are arrays of IPAM IDs representing the IPs to assign to this Elastic Metal server on the Private Network. If the array supplied for a Private Network is empty, the next available IP from the Private Network's CIDR block will automatically be used for attachment. */ perPrivateNetworkIpamIpIds: Record } diff --git a/packages/clients/src/api/billing/v2beta1/api.gen.ts b/packages/clients/src/api/billing/v2beta1/api.gen.ts index 4d2276804..2b99c5cf6 100644 --- a/packages/clients/src/api/billing/v2beta1/api.gen.ts +++ b/packages/clients/src/api/billing/v2beta1/api.gen.ts @@ -31,9 +31,8 @@ import type { /** * Billing API. - * - * This API allows you to manage and query your Scaleway billing and - * consumption. + +This API allows you to manage and query your Scaleway billing and consumption. */ export class API extends ParentAPI { protected pageOfListConsumptions = ( @@ -72,8 +71,7 @@ export class API extends ParentAPI { ) /** - * Get monthly consumption. Consumption allows you to retrieve your past or - * current consumption cost, by project or category. + * Get monthly consumption. Consumption allows you to retrieve your past or current consumption cost, by project or category. * * @param request - The request {@link ListConsumptionsRequest} * @returns A Promise of ListConsumptionsResponse @@ -105,8 +103,7 @@ export class API extends ParentAPI { ) /** - * Get monthly consumption taxes. Consumption Tax allows you to retrieve your - * past or current tax charges, by project or category. + * Get monthly consumption taxes. Consumption Tax allows you to retrieve your past or current tax charges, by project or category. * * @param request - The request {@link ListTaxesRequest} * @returns A Promise of ListTaxesResponse @@ -138,8 +135,7 @@ export class API extends ParentAPI { ) /** - * List invoices. List all your invoices, filtering by `start_date` and - * `invoice_type`. Each invoice has its own ID. + * List invoices. List all your invoices, filtering by `start_date` and `invoice_type`. Each invoice has its own ID. * * @param request - The request {@link ListInvoicesRequest} * @returns A Promise of ListInvoicesResponse @@ -221,16 +217,10 @@ export class API extends ParentAPI { ) /** - * List discounts. List all discounts for your Organization and usable - * categories, products, offers, references, regions and zones where the - * discount can be applied. As a reseller: - * - * - If you do not specify an `organization_id` you will list the discounts - * applied to your own Organization and your customers - * - If you indicate your `organization_id` you will list only the discounts - * applied to your Organization - * - If you indicate `the organization_id` of one of your customers, you will - * list the discounts applied to their Organization. + * List discounts. List all discounts for your Organization and usable categories, products, offers, references, regions and zones where the discount can be applied. As a reseller: +- If you do not specify an `organization_id` you will list the discounts applied to your own Organization and your customers +- If you indicate your `organization_id` you will list only the discounts applied to your Organization +- If you indicate `the organization_id` of one of your customers, you will list the discounts applied to their Organization. * * @param request - The request {@link ListDiscountsRequest} * @returns A Promise of ListDiscountsResponse diff --git a/packages/clients/src/api/billing/v2beta1/types.gen.ts b/packages/clients/src/api/billing/v2beta1/types.gen.ts index f23420c6d..9553d0e0b 100644 --- a/packages/clients/src/api/billing/v2beta1/types.gen.ts +++ b/packages/clients/src/api/billing/v2beta1/types.gen.ts @@ -76,278 +76,407 @@ export type ListTaxesRequestOrderBy = | 'category_name_asc' export interface DiscountCoupon { - /** The description of the coupon. */ + /** + * The description of the coupon. + */ description?: string } export interface DiscountFilter { /** - * Type of the filter (category name, product name, product range, resource - * name, region or zone). + * Type of the filter (category name, product name, product range, resource name, region or zone). */ type: DiscountFilterType - /** Value of filter. */ + /** + * Value of filter. + */ value: string - /** Boolean to describe if filter is an excluding filter. */ + /** + * Boolean to describe if filter is an excluding filter. + */ exclude: boolean } export interface ListConsumptionsResponseConsumption { - /** Monetary value of the consumption. */ + /** + * Monetary value of the consumption. + */ value?: Money /** - * The product name. For example, "VPC Public Gateway S", "VPC Public Gateway - * M" for the VPC product. + * The product name. For example, "VPC Public Gateway S", "VPC Public Gateway M" for the VPC product. */ productName: string - /** Identifies the reference based on the category. */ + /** + * Identifies the reference based on the category. + */ resourceName: string - /** Unique identifier of the product. */ + /** + * Unique identifier of the product. + */ sku: string - /** Project ID of the consumption. */ + /** + * Project ID of the consumption. + */ projectId: string - /** Name of consumption category. */ + /** + * Name of consumption category. + */ categoryName: string - /** Unit of consumed quantity. */ + /** + * Unit of consumed quantity. + */ unit: string - /** Consumed quantity. */ + /** + * Consumed quantity. + */ billedQuantity: string } export interface Discount { - /** The ID of the discount. */ + /** + * The ID of the discount. + */ id: string - /** The creation date of the discount. */ + /** + * The creation date of the discount. + */ creationDate?: Date - /** The Organization ID of the discount. */ + /** + * The Organization ID of the discount. + */ organizationId: string - /** The description of the discount. */ + /** + * The description of the discount. + */ description: string - /** The initial value of the discount. */ + /** + * The initial value of the discount. + */ value: number - /** The value indicating how much of the discount has been used. */ + /** + * The value indicating how much of the discount has been used. + */ valueUsed: number - /** The remaining value of the discount. */ + /** + * The remaining value of the discount. + */ valueRemaining: number - /** The mode of the discount. */ + /** + * The mode of the discount. + */ mode: DiscountDiscountMode - /** The start date of the discount. */ + /** + * The start date of the discount. + */ startDate?: Date - /** The stop date of the discount. */ + /** + * The stop date of the discount. + */ stopDate?: Date - /** The description of the coupon. */ + /** + * The description of the coupon. + */ coupon?: DiscountCoupon - /** List of the discount scopes. */ + /** + * List of the discount scopes. + */ filters: DiscountFilter[] } export interface Invoice { - /** Invoice ID. */ + /** + * Invoice ID. + */ id: string organizationId: string organizationName: string - /** Start date of the billing period. */ + /** + * Start date of the billing period. + */ startDate?: Date stopDate?: Date - /** The billing period of the invoice in the YYYY-MM format. */ + /** + * The billing period of the invoice in the YYYY-MM format. + */ billingPeriod?: Date - /** Date when the invoice was sent to the customer. */ + /** + * Date when the invoice was sent to the customer. + */ issuedDate?: Date - /** Payment time limit, set according to the Organization's payment conditions. */ + /** + * Payment time limit, set according to the Organization's payment conditions. + */ dueDate?: Date - /** Total amount, untaxed. */ + /** + * Total amount, untaxed. + */ totalUntaxed?: Money - /** Total amount, taxed. */ + /** + * Total amount, taxed. + */ totalTaxed?: Money - /** The total tax amount of the invoice. */ + /** + * The total tax amount of the invoice. + */ totalTax?: Money - /** The total discount amount of the invoice. */ + /** + * The total discount amount of the invoice. + */ totalDiscount?: Money - /** The total amount of the invoice before applying the discount. */ + /** + * The total amount of the invoice before applying the discount. + */ totalUndiscount?: Money - /** Type of invoice, either periodic or purchase. */ + /** + * Type of invoice, either periodic or purchase. + */ type: InvoiceType - /** The state of the Invoice. */ + /** + * The state of the Invoice. + */ state: string - /** Invoice number. */ + /** + * Invoice number. + */ number: number - /** The name of the seller (Scaleway). */ + /** + * The name of the seller (Scaleway). + */ sellerName: string } export interface ListTaxesResponseTax { - /** Description of the tax applied. */ + /** + * Description of the tax applied. + */ description: string - /** The three-letter currency code. */ + /** + * The three-letter currency code. + */ currency: string - /** Applied tax rate (0.2 means a VAT of 20%). */ + /** + * Applied tax rate (0.2 means a VAT of 20%). + */ rate?: number - /** The total tax value of the consumption. */ + /** + * The total tax value of the consumption. + */ totalTaxValue?: number } export type DownloadInvoiceRequest = { - /** Invoice ID. */ + /** + * Invoice ID. + */ invoiceId: string - /** File type. PDF by default. */ + /** + * File type. PDF by default. + */ fileType?: DownloadInvoiceRequestFileType } export type ExportInvoicesRequest = { /** - * Organization ID. If specified, only invoices from this Organization will be - * returned. + * Organization ID. If specified, only invoices from this Organization will be returned. */ organizationId?: string - /** Return only invoice with start date greater than billing_period_start. */ + /** + * Return only invoice with start date greater than billing_period_start. + */ billingPeriodStartAfter?: Date - /** Return only invoice with start date less than billing_period_start. */ + /** + * Return only invoice with start date less than billing_period_start. + */ billingPeriodStartBefore?: Date - /** Invoice type. It can either be `periodic` or `purchase`. */ + /** + * Invoice type. It can either be `periodic` or `purchase`. + */ invoiceType?: InvoiceType - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Positive integer lower or equal to 100 to select the number of items to - * return. + * Positive integer lower or equal to 100 to select the number of items to return. */ pageSize?: number - /** How invoices are ordered in the response. */ + /** + * How invoices are ordered in the response. + */ orderBy?: ExportInvoicesRequestOrderBy - /** File format for exporting the invoice list. */ + /** + * File format for exporting the invoice list. + */ fileType?: ExportInvoicesRequestFileType } export type GetInvoiceRequest = { - /** Invoice ID. */ + /** + * Invoice ID. + */ invoiceId: string } export type ListConsumptionsRequest = { - /** Order consumptions list in the response by their update date. */ + /** + * Order consumptions list in the response by their update date. + */ orderBy?: ListConsumptionsRequestOrderBy - /** Positive integer to choose the page to return. */ + /** + * Positive integer to choose the page to return. + */ page?: number /** - * Positive integer lower or equal to 100 to select the number of items to - * return. + * Positive integer lower or equal to 100 to select the number of items to return. */ pageSize?: number /** * Filter by Organization ID. * - * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' could be set. */ organizationId?: string /** * Filter by Project ID. * - * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' could be set. */ projectId?: string /** - * Filter by name of a Category as they are shown in the invoice (Compute, - * Network, Observability). + * Filter by name of a Category as they are shown in the invoice (Compute, Network, Observability). */ categoryName?: string /** - * Filter by the billing period in the YYYY-MM format. If it is empty the - * current billing period will be used as default. + * Filter by the billing period in the YYYY-MM format. If it is empty the current billing period will be used as default. */ billingPeriod?: string } export interface ListConsumptionsResponse { - /** Detailed consumption list. */ + /** + * Detailed consumption list. + */ consumptions: ListConsumptionsResponseConsumption[] - /** Total number of returned items. */ + /** + * Total number of returned items. + */ totalCount: number /** - * Sum of all discounts, displayed only when no category or project ID filter - * is applied. + * Sum of all discounts, displayed only when no category or project ID filter is applied. */ totalDiscountUntaxedValue: number - /** Last consumption update date. */ + /** + * Last consumption update date. + */ updatedAt?: Date } export type ListDiscountsRequest = { - /** Order discounts in the response by their description. */ + /** + * Order discounts in the response by their description. + */ orderBy?: ListDiscountsRequestOrderBy - /** Positive integer to choose the page to return. */ + /** + * Positive integer to choose the page to return. + */ page?: number /** - * Positive integer lower or equal to 100 to select the number of items to - * return. + * Positive integer lower or equal to 100 to select the number of items to return. */ pageSize?: number - /** ID of the organization. */ + /** + * ID of the organization. + */ organizationId?: string } export interface ListDiscountsResponse { - /** Total number of discounts. */ + /** + * Total number of discounts. + */ totalCount: number - /** Paginated returned discounts. */ + /** + * Paginated returned discounts. + */ discounts: Discount[] } export type ListInvoicesRequest = { /** - * Organization ID. If specified, only invoices from this Organization will be - * returned. + * Organization ID. If specified, only invoices from this Organization will be returned. */ organizationId?: string - /** Return only invoice with start date greater than billing_period_start. */ + /** + * Return only invoice with start date greater than billing_period_start. + */ billingPeriodStartAfter?: Date - /** Return only invoice with start date less than billing_period_start. */ + /** + * Return only invoice with start date less than billing_period_start. + */ billingPeriodStartBefore?: Date - /** Invoice type. It can either be `periodic` or `purchase`. */ + /** + * Invoice type. It can either be `periodic` or `purchase`. + */ invoiceType?: InvoiceType - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Positive integer lower or equal to 100 to select the number of items to - * return. + * Positive integer lower or equal to 100 to select the number of items to return. */ pageSize?: number - /** How invoices are ordered in the response. */ + /** + * How invoices are ordered in the response. + */ orderBy?: ListInvoicesRequestOrderBy } export interface ListInvoicesResponse { - /** Total number of invoices. */ + /** + * Total number of invoices. + */ totalCount: number - /** Paginated returned invoices. */ + /** + * Paginated returned invoices. + */ invoices: Invoice[] } export type ListTaxesRequest = { - /** Order consumed taxes list in the response by their update date. */ + /** + * Order consumed taxes list in the response by their update date. + */ orderBy?: ListTaxesRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Positive integer lower or equal to 100 to select the number of items to - * return. + * Positive integer lower or equal to 100 to select the number of items to return. */ pageSize?: number - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string /** - * Filter by the billing period in the YYYY-MM format. If it is empty the - * current billing period will be used as default. + * Filter by the billing period in the YYYY-MM format. If it is empty the current billing period will be used as default. */ billingPeriod?: string } export interface ListTaxesResponse { - /** Detailed consumption tax. */ + /** + * Detailed consumption tax. + */ taxes: ListTaxesResponseTax[] - /** Total number of returned items. */ + /** + * Total number of returned items. + */ totalCount: number - /** Last consumption update date. */ + /** + * Last consumption update date. + */ updatedAt?: Date } diff --git a/packages/clients/src/api/block/v1/api.gen.ts b/packages/clients/src/api/block/v1/api.gen.ts index 6ff151ba7..117503bd1 100644 --- a/packages/clients/src/api/block/v1/api.gen.ts +++ b/packages/clients/src/api/block/v1/api.gen.ts @@ -52,8 +52,8 @@ const jsonContentHeaders = { /** * Block Storage API. - * - * This API allows you to manage your Block Storage volumes. + +This API allows you to manage your Block Storage volumes. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -88,8 +88,7 @@ export class API extends ParentAPI { ) /** - * List volume types. List all available volume types in a specified zone. The - * volume types listed are ordered by name in ascending order. + * List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order. * * @param request - The request {@link ListVolumeTypesRequest} * @returns A Promise of ListVolumeTypesResponse @@ -120,9 +119,7 @@ export class API extends ParentAPI { ) /** - * List volumes. List all existing volumes in a specified zone. By default, - * the volumes listed are ordered by creation date in ascending order. This - * can be modified via the `order_by` field. + * List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. * * @param request - The request {@link ListVolumesRequest} * @returns A Promise of ListVolumesResponse @@ -131,12 +128,8 @@ export class API extends ParentAPI { enrichForPagination('volumes', this.pageOfListVolumes, request) /** - * Create a volume. To create a new volume from scratch, you must specify - * `from_empty` and the `size`. To create a volume from an existing snapshot, - * specify `from_snapshot` and the `snapshot_id` in the request payload - * instead, size is optional and can be specified if you need to extend the - * original size. The volume will take on the same volume class and underlying - * IOPS limitations as the original snapshot. + * Create a volume. To create a new volume from scratch, you must specify `from_empty` and the `size`. +To create a volume from an existing snapshot, specify `from_snapshot` and the `snapshot_id` in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot. * * @param request - The request {@link CreateVolumeRequest} * @returns A Promise of Volume @@ -155,8 +148,7 @@ export class API extends ParentAPI { ) /** - * Get a volume. Retrieve technical information about a specific volume. - * Details such as size, type, and status are returned in the response. + * Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response. * * @param request - The request {@link GetVolumeRequest} * @returns A Promise of Volume @@ -193,8 +185,7 @@ export class API extends ParentAPI { ) /** - * Delete a detached volume. You must specify the `volume_id` of the volume - * you want to delete. The volume must not be in the `in_use` status. + * Delete a detached volume. You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status. * * @param request - The request {@link DeleteVolumeRequest} */ @@ -205,10 +196,8 @@ export class API extends ParentAPI { }) /** - * Update a volume. Update the technical details of a volume, such as its - * name, tags, or its new size and `volume_type` (within the same Block - * Storage class). You can only resize a volume to a larger size. It is - * currently not possible to change your Block Storage Class. + * Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and `volume_type` (within the same Block Storage class). +You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class. * * @param request - The request {@link UpdateVolumeRequest} * @returns A Promise of Volume @@ -251,9 +240,7 @@ export class API extends ParentAPI { ) /** - * List all snapshots. List all available snapshots in a specified zone. By - * default, the snapshots listed are ordered by creation date in ascending - * order. This can be modified via the `order_by` field. + * List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. * * @param request - The request {@link ListSnapshotsRequest} * @returns A Promise of ListSnapshotsResponse @@ -262,9 +249,7 @@ export class API extends ParentAPI { enrichForPagination('snapshots', this.pageOfListSnapshots, request) /** - * Get a snapshot. Retrieve technical information about a specific snapshot. - * Details such as size, volume type, and status are returned in the - * response. + * Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response. * * @param request - The request {@link GetSnapshotRequest} * @returns A Promise of Snapshot @@ -301,9 +286,8 @@ export class API extends ParentAPI { ) /** - * Create a snapshot of a volume. To create a snapshot, the volume must be in - * the `in_use` or the `available` status. If your volume is in a transient - * state, you need to wait until the end of the current operation. + * Create a snapshot of a volume. To create a snapshot, the volume must be in the `in_use` or the `available` status. +If your volume is in a transient state, you need to wait until the end of the current operation. * * @param request - The request {@link CreateSnapshotRequest} * @returns A Promise of Snapshot @@ -322,9 +306,8 @@ export class API extends ParentAPI { ) /** - * Import a snapshot from a Scaleway Object Storage bucket. The bucket must - * contain a QCOW2 image. The bucket can be imported into any Availability - * Zone as long as it is in the same region as the bucket. + * Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image. +The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket. * * @param request - The request {@link ImportSnapshotFromObjectStorageRequest} * @returns A Promise of Snapshot @@ -348,8 +331,8 @@ export class API extends ParentAPI { ) /** - * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is - * exported in QCOW2 format. The snapshot must not be in transient state. + * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format. +The snapshot must not be in transient state. * * @param request - The request {@link ExportSnapshotToObjectStorageRequest} * @returns A Promise of Snapshot @@ -373,8 +356,7 @@ export class API extends ParentAPI { ) /** - * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you - * want to delete. The snapshot must not be in use. + * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use. * * @param request - The request {@link DeleteSnapshotRequest} */ diff --git a/packages/clients/src/api/block/v1/types.gen.ts b/packages/clients/src/api/block/v1/types.gen.ts index 5ff8ed5ca..d8515b33d 100644 --- a/packages/clients/src/api/block/v1/types.gen.ts +++ b/packages/clients/src/api/block/v1/types.gen.ts @@ -56,161 +56,251 @@ export type VolumeStatus = | 'updating' export interface Reference { - /** UUID of the reference. */ + /** + * UUID of the reference. + */ id: string - /** Type of resource to which the reference is associated. */ + /** + * Type of resource to which the reference is associated. + */ productResourceType: string /** - * UUID of the product resource it refers to (according to the - * product_resource_type). + * UUID of the product resource it refers to (according to the product_resource_type). */ productResourceId: string - /** Creation date of the reference. */ + /** + * Creation date of the reference. + */ createdAt?: Date - /** Type of reference (link, exclusive, read_only). */ + /** + * Type of reference (link, exclusive, read_only). + */ type: ReferenceType /** - * Status of the reference. Statuses include `attaching`, `attached`, and - * `detaching`. + * Status of the reference. Statuses include `attaching`, `attached`, and `detaching`. */ status: ReferenceStatus } export interface SnapshotParentVolume { - /** Parent volume UUID (volume from which the snapshot originates). */ + /** + * Parent volume UUID (volume from which the snapshot originates). + */ id: string - /** Name of the parent volume. */ + /** + * Name of the parent volume. + */ name: string - /** Volume type of the parent volume. */ + /** + * Volume type of the parent volume. + */ type: string - /** Current status the parent volume. */ + /** + * Current status the parent volume. + */ status: VolumeStatus } export interface VolumeSpecifications { /** - * The maximum IO/s expected, according to the different options available in - * stock (`5000 | 15000`). + * The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). */ perfIops?: number - /** The storage class of the volume. */ + /** + * The storage class of the volume. + */ class: StorageClass } export interface CreateVolumeRequestFromEmpty { - /** Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. */ + /** + * Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. + */ size: number } export interface CreateVolumeRequestFromSnapshot { /** * Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. - * Size is optional and is used only if a resize of the volume is requested, - * otherwise original snapshot size will be used. +Size is optional and is used only if a resize of the volume is requested, otherwise original snapshot size will be used. */ size?: number - /** Source snapshot from which volume will be created. */ + /** + * Source snapshot from which volume will be created. + */ snapshotId: string } export interface Snapshot { - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ id: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** If the parent volume was deleted, value is null. */ + /** + * If the parent volume was deleted, value is null. + */ parentVolume?: SnapshotParentVolume - /** Size in bytes of the snapshot. */ + /** + * Size in bytes of the snapshot. + */ size: number - /** UUID of the project the snapshot belongs to. */ + /** + * UUID of the project the snapshot belongs to. + */ projectId: string - /** Creation date of the snapshot. */ + /** + * Creation date of the snapshot. + */ createdAt?: Date - /** Last modification date of the properties of a snapshot. */ + /** + * Last modification date of the properties of a snapshot. + */ updatedAt?: Date - /** List of the references to the snapshot. */ + /** + * List of the references to the snapshot. + */ references: Reference[] - /** Current status of the snapshot (available, in_use, ...). */ + /** + * Current status of the snapshot (available, in_use, ...). + */ status: SnapshotStatus - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags: string[] - /** Snapshot zone. */ + /** + * Snapshot zone. + */ zone: ScwZone - /** Storage class of the snapshot. */ + /** + * Storage class of the snapshot. + */ class: StorageClass } export interface VolumeType { - /** Volume type. */ + /** + * Volume type. + */ type: string - /** Price of the volume billed in GB/hour. */ + /** + * Price of the volume billed in GB/hour. + */ pricing?: Money - /** Price of the snapshot billed in GB/hour. */ + /** + * Price of the snapshot billed in GB/hour. + */ snapshotPricing?: Money - /** Volume specifications of the volume type. */ + /** + * Volume specifications of the volume type. + */ specs?: VolumeSpecifications } export interface Volume { - /** UUID of the volume. */ + /** + * UUID of the volume. + */ id: string - /** Name of the volume. */ + /** + * Name of the volume. + */ name: string - /** Volume type. */ + /** + * Volume type. + */ type: string - /** Volume size in bytes. */ + /** + * Volume size in bytes. + */ size: number - /** UUID of the project to which the volume belongs. */ + /** + * UUID of the project to which the volume belongs. + */ projectId: string - /** Creation date of the volume. */ + /** + * Creation date of the volume. + */ createdAt?: Date - /** Last update of the properties of a volume. */ + /** + * Last update of the properties of a volume. + */ updatedAt?: Date - /** List of the references to the volume. */ + /** + * List of the references to the volume. + */ references: Reference[] /** - * When a volume is created from a snapshot, is the UUID of the snapshot from - * which the volume has been created. + * When a volume is created from a snapshot, is the UUID of the snapshot from which the volume has been created. */ parentSnapshotId?: string - /** Current status of the volume (available, in_use, ...). */ + /** + * Current status of the volume (available, in_use, ...). + */ status: VolumeStatus - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags: string[] - /** Volume zone. */ + /** + * Volume zone. + */ zone: ScwZone - /** Specifications of the volume. */ + /** + * Specifications of the volume. + */ specs?: VolumeSpecifications - /** Last time the volume was detached. */ + /** + * Last time the volume was detached. + */ lastDetachedAt?: Date } export type CreateSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume to snapshot. */ + /** + * UUID of the volume to snapshot. + */ volumeId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** UUID of the project to which the volume and the snapshot belong. */ + /** + * UUID of the project to which the volume and the snapshot belong. + */ projectId?: string - /** List of tags assigned to the snapshot. */ + /** + * List of tags assigned to the snapshot. + */ tags?: string[] } export type CreateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Name of the volume. */ + /** + * Name of the volume. + */ name?: string /** - * The maximum IO/s expected, according to the different options available in - * stock (`5000 | 15000`). + * The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). * * One-of ('requirements'): at most one of 'perfIops' could be set. */ perfIops?: number - /** UUID of the project the volume belongs to. */ + /** + * UUID of the project the volume belongs to. + */ projectId?: string /** * Specify the size of the new volume if creating a new one from scratch. @@ -224,184 +314,275 @@ export type CreateVolumeRequest = { * One-of ('from'): at most one of 'fromEmpty', 'fromSnapshot' could be set. */ fromSnapshot?: CreateVolumeRequestFromSnapshot - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags?: string[] } export type DeleteSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string } export type DeleteVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId: string } export type ExportSnapshotToObjectStorageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string - /** Scaleway Object Storage bucket where the object is stored. */ + /** + * Scaleway Object Storage bucket where the object is stored. + */ bucket: string - /** The object key inside the given bucket. */ + /** + * The object key inside the given bucket. + */ key: string } export type GetSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string } export type GetVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId: string } export type ImportSnapshotFromObjectStorageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Scaleway Object Storage bucket where the object is stored. */ + /** + * Scaleway Object Storage bucket where the object is stored. + */ bucket: string - /** The object key inside the given bucket. */ + /** + * The object key inside the given bucket. + */ key: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** UUID of the Project to which the volume and the snapshot belong. */ + /** + * UUID of the Project to which the volume and the snapshot belong. + */ projectId?: string - /** List of tags assigned to the snapshot. */ + /** + * List of tags assigned to the snapshot. + */ tags?: string[] - /** Size of the snapshot. */ + /** + * Size of the snapshot. + */ size?: number } export type ListSnapshotsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Criteria to use when ordering the list. */ + /** + * Criteria to use when ordering the list. + */ orderBy?: ListSnapshotsRequestOrderBy - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Page size, defines how many entries are returned in one page, must be lower - * or equal to 100. + * Page size, defines how many entries are returned in one page, must be lower or equal to 100. */ pageSize?: number - /** Filter snapshots by the ID of the original volume. */ + /** + * Filter snapshots by the ID of the original volume. + */ volumeId?: string - /** Filter snapshots by their names. */ + /** + * Filter snapshots by their names. + */ name?: string /** - * Filter by tags. Only snapshots with one or more matching tags will be - * returned. + * Filter by tags. Only snapshots with one or more matching tags will be returned. */ tags?: string[] } export interface ListSnapshotsResponse { - /** Paginated returned list of snapshots. */ + /** + * Paginated returned list of snapshots. + */ snapshots: Snapshot[] - /** Total number of snpashots in the project. */ + /** + * Total number of snpashots in the project. + */ totalCount: number } export type ListVolumeTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Page size, defines how many entries are returned in one page, must be lower - * or equal to 100. + * Page size, defines how many entries are returned in one page, must be lower or equal to 100. */ pageSize?: number } export interface ListVolumeTypesResponse { - /** Returns paginated list of volume-types. */ + /** + * Returns paginated list of volume-types. + */ volumeTypes: VolumeType[] - /** Total number of volume-types currently available in stock. */ + /** + * Total number of volume-types currently available in stock. + */ totalCount: number } export type ListVolumesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Criteria to use when ordering the list. */ + /** + * Criteria to use when ordering the list. + */ orderBy?: ListVolumesRequestOrderBy - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Page size, defines how many entries are returned in one page, must be lower - * or equal to 100. + * Page size, defines how many entries are returned in one page, must be lower or equal to 100. */ pageSize?: number - /** Filter the return volumes by their names. */ + /** + * Filter the return volumes by their names. + */ name?: string /** - * Filter by a product resource ID linked to this volume (such as an Instance - * ID). + * Filter by a product resource ID linked to this volume (such as an Instance ID). */ productResourceId?: string /** - * Filter by tags. Only volumes with one or more matching tags will be - * returned. + * Filter by tags. Only volumes with one or more matching tags will be returned. */ tags?: string[] } export interface ListVolumesResponse { - /** Paginated returned list of volumes. */ + /** + * Paginated returned list of volumes. + */ volumes: Volume[] - /** Total number of volumes in the project. */ + /** + * Total number of volumes in the project. + */ totalCount: number } export type UpdateSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string - /** When defined, is the name of the snapshot. */ + /** + * When defined, is the name of the snapshot. + */ name?: string - /** List of tags assigned to the snapshot. */ + /** + * List of tags assigned to the snapshot. + */ tags?: string[] } export type UpdateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId: string - /** When defined, is the new name of the volume. */ + /** + * When defined, is the new name of the volume. + */ name?: string /** - * Size in bytes of the volume, with a granularity of 1 GB (10^9 bytes). Must - * be compliant with the minimum (1GB) and maximum (10TB) allowed size. + * Size in bytes of the volume, with a granularity of 1 GB (10^9 bytes). +Must be compliant with the minimum (1GB) and maximum (10TB) allowed size. */ size?: number - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags?: string[] /** - * The selected value must be available for the volume's current storage - * class. + * The selected value must be available for the volume's current storage class. */ perfIops?: number } diff --git a/packages/clients/src/api/block/v1alpha1/api.gen.ts b/packages/clients/src/api/block/v1alpha1/api.gen.ts index 945d7bbc0..b956172b9 100644 --- a/packages/clients/src/api/block/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/block/v1alpha1/api.gen.ts @@ -54,8 +54,8 @@ const jsonContentHeaders = { /** * Block Storage API. - * - * This API allows you to manage your Block Storage volumes. + +This API allows you to manage your Block Storage volumes. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -90,8 +90,7 @@ export class API extends ParentAPI { ) /** - * List volume types. List all available volume types in a specified zone. The - * volume types listed are ordered by name in ascending order. + * List volume types. List all available volume types in a specified zone. The volume types listed are ordered by name in ascending order. * * @param request - The request {@link ListVolumeTypesRequest} * @returns A Promise of ListVolumeTypesResponse @@ -122,9 +121,7 @@ export class API extends ParentAPI { ) /** - * List volumes. List all existing volumes in a specified zone. By default, - * the volumes listed are ordered by creation date in ascending order. This - * can be modified via the `order_by` field. + * List volumes. List all existing volumes in a specified zone. By default, the volumes listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. * * @param request - The request {@link ListVolumesRequest} * @returns A Promise of ListVolumesResponse @@ -133,12 +130,8 @@ export class API extends ParentAPI { enrichForPagination('volumes', this.pageOfListVolumes, request) /** - * Create a volume. To create a new volume from scratch, you must specify - * `from_empty` and the `size`. To create a volume from an existing snapshot, - * specify `from_snapshot` and the `snapshot_id` in the request payload - * instead, size is optional and can be specified if you need to extend the - * original size. The volume will take on the same volume class and underlying - * IOPS limitations as the original snapshot. + * Create a volume. To create a new volume from scratch, you must specify `from_empty` and the `size`. +To create a volume from an existing snapshot, specify `from_snapshot` and the `snapshot_id` in the request payload instead, size is optional and can be specified if you need to extend the original size. The volume will take on the same volume class and underlying IOPS limitations as the original snapshot. * * @param request - The request {@link CreateVolumeRequest} * @returns A Promise of Volume @@ -157,8 +150,7 @@ export class API extends ParentAPI { ) /** - * Get a volume. Retrieve technical information about a specific volume. - * Details such as size, type, and status are returned in the response. + * Get a volume. Retrieve technical information about a specific volume. Details such as size, type, and status are returned in the response. * * @param request - The request {@link GetVolumeRequest} * @returns A Promise of Volume @@ -195,8 +187,7 @@ export class API extends ParentAPI { ) /** - * Delete a detached volume. You must specify the `volume_id` of the volume - * you want to delete. The volume must not be in the `in_use` status. + * Delete a detached volume. You must specify the `volume_id` of the volume you want to delete. The volume must not be in the `in_use` status. * * @param request - The request {@link DeleteVolumeRequest} */ @@ -207,10 +198,8 @@ export class API extends ParentAPI { }) /** - * Update a volume. Update the technical details of a volume, such as its - * name, tags, or its new size and `volume_type` (within the same Block - * Storage class). You can only resize a volume to a larger size. It is - * currently not possible to change your Block Storage Class. + * Update a volume. Update the technical details of a volume, such as its name, tags, or its new size and `volume_type` (within the same Block Storage class). +You can only resize a volume to a larger size. It is currently not possible to change your Block Storage Class. * * @param request - The request {@link UpdateVolumeRequest} * @returns A Promise of Volume @@ -253,9 +242,7 @@ export class API extends ParentAPI { ) /** - * List all snapshots. List all available snapshots in a specified zone. By - * default, the snapshots listed are ordered by creation date in ascending - * order. This can be modified via the `order_by` field. + * List all snapshots. List all available snapshots in a specified zone. By default, the snapshots listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. * * @param request - The request {@link ListSnapshotsRequest} * @returns A Promise of ListSnapshotsResponse @@ -264,9 +251,7 @@ export class API extends ParentAPI { enrichForPagination('snapshots', this.pageOfListSnapshots, request) /** - * Get a snapshot. Retrieve technical information about a specific snapshot. - * Details such as size, volume type, and status are returned in the - * response. + * Get a snapshot. Retrieve technical information about a specific snapshot. Details such as size, volume type, and status are returned in the response. * * @param request - The request {@link GetSnapshotRequest} * @returns A Promise of Snapshot @@ -303,9 +288,8 @@ export class API extends ParentAPI { ) /** - * Create a snapshot of a volume. To create a snapshot, the volume must be in - * the `in_use` or the `available` status. If your volume is in a transient - * state, you need to wait until the end of the current operation. + * Create a snapshot of a volume. To create a snapshot, the volume must be in the `in_use` or the `available` status. +If your volume is in a transient state, you need to wait until the end of the current operation. * * @param request - The request {@link CreateSnapshotRequest} * @returns A Promise of Snapshot @@ -324,10 +308,9 @@ export class API extends ParentAPI { ) /** - * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a - * snapshot from a Scaleway Object Storage bucket The bucket must contain a - * QCOW2 image. The bucket can be imported into any Availability Zone as long - * as it is in the same region as the bucket. + * (Deprecated in favor of `ImportSnapshotFromObjectStorage`). Import a snapshot from a Scaleway Object Storage bucket +The bucket must contain a QCOW2 image. +The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket. * * @deprecated * @param request - The request {@link ImportSnapshotFromS3Request} @@ -347,9 +330,8 @@ export class API extends ParentAPI { ) /** - * Import a snapshot from a Scaleway Object Storage bucket. The bucket must - * contain a QCOW2 image. The bucket can be imported into any Availability - * Zone as long as it is in the same region as the bucket. + * Import a snapshot from a Scaleway Object Storage bucket. The bucket must contain a QCOW2 image. +The bucket can be imported into any Availability Zone as long as it is in the same region as the bucket. * * @param request - The request {@link ImportSnapshotFromObjectStorageRequest} * @returns A Promise of Snapshot @@ -373,8 +355,8 @@ export class API extends ParentAPI { ) /** - * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is - * exported in QCOW2 format. The snapshot must not be in transient state. + * Export a snapshot to a Scaleway Object Storage bucket. The snapshot is exported in QCOW2 format. +The snapshot must not be in transient state. * * @param request - The request {@link ExportSnapshotToObjectStorageRequest} * @returns A Promise of Snapshot @@ -398,8 +380,7 @@ export class API extends ParentAPI { ) /** - * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you - * want to delete. The snapshot must not be in use. + * Delete a snapshot. You must specify the `snapshot_id` of the snapshot you want to delete. The snapshot must not be in use. * * @param request - The request {@link DeleteSnapshotRequest} */ diff --git a/packages/clients/src/api/block/v1alpha1/types.gen.ts b/packages/clients/src/api/block/v1alpha1/types.gen.ts index d16f1f544..59d6355e2 100644 --- a/packages/clients/src/api/block/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/block/v1alpha1/types.gen.ts @@ -56,161 +56,251 @@ export type VolumeStatus = | 'updating' export interface Reference { - /** UUID of the reference. */ + /** + * UUID of the reference. + */ id: string - /** Type of resource to which the reference is associated. */ + /** + * Type of resource to which the reference is associated. + */ productResourceType: string /** - * UUID of the product resource it refers to (according to the - * product_resource_type). + * UUID of the product resource it refers to (according to the product_resource_type). */ productResourceId: string - /** Creation date of the reference. */ + /** + * Creation date of the reference. + */ createdAt?: Date - /** Type of reference (link, exclusive, read_only). */ + /** + * Type of reference (link, exclusive, read_only). + */ type: ReferenceType /** - * Status of the reference. Statuses include `attaching`, `attached`, and - * `detaching`. + * Status of the reference. Statuses include `attaching`, `attached`, and `detaching`. */ status: ReferenceStatus } export interface SnapshotParentVolume { - /** Parent volume UUID (volume from which the snapshot originates). */ + /** + * Parent volume UUID (volume from which the snapshot originates). + */ id: string - /** Name of the parent volume. */ + /** + * Name of the parent volume. + */ name: string - /** Volume type of the parent volume. */ + /** + * Volume type of the parent volume. + */ type: string - /** Current status the parent volume. */ + /** + * Current status the parent volume. + */ status: VolumeStatus } export interface VolumeSpecifications { /** - * The maximum IO/s expected, according to the different options available in - * stock (`5000 | 15000`). + * The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). */ perfIops?: number - /** The storage class of the volume. */ + /** + * The storage class of the volume. + */ class: StorageClass } export interface CreateVolumeRequestFromEmpty { - /** Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. */ + /** + * Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. + */ size: number } export interface CreateVolumeRequestFromSnapshot { /** * Must be compliant with the minimum (1 GB) and maximum (10 TB) allowed size. - * Size is optional and is used only if a resize of the volume is requested, - * otherwise original snapshot size will be used. +Size is optional and is used only if a resize of the volume is requested, otherwise original snapshot size will be used. */ size?: number - /** Source snapshot from which volume will be created. */ + /** + * Source snapshot from which volume will be created. + */ snapshotId: string } export interface Snapshot { - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ id: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** If the parent volume was deleted, value is null. */ + /** + * If the parent volume was deleted, value is null. + */ parentVolume?: SnapshotParentVolume - /** Size in bytes of the snapshot. */ + /** + * Size in bytes of the snapshot. + */ size: number - /** UUID of the project the snapshot belongs to. */ + /** + * UUID of the project the snapshot belongs to. + */ projectId: string - /** Creation date of the snapshot. */ + /** + * Creation date of the snapshot. + */ createdAt?: Date - /** Last modification date of the properties of a snapshot. */ + /** + * Last modification date of the properties of a snapshot. + */ updatedAt?: Date - /** List of the references to the snapshot. */ + /** + * List of the references to the snapshot. + */ references: Reference[] - /** Current status of the snapshot (available, in_use, ...). */ + /** + * Current status of the snapshot (available, in_use, ...). + */ status: SnapshotStatus - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags: string[] - /** Snapshot zone. */ + /** + * Snapshot zone. + */ zone: ScwZone - /** Storage class of the snapshot. */ + /** + * Storage class of the snapshot. + */ class: StorageClass } export interface VolumeType { - /** Volume type. */ + /** + * Volume type. + */ type: string - /** Price of the volume billed in GB/hour. */ + /** + * Price of the volume billed in GB/hour. + */ pricing?: Money - /** Price of the snapshot billed in GB/hour. */ + /** + * Price of the snapshot billed in GB/hour. + */ snapshotPricing?: Money - /** Volume specifications of the volume type. */ + /** + * Volume specifications of the volume type. + */ specs?: VolumeSpecifications } export interface Volume { - /** UUID of the volume. */ + /** + * UUID of the volume. + */ id: string - /** Name of the volume. */ + /** + * Name of the volume. + */ name: string - /** Volume type. */ + /** + * Volume type. + */ type: string - /** Volume size in bytes. */ + /** + * Volume size in bytes. + */ size: number - /** UUID of the project to which the volume belongs. */ + /** + * UUID of the project to which the volume belongs. + */ projectId: string - /** Creation date of the volume. */ + /** + * Creation date of the volume. + */ createdAt?: Date - /** Last update of the properties of a volume. */ + /** + * Last update of the properties of a volume. + */ updatedAt?: Date - /** List of the references to the volume. */ + /** + * List of the references to the volume. + */ references: Reference[] /** - * When a volume is created from a snapshot, is the UUID of the snapshot from - * which the volume has been created. + * When a volume is created from a snapshot, is the UUID of the snapshot from which the volume has been created. */ parentSnapshotId?: string - /** Current status of the volume (available, in_use, ...). */ + /** + * Current status of the volume (available, in_use, ...). + */ status: VolumeStatus - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags: string[] - /** Volume zone. */ + /** + * Volume zone. + */ zone: ScwZone - /** Specifications of the volume. */ + /** + * Specifications of the volume. + */ specs?: VolumeSpecifications - /** Last time the volume was detached. */ + /** + * Last time the volume was detached. + */ lastDetachedAt?: Date } export type CreateSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume to snapshot. */ + /** + * UUID of the volume to snapshot. + */ volumeId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** UUID of the project to which the volume and the snapshot belong. */ + /** + * UUID of the project to which the volume and the snapshot belong. + */ projectId?: string - /** List of tags assigned to the snapshot. */ + /** + * List of tags assigned to the snapshot. + */ tags?: string[] } export type CreateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Name of the volume. */ + /** + * Name of the volume. + */ name?: string /** - * The maximum IO/s expected, according to the different options available in - * stock (`5000 | 15000`). + * The maximum IO/s expected, according to the different options available in stock (`5000 | 15000`). * * One-of ('requirements'): at most one of 'perfIops' could be set. */ perfIops?: number - /** UUID of the project the volume belongs to. */ + /** + * UUID of the project the volume belongs to. + */ projectId?: string /** * Specify the size of the new volume if creating a new one from scratch. @@ -224,201 +314,306 @@ export type CreateVolumeRequest = { * One-of ('from'): at most one of 'fromEmpty', 'fromSnapshot' could be set. */ fromSnapshot?: CreateVolumeRequestFromSnapshot - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags?: string[] } export type DeleteSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string } export type DeleteVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId: string } export type ExportSnapshotToObjectStorageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string - /** Scaleway Object Storage bucket where the object is stored. */ + /** + * Scaleway Object Storage bucket where the object is stored. + */ bucket: string - /** The object key inside the given bucket. */ + /** + * The object key inside the given bucket. + */ key: string } export type GetSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string } export type GetVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId: string } export type ImportSnapshotFromObjectStorageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Scaleway Object Storage bucket where the object is stored. */ + /** + * Scaleway Object Storage bucket where the object is stored. + */ bucket: string - /** The object key inside the given bucket. */ + /** + * The object key inside the given bucket. + */ key: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** UUID of the Project to which the volume and the snapshot belong. */ + /** + * UUID of the Project to which the volume and the snapshot belong. + */ projectId?: string - /** List of tags assigned to the snapshot. */ + /** + * List of tags assigned to the snapshot. + */ tags?: string[] - /** Size of the snapshot. */ + /** + * Size of the snapshot. + */ size?: number } export type ImportSnapshotFromS3Request = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Scaleway Object Storage bucket where the object is stored. */ + /** + * Scaleway Object Storage bucket where the object is stored. + */ bucket: string - /** The object key inside the given bucket. */ + /** + * The object key inside the given bucket. + */ key: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** UUID of the Project to which the volume and the snapshot belong. */ + /** + * UUID of the Project to which the volume and the snapshot belong. + */ projectId?: string - /** List of tags assigned to the snapshot. */ + /** + * List of tags assigned to the snapshot. + */ tags?: string[] - /** Size of the snapshot. */ + /** + * Size of the snapshot. + */ size?: number } export type ListSnapshotsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Criteria to use when ordering the list. */ + /** + * Criteria to use when ordering the list. + */ orderBy?: ListSnapshotsRequestOrderBy - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Page size, defines how many entries are returned in one page, must be lower - * or equal to 100. + * Page size, defines how many entries are returned in one page, must be lower or equal to 100. */ pageSize?: number - /** Filter snapshots by the ID of the original volume. */ + /** + * Filter snapshots by the ID of the original volume. + */ volumeId?: string - /** Filter snapshots by their names. */ + /** + * Filter snapshots by their names. + */ name?: string /** - * Filter by tags. Only snapshots with one or more matching tags will be - * returned. + * Filter by tags. Only snapshots with one or more matching tags will be returned. */ tags?: string[] } export interface ListSnapshotsResponse { - /** Paginated returned list of snapshots. */ + /** + * Paginated returned list of snapshots. + */ snapshots: Snapshot[] - /** Total number of snpashots in the project. */ + /** + * Total number of snpashots in the project. + */ totalCount: number } export type ListVolumeTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Page size, defines how many entries are returned in one page, must be lower - * or equal to 100. + * Page size, defines how many entries are returned in one page, must be lower or equal to 100. */ pageSize?: number } export interface ListVolumeTypesResponse { - /** Returns paginated list of volume-types. */ + /** + * Returns paginated list of volume-types. + */ volumeTypes: VolumeType[] - /** Total number of volume-types currently available in stock. */ + /** + * Total number of volume-types currently available in stock. + */ totalCount: number } export type ListVolumesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Criteria to use when ordering the list. */ + /** + * Criteria to use when ordering the list. + */ orderBy?: ListVolumesRequestOrderBy - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Page number. */ + /** + * Page number. + */ page?: number /** - * Page size, defines how many entries are returned in one page, must be lower - * or equal to 100. + * Page size, defines how many entries are returned in one page, must be lower or equal to 100. */ pageSize?: number - /** Filter the return volumes by their names. */ + /** + * Filter the return volumes by their names. + */ name?: string /** - * Filter by a product resource ID linked to this volume (such as an Instance - * ID). + * Filter by a product resource ID linked to this volume (such as an Instance ID). */ productResourceId?: string /** - * Filter by tags. Only volumes with one or more matching tags will be - * returned. + * Filter by tags. Only volumes with one or more matching tags will be returned. */ tags?: string[] } export interface ListVolumesResponse { - /** Paginated returned list of volumes. */ + /** + * Paginated returned list of volumes. + */ volumes: Volume[] - /** Total number of volumes in the project. */ + /** + * Total number of volumes in the project. + */ totalCount: number } export type UpdateSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string - /** When defined, is the name of the snapshot. */ + /** + * When defined, is the name of the snapshot. + */ name?: string - /** List of tags assigned to the snapshot. */ + /** + * List of tags assigned to the snapshot. + */ tags?: string[] } export type UpdateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId: string - /** When defined, is the new name of the volume. */ + /** + * When defined, is the new name of the volume. + */ name?: string /** - * Size in bytes of the volume, with a granularity of 1 GB (10^9 bytes). Must - * be compliant with the minimum (1GB) and maximum (10TB) allowed size. + * Size in bytes of the volume, with a granularity of 1 GB (10^9 bytes). +Must be compliant with the minimum (1GB) and maximum (10TB) allowed size. */ size?: number - /** List of tags assigned to the volume. */ + /** + * List of tags assigned to the volume. + */ tags?: string[] /** - * The selected value must be available for the volume's current storage - * class. + * The selected value must be available for the volume's current storage class. */ perfIops?: number } diff --git a/packages/clients/src/api/cockpit/v1/api.gen.ts b/packages/clients/src/api/cockpit/v1/api.gen.ts index 2b6f257d9..917abad48 100644 --- a/packages/clients/src/api/cockpit/v1/api.gen.ts +++ b/packages/clients/src/api/cockpit/v1/api.gen.ts @@ -100,14 +100,13 @@ const jsonContentHeaders = { /** * Cockpit Global API. - * - * The Cockpit Global API allows you to manage your Cockpit's Grafana and plans. + +The Cockpit Global API allows you to manage your Cockpit's Grafana and plans. */ export class GlobalAPI extends ParentAPI { /** - * Get your Cockpit's Grafana. Retrieve information on your Cockpit's Grafana, - * specified by the ID of the Project the Cockpit belongs to. The output - * returned displays the URL to access your Cockpit's Grafana. + * Get your Cockpit's Grafana. Retrieve information on your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to. +The output returned displays the URL to access your Cockpit's Grafana. * * @param request - The request {@link GlobalApiGetGrafanaRequest} * @returns A Promise of Grafana @@ -126,9 +125,7 @@ export class GlobalAPI extends ParentAPI { ) /** - * Synchronize Grafana data sources. Trigger the synchronization of all your - * data sources and the alert manager in the relevant regions. The alert - * manager will only be synchronized if you have enabled it. + * Synchronize Grafana data sources. Trigger the synchronization of all your data sources and the alert manager in the relevant regions. The alert manager will only be synchronized if you have enabled it. * * @param request - The request {@link GlobalApiSyncGrafanaDataSourcesRequest} */ @@ -148,12 +145,8 @@ export class GlobalAPI extends ParentAPI { }) /** - * Create a Grafana user. Create a Grafana user to connect to your Cockpit's - * Grafana. Upon creation, your user password displays only once, so make sure - * that you save it. Each Grafana user is associated with a role: viewer or - * editor. A viewer can only view dashboards, whereas an editor can create and - * edit dashboards. Note that the `admin` username is not available for - * creation. + * Create a Grafana user. Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it. +Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation. * * @param request - The request {@link GlobalApiCreateGrafanaUserRequest} * @returns A Promise of GrafanaUser @@ -198,9 +191,7 @@ export class GlobalAPI extends ParentAPI { ) /** - * List Grafana users. List all Grafana users created in your Cockpit's - * Grafana. By default, the Grafana users returned in the list are ordered in - * ascending order. + * List Grafana users. List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order. * * @param request - The request {@link GlobalApiListGrafanaUsersRequest} * @returns A Promise of ListGrafanaUsersResponse @@ -210,9 +201,7 @@ export class GlobalAPI extends ParentAPI { ) => enrichForPagination('grafanaUsers', this.pageOfListGrafanaUsers, request) /** - * Delete a Grafana user. Delete a Grafana user from your Cockpit's Grafana, - * specified by the ID of the Project the Cockpit belongs to, and the ID of - * the Grafana user. + * Delete a Grafana user. Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. * * @param request - The request {@link GlobalApiDeleteGrafanaUserRequest} */ @@ -227,13 +216,10 @@ export class GlobalAPI extends ParentAPI { }) /** - * Reset a Grafana user password. Reset the password of a Grafana user, - * specified by the ID of the Project the Cockpit belongs to, and the ID of - * the Grafana user. A new password regenerates and only displays once. Make - * sure that you save it. + * Reset a Grafana user password. Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. +A new password regenerates and only displays once. Make sure that you save it. * - * @param request - The request - * {@link GlobalApiResetGrafanaUserPasswordRequest} + * @param request - The request {@link GlobalApiResetGrafanaUserPasswordRequest} * @returns A Promise of GrafanaUser */ resetGrafanaUserPassword = ( @@ -278,11 +264,9 @@ export class GlobalAPI extends ParentAPI { ) /** - * List Scaleway resources dashboards. Retrieve a list of available dashboards - * in Grafana, for all Scaleway resources which are integrated with Cockpit. + * List Scaleway resources dashboards. Retrieve a list of available dashboards in Grafana, for all Scaleway resources which are integrated with Cockpit. * - * @param request - The request - * {@link GlobalApiListGrafanaProductDashboardsRequest} + * @param request - The request {@link GlobalApiListGrafanaProductDashboardsRequest} * @returns A Promise of ListGrafanaProductDashboardsResponse */ listGrafanaProductDashboards = ( @@ -295,12 +279,9 @@ export class GlobalAPI extends ParentAPI { ) /** - * Get Scaleway resource dashboard. Retrieve information about the dashboard - * of a Scaleway resource in Grafana, specified by the ID of the Project the - * Cockpit belongs to, and the name of the dashboard. + * Get Scaleway resource dashboard. Retrieve information about the dashboard of a Scaleway resource in Grafana, specified by the ID of the Project the Cockpit belongs to, and the name of the dashboard. * - * @param request - The request - * {@link GlobalApiGetGrafanaProductDashboardRequest} + * @param request - The request {@link GlobalApiGetGrafanaProductDashboardRequest} * @returns A Promise of GrafanaProductDashboard */ getGrafanaProductDashboard = ( @@ -339,7 +320,7 @@ export class GlobalAPI extends ParentAPI { /** * List plan types. Retrieve a list of available pricing plan types. - * Deprecated, retention is now managed at the data source level. +Deprecated, retention is now managed at the data source level. * * @deprecated * @param request - The request {@link GlobalApiListPlansRequest} @@ -349,10 +330,8 @@ export class GlobalAPI extends ParentAPI { enrichForPagination('plans', this.pageOfListPlans, request) /** - * Apply a pricing plan. Apply a pricing plan on a given Project. You must - * specify the ID of the pricing plan type. Note that you will be billed for - * the plan you apply. Deprecated, retention is now managed at the data source - * level. + * Apply a pricing plan. Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply. +Deprecated, retention is now managed at the data source level. * * @deprecated * @param request - The request {@link GlobalApiSelectPlanRequest} @@ -372,9 +351,8 @@ export class GlobalAPI extends ParentAPI { ) /** - * Get current plan. Retrieve a pricing plan for the given Project, specified - * by the ID of the Project. Deprecated, retention is now managed at the data - * source level. + * Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project. +Deprecated, retention is now managed at the data source level. * * @deprecated * @param request - The request {@link GlobalApiGetCurrentPlanRequest} @@ -396,11 +374,8 @@ export class GlobalAPI extends ParentAPI { /** * Cockpit Regional API. - * - * The Cockpit Regional API allows you to create data sources and tokens to - * store and query data types such as metrics, logs, and traces. You can also - * push your data into Cockpit, and send alerts to your contact points when your - * resources may require your attention, using the regional Alert manager. + +The Cockpit Regional API allows you to create data sources and tokens to store and query data types such as metrics, logs, and traces. You can also push your data into Cockpit, and send alerts to your contact points when your resources may require your attention, using the regional Alert manager. */ export class RegionalAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -426,13 +401,11 @@ export class RegionalAPI extends ParentAPI { ) /** - * Create a data source. You must specify the data source type upon creation. - * Available data source types include: - * - * - Metrics - * - Logs - * - Traces The name of the data source will then be used as reference to name - * the associated Grafana data source. + * Create a data source. You must specify the data source type upon creation. Available data source types include: + - metrics + - logs + - traces +The name of the data source will then be used as reference to name the associated Grafana data source. * * @param request - The request {@link RegionalApiCreateDataSourceRequest} * @returns A Promise of DataSource @@ -454,9 +427,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Get a data source. Retrieve information about a given data source, - * specified by the data source ID. The data source's information such as its - * name, type, URL, origin, and retention period, is returned. + * Get a data source. Retrieve information about a given data source, specified by the data source ID. The data source's information such as its name, type, URL, origin, and retention period, is returned. * * @param request - The request {@link RegionalApiGetDataSourceRequest} * @returns A Promise of DataSource @@ -471,9 +442,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Delete a data source. Delete a given data source, specified by the data - * source ID. Note that deleting a data source is irreversible, and cannot be - * undone. + * Delete a data source. Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone. * * @param request - The request {@link RegionalApiDeleteDataSourceRequest} */ @@ -509,10 +478,8 @@ export class RegionalAPI extends ParentAPI { ) /** - * List data sources. Retrieve the list of data sources available in the - * specified region. By default, the data sources returned in the list are - * ordered by creation date, in ascending order. You can list data sources by - * Project, type and origin. + * List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order. +You can list data sources by Project, type and origin. * * @param request - The request {@link RegionalApiListDataSourcesRequest} * @returns A Promise of ListDataSourcesResponse @@ -522,8 +489,7 @@ export class RegionalAPI extends ParentAPI { ) => enrichForPagination('dataSources', this.pageOfListDataSources, request) /** - * Update a data source. Update a given data source name, specified by the - * data source ID. + * Update a data source. Update a given data source name, specified by the data source ID. * * @param request - The request {@link RegionalApiUpdateDataSourceRequest} * @returns A Promise of DataSource @@ -545,8 +511,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Get data source usage overview. Retrieve the data source usage overview per - * type for the specified Project. + * Get data source usage overview. Retrieve the data source usage overview per type for the specified Project. * * @param request - The request {@link RegionalApiGetUsageOverviewRequest} * @returns A Promise of UsageOverview @@ -570,11 +535,8 @@ export class RegionalAPI extends ParentAPI { ) /** - * Create a token. Give your token the relevant scopes to ensure it has the - * right permissions to interact with your data sources and the Alert manager. - * Make sure that you create your token in the same regions as the data - * sources you want to use it for. Upon creation, your token's secret key - * display only once. Make sure that you save it. + * Create a token. Give your token the relevant scopes to ensure it has the right permissions to interact with your data sources and the Alert manager. Make sure that you create your token in the same regions as the data sources you want to use it for. +Upon creation, your token's secret key display only once. Make sure that you save it. * * @param request - The request {@link RegionalApiCreateTokenRequest} * @returns A Promise of Token @@ -617,9 +579,8 @@ export class RegionalAPI extends ParentAPI { ) /** - * List tokens. Retrieve a list of all tokens in the specified region. By - * default, tokens returned in the list are ordered by creation date, in - * ascending order. You can filter tokens by Project ID and token scopes. + * List tokens. Retrieve a list of all tokens in the specified region. By default, tokens returned in the list are ordered by creation date, in ascending order. +You can filter tokens by Project ID and token scopes. * * @param request - The request {@link RegionalApiListTokensRequest} * @returns A Promise of ListTokensResponse @@ -628,8 +589,7 @@ export class RegionalAPI extends ParentAPI { enrichForPagination('tokens', this.pageOfListTokens, request) /** - * Get a token. Retrieve information about a given token, specified by the - * token ID. The token's information such as its scopes, is returned. + * Get a token. Retrieve information about a given token, specified by the token ID. The token's information such as its scopes, is returned. * * @param request - The request {@link RegionalApiGetTokenRequest} * @returns A Promise of Token @@ -644,8 +604,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Delete a token. Delete a given token, specified by the token ID. Deleting a - * token is irreversible and cannot be undone. + * Delete a token. Delete a given token, specified by the token ID. Deleting a token is irreversible and cannot be undone. * * @param request - The request {@link RegionalApiDeleteTokenRequest} */ @@ -656,10 +615,8 @@ export class RegionalAPI extends ParentAPI { }) /** - * Get the Alert manager. Retrieve information about the Alert manager which - * is unique per Project and region. By default the Alert manager is disabled. - * The output returned displays a URL to access the Alert manager, and whether - * the Alert manager and managed alerts are enabled. + * Get the Alert manager. Retrieve information about the Alert manager which is unique per Project and region. By default the Alert manager is disabled. +The output returned displays a URL to access the Alert manager, and whether the Alert manager and managed alerts are enabled. * * @param request - The request {@link RegionalApiGetAlertManagerRequest} * @returns A Promise of AlertManager @@ -680,10 +637,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Enable the Alert manager. Enabling the Alert manager allows you to enable - * managed alerts and create contact points in the specified Project and - * region, to be notified when your Scaleway resources may require your - * attention. + * Enable the Alert manager. Enabling the Alert manager allows you to enable managed alerts and create contact points in the specified Project and region, to be notified when your Scaleway resources may require your attention. * * @param request - The request {@link RegionalApiEnableAlertManagerRequest} * @returns A Promise of AlertManager @@ -707,9 +661,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Disable the Alert manager. Disabling the Alert manager deletes the contact - * points you have created and disables managed alerts in the specified - * Project and region. + * Disable the Alert manager. Disabling the Alert manager deletes the contact points you have created and disables managed alerts in the specified Project and region. * * @param request - The request {@link RegionalApiDisableAlertManagerRequest} * @returns A Promise of AlertManager @@ -733,12 +685,9 @@ export class RegionalAPI extends ParentAPI { ) /** - * Create a contact point. Contact points are email addresses associated with - * the default receiver, that the Alert manager sends alerts to. The source of - * the alerts are data sources within the same Project and region as the Alert - * manager. If you need to receive alerts for other receivers, you can create - * additional contact points and receivers in Grafana. Make sure that you - * select the Scaleway Alert manager. + * Create a contact point. Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to. +The source of the alerts are data sources within the same Project and region as the Alert manager. +If you need to receive alerts for other receivers, you can create additional contact points and receivers in Grafana. Make sure that you select the Scaleway Alert manager. * * @param request - The request {@link RegionalApiCreateContactPointRequest} * @returns A Promise of ContactPoint @@ -784,9 +733,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * List contact points. Retrieve a list of contact points for the specified - * Project. The response lists all contact points and receivers created in - * Grafana or via the API. + * List contact points. Retrieve a list of contact points for the specified Project. The response lists all contact points and receivers created in Grafana or via the API. * * @param request - The request {@link RegionalApiListContactPointsRequest} * @returns A Promise of ListContactPointsResponse @@ -815,8 +762,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Delete a contact point. Delete a contact point associated with the default - * receiver. + * Delete a contact point. Delete a contact point associated with the default receiver. * * @param request - The request {@link RegionalApiDeleteContactPointRequest} */ @@ -836,8 +782,7 @@ export class RegionalAPI extends ParentAPI { }) /** - * List alerts. List preconfigured and/or custom alerts for the specified - * Project. + * List alerts. List preconfigured and/or custom alerts for the specified Project. * * @param request - The request {@link RegionalApiListAlertsRequest} * @returns A Promise of ListAlertsResponse @@ -861,9 +806,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Enable managed alerts. Enable the sending of managed alerts for the - * specified Project. Managed alerts are predefined alerts that apply to - * Scaleway recources integrated with Cockpit by default. + * Enable managed alerts. Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway recources integrated with Cockpit by default. * * @param request - The request {@link RegionalApiEnableManagedAlertsRequest} * @returns A Promise of AlertManager @@ -887,8 +830,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Disable managed alerts. Disable the sending of managed alerts for the - * specified Project. + * Disable managed alerts. Disable the sending of managed alerts for the specified Project. * * @param request - The request {@link RegionalApiDisableManagedAlertsRequest} * @returns A Promise of AlertManager @@ -912,8 +854,7 @@ export class RegionalAPI extends ParentAPI { ) /** - * Trigger a test alert. Send a test alert to the Alert manager to make sure - * your contact points get notified. + * Trigger a test alert. Send a test alert to the Alert manager to make sure your contact points get notified. * * @param request - The request {@link RegionalApiTriggerTestAlertRequest} */ diff --git a/packages/clients/src/api/cockpit/v1/types.gen.ts b/packages/clients/src/api/cockpit/v1/types.gen.ts index 2ea716ce1..03bc5d589 100644 --- a/packages/clients/src/api/cockpit/v1/types.gen.ts +++ b/packages/clients/src/api/cockpit/v1/types.gen.ts @@ -60,8 +60,7 @@ export interface GetConfigResponseRetention { export interface Alert { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region: ScwRegion preconfigured: boolean @@ -73,7 +72,9 @@ export interface Alert { annotations: Record } -/** Contact point. */ +/** + * Contact point. + */ export interface ContactPoint { /** * Email address to send alerts to. @@ -81,329 +82,566 @@ export interface ContactPoint { * One-of ('configuration'): at most one of 'email' could be set. */ email?: ContactPointEmail - /** Region. */ + /** + * Region. + */ region: ScwRegion - /** Send an email notification when an alert is marked as resolved. */ + /** + * Send an email notification when an alert is marked as resolved. + */ sendResolvedNotifications: boolean } -/** Data source. */ +/** + * Data source. + */ export interface DataSource { - /** ID of the data source. */ + /** + * ID of the data source. + */ id: string - /** ID of the Project the data source belongs to. */ + /** + * ID of the Project the data source belongs to. + */ projectId: string - /** Data source name. */ + /** + * Data source name. + */ name: string - /** Data source URL. */ + /** + * Data source URL. + */ url: string - /** Data source type. */ + /** + * Data source type. + */ type: DataSourceType - /** Data source origin. */ + /** + * Data source origin. + */ origin: DataSourceOrigin - /** Date the data source was created. */ + /** + * Date the data source was created. + */ createdAt?: Date - /** Date the data source was last updated. */ + /** + * Date the data source was last updated. + */ updatedAt?: Date - /** Indicates whether the data source is synchronized with Grafana. */ + /** + * Indicates whether the data source is synchronized with Grafana. + */ synchronizedWithGrafana: boolean - /** BETA - Duration for which the data will be retained in the data source. */ + /** + * BETA - Duration for which the data will be retained in the data source. + */ retentionDays: number - /** Region of the data source. */ + /** + * Region of the data source. + */ region: ScwRegion } -/** Grafana dashboard. */ +/** + * Grafana dashboard. + */ export interface GrafanaProductDashboard { - /** Dashboard name. */ + /** + * Dashboard name. + */ name: string - /** Dashboard title. */ + /** + * Dashboard title. + */ title: string - /** Dashboard URL. */ + /** + * Dashboard URL. + */ url: string - /** Dashboard tags. */ + /** + * Dashboard tags. + */ tags: string[] - /** Dashboard variables. */ + /** + * Dashboard variables. + */ variables: string[] } -/** Grafana user. */ +/** + * Grafana user. + */ export interface GrafanaUser { - /** ID of the Grafana user. */ + /** + * ID of the Grafana user. + */ id: number - /** Username of the Grafana user. */ + /** + * Username of the Grafana user. + */ login: string - /** Role assigned to the Grafana user. */ + /** + * Role assigned to the Grafana user. + */ role: GrafanaUserRole - /** Grafana user's password. */ + /** + * Grafana user's password. + */ password?: string } -/** Type of pricing plan. */ +/** + * Type of pricing plan. + */ export interface Plan { - /** Name of a given pricing plan. */ + /** + * Name of a given pricing plan. + */ name: PlanName - /** Interval of time during which Scaleway's Cockpit keeps your metrics. */ + /** + * Interval of time during which Scaleway's Cockpit keeps your metrics. + */ retentionMetricsInterval?: string - /** Interval of time during which Scaleway's Cockpit keeps your logs. */ + /** + * Interval of time during which Scaleway's Cockpit keeps your logs. + */ retentionLogsInterval?: string - /** Interval of time during which Scaleway's Cockpit keeps your traces. */ + /** + * Interval of time during which Scaleway's Cockpit keeps your traces. + */ retentionTracesInterval?: string - /** Ingestion price in cents for 1 million samples. */ + /** + * Ingestion price in cents for 1 million samples. + */ sampleIngestionPrice: number - /** Ingestion price in cents for 1 GB of logs. */ + /** + * Ingestion price in cents for 1 GB of logs. + */ logsIngestionPrice: number - /** Ingestion price in cents for 1 GB of traces. */ + /** + * Ingestion price in cents for 1 GB of traces. + */ tracesIngestionPrice: number - /** Retention price in euros per month. */ + /** + * Retention price in euros per month. + */ monthlyPrice: number } -/** Token. */ +/** + * Token. + */ export interface Token { - /** ID of the token. */ + /** + * ID of the token. + */ id: string - /** ID of the Project the token belongs to. */ + /** + * ID of the Project the token belongs to. + */ projectId: string - /** Name of the token. */ + /** + * Name of the token. + */ name: string - /** Token creation date. */ + /** + * Token creation date. + */ createdAt?: Date - /** Token last modification date. */ + /** + * Token last modification date. + */ updatedAt?: Date - /** Token permission scopes. */ + /** + * Token permission scopes. + */ scopes: TokenScope[] - /** Token secret key. */ + /** + * Token secret key. + */ secretKey?: string - /** Regions where the token is located. */ + /** + * Regions where the token is located. + */ region: ScwRegion } -/** Data source usage. */ +/** + * Data source usage. + */ export interface Usage { - /** ID of the data source. */ + /** + * ID of the data source. + */ dataSourceId?: string - /** ID of the Project the data source belongs to. */ + /** + * ID of the Project the data source belongs to. + */ projectId: string - /** Origin of the data source. */ + /** + * Origin of the data source. + */ dataSourceOrigin: DataSourceOrigin - /** Type of the data source. */ + /** + * Type of the data source. + */ dataSourceType: DataSourceType - /** Unit of the data source usage. */ + /** + * Unit of the data source usage. + */ unit: UsageUnit - /** Interval for the data source usage. */ + /** + * Interval for the data source usage. + */ interval?: string - /** Data source usage for the given interval. */ + /** + * Data source usage for the given interval. + */ quantityOverInterval: number - /** Region of the data source usage. */ + /** + * Region of the data source usage. + */ region: ScwRegion } -/** Alert manager information. */ +/** + * Alert manager information. + */ export interface AlertManager { - /** Alert manager URL. */ + /** + * Alert manager URL. + */ alertManagerUrl?: string - /** The Alert manager is enabled. */ + /** + * The Alert manager is enabled. + */ alertManagerEnabled: boolean - /** Managed alerts are enabled. */ + /** + * Managed alerts are enabled. + */ managedAlertsEnabled: boolean - /** Regions where the Alert manager is enabled. */ + /** + * Regions where the Alert manager is enabled. + */ region: ScwRegion } -/** Cockpit configuration. */ +/** + * Cockpit configuration. + */ export interface GetConfigResponse { - /** Custom metrics retention configuration. */ + /** + * Custom metrics retention configuration. + */ customMetricsRetention?: GetConfigResponseRetention - /** Custom logs retention configuration. */ + /** + * Custom logs retention configuration. + */ customLogsRetention?: GetConfigResponseRetention - /** Custom traces retention configuration. */ + /** + * Custom traces retention configuration. + */ customTracesRetention?: GetConfigResponseRetention - /** Scaleway metrics retention configuration. */ + /** + * Scaleway metrics retention configuration. + */ productMetricsRetention?: GetConfigResponseRetention - /** Scaleway logs retention configuration. */ + /** + * Scaleway logs retention configuration. + */ productLogsRetention?: GetConfigResponseRetention } -/** Create a Grafana user. */ +/** + * Create a Grafana user. + */ export type GlobalApiCreateGrafanaUserRequest = { - /** ID of the Project in which to create the Grafana user. */ + /** + * ID of the Project in which to create the Grafana user. + */ projectId?: string /** - * Username of the Grafana user. Note that the `admin` username is not - * available for creation. + * Username of the Grafana user. Note that the `admin` username is not available for creation. */ login: string - /** Role assigned to the Grafana user. */ + /** + * Role assigned to the Grafana user. + */ role?: GrafanaUserRole } -/** Delete a Grafana user. */ +/** + * Delete a Grafana user. + */ export type GlobalApiDeleteGrafanaUserRequest = { - /** ID of the Grafana user. */ + /** + * ID of the Grafana user. + */ grafanaUserId: number - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string } -/** Retrieve a pricing plan for the given Project. */ +/** + * Retrieve a pricing plan for the given Project. + */ export type GlobalApiGetCurrentPlanRequest = { - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } -/** Retrieve a specific dashboard. */ +/** + * Retrieve a specific dashboard. + */ export type GlobalApiGetGrafanaProductDashboardRequest = { - /** Name of the dashboard. */ + /** + * Name of the dashboard. + */ dashboardName: string - /** ID of the Project the dashboard belongs to. */ + /** + * ID of the Project the dashboard belongs to. + */ projectId?: string } -/** Request a Grafana. */ +/** + * Request a Grafana. + */ export type GlobalApiGetGrafanaRequest = { - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } -/** Retrieve a list of available product dashboards. */ +/** + * Retrieve a list of available product dashboards. + */ export type GlobalApiListGrafanaProductDashboardsRequest = { - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string - /** Page number. */ + /** + * Page number. + */ page?: number - /** Page size. */ + /** + * Page size. + */ pageSize?: number - /** Tags to filter for. */ + /** + * Tags to filter for. + */ tags?: string[] } -/** List all Grafana users. */ +/** + * List all Grafana users. + */ export type GlobalApiListGrafanaUsersRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Page size. */ + /** + * Page size. + */ pageSize?: number - /** Order of the Grafana users. */ + /** + * Order of the Grafana users. + */ orderBy?: ListGrafanaUsersRequestOrderBy - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string } -/** Retrieve a list of available pricing plans. */ +/** + * Retrieve a list of available pricing plans. + */ export type GlobalApiListPlansRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Page size. */ + /** + * Page size. + */ pageSize?: number orderBy?: ListPlansRequestOrderBy } -/** Reset a Grafana user's password. */ +/** + * Reset a Grafana user's password. + */ export type GlobalApiResetGrafanaUserPasswordRequest = { - /** ID of the Grafana user. */ + /** + * ID of the Grafana user. + */ grafanaUserId: number - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string } -/** Select a specific pricing plan. */ +/** + * Select a specific pricing plan. + */ export type GlobalApiSelectPlanRequest = { - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string - /** Name of the pricing plan. */ + /** + * Name of the pricing plan. + */ planName?: PlanName } /** - * Trigger the synchronization of all data sources created in the relevant - * regions. + * Trigger the synchronization of all data sources created in the relevant regions. */ export type GlobalApiSyncGrafanaDataSourcesRequest = { - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string } -/** Grafana user. */ +/** + * Grafana user. + */ export interface Grafana { - /** URL to access your Cockpit's Grafana. */ + /** + * URL to access your Cockpit's Grafana. + */ grafanaUrl: string } -/** Retrieve a list of alerts matching the request. */ +/** + * Retrieve a list of alerts matching the request. + */ export interface ListAlertsResponse { - /** Total count of alerts matching the request. */ + /** + * Total count of alerts matching the request. + */ totalCount: number - /** List of alerts matching the applied filters. */ + /** + * List of alerts matching the applied filters. + */ alerts: Alert[] } -/** Response returned when listing contact points. */ +/** + * Response returned when listing contact points. + */ export interface ListContactPointsResponse { - /** Total count of contact points associated with the default receiver. */ + /** + * Total count of contact points associated with the default receiver. + */ totalCount: number - /** List of contact points associated with the default receiver. */ + /** + * List of contact points associated with the default receiver. + */ contactPoints: ContactPoint[] /** - * Indicates whether the Alert manager has other receivers than the default - * one. + * Indicates whether the Alert manager has other receivers than the default one. */ hasAdditionalReceivers: boolean /** - * Indicates whether there are unmanaged contact points on the default - * receiver. + * Indicates whether there are unmanaged contact points on the default receiver. */ hasAdditionalContactPoints: boolean } -/** Response returned when listing data sources. */ +/** + * Response returned when listing data sources. + */ export interface ListDataSourcesResponse { - /** Total count of data sources matching the request. */ + /** + * Total count of data sources matching the request. + */ totalCount: number - /** Data sources matching the request within the pagination. */ + /** + * Data sources matching the request within the pagination. + */ dataSources: DataSource[] } -/** Output returned when listing dashboards. */ +/** + * Output returned when listing dashboards. + */ export interface ListGrafanaProductDashboardsResponse { - /** Total count of Grafana dashboards. */ + /** + * Total count of Grafana dashboards. + */ totalCount: number - /** Grafana dashboards information. */ + /** + * Grafana dashboards information. + */ dashboards: GrafanaProductDashboard[] } -/** Ouptut returned when listing Grafana users. */ +/** + * Ouptut returned when listing Grafana users. + */ export interface ListGrafanaUsersResponse { - /** Total count of Grafana users. */ + /** + * Total count of Grafana users. + */ totalCount: number - /** Grafana users information. */ + /** + * Grafana users information. + */ grafanaUsers: GrafanaUser[] } -/** Output returned when listing pricing plans. */ +/** + * Output returned when listing pricing plans. + */ export interface ListPlansResponse { - /** Total count of available pricing plans. */ + /** + * Total count of available pricing plans. + */ totalCount: number - /** Plan types information. */ + /** + * Plan types information. + */ plans: Plan[] } -/** Response returned when listing tokens. */ +/** + * Response returned when listing tokens. + */ export interface ListTokensResponse { - /** Total count of tokens matching the request. */ + /** + * Total count of tokens matching the request. + */ totalCount: number - /** Tokens matching the request within the pagination. */ + /** + * Tokens matching the request within the pagination. + */ tokens: Token[] } -/** Create a contact point. */ +/** + * Create a contact point. + */ export type RegionalApiCreateContactPointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project to create the contact point in. */ + /** + * ID of the Project to create the contact point in. + */ projectId?: string /** * Email address of the contact point to create. @@ -411,50 +649,71 @@ export type RegionalApiCreateContactPointRequest = { * One-of ('configuration'): at most one of 'email' could be set. */ email?: ContactPointEmail - /** Send an email notification when an alert is marked as resolved. */ + /** + * Send an email notification when an alert is marked as resolved. + */ sendResolvedNotifications?: boolean } -/** Create a data source. */ +/** + * Create a data source. + */ export type RegionalApiCreateDataSourceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project the data source belongs to. */ + /** + * ID of the Project the data source belongs to. + */ projectId?: string - /** Data source name. */ + /** + * Data source name. + */ name: string - /** Data source type. */ + /** + * Data source type. + */ type?: DataSourceType - /** Default values are 30 days for metrics, 7 days for logs and traces. */ + /** + * Default values are 30 days for metrics, 7 days for logs and traces. + */ retentionDays?: number } -/** Create a token. */ +/** + * Create a token. + */ export type RegionalApiCreateTokenRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project the token belongs to. */ + /** + * ID of the Project the token belongs to. + */ projectId?: string - /** Name of the token. */ + /** + * Name of the token. + */ name: string - /** Token permission scopes. */ + /** + * Token permission scopes. + */ tokenScopes?: TokenScope[] } -/** Delete a contact point. */ +/** + * Delete a contact point. + */ export type RegionalApiDeleteContactPointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project containing the contact point to delete. */ + /** + * ID of the Project containing the contact point to delete. + */ projectId?: string /** * Email address of the contact point to delete. @@ -464,235 +723,288 @@ export type RegionalApiDeleteContactPointRequest = { email?: ContactPointEmail } -/** Delete a data source. */ +/** + * Delete a data source. + */ export type RegionalApiDeleteDataSourceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the data source to delete. */ + /** + * ID of the data source to delete. + */ dataSourceId: string } -/** Delete a token. */ +/** + * Delete a token. + */ export type RegionalApiDeleteTokenRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the token to delete. */ + /** + * ID of the token to delete. + */ tokenId: string } -/** Disable the Alert manager. */ +/** + * Disable the Alert manager. + */ export type RegionalApiDisableAlertManagerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project to disable the Alert manager in. */ + /** + * ID of the Project to disable the Alert manager in. + */ projectId?: string } -/** Disable the sending of managed alerts. */ +/** + * Disable the sending of managed alerts. + */ export type RegionalApiDisableManagedAlertsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } -/** Enable the Alert manager. */ +/** + * Enable the Alert manager. + */ export type RegionalApiEnableAlertManagerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project to enable the Alert manager in. */ + /** + * ID of the Project to enable the Alert manager in. + */ projectId?: string } -/** Enable the sending of managed alerts. */ +/** + * Enable the sending of managed alerts. + */ export type RegionalApiEnableManagedAlertsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } -/** Get the Alert manager. */ +/** + * Get the Alert manager. + */ export type RegionalApiGetAlertManagerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project ID of the requested Alert manager. */ + /** + * Project ID of the requested Alert manager. + */ projectId?: string } -/** Get Cockpit configuration. */ +/** + * Get Cockpit configuration. + */ export type RegionalApiGetConfigRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion } -/** Retrieve a data source. */ +/** + * Retrieve a data source. + */ export type RegionalApiGetDataSourceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the relevant data source. */ + /** + * ID of the relevant data source. + */ dataSourceId: string } -/** Get a token. */ +/** + * Get a token. + */ export type RegionalApiGetTokenRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Token ID. */ + /** + * Token ID. + */ tokenId: string } export type RegionalApiGetUsageOverviewRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion projectId?: string interval?: string } -/** Retrieve a list of alerts. */ +/** + * Retrieve a list of alerts. + */ export type RegionalApiListAlertsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project ID to filter for, only alerts from this Project will be returned. */ + /** + * Project ID to filter for, only alerts from this Project will be returned. + */ projectId?: string /** - * True returns only enabled alerts. False returns only disabled alerts. If - * omitted, no alert filtering is applied. Other filters may still apply. + * True returns only enabled alerts. False returns only disabled alerts. If omitted, no alert filtering is applied. Other filters may still apply. */ isEnabled?: boolean /** - * True returns only preconfigured alerts. False returns only custom alerts. - * If omitted, no filtering is applied on alert types. Other filters may still - * apply. + * True returns only preconfigured alerts. False returns only custom alerts. If omitted, no filtering is applied on alert types. Other filters may still apply. */ isPreconfigured?: boolean /** - * Valid values to filter on are `disabled`, `enabled`, `pending` and - * `firing`. If omitted, no filtering is applied on alert states. Other - * filters may still apply. + * Valid values to filter on are `disabled`, `enabled`, `pending` and `firing`. If omitted, no filtering is applied on alert states. Other filters may still apply. */ state?: AlertState } -/** List contact points. */ +/** + * List contact points. + */ export type RegionalApiListContactPointsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Total count of contact points to return per page. */ + /** + * Total count of contact points to return per page. + */ pageSize?: number - /** ID of the Project containing the contact points to list. */ + /** + * ID of the Project containing the contact points to list. + */ projectId?: string } -/** List data sources. */ +/** + * List data sources. + */ export type RegionalApiListDataSourcesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of data sources to return per page. */ + /** + * Number of data sources to return per page. + */ pageSize?: number - /** Sort order for data sources in the response. */ + /** + * Sort order for data sources in the response. + */ orderBy?: ListDataSourcesRequestOrderBy /** - * Project ID to filter for, only data sources from this Project will be - * returned. + * Project ID to filter for, only data sources from this Project will be returned. */ projectId?: string /** - * Origin to filter for, only data sources with matching origin will be - * returned. + * Origin to filter for, only data sources with matching origin will be returned. */ origin?: DataSourceOrigin /** - * Types to filter for, only data sources with matching types will be - * returned. + * Types to filter for, only data sources with matching types will be returned. */ types?: DataSourceType[] } -/** List tokens. */ +/** + * List tokens. + */ export type RegionalApiListTokensRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of tokens to return per page. */ + /** + * Number of tokens to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListTokensRequestOrderBy - /** ID of the Project the tokens belong to. */ + /** + * ID of the Project the tokens belong to. + */ projectId?: string - /** Token scopes to filter for. */ + /** + * Token scopes to filter for. + */ tokenScopes?: TokenScope[] } -/** Request to trigger a test alert. */ +/** + * Request to trigger a test alert. + */ export type RegionalApiTriggerTestAlertRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } -/** Update a contact point. */ +/** + * Update a contact point. + */ export type RegionalApiUpdateContactPointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project containing the contact point to update. */ + /** + * ID of the Project containing the contact point to update. + */ projectId?: string /** * Email address of the contact point to update. @@ -700,22 +1012,31 @@ export type RegionalApiUpdateContactPointRequest = { * One-of ('configuration'): at most one of 'email' could be set. */ email?: ContactPointEmail - /** Enable or disable notifications when alert is resolved. */ + /** + * Enable or disable notifications when alert is resolved. + */ sendResolvedNotifications?: boolean } -/** Update a data source name. */ +/** + * Update a data source name. + */ export type RegionalApiUpdateDataSourceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the data source to update. */ + /** + * ID of the data source to update. + */ dataSourceId: string - /** Updated name of the data source. */ + /** + * Updated name of the data source. + */ name?: string - /** BETA - Duration for which the data will be retained in the data source. */ + /** + * BETA - Duration for which the data will be retained in the data source. + */ retentionDays?: number } diff --git a/packages/clients/src/api/container/v1beta1/api.gen.ts b/packages/clients/src/api/container/v1beta1/api.gen.ts index b4560865f..cf0e1ed89 100644 --- a/packages/clients/src/api/container/v1beta1/api.gen.ts +++ b/packages/clients/src/api/container/v1beta1/api.gen.ts @@ -91,8 +91,8 @@ const jsonContentHeaders = { /** * Serverless Containers API. - * - * This API allows you to manage your Serverless Containers. + +This API allows you to manage your Serverless Containers. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -190,8 +190,7 @@ export class API extends ParentAPI { ) /** - * Update an existing namespace. Update the space associated with the - * specified ID. + * Update an existing namespace. Update the space associated with the specified ID. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -210,8 +209,7 @@ export class API extends ParentAPI { ) /** - * Delete an existing namespace. Delete the namespace associated with the - * specified ID. + * Delete an existing namespace. Delete the namespace associated with the specified ID. * * @param request - The request {@link DeleteNamespaceRequest} * @returns A Promise of Namespace @@ -312,8 +310,7 @@ export class API extends ParentAPI { ) /** - * Update an existing container. Update the container associated with the - * specified ID. + * Update an existing container. Update the container associated with the specified ID. * * @param request - The request {@link UpdateContainerRequest} * @returns A Promise of Container @@ -508,8 +505,7 @@ export class API extends ParentAPI { enrichForPagination('domains', this.pageOfListDomains, request) /** - * Get a custom domain. Get a custom domain for the container with the - * specified ID. + * Get a custom domain. Get a custom domain for the container with the specified ID. * * @param request - The request {@link GetDomainRequest} * @returns A Promise of Domain @@ -546,8 +542,7 @@ export class API extends ParentAPI { ) /** - * Create a custom domain. Create a custom domain for the container with the - * specified ID. + * Create a custom domain. Create a custom domain for the container with the specified ID. * * @param request - The request {@link CreateDomainRequest} * @returns A Promise of Domain @@ -656,8 +651,7 @@ export class API extends ParentAPI { ) /** - * List all tokens. List all tokens belonging to a specified Organization or - * Project. + * List all tokens. List all tokens belonging to a specified Organization or Project. * * @param request - The request {@link ListTokensRequest} * @returns A Promise of ListTokensResponse @@ -767,8 +761,7 @@ export class API extends ParentAPI { ) /** - * List all triggers. List all triggers belonging to a specified Organization - * or Project. + * List all triggers. List all triggers belonging to a specified Organization or Project. * * @param request - The request {@link ListTriggersRequest} * @returns A Promise of ListTriggersResponse diff --git a/packages/clients/src/api/container/v1beta1/types.gen.ts b/packages/clients/src/api/container/v1beta1/types.gen.ts index 203186996..6dd7020a8 100644 --- a/packages/clients/src/api/container/v1beta1/types.gen.ts +++ b/packages/clients/src/api/container/v1beta1/types.gen.ts @@ -96,7 +96,9 @@ export type TriggerStatus = | 'pending' export interface ContainerHealthCheckSpecHTTPProbe { - /** Path to use for the HTTP health check. */ + /** + * Path to use for the HTTP health check. + */ path: string } @@ -116,29 +118,30 @@ export interface ContainerHealthCheckSpec { */ tcp?: ContainerHealthCheckSpecTCPProbe /** - * During a deployment, if a newly created container fails to pass the health - * check, the deployment is aborted. As a result, lowering this value can help - * to reduce the time it takes to detect a failed deployment. + * During a deployment, if a newly created container fails to pass the health check, the deployment is aborted. +As a result, lowering this value can help to reduce the time it takes to detect a failed deployment. */ failureThreshold: number - /** Period between health checks. */ + /** + * Period between health checks. + */ interval?: string } export interface ContainerScalingOption { /** - * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold', - * 'cpuUsageThreshold', 'memoryUsageThreshold' could be set. + * + * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold', 'cpuUsageThreshold', 'memoryUsageThreshold' could be set. */ concurrentRequestsThreshold?: number /** - * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold', - * 'cpuUsageThreshold', 'memoryUsageThreshold' could be set. + * + * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold', 'cpuUsageThreshold', 'memoryUsageThreshold' could be set. */ cpuUsageThreshold?: number /** - * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold', - * 'cpuUsageThreshold', 'memoryUsageThreshold' could be set. + * + * One-of ('scalingRule'): at most one of 'concurrentRequestsThreshold', 'cpuUsageThreshold', 'memoryUsageThreshold' could be set. */ memoryUsageThreshold?: number } @@ -149,31 +152,43 @@ export interface SecretHashedValue { } export interface TriggerMnqNatsClientConfig { - /** Name of the NATS subject the trigger listens to. */ + /** + * Name of the NATS subject the trigger listens to. + */ subject: string - /** ID of the Messaging and Queuing NATS account. */ + /** + * ID of the Messaging and Queuing NATS account. + */ mnqNatsAccountId: string - /** ID of the Messaging and Queuing project. */ + /** + * ID of the Messaging and Queuing project. + */ mnqProjectId: string - /** Currently, only the `fr-par` and `nl-ams` regions are available. */ + /** + * Currently, only the `fr-par` and `nl-ams` regions are available. + */ mnqRegion: string /** - * ID of the Messaging and Queuing credentials used to subscribe to the NATS - * subject. + * ID of the Messaging and Queuing credentials used to subscribe to the NATS subject. */ mnqCredentialId?: string } export interface TriggerMnqSqsClientConfig { - /** Name of the SQS queue the trigger listens to. */ + /** + * Name of the SQS queue the trigger listens to. + */ queue: string - /** ID of the Messaging and Queuing project. */ + /** + * ID of the Messaging and Queuing project. + */ mnqProjectId: string - /** Currently, only the `fr-par` and `nl-ams` regions are available. */ + /** + * Currently, only the `fr-par` and `nl-ams` regions are available. + */ mnqRegion: string /** - * ID of the Messaging and Queuing credentials used to read from the SQS - * queue. + * ID of the Messaging and Queuing credentials used to read from the SQS queue. */ mnqCredentialId?: string } @@ -191,22 +206,36 @@ export interface Secret { } export interface CreateTriggerRequestMnqNatsClientConfig { - /** Name of the NATS subject the trigger should listen to. */ + /** + * Name of the NATS subject the trigger should listen to. + */ subject: string - /** ID of the Messaging and Queuing NATS account. */ + /** + * ID of the Messaging and Queuing NATS account. + */ mnqNatsAccountId: string - /** ID of the Messaging and Queuing project. */ + /** + * ID of the Messaging and Queuing project. + */ mnqProjectId: string - /** Currently, only the `fr-par` and `nl-ams` regions are available. */ + /** + * Currently, only the `fr-par` and `nl-ams` regions are available. + */ mnqRegion: string } export interface CreateTriggerRequestMnqSqsClientConfig { - /** Name of the SQS queue the trigger should listen to. */ + /** + * Name of the SQS queue the trigger should listen to. + */ queue: string - /** You must have activated SQS on this project. */ + /** + * You must have activated SQS on this project. + */ mnqProjectId: string - /** Currently, only the `fr-par` and `nl-ams` regions are available. */ + /** + * Currently, only the `fr-par` and `nl-ams` regions are available. + */ mnqRegion: string } @@ -218,149 +247,250 @@ export interface CreateTriggerRequestSqsClientConfig { } export interface Container { - /** UUID of the container. */ + /** + * UUID of the container. + */ id: string - /** Name of the container. */ + /** + * Name of the container. + */ name: string - /** UUID of the namespace the container belongs to. */ + /** + * UUID of the namespace the container belongs to. + */ namespaceId: string - /** Status of the container. */ + /** + * Status of the container. + */ status: ContainerStatus - /** Environment variables of the container. */ + /** + * Environment variables of the container. + */ environmentVariables: Record - /** Minimum number of instances to scale the container to. */ + /** + * Minimum number of instances to scale the container to. + */ minScale: number - /** Maximum number of instances to scale the container to. */ + /** + * Maximum number of instances to scale the container to. + */ maxScale: number - /** Memory limit of the container in MB. */ + /** + * Memory limit of the container in MB. + */ memoryLimit: number - /** CPU limit of the container in mvCPU. */ + /** + * CPU limit of the container in mvCPU. + */ cpuLimit: number - /** Processing time limit for the container. */ + /** + * Processing time limit for the container. + */ timeout?: string - /** Last error message of the container. */ + /** + * Last error message of the container. + */ errorMessage?: string - /** Privacy setting of the container. */ + /** + * Privacy setting of the container. + */ privacy: ContainerPrivacy - /** Description of the container. */ + /** + * Description of the container. + */ description?: string /** - * Name of the registry image (e.g. - * "rg.fr-par.scw.cloud/something/image:tag"). + * Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag"). */ registryImage: string - /** Number of maximum concurrent executions of the container. */ + /** + * Number of maximum concurrent executions of the container. + */ maxConcurrency: number - /** Domain name attributed to the contaioner. */ + /** + * Domain name attributed to the contaioner. + */ domainName: string - /** Protocol the container uses. */ + /** + * Protocol the container uses. + */ protocol: ContainerProtocol - /** Port the container listens on. */ + /** + * Port the container listens on. + */ port: number - /** Secret environment variables of the container. */ + /** + * Secret environment variables of the container. + */ secretEnvironmentVariables: SecretHashedValue[] /** * Possible values: - * - * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients - * to use HTTPS. - * - Enabled: Serve both HTTP and HTTPS traffic. + - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS. + - enabled: Serve both HTTP and HTTPS traffic. */ httpOption: ContainerHttpOption - /** Execution environment of the container. */ + /** + * Execution environment of the container. + */ sandbox: ContainerSandbox - /** Local storage limit of the container (in MB). */ + /** + * Local storage limit of the container (in MB). + */ localStorageLimit: number /** * Possible values: - * - * - Concurrent_requests_threshold: Scale depending on the number of concurrent - * requests being processed per container instance. - * - Cpu_usage_threshold: Scale depending on the CPU usage of a container - * instance. - * - Memory_usage_threshold: Scale depending on the memory usage of a container - * instance. +- concurrent_requests_threshold: Scale depending on the number of concurrent requests being processed per container instance. +- cpu_usage_threshold: Scale depending on the CPU usage of a container instance. +- memory_usage_threshold: Scale depending on the memory usage of a container instance. */ scalingOption?: ContainerScalingOption - /** Health check configuration of the container. */ + /** + * Health check configuration of the container. + */ healthCheck?: ContainerHealthCheckSpec - /** Creation date of the container. */ + /** + * Creation date of the container. + */ createdAt?: Date - /** Last update date of the container. */ + /** + * Last update date of the container. + */ updatedAt?: Date - /** Last date when the container was successfully deployed and set to ready. */ + /** + * Last date when the container was successfully deployed and set to ready. + */ readyAt?: Date - /** Region in which the container will be deployed. */ + /** + * Region in which the container will be deployed. + */ region: ScwRegion } export interface Cron { - /** UUID of the cron. */ + /** + * UUID of the cron. + */ id: string - /** UUID of the container invoked by this cron. */ + /** + * UUID of the container invoked by this cron. + */ containerId: string - /** UNIX cron shedule. */ + /** + * UNIX cron shedule. + */ schedule: string - /** Arguments to pass with the cron. */ + /** + * Arguments to pass with the cron. + */ args?: Record - /** Status of the cron. */ + /** + * Status of the cron. + */ status: CronStatus - /** Name of the cron. */ + /** + * Name of the cron. + */ name: string } export interface Domain { - /** UUID of the domain. */ + /** + * UUID of the domain. + */ id: string - /** Domain assigned to the container. */ + /** + * Domain assigned to the container. + */ hostname: string - /** UUID of the container. */ + /** + * UUID of the container. + */ containerId: string - /** URL (TBD). */ + /** + * URL (TBD). + */ url: string - /** Status of the domain. */ + /** + * Status of the domain. + */ status: DomainStatus - /** Last error message of the domain. */ + /** + * Last error message of the domain. + */ errorMessage?: string } export interface Namespace { - /** UUID of the namespace. */ + /** + * UUID of the namespace. + */ id: string - /** Name of the namespace. */ + /** + * Name of the namespace. + */ name: string - /** Environment variables of the namespace. */ + /** + * Environment variables of the namespace. + */ environmentVariables: Record - /** UUID of the Organization the namespace belongs to. */ + /** + * UUID of the Organization the namespace belongs to. + */ organizationId: string - /** UUID of the Project the namespace belongs to. */ + /** + * UUID of the Project the namespace belongs to. + */ projectId: string - /** Status of the namespace. */ + /** + * Status of the namespace. + */ status: NamespaceStatus - /** UUID of the registry namespace. */ + /** + * UUID of the registry namespace. + */ registryNamespaceId: string - /** Last error message of the namesace. */ + /** + * Last error message of the namesace. + */ errorMessage?: string - /** Registry endpoint of the namespace. */ + /** + * Registry endpoint of the namespace. + */ registryEndpoint: string - /** Description of the endpoint. */ + /** + * Description of the endpoint. + */ description?: string - /** Secret environment variables of the namespace. */ + /** + * Secret environment variables of the namespace. + */ secretEnvironmentVariables: SecretHashedValue[] - /** Region in which the namespace will be created. */ + /** + * Region in which the namespace will be created. + */ region: ScwRegion - /** [ALPHA] List of tags applied to the Serverless Container Namespace. */ + /** + * [ALPHA] List of tags applied to the Serverless Container Namespace. + */ tags: string[] - /** Creation date of the namespace. */ + /** + * Creation date of the namespace. + */ createdAt?: Date - /** Last update date of the namespace. */ + /** + * Last update date of the namespace. + */ updatedAt?: Date } export interface Token { - /** UUID of the token. */ + /** + * UUID of the token. + */ id: string - /** Identifier of the token. */ + /** + * Identifier of the token. + */ token: string /** * UUID of the container the token belongs to. @@ -374,50 +504,69 @@ export interface Token { * One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */ namespaceId?: string - /** @deprecated Public key of the token. */ + /** + * @deprecated Public key of the token. + */ publicKey?: string - /** Status of the token. */ + /** + * Status of the token. + */ status: TokenStatus - /** Description of the token. */ + /** + * Description of the token. + */ description?: string - /** Expiry date of the token. */ + /** + * Expiry date of the token. + */ expiresAt?: Date } export interface Trigger { - /** ID of the trigger. */ + /** + * ID of the trigger. + */ id: string - /** Name of the trigger. */ + /** + * Name of the trigger. + */ name: string - /** Description of the trigger. */ + /** + * Description of the trigger. + */ description: string - /** ID of the container to trigger. */ + /** + * ID of the container to trigger. + */ containerId: string - /** Type of the input. */ + /** + * Type of the input. + */ inputType: TriggerInputType - /** Status of the trigger. */ + /** + * Status of the trigger. + */ status: TriggerStatus - /** Error message of the trigger. */ + /** + * Error message of the trigger. + */ errorMessage?: string /** * Configuration for a Scaleway Messaging and Queuing SQS queue. * - * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', - * 'sqsConfig' could be set. + * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', 'sqsConfig' could be set. */ scwSqsConfig?: TriggerMnqSqsClientConfig /** * Configuration for a Scaleway Messaging and Queuing NATS subject. * - * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', - * 'sqsConfig' could be set. + * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', 'sqsConfig' could be set. */ scwNatsConfig?: TriggerMnqNatsClientConfig /** * Configuration for an AWS SQS queue. * - * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', - * 'sqsConfig' could be set. + * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', 'sqsConfig' could be set. */ sqsConfig?: TriggerSqsClientConfig } @@ -429,122 +578,168 @@ export interface UpdateTriggerRequestSqsClientConfig { export type CreateContainerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the namespace the container belongs to. */ + /** + * UUID of the namespace the container belongs to. + */ namespaceId: string - /** Name of the container. */ + /** + * Name of the container. + */ name: string - /** Environment variables of the container. */ + /** + * Environment variables of the container. + */ environmentVariables?: Record - /** Minimum number of instances to scale the container to. */ + /** + * Minimum number of instances to scale the container to. + */ minScale?: number - /** Maximum number of instances to scale the container to. */ + /** + * Maximum number of instances to scale the container to. + */ maxScale?: number - /** Memory limit of the container in MB. */ + /** + * Memory limit of the container in MB. + */ memoryLimit?: number - /** CPU limit of the container in mvCPU. */ + /** + * CPU limit of the container in mvCPU. + */ cpuLimit?: number - /** Processing time limit for the container. */ + /** + * Processing time limit for the container. + */ timeout?: string - /** Privacy setting of the container. */ + /** + * Privacy setting of the container. + */ privacy?: ContainerPrivacy - /** Description of the container. */ + /** + * Description of the container. + */ description?: string /** - * Name of the registry image (e.g. - * "rg.fr-par.scw.cloud/something/image:tag"). + * Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag"). */ registryImage?: string - /** @deprecated Number of maximum concurrent executions of the container. */ + /** + * @deprecated Number of maximum concurrent executions of the container. + */ maxConcurrency?: number - /** Protocol the container uses. */ + /** + * Protocol the container uses. + */ protocol?: ContainerProtocol - /** Port the container listens on. */ + /** + * Port the container listens on. + */ port?: number - /** Secret environment variables of the container. */ + /** + * Secret environment variables of the container. + */ secretEnvironmentVariables?: Secret[] /** * Possible values: - * - * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients - * to use HTTPS. - * - Enabled: Serve both HTTP and HTTPS traffic. + - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS. + - enabled: Serve both HTTP and HTTPS traffic. */ httpOption?: ContainerHttpOption - /** Execution environment of the container. */ + /** + * Execution environment of the container. + */ sandbox?: ContainerSandbox - /** Local storage limit of the container (in MB). */ + /** + * Local storage limit of the container (in MB). + */ localStorageLimit?: number /** * Possible values: - * - * - Concurrent_requests_threshold: Scale depending on the number of concurrent - * requests being processed per container instance. - * - Cpu_usage_threshold: Scale depending on the CPU usage of a container - * instance. - * - Memory_usage_threshold: Scale depending on the memory usage of a container - * instance. +- concurrent_requests_threshold: Scale depending on the number of concurrent requests being processed per container instance. +- cpu_usage_threshold: Scale depending on the CPU usage of a container instance. +- memory_usage_threshold: Scale depending on the memory usage of a container instance. */ scalingOption?: ContainerScalingOption - /** Health check configuration of the container. */ + /** + * Health check configuration of the container. + */ healthCheck?: ContainerHealthCheckSpec } export type CreateCronRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the container to invoke by the cron. */ + /** + * UUID of the container to invoke by the cron. + */ containerId: string - /** UNIX cron shedule. */ + /** + * UNIX cron shedule. + */ schedule: string - /** Arguments to pass with the cron. */ + /** + * Arguments to pass with the cron. + */ args?: Record - /** Name of the cron to create. */ + /** + * Name of the cron to create. + */ name?: string } export type CreateDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Domain to assign. */ + /** + * Domain to assign. + */ hostname: string - /** UUID of the container to assign the domain to. */ + /** + * UUID of the container to assign the domain to. + */ containerId: string } export type CreateNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the namespace to create. */ + /** + * Name of the namespace to create. + */ name?: string - /** Environment variables of the namespace to create. */ + /** + * Environment variables of the namespace to create. + */ environmentVariables?: Record - /** UUID of the Project in which the namespace will be created. */ + /** + * UUID of the Project in which the namespace will be created. + */ projectId?: string - /** Description of the namespace to create. */ + /** + * Description of the namespace to create. + */ description?: string - /** Secret environment variables of the namespace to create. */ + /** + * Secret environment variables of the namespace to create. + */ secretEnvironmentVariables?: Secret[] - /** [ALPHA] Tags of the Serverless Container Namespace. */ + /** + * [ALPHA] Tags of the Serverless Container Namespace. + */ tags?: string[] } export type CreateTokenRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** @@ -559,294 +754,376 @@ export type CreateTokenRequest = { * One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */ namespaceId?: string - /** Description of the token. */ + /** + * Description of the token. + */ description?: string - /** Expiry date of the token. */ + /** + * Expiry date of the token. + */ expiresAt?: Date } export type CreateTriggerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the trigger. */ + /** + * Name of the trigger. + */ name: string - /** ID of the container to trigger. */ + /** + * ID of the container to trigger. + */ containerId: string - /** Description of the trigger. */ + /** + * Description of the trigger. + */ description?: string /** * Configuration for a Scaleway Messaging and Queuing SQS queue. * - * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', - * 'sqsConfig' could be set. + * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', 'sqsConfig' could be set. */ scwSqsConfig?: CreateTriggerRequestMnqSqsClientConfig /** * Configuration for a Scaleway Messaging and Queuing NATS subject. * - * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', - * 'sqsConfig' could be set. + * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', 'sqsConfig' could be set. */ scwNatsConfig?: CreateTriggerRequestMnqNatsClientConfig /** * Configuration for an AWS SQS queue. * - * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', - * 'sqsConfig' could be set. + * One-of ('config'): at most one of 'scwSqsConfig', 'scwNatsConfig', 'sqsConfig' could be set. */ sqsConfig?: CreateTriggerRequestSqsClientConfig } export type DeleteContainerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the container to delete. */ + /** + * UUID of the container to delete. + */ containerId: string } export type DeleteCronRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the cron to delete. */ + /** + * UUID of the cron to delete. + */ cronId: string } export type DeleteDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the domain to delete. */ + /** + * UUID of the domain to delete. + */ domainId: string } export type DeleteNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the namespace to delete. */ + /** + * UUID of the namespace to delete. + */ namespaceId: string } export type DeleteTokenRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the token to delete. */ + /** + * UUID of the token to delete. + */ tokenId: string } export type DeleteTriggerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the trigger to delete. */ + /** + * ID of the trigger to delete. + */ triggerId: string } export type DeployContainerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the container to deploy. */ + /** + * UUID of the container to deploy. + */ containerId: string } export type GetContainerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the container to get. */ + /** + * UUID of the container to get. + */ containerId: string } export type GetCronRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the cron to get. */ + /** + * UUID of the cron to get. + */ cronId: string } export type GetDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the domain to get. */ + /** + * UUID of the domain to get. + */ domainId: string } export type GetNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the namespace to get. */ + /** + * UUID of the namespace to get. + */ namespaceId: string } export type GetTokenRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the token to get. */ + /** + * UUID of the token to get. + */ tokenId: string } export type GetTriggerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the trigger to get. */ + /** + * ID of the trigger to get. + */ triggerId: string } export type ListContainersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of containers per page. */ + /** + * Number of containers per page. + */ pageSize?: number - /** Order of the containers. */ + /** + * Order of the containers. + */ orderBy?: ListContainersRequestOrderBy - /** UUID of the namespace the container belongs to. */ + /** + * UUID of the namespace the container belongs to. + */ namespaceId: string - /** Name of the container. */ + /** + * Name of the container. + */ name?: string - /** UUID of the Organization the container belongs to. */ + /** + * UUID of the Organization the container belongs to. + */ organizationId?: string - /** UUID of the Project the container belongs to. */ + /** + * UUID of the Project the container belongs to. + */ projectId?: string } export interface ListContainersResponse { - /** Array of containers. */ + /** + * Array of containers. + */ containers: Container[] - /** Total number of containers. */ + /** + * Total number of containers. + */ totalCount: number } export type ListCronsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of crons per page. */ + /** + * Number of crons per page. + */ pageSize?: number - /** Order of the crons. */ + /** + * Order of the crons. + */ orderBy?: ListCronsRequestOrderBy - /** UUID of the container invoked by the cron. */ + /** + * UUID of the container invoked by the cron. + */ containerId: string } export interface ListCronsResponse { - /** Array of crons. */ + /** + * Array of crons. + */ crons: Cron[] - /** Total number of crons. */ + /** + * Total number of crons. + */ totalCount: number } export type ListDomainsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of domains per page. */ + /** + * Number of domains per page. + */ pageSize?: number - /** Order of the domains. */ + /** + * Order of the domains. + */ orderBy?: ListDomainsRequestOrderBy - /** UUID of the container the domain belongs to. */ + /** + * UUID of the container the domain belongs to. + */ containerId: string } export interface ListDomainsResponse { - /** Array of domains. */ + /** + * Array of domains. + */ domains: Domain[] - /** Total number of domains. */ + /** + * Total number of domains. + */ totalCount: number } export type ListNamespacesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of namespaces per page. */ + /** + * Number of namespaces per page. + */ pageSize?: number - /** Order of the namespaces. */ + /** + * Order of the namespaces. + */ orderBy?: ListNamespacesRequestOrderBy - /** Name of the namespaces. */ + /** + * Name of the namespaces. + */ name?: string - /** UUID of the Organization the namespace belongs to. */ + /** + * UUID of the Organization the namespace belongs to. + */ organizationId?: string - /** UUID of the Project the namespace belongs to. */ + /** + * UUID of the Project the namespace belongs to. + */ projectId?: string } export interface ListNamespacesResponse { - /** Array of the namespaces. */ + /** + * Array of the namespaces. + */ namespaces: Namespace[] - /** Total number of namespaces. */ + /** + * Total number of namespaces. + */ totalCount: number } export type ListTokensRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of tokens per page. */ + /** + * Number of tokens per page. + */ pageSize?: number - /** Order of the tokens. */ + /** + * Order of the tokens. + */ orderBy?: ListTokensRequestOrderBy - /** UUID of the container the token belongs to. */ + /** + * UUID of the container the token belongs to. + */ containerId?: string - /** UUID of the namespace the token belongs to. */ + /** + * UUID of the namespace the token belongs to. + */ namespaceId?: string } @@ -857,156 +1134,205 @@ export interface ListTokensResponse { export type ListTriggersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of triggers to return per page. */ + /** + * Maximum number of triggers to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListTriggersRequestOrderBy /** * ID of the container the triggers belongs to. * - * One-of ('scope'): at most one of 'containerId', 'namespaceId', 'projectId' - * could be set. + * One-of ('scope'): at most one of 'containerId', 'namespaceId', 'projectId' could be set. */ containerId?: string /** * ID of the namespace the triggers belongs to. * - * One-of ('scope'): at most one of 'containerId', 'namespaceId', 'projectId' - * could be set. + * One-of ('scope'): at most one of 'containerId', 'namespaceId', 'projectId' could be set. */ namespaceId?: string /** * ID of the project the triggers belongs to. * - * One-of ('scope'): at most one of 'containerId', 'namespaceId', 'projectId' - * could be set. + * One-of ('scope'): at most one of 'containerId', 'namespaceId', 'projectId' could be set. */ projectId?: string } export interface ListTriggersResponse { - /** Total count of existing triggers (matching any filters specified). */ + /** + * Total count of existing triggers (matching any filters specified). + */ totalCount: number - /** Triggers on this page. */ + /** + * Triggers on this page. + */ triggers: Trigger[] } export type UpdateContainerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the container to update. */ + /** + * UUID of the container to update. + */ containerId: string - /** Environment variables of the container. */ + /** + * Environment variables of the container. + */ environmentVariables?: Record - /** Minimum number of instances to scale the container to. */ + /** + * Minimum number of instances to scale the container to. + */ minScale?: number - /** Maximum number of instances to scale the container to. */ + /** + * Maximum number of instances to scale the container to. + */ maxScale?: number - /** Memory limit of the container in MB. */ + /** + * Memory limit of the container in MB. + */ memoryLimit?: number - /** CPU limit of the container in mvCPU. */ + /** + * CPU limit of the container in mvCPU. + */ cpuLimit?: number - /** Processing time limit for the container. */ + /** + * Processing time limit for the container. + */ timeout?: string - /** Defines whether to redeploy failed containers. */ + /** + * Defines whether to redeploy failed containers. + */ redeploy?: boolean - /** Privacy settings of the container. */ + /** + * Privacy settings of the container. + */ privacy?: ContainerPrivacy - /** Description of the container. */ + /** + * Description of the container. + */ description?: string /** - * Name of the registry image (e.g. - * "rg.fr-par.scw.cloud/something/image:tag"). + * Name of the registry image (e.g. "rg.fr-par.scw.cloud/something/image:tag"). */ registryImage?: string - /** @deprecated Number of maximum concurrent executions of the container. */ + /** + * @deprecated Number of maximum concurrent executions of the container. + */ maxConcurrency?: number protocol?: ContainerProtocol port?: number secretEnvironmentVariables?: Secret[] /** * Possible values: - * - * - Redirected: Responds to HTTP request with a 301 redirect to ask the clients - * to use HTTPS. - * - Enabled: Serve both HTTP and HTTPS traffic. + - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS. + - enabled: Serve both HTTP and HTTPS traffic. */ httpOption?: ContainerHttpOption - /** Execution environment of the container. */ + /** + * Execution environment of the container. + */ sandbox?: ContainerSandbox - /** Local storage limit of the container (in MB). */ + /** + * Local storage limit of the container (in MB). + */ localStorageLimit?: number /** * Possible values: - * - * - Concurrent_requests_threshold: Scale depending on the number of concurrent - * requests being processed per container instance. - * - Cpu_usage_threshold: Scale depending on the CPU usage of a container - * instance. - * - Memory_usage_threshold: Scale depending on the memory usage of a container - * instance. +- concurrent_requests_threshold: Scale depending on the number of concurrent requests being processed per container instance. +- cpu_usage_threshold: Scale depending on the CPU usage of a container instance. +- memory_usage_threshold: Scale depending on the memory usage of a container instance. */ scalingOption?: ContainerScalingOption - /** Health check configuration of the container. */ + /** + * Health check configuration of the container. + */ healthCheck?: ContainerHealthCheckSpec } export type UpdateCronRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the cron to update. */ + /** + * UUID of the cron to update. + */ cronId: string - /** UUID of the container invoked by the cron. */ + /** + * UUID of the container invoked by the cron. + */ containerId?: string - /** UNIX cron schedule. */ + /** + * UNIX cron schedule. + */ schedule?: string - /** Arguments to pass with the cron. */ + /** + * Arguments to pass with the cron. + */ args?: Record - /** Name of the cron. */ + /** + * Name of the cron. + */ name?: string } export type UpdateNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the namespace to update. */ + /** + * UUID of the namespace to update. + */ namespaceId: string - /** Environment variables of the namespace to update. */ + /** + * Environment variables of the namespace to update. + */ environmentVariables?: Record - /** Description of the namespace to update. */ + /** + * Description of the namespace to update. + */ description?: string - /** Secret environment variables of the namespace to update. */ + /** + * Secret environment variables of the namespace to update. + */ secretEnvironmentVariables?: Secret[] - /** [ALPHA] Tags of the Serverless Container Namespace. */ + /** + * [ALPHA] Tags of the Serverless Container Namespace. + */ tags?: string[] } export type UpdateTriggerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the trigger to update. */ + /** + * ID of the trigger to update. + */ triggerId: string - /** Name of the trigger. */ + /** + * Name of the trigger. + */ name?: string - /** Description of the trigger. */ + /** + * Description of the trigger. + */ description?: string /** * Configuration for an AWS SQS queue. diff --git a/packages/clients/src/api/dedibox/v1/api.gen.ts b/packages/clients/src/api/dedibox/v1/api.gen.ts index e8ec4a463..8579d7a17 100644 --- a/packages/clients/src/api/dedibox/v1/api.gen.ts +++ b/packages/clients/src/api/dedibox/v1/api.gen.ts @@ -249,7 +249,9 @@ const jsonContentHeaders = { 'Content-Type': 'application/json; charset=utf-8', } -/** Dedibox Phoenix API. */ +/** + * Dedibox Phoenix API. + */ export class API extends ParentAPI { /** Lists the available zones of the API. */ public static readonly LOCALITIES: ScwZone[] = [ @@ -290,8 +292,7 @@ export class API extends ParentAPI { enrichForPagination('servers', this.pageOfListServers, request) /** - * Get a specific baremetal server. Get the server associated with the given - * ID. + * Get a specific baremetal server. Get the server associated with the given ID. * * @param request - The request {@link GetServerRequest} * @returns A Promise of Server @@ -368,8 +369,7 @@ export class API extends ParentAPI { ) /** - * List subscribable server options. List subscribable options associated to - * the given server ID. + * List subscribable server options. List subscribable options associated to the given server ID. * * @param request - The request {@link ListSubscribableServerOptionsRequest} * @returns A Promise of ListSubscribableServerOptionsResponse @@ -403,9 +403,7 @@ export class API extends ParentAPI { ) /** - * Create a baremetal server. Create a new baremetal server. The order return - * you a service ID to follow the provisionning status you could call - * GetService. + * Create a baremetal server. Create a new baremetal server. The order return you a service ID to follow the provisionning status you could call GetService. * * @param request - The request {@link CreateServerRequest} * @returns A Promise of Service @@ -424,8 +422,7 @@ export class API extends ParentAPI { ) /** - * Subscribe storage server option. Subscribe storage option for the given - * server ID. + * Subscribe storage server option. Subscribe storage option for the given server ID. * * @param request - The request {@link SubscribeStorageOptionsRequest} * @returns A Promise of SubscribeStorageOptionsResponse @@ -478,8 +475,7 @@ export class API extends ParentAPI { ) /** - * Reboot a baremetal server. Reboot the server associated with the given ID, - * use boot param to reboot in rescue. + * Reboot a baremetal server. Reboot the server associated with the given ID, use boot param to reboot in rescue. * * @param request - The request {@link RebootServerRequest} */ @@ -655,8 +651,7 @@ export class API extends ParentAPI { enrichForPagination('services', this.pageOfListServices, request) /** - * Install a baremetal server. Install an OS on the server associated with the - * given ID. + * Install a baremetal server. Install an OS on the server associated with the given ID. * * @param request - The request {@link InstallServerRequest} * @returns A Promise of ServerInstall @@ -675,8 +670,7 @@ export class API extends ParentAPI { ) /** - * Get a specific server installation status. Get the server installation - * status associated with the given server ID. + * Get a specific server installation status. Get the server installation status associated with the given server ID. * * @param request - The request {@link GetServerInstallRequest} * @returns A Promise of ServerInstall @@ -713,8 +707,7 @@ export class API extends ParentAPI { ) /** - * Cancels the current (running) server installation. Cancels the current - * server installation associated with the given server ID. + * Cancels the current (running) server installation. Cancels the current server installation associated with the given server ID. * * @param request - The request {@link CancelServerInstallRequest} */ @@ -725,8 +718,7 @@ export class API extends ParentAPI { }) /** - * Get server default partitioning. Get the server default partitioning schema - * associated with the given server ID and OS ID. + * Get server default partitioning. Get the server default partitioning schema associated with the given server ID and OS ID. * * @param request - The request {@link GetServerDefaultPartitioningRequest} * @returns A Promise of ServerDefaultPartitioning @@ -743,10 +735,8 @@ export class API extends ParentAPI { ) /** - * Start BMC (Baseboard Management Controller) access for a given baremetal - * server. Start BMC (Baseboard Management Controller) access associated with - * the given ID. The BMC (Baseboard Management Controller) access is available - * one hour after the installation of the server. + * Start BMC (Baseboard Management Controller) access for a given baremetal server. Start BMC (Baseboard Management Controller) access associated with the given ID. +The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. * * @param request - The request {@link StartBMCAccessRequest} */ @@ -761,9 +751,7 @@ export class API extends ParentAPI { }) /** - * Get BMC (Baseboard Management Controller) access for a given baremetal - * server. Get the BMC (Baseboard Management Controller) access associated - * with the given ID. + * Get BMC (Baseboard Management Controller) access for a given baremetal server. Get the BMC (Baseboard Management Controller) access associated with the given ID. * * @param request - The request {@link GetBMCAccessRequest} * @returns A Promise of BMCAccess @@ -800,9 +788,7 @@ export class API extends ParentAPI { ) /** - * Stop BMC (Baseboard Management Controller) access for a given baremetal - * server. Stop BMC (Baseboard Management Controller) access associated with - * the given ID. + * Stop BMC (Baseboard Management Controller) access for a given baremetal server. Stop BMC (Baseboard Management Controller) access associated with the given ID. * * @param request - The request {@link StopBMCAccessRequest} */ @@ -954,8 +940,7 @@ export class API extends ParentAPI { ) /** - * Attach failovers on baremetal server. Attach failovers on the server - * associated with the given ID. + * Attach failovers on baremetal server. Attach failovers on the server associated with the given ID. * * @param request - The request {@link AttachFailoverIPsRequest} */ @@ -970,8 +955,7 @@ export class API extends ParentAPI { }) /** - * Detach failovers on baremetal server. Detach failovers on the server - * associated with the given ID. + * Detach failovers on baremetal server. Detach failovers on the server associated with the given ID. * * @param request - The request {@link DetachFailoverIPsRequest} */ @@ -1074,8 +1058,7 @@ export class API extends ParentAPI { enrichForPagination('failoverIps', this.pageOfListFailoverIPs, request) /** - * Get a specific baremetal server. Get the server associated with the given - * ID. + * Get a specific baremetal server. Get the server associated with the given ID. * * @param request - The request {@link GetFailoverIPRequest} * @returns A Promise of FailoverIP @@ -1136,8 +1119,7 @@ export class API extends ParentAPI { }) /** - * Start in rescue baremetal server. Start in rescue the server associated - * with the given ID. + * Start in rescue baremetal server. Start in rescue the server associated with the given ID. * * @param request - The request {@link StartRescueRequest} * @returns A Promise of Rescue @@ -1171,8 +1153,7 @@ export class API extends ParentAPI { ) /** - * Stop rescue on baremetal server. Stop rescue on the server associated with - * the given ID. + * Stop rescue on baremetal server. Stop rescue on the server associated with the given ID. * * @param request - The request {@link StopRescueRequest} */ @@ -1183,7 +1164,9 @@ export class API extends ParentAPI { }) } -/** Dedibox Phoenix Billing API. */ +/** + * Dedibox Phoenix Billing API. + */ export class BillingAPI extends ParentAPI { protected pageOfListInvoices = ( request: Readonly = {}, @@ -1279,12 +1262,15 @@ export class BillingAPI extends ParentAPI { ) } -/** Dedibox Phoenix IPv6 Block API. */ +/** + * Dedibox Phoenix IPv6 Block API. + */ export class IPv6BlockAPI extends ParentAPI { /** - * Get IPv6 block quota. Get IPv6 block quota with the given project ID. /48 - * one per organization. /56 link to your number of server. /64 link to your - * number of failover IP. + * Get IPv6 block quota. Get IPv6 block quota with the given project ID. +/48 one per organization. +/56 link to your number of server. +/64 link to your number of failover IP. * * @param request - The request {@link IPv6BlockApiGetIPv6BlockQuotasRequest} * @returns A Promise of GetIPv6BlockQuotasResponse @@ -1302,8 +1288,7 @@ export class IPv6BlockAPI extends ParentAPI { ) /** - * Create IPv6 block for baremetal server. Create IPv6 block associated with - * the given project ID. + * Create IPv6 block for baremetal server. Create IPv6 block associated with the given project ID. * * @param request - The request {@link IPv6BlockApiCreateIPv6BlockRequest} * @returns A Promise of IPv6Block @@ -1343,8 +1328,8 @@ export class IPv6BlockAPI extends ParentAPI { ) /** - * Update IPv6 block. Update DNS associated to IPv6 block. If DNS is used, - * minimum of 2 is necessary and maximum of 5 (no duplicate). + * Update IPv6 block. Update DNS associated to IPv6 block. +If DNS is used, minimum of 2 is necessary and maximum of 5 (no duplicate). * * @param request - The request {@link IPv6BlockApiUpdateIPv6BlockRequest} * @returns A Promise of IPv6Block @@ -1377,12 +1362,11 @@ export class IPv6BlockAPI extends ParentAPI { }) /** - * Create IPv6 block subnet. Create IPv6 block subnet for the given IP ID. /48 - * could create subnet in /56 (quota link to your number of server). /56 could - * create subnet in /64 (quota link to your number of failover IP). + * Create IPv6 block subnet. Create IPv6 block subnet for the given IP ID. +/48 could create subnet in /56 (quota link to your number of server). +/56 could create subnet in /64 (quota link to your number of failover IP). * - * @param request - The request - * {@link IPv6BlockApiCreateIPv6BlockSubnetRequest} + * @param request - The request {@link IPv6BlockApiCreateIPv6BlockSubnetRequest} * @returns A Promise of IPv6Block */ createIPv6BlockSubnet = ( @@ -1404,11 +1388,9 @@ export class IPv6BlockAPI extends ParentAPI { ) /** - * List available IPv6 block subnets. List all available IPv6 block subnets - * for given IP ID. + * List available IPv6 block subnets. List all available IPv6 block subnets for given IP ID. * - * @param request - The request - * {@link IPv6BlockApiListIPv6BlockSubnetsAvailableRequest} + * @param request - The request {@link IPv6BlockApiListIPv6BlockSubnetsAvailableRequest} * @returns A Promise of ListIPv6BlockSubnetsAvailableResponse */ listIPv6BlockSubnetsAvailable = ( @@ -1423,7 +1405,9 @@ export class IPv6BlockAPI extends ParentAPI { ) } -/** Dedibox Phoenix RPN API. */ +/** + * Dedibox Phoenix RPN API. + */ export class RpnAPI extends ParentAPI { protected pageOfListRpnServerCapabilities = ( request: Readonly = {}, @@ -1469,7 +1453,9 @@ export class RpnAPI extends ParentAPI { ) } -/** Dedibox Phoenix RPN SAN API. */ +/** + * Dedibox Phoenix RPN SAN API. + */ export class RpnSanAPI extends ParentAPI { protected pageOfListRpnSans = ( request: Readonly = {}, @@ -1585,7 +1571,9 @@ export class RpnSanAPI extends ParentAPI { ) } -/** Dedibox Phoenix RPN v1 API. */ +/** + * Dedibox Phoenix RPN v1 API. + */ export class RpnV1API extends ParentAPI { protected pageOfListRpnGroups = ( request: Readonly = {}, @@ -1824,7 +1812,9 @@ export class RpnV1API extends ParentAPI { }) } -/** Dedibox Phoenix RPN v2 API. */ +/** + * Dedibox Phoenix RPN v2 API. + */ export class RpnV2API extends ParentAPI { protected pageOfListRpnV2Groups = ( request: Readonly = {}, diff --git a/packages/clients/src/api/dedibox/v1/types.gen.ts b/packages/clients/src/api/dedibox/v1/types.gen.ts index 2cfc8acea..b25d4d9f0 100644 --- a/packages/clients/src/api/dedibox/v1/types.gen.ts +++ b/packages/clients/src/api/dedibox/v1/types.gen.ts @@ -316,11 +316,17 @@ export interface OfferRPNInfo { } export interface OfferSANInfo { - /** SAN size (in bytes). */ + /** + * SAN size (in bytes). + */ size: number - /** High availabilty offer. */ + /** + * High availabilty offer. + */ ha: boolean - /** Type of SAN device (hdd / ssd). */ + /** + * Type of SAN device (hdd / ssd). + */ deviceType: OfferSANInfoType } @@ -330,208 +336,246 @@ export interface OfferStorageInfo { } export interface IP { - /** ID of the IP. */ + /** + * ID of the IP. + */ ipId: number - /** Address of the IP. */ + /** + * Address of the IP. + */ address: string - /** Reverse IP value. */ + /** + * Reverse IP value. + */ reverse: string - /** Version of IP (v4 or v6). */ + /** + * Version of IP (v4 or v6). + */ version: IPVersion - /** Classless InterDomain Routing notation of the IP. */ + /** + * Classless InterDomain Routing notation of the IP. + */ cidr: number - /** Network mask of IP. */ + /** + * Network mask of IP. + */ netmask: string - /** Semantic of IP. */ + /** + * Semantic of IP. + */ semantic: IPSemantic - /** Gateway of IP. */ + /** + * Gateway of IP. + */ gateway: string - /** Status of the IP. */ + /** + * Status of the IP. + */ status: IPStatus } export interface Offer { - /** ID of the offer. */ + /** + * ID of the offer. + */ id: number - /** Name of the offer. */ + /** + * Name of the offer. + */ name: string - /** Catalog of the offer. */ + /** + * Catalog of the offer. + */ catalog: OfferCatalog - /** Payment frequency of the offer. */ + /** + * Payment frequency of the offer. + */ paymentFrequency: OfferPaymentFrequency - /** Price of the offer. */ + /** + * Price of the offer. + */ pricing?: Money /** * Server info if it is a server offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ serverInfo?: OfferServerInfo /** * Service level info if it is a service level offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ serviceLevelInfo?: OfferServiceLevelInfo /** * RPN info if it is a RPN offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ rpnInfo?: OfferRPNInfo /** * SAN info if it is a SAN offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ sanInfo?: OfferSANInfo /** * AntiDOS info if it is a antiDOS offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ antidosInfo?: OfferAntiDosInfo /** * Backup info if it is a backup offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ backupInfo?: OfferBackupInfo /** * USB storage info if it is a USB storage offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ usbStorageInfo?: OfferStorageInfo /** * Storage info if it is a storage offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ storageInfo?: OfferStorageInfo /** * License info if it is a license offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ licenseInfo?: OfferLicenseInfo /** * Failover IP info if it is a failover IP offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ failoverIpInfo?: OfferFailoverIpInfo /** * Failover block info if it is a failover block offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ failoverBlockInfo?: OfferFailoverBlockInfo /** * Bandwidth info if it is a bandwidth offer. * - * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', - * 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', - * 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', - * 'bandwidthInfo' could be set. + * One-of ('offerInfo'): at most one of 'serverInfo', 'serviceLevelInfo', 'rpnInfo', 'sanInfo', 'antidosInfo', 'backupInfo', 'usbStorageInfo', 'storageInfo', 'licenseInfo', 'failoverIpInfo', 'failoverBlockInfo', 'bandwidthInfo' could be set. */ bandwidthInfo?: OfferBandwidthInfo } export interface NetworkInterface { - /** Card ID of the network interface. */ + /** + * Card ID of the network interface. + */ cardId: number - /** Device ID of the network interface. */ + /** + * Device ID of the network interface. + */ deviceId: number - /** MAC address of the network interface. */ + /** + * MAC address of the network interface. + */ mac: string - /** Network interface type. */ + /** + * Network interface type. + */ type: NetworkInterfaceInterfaceType - /** IPs of the network interface. */ + /** + * IPs of the network interface. + */ ips: IP[] } export interface OS { - /** ID of the OS. */ + /** + * ID of the OS. + */ id: number - /** Name of the OS. */ + /** + * Name of the OS. + */ name: string - /** Type of the OS. */ + /** + * Type of the OS. + */ type: OSType - /** Version of the OS. */ + /** + * Version of the OS. + */ version: string - /** Architecture of the OS. */ + /** + * Architecture of the OS. + */ arch: OSArch - /** True if the OS allow custom partitioning. */ + /** + * True if the OS allow custom partitioning. + */ allowCustomPartitioning: boolean - /** True if the OS allow SSH Keys. */ + /** + * True if the OS allow SSH Keys. + */ allowSshKeys: boolean - /** True if the OS requires user. */ + /** + * True if the OS requires user. + */ requiresUser: boolean - /** True if the OS requires admin password. */ + /** + * True if the OS requires admin password. + */ requiresAdminPassword: boolean - /** True if the OS requires panel password. */ + /** + * True if the OS requires panel password. + */ requiresPanelPassword: boolean - /** True if the OS allow file systems. */ + /** + * True if the OS allow file systems. + */ allowedFilesystems: PartitionFileSystem[] - /** True if the OS requires license. */ + /** + * True if the OS requires license. + */ requiresLicense: boolean - /** License offers available with the OS. */ + /** + * License offers available with the OS. + */ licenseOffers: Offer[] - /** Maximum number of partitions which can be created. */ + /** + * Maximum number of partitions which can be created. + */ maxPartitions?: number - /** Display name of the OS. */ + /** + * Display name of the OS. + */ displayName: string - /** Regex used to validate the installation passwords. */ + /** + * Regex used to validate the installation passwords. + */ passwordRegex: string - /** Regex used to validate the panel installation password. */ + /** + * Regex used to validate the panel installation password. + */ panelPasswordRegex?: string /** - * If both requires_valid_hostname & hostname_regex are set, it means that at - * least one of the criterias must be valid. + * If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid. */ requiresValidHostname?: boolean /** - * If both requires_valid_hostname & hostname_regex are set, it means that at - * least one of the criterias must be valid. + * If both requires_valid_hostname & hostname_regex are set, it means that at least one of the criterias must be valid. */ hostnameRegex?: string - /** Hostname max length. */ + /** + * Hostname max length. + */ hostnameMaxLength: number - /** OS release date. */ + /** + * OS release date. + */ releasedAt?: Date } @@ -550,70 +594,121 @@ export interface ServerOption { } export interface ServiceLevel { - /** Offer ID of service level. */ + /** + * Offer ID of service level. + */ offerId: number - /** Level type of service level. */ + /** + * Level type of service level. + */ level: ServiceLevelLevel } export interface RpnSan { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ id: number - /** Datacenter location. */ + /** + * Datacenter location. + */ datacenterName: string - /** Organization ID. */ + /** + * Organization ID. + */ organizationId: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** RPN SAN server hostname. */ + /** + * RPN SAN server hostname. + */ serverHostname: string - /** IQN suffix. */ + /** + * IQN suffix. + */ iqnSuffix: string - /** Date of creation of the RPN SAN. */ + /** + * Date of creation of the RPN SAN. + */ createdAt?: Date - /** Offer ID. */ + /** + * Offer ID. + */ offerId: number - /** Offer description. */ + /** + * Offer description. + */ offerName: string - /** Status. */ + /** + * Status. + */ status: RpnSanStatus - /** RPN SAN storage size. */ + /** + * RPN SAN storage size. + */ storageSize: number iqn: string offer?: Offer - /** True if the SAN is compatible with the RPNv1 technology. */ + /** + * True if the SAN is compatible with the RPNv1 technology. + */ rpnv1Compatible: boolean /** - * True if the offer supports the RPNv1 implicitly, false if it must to be - * added to a group to support RPNv1. + * True if the offer supports the RPNv1 implicitly, false if it must to be added to a group to support RPNv1. */ rpnv1Implicit: boolean - /** RPN SAN delivery date. */ + /** + * RPN SAN delivery date. + */ deliveredAt?: Date - /** RPN SAN termination date. */ + /** + * RPN SAN termination date. + */ terminatedAt?: Date - /** RPN SAN expiration date. */ + /** + * RPN SAN expiration date. + */ expiresAt?: Date } export interface RpnGroup { - /** Rpn group member ID. */ + /** + * Rpn group member ID. + */ id: number - /** Rpn group name. */ + /** + * Rpn group name. + */ name: string - /** Rpn group type (local or shared). */ + /** + * Rpn group type (local or shared). + */ type: RpnGroupType - /** Whether the group is active or not. */ + /** + * Whether the group is active or not. + */ active: boolean - /** Rpn group creation date. */ + /** + * Rpn group creation date. + */ createdAt?: Date - /** RPN group owner. */ + /** + * RPN group owner. + */ owner: string - /** Total number of members. */ + /** + * Total number of members. + */ membersCount: number - /** Rpn group organization ID. */ + /** + * Rpn group organization ID. + */ organizationId: string - /** Rpn group project ID. */ + /** + * Rpn group project ID. + */ projectId: string } @@ -623,70 +718,132 @@ export interface RpnV2GroupSubnet { } export interface Server { - /** ID of the server. */ + /** + * ID of the server. + */ id: number - /** Organization ID the server is attached to. */ + /** + * Organization ID the server is attached to. + */ organizationId: string - /** Project ID the server is attached to. */ + /** + * Project ID the server is attached to. + */ projectId: string - /** Hostname of the server. */ + /** + * Hostname of the server. + */ hostname: string - /** Date of last reboot of the server. */ + /** + * Date of last reboot of the server. + */ rebootedAt?: Date - /** Date of creation of the server. */ + /** + * Date of creation of the server. + */ createdAt?: Date - /** Date of last modification of the server. */ + /** + * Date of last modification of the server. + */ updatedAt?: Date - /** Date of release of the server. */ + /** + * Date of release of the server. + */ expiredAt?: Date - /** Offer of the server. */ + /** + * Offer of the server. + */ offer?: Offer - /** Status of the server. */ + /** + * Status of the server. + */ status: ServerStatus - /** Location of the server. */ + /** + * Location of the server. + */ location?: ServerLocation - /** Abuse contact of the server. */ + /** + * Abuse contact of the server. + */ abuseContact: string - /** OS installed on the server. */ + /** + * OS installed on the server. + */ os?: OS - /** Network interfaces of the server. */ + /** + * Network interfaces of the server. + */ interfaces: NetworkInterface[] - /** The zone in which is the server. */ + /** + * The zone in which is the server. + */ zone: ScwZone - /** Options subscribe on the server. */ + /** + * Options subscribe on the server. + */ options: ServerOption[] - /** Service level of the server. */ + /** + * Service level of the server. + */ level?: ServiceLevel - /** Boolean if the server has a BMC. */ + /** + * Boolean if the server has a BMC. + */ hasBmc: boolean - /** Rescue OS of the server. */ + /** + * Rescue OS of the server. + */ rescueOs?: OS - /** Array of customs tags attached to the server. */ + /** + * Array of customs tags attached to the server. + */ tags: string[] - /** Whether the server is outsourced or not. */ + /** + * Whether the server is outsourced or not. + */ isOutsourced: boolean - /** Whether or not you can enable/disable the IPv6. */ + /** + * Whether or not you can enable/disable the IPv6. + */ ipv6Slaac: boolean - /** Whether the server is compatible with QinQ. */ + /** + * Whether the server is compatible with QinQ. + */ qinq: boolean - /** Whether or not the server is already part of an rpnv2 group. */ + /** + * Whether or not the server is already part of an rpnv2 group. + */ isRpnv2Member: boolean } export interface FailoverBlock { - /** ID of the failover block. */ + /** + * ID of the failover block. + */ id: number - /** IP of the failover block. */ + /** + * IP of the failover block. + */ address: string - /** Name servers. */ + /** + * Name servers. + */ nameservers: string[] - /** IP version of the failover block. */ + /** + * IP version of the failover block. + */ ipVersion: FailoverBlockVersion - /** Classless InterDomain Routing notation of the failover block. */ + /** + * Classless InterDomain Routing notation of the failover block. + */ cidr: number - /** Netmask of the failover block. */ + /** + * Netmask of the failover block. + */ netmask: string - /** Gateway IP of the failover block. */ + /** + * Gateway IP of the failover block. + */ gatewayIp: string } @@ -702,51 +859,91 @@ export interface RpnSanIpServer { } export interface RpnSanServer { - /** The RPN SAN server ID. */ + /** + * The RPN SAN server ID. + */ id: number - /** The RPN SAN server datacenter name. */ + /** + * The RPN SAN server datacenter name. + */ datacenterName: string - /** The RPN SAN server hostname. */ + /** + * The RPN SAN server hostname. + */ hostname: string - /** RPN SANs linked to the RPN SAN server. */ + /** + * RPN SANs linked to the RPN SAN server. + */ sans: RpnSan[] - /** The RPN SAN server zone. */ + /** + * The RPN SAN server zone. + */ zone: ScwZone } export interface RpnV2Group { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ id: number - /** RPN V2 group name. */ + /** + * RPN V2 group name. + */ name: string - /** Whether or not the RPN V1 compatibility was enabled. */ + /** + * Whether or not the RPN V1 compatibility was enabled. + */ compatibleRpnv1: boolean - /** Organization ID of the RPN V2 group. */ + /** + * Organization ID of the RPN V2 group. + */ organizationId: string - /** Project ID of the RPN V2 group. */ + /** + * Project ID of the RPN V2 group. + */ projectId: string - /** RPN V2 group type (qing / standard). */ + /** + * RPN V2 group type (qing / standard). + */ type: RpnV2GroupType - /** RPN V2 group status. */ + /** + * RPN V2 group status. + */ status: RpnV2GroupStatus - /** RPN V2 group owner. */ + /** + * RPN V2 group owner. + */ owner: string - /** Total number of members. */ + /** + * Total number of members. + */ membersCount: number - /** RPN V2 subnet. */ + /** + * RPN V2 subnet. + */ subnet?: RpnV2GroupSubnet - /** RPN V2 gateway. */ + /** + * RPN V2 gateway. + */ gateway: string - /** The RPNv1 group (if the compatibility was enabled). */ + /** + * The RPNv1 group (if the compatibility was enabled). + */ rpnv1Group?: RpnGroup } export interface RpnV2Member { - /** RPN V2 member ID. */ + /** + * RPN V2 member ID. + */ id: number - /** RPN V2 member status. */ + /** + * RPN V2 member status. + */ status: RpnV2MemberStatus - /** RPN V2 member VLAN. */ + /** + * RPN V2 member VLAN. + */ vlan: string /** * Server behind the member (may be empty). @@ -760,7 +957,9 @@ export interface RpnV2Member { * One-of ('resource'): at most one of 'server', 'rpnv1Group' could be set. */ rpnv1Group?: RpnGroup - /** RPN speed. */ + /** + * RPN speed. + */ speed?: number } @@ -773,23 +972,41 @@ export interface ServerDisk { } export interface Service { - /** ID of the service. */ + /** + * ID of the service. + */ id: number - /** Resource ID of the service. */ + /** + * Resource ID of the service. + */ resourceId?: number - /** Provisioning status of the service. */ + /** + * Provisioning status of the service. + */ provisioningStatus: ServiceProvisioningStatus - /** Offer of the service. */ + /** + * Offer of the service. + */ offer?: Offer - /** Creation date of the service. */ + /** + * Creation date of the service. + */ createdAt?: Date - /** Delivery date of the service. */ + /** + * Delivery date of the service. + */ deliveredAt?: Date - /** Terminatation date of the service. */ + /** + * Terminatation date of the service. + */ terminatedAt?: Date - /** Expiration date of the service. */ + /** + * Expiration date of the service. + */ expiresAt?: Date - /** Service type, either order or service. */ + /** + * Service type, either order or service. + */ type: ServiceType } @@ -799,44 +1016,80 @@ export interface GetIPv6BlockQuotasResponseQuota { } export interface InstallPartition { - /** File system of the installation partition. */ + /** + * File system of the installation partition. + */ fileSystem: PartitionFileSystem - /** Mount point of the installation partition. */ + /** + * Mount point of the installation partition. + */ mountPoint?: string - /** RAID level of the installation partition. */ + /** + * RAID level of the installation partition. + */ raidLevel: RaidArrayRaidLevel - /** Capacity of the installation partition. */ + /** + * Capacity of the installation partition. + */ capacity: number - /** Connectors of the installation partition. */ + /** + * Connectors of the installation partition. + */ connectors: string[] } export interface FailoverIP { - /** ID of the failover IP. */ + /** + * ID of the failover IP. + */ id: number - /** IP of the failover IP. */ + /** + * IP of the failover IP. + */ address: string - /** Reverse IP value. */ + /** + * Reverse IP value. + */ reverse: string - /** IP version of the failover IP. */ + /** + * IP version of the failover IP. + */ ipVersion: FailoverIPVersion - /** Classless InterDomain Routing notation of the failover IP. */ + /** + * Classless InterDomain Routing notation of the failover IP. + */ cidr: number - /** Netmask of the failover IP. */ + /** + * Netmask of the failover IP. + */ netmask: string - /** Gateway IP of the failover IP. */ + /** + * Gateway IP of the failover IP. + */ gatewayIp: string - /** MAC address of the IP failover. */ + /** + * MAC address of the IP failover. + */ mac?: string - /** Server ID linked to the IP failover. */ + /** + * Server ID linked to the IP failover. + */ serverId?: number - /** Status of the IP failover. */ + /** + * Status of the IP failover. + */ status: FailoverIPStatus - /** Block of the IP failover. */ + /** + * Block of the IP failover. + */ block?: FailoverBlock - /** The interface type. */ + /** + * The interface type. + */ type: FailoverIPInterfaceType - /** The server zone (if assigned). */ + /** + * The server zone (if assigned). + */ serverZone?: string } @@ -869,9 +1122,13 @@ export interface RpnSanIp { * One-of ('rpnSanIp'): at most one of 'server', 'rpnv2Group' could be set. */ rpnv2Group?: RpnSanIpRpnV2Group - /** An IP object. */ + /** + * An IP object. + */ ip?: IP - /** IP type (server | rpnv2_subnet). */ + /** + * IP type (server | rpnv2_subnet). + */ type: RpnSanIpType } @@ -886,290 +1143,500 @@ export interface RefundSummary { } export interface RpnGroupMember { - /** Rpn group member ID. */ + /** + * Rpn group member ID. + */ id: number - /** RPN group member status. */ + /** + * RPN group member status. + */ status: RpnGroupMemberStatus - /** Authorized RPN SAN server. */ + /** + * Authorized RPN SAN server. + */ sanServer?: RpnSanServer - /** Authorized rpn v1 capable server. */ + /** + * Authorized rpn v1 capable server. + */ server?: Server - /** RPN group ID. */ + /** + * RPN group ID. + */ groupId: number - /** RPN group name. */ + /** + * RPN group name. + */ groupName: string - /** RPN group owner. */ + /** + * RPN group owner. + */ groupOwner: string - /** RPN speed. */ + /** + * RPN speed. + */ speed?: number - /** RPN member owner. */ + /** + * RPN member owner. + */ owner: string } export interface RpnSanSummary { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ id: number - /** Datacenter location. */ + /** + * Datacenter location. + */ datacenterName: string - /** Organization ID. */ + /** + * Organization ID. + */ organizationId: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** RPN SAN server hostname. */ + /** + * RPN SAN server hostname. + */ serverHostname: string - /** IQN suffix. */ + /** + * IQN suffix. + */ iqnSuffix: string - /** Date of creation of the RPN SAN. */ + /** + * Date of creation of the RPN SAN. + */ createdAt?: Date - /** Offer ID. */ + /** + * Offer ID. + */ offerId: number - /** Offer description. */ + /** + * Offer description. + */ offerName: string - /** Status. */ + /** + * Status. + */ status: RpnSanStatus - /** RPN SAN storage size. */ + /** + * RPN SAN storage size. + */ storageSize: number - /** True if the SAN is compatible with the RPNv1 technology. */ + /** + * True if the SAN is compatible with the RPNv1 technology. + */ rpnv1Compatible: boolean /** - * True if the offer supports the RPNv1 implicitly, false if it must to be - * added to a group to support RPNv1. + * True if the offer supports the RPNv1 implicitly, false if it must to be added to a group to support RPNv1. */ rpnv1Implicit: boolean - /** RPN SAN delivery date. */ + /** + * RPN SAN delivery date. + */ deliveredAt?: Date - /** RPN SAN termination date. */ + /** + * RPN SAN termination date. + */ terminatedAt?: Date - /** RPN SAN expiration date. */ + /** + * RPN SAN expiration date. + */ expiresAt?: Date } export interface RpnServerCapability { - /** Server ID. */ + /** + * Server ID. + */ id: number - /** Server hostname. */ + /** + * Server hostname. + */ hostname: string - /** Server datacenter name. */ + /** + * Server datacenter name. + */ datacenterName: string - /** Server zone. */ + /** + * Server zone. + */ zone: ScwZone - /** Private IP address (if rpn compatiblle). */ + /** + * Private IP address (if rpn compatiblle). + */ ipAddress?: string - /** Supported rpn version. */ + /** + * Supported rpn version. + */ rpnVersion?: number - /** True if server is compatible with QinQ protocol (rpn v2). */ + /** + * True if server is compatible with QinQ protocol (rpn v2). + */ compatibleQinq: boolean - /** True if server can join a QinQ group. */ + /** + * True if server can join a QinQ group. + */ canJoinQinqGroup: boolean - /** Times server is linked in a rpnv1 group. */ + /** + * Times server is linked in a rpnv1 group. + */ rpnv1GroupCount: number - /** Times server is linked in a rpnv2 group. */ + /** + * Times server is linked in a rpnv2 group. + */ rpnv2GroupCount: number - /** True if server can join an rpnv2 group. */ + /** + * True if server can join an rpnv2 group. + */ canJoinRpnv2Group: boolean } export interface Log { - /** RPN V2 log ID. */ + /** + * RPN V2 log ID. + */ id: number - /** RPN V2 group. */ + /** + * RPN V2 group. + */ group?: RpnV2Group - /** RPN V2 member (if appliable). */ + /** + * RPN V2 member (if appliable). + */ member?: RpnV2Member - /** Which action was performed. */ + /** + * Which action was performed. + */ action: LogAction - /** Action status. */ + /** + * Action status. + */ status: LogStatus - /** Creation date. */ + /** + * Creation date. + */ createdAt?: Date - /** Completion date. */ + /** + * Completion date. + */ finishedAt?: Date } export interface ServerEvent { - /** ID of the event. */ + /** + * ID of the event. + */ eventId: number - /** Description of the event. */ + /** + * Description of the event. + */ description: string - /** Date of the event. */ + /** + * Date of the event. + */ date?: Date } export interface ServerSummary { - /** ID of the server. */ + /** + * ID of the server. + */ id: number - /** Datacenter of the server. */ + /** + * Datacenter of the server. + */ datacenterName: string - /** Organization ID the server is attached to. */ + /** + * Organization ID the server is attached to. + */ organizationId: string - /** Project ID the server is attached to. */ + /** + * Project ID the server is attached to. + */ projectId: string - /** Hostname of the server. */ + /** + * Hostname of the server. + */ hostname: string - /** Date of creation of the server. */ + /** + * Date of creation of the server. + */ createdAt?: Date - /** Date of last modification of the server. */ + /** + * Date of last modification of the server. + */ updatedAt?: Date - /** Date of release of the server. */ + /** + * Date of release of the server. + */ expiredAt?: Date - /** Offer ID of the server. */ + /** + * Offer ID of the server. + */ offerId: number - /** Offer name of the server. */ + /** + * Offer name of the server. + */ offerName: string - /** Status of the server. */ + /** + * Status of the server. + */ status: ServerStatus - /** OS ID installed on server. */ + /** + * OS ID installed on server. + */ osId?: number - /** Network interfaces of the server. */ + /** + * Network interfaces of the server. + */ interfaces: NetworkInterface[] - /** The zone in which is the server. */ + /** + * The zone in which is the server. + */ zone: ScwZone - /** Service level of the server. */ + /** + * Service level of the server. + */ level?: ServiceLevel - /** Whether the server is outsourced or not. */ + /** + * Whether the server is outsourced or not. + */ isOutsourced: boolean - /** Whether the server is compatible with QinQ. */ + /** + * Whether the server is compatible with QinQ. + */ qinq: boolean - /** Supported RPN version. */ + /** + * Supported RPN version. + */ rpnVersion?: number } export interface CPU { - /** Name of CPU. */ + /** + * Name of CPU. + */ name: string - /** Number of cores of the CPU. */ + /** + * Number of cores of the CPU. + */ coreCount: number - /** Number of threads of the CPU. */ + /** + * Number of threads of the CPU. + */ threadCount: number - /** Frequency of the CPU. */ + /** + * Frequency of the CPU. + */ frequency: number } export interface Disk { - /** Capacity of the disk. */ + /** + * Capacity of the disk. + */ capacity: number - /** Type of the disk. */ + /** + * Type of the disk. + */ type: ServerDiskType } export interface Memory { - /** Capacity of the memory. */ + /** + * Capacity of the memory. + */ capacity: number - /** Type of the memory. */ + /** + * Type of the memory. + */ type: MemoryType - /** Frequency of the memory. */ + /** + * Frequency of the memory. + */ frequency: number - /** True if the memory is an error-correcting code memory. */ + /** + * True if the memory is an error-correcting code memory. + */ isEcc: boolean } export interface PersistentMemory { - /** Capacity of the persistent memory. */ + /** + * Capacity of the persistent memory. + */ capacity: number - /** Frequency of the persistent memory. */ + /** + * Frequency of the persistent memory. + */ frequency: number - /** Model of the persistent memory. */ + /** + * Model of the persistent memory. + */ model: string } export interface RaidController { - /** Model of the RAID controller. */ + /** + * Model of the RAID controller. + */ model: string - /** RAID level of the RAID controller. */ + /** + * RAID level of the RAID controller. + */ raidLevel: string[] } export interface RaidArray { - /** The RAID level. */ + /** + * The RAID level. + */ raidLevel: RaidArrayRaidLevel - /** Disks on the RAID controller. */ + /** + * Disks on the RAID controller. + */ disks: ServerDisk[] } export interface Partition { - /** Type of the partition. */ + /** + * Type of the partition. + */ type: PartitionType - /** File system of the partition. */ + /** + * File system of the partition. + */ fileSystem: PartitionFileSystem - /** Mount point of the partition. */ + /** + * Mount point of the partition. + */ mountPoint?: string - /** Raid level of the partition. */ + /** + * Raid level of the partition. + */ raidLevel: RaidArrayRaidLevel - /** Capacity of the partition. */ + /** + * Capacity of the partition. + */ capacity: number - /** Connectors of the partition. */ + /** + * Connectors of the partition. + */ connectors: string[] } export interface UpdatableRaidArray { - /** The RAID level. */ + /** + * The RAID level. + */ raidLevel: RaidArrayRaidLevel - /** The list of Disk ID of the updatable RAID. */ + /** + * The list of Disk ID of the updatable RAID. + */ diskIds: number[] } export type AttachFailoverIPToMacAddressRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the failover IP. */ + /** + * ID of the failover IP. + */ ipId: number - /** A mac type. */ + /** + * A mac type. + */ type?: AttachFailoverIPToMacAddressRequestMacType - /** A valid mac address (existing or not). */ + /** + * A valid mac address (existing or not). + */ mac?: string } export type AttachFailoverIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: number - /** List of ID of failovers IP to attach. */ + /** + * List of ID of failovers IP to attach. + */ fipsIds: number[] } export interface BMCAccess { - /** URL to access to the server console. */ + /** + * URL to access to the server console. + */ url: string /** - * The login to use for the BMC (Baseboard Management Controller) access - * authentification. + * The login to use for the BMC (Baseboard Management Controller) access authentification. */ login: string /** - * The password to use for the BMC (Baseboard Management Controller) access - * authentification. + * The password to use for the BMC (Baseboard Management Controller) access authentification. */ password: string /** - * The date after which the BMC (Baseboard Management Controller) access will - * be closed. + * The date after which the BMC (Baseboard Management Controller) access will be closed. */ expiresAt?: Date - /** Status of the connection. */ + /** + * Status of the connection. + */ status: BMCAccessStatus } export interface Backup { - /** ID of the backup. */ + /** + * ID of the backup. + */ id: number - /** Login of the backup. */ + /** + * Login of the backup. + */ login: string - /** Server of the backup. */ + /** + * Server of the backup. + */ server: string - /** Status of the backup. */ + /** + * Status of the backup. + */ status: BackupStatus - /** ACL enable boolean of the backup. */ + /** + * ACL enable boolean of the backup. + */ aclEnabled: boolean - /** Autologin boolean of the backup. */ + /** + * Autologin boolean of the backup. + */ autologin: boolean - /** Total quota space of the backup. */ + /** + * Total quota space of the backup. + */ quotaSpace: number - /** Quota space used of the backup. */ + /** + * Quota space used of the backup. + */ quotaSpaceUsed: number - /** Total quota files of the backup. */ + /** + * Total quota files of the backup. + */ quotaFiles: number - /** Quota files used of the backup. */ + /** + * Quota files used of the backup. + */ quotaFilesUsed: number } @@ -1219,20 +1686,32 @@ export interface CanOrderResponse { } export type CancelServerInstallRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID of the server to cancel install. */ + /** + * Server ID of the server to cancel install. + */ serverId: number } export type CreateFailoverIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Failover IP offer ID. */ + /** + * Failover IP offer ID. + */ offerId: number - /** Project ID. */ + /** + * Project ID. + */ projectId?: string - /** Quantity. */ + /** + * Quantity. + */ quantity: number } @@ -1242,258 +1721,420 @@ export interface CreateFailoverIPsResponse { } export type CreateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Offer ID of the new server. */ + /** + * Offer ID of the new server. + */ offerId: number - /** Server option IDs of the new server. */ + /** + * Server option IDs of the new server. + */ serverOptionIds: number[] - /** Project ID of the new server. */ + /** + * Project ID of the new server. + */ projectId?: string - /** Datacenter name of the new server. */ + /** + * Datacenter name of the new server. + */ datacenterName?: string } export type DeleteFailoverIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the failover IP to delete. */ + /** + * ID of the failover IP to delete. + */ ipId: number } export type DeleteServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to delete. */ + /** + * Server ID to delete. + */ serverId: number } export type DeleteServiceRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the service. */ + /** + * ID of the service. + */ serviceId: number } export type DetachFailoverIPFromMacAddressRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the failover IP. */ + /** + * ID of the failover IP. + */ ipId: number } export type DetachFailoverIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** List of IDs of failovers IP to detach. */ + /** + * List of IDs of failovers IP to detach. + */ fipsIds: number[] } export type GetBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to get BMC access. */ + /** + * ID of the server to get BMC access. + */ serverId: number } export type GetFailoverIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the failover IP. */ + /** + * ID of the failover IP. + */ ipId: number } export interface GetIPv6BlockQuotasResponse { - /** Quota for each CIDR of IPv6 block. */ + /** + * Quota for each CIDR of IPv6 block. + */ quotas: GetIPv6BlockQuotasResponseQuota[] - /** Total count of quotas. */ + /** + * Total count of quotas. + */ totalCount: number } export type GetOSRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the OS. */ + /** + * ID of the OS. + */ osId: number - /** ID of the server. */ + /** + * ID of the server. + */ serverId: number - /** Project ID. */ + /** + * Project ID. + */ projectId?: string } export type GetOfferRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of offer. */ + /** + * ID of offer. + */ offerId: number - /** Project ID. */ + /** + * Project ID. + */ projectId?: string } export type GetOrderedServiceRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone orderedServiceId: number } export type GetRaidRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: number } export type GetRemainingQuotaRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Project ID. */ + /** + * Project ID. + */ projectId?: string } export interface GetRemainingQuotaResponse { - /** Current failover IP quota. */ + /** + * Current failover IP quota. + */ failoverIpQuota: number - /** Remaining failover IP quota. */ + /** + * Remaining failover IP quota. + */ failoverIpRemainingQuota: number - /** Current failover block quota. */ + /** + * Current failover block quota. + */ failoverBlockQuota: number - /** Remaining failover block quota. */ + /** + * Remaining failover block quota. + */ failoverBlockRemainingQuota: number } export type GetRescueRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to get rescue. */ + /** + * ID of the server to get rescue. + */ serverId: number } export interface GetRpnStatusResponse { - /** If status = 'operational', you can perform rpn actions in write. */ + /** + * If status = 'operational', you can perform rpn actions in write. + */ status: GetRpnStatusResponseStatus - /** Number of operations left to perform before being operational. */ + /** + * Number of operations left to perform before being operational. + */ operationsLeft?: number } export type GetServerBackupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID of the backup. */ + /** + * Server ID of the backup. + */ serverId: number } export type GetServerDefaultPartitioningRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: number - /** OS ID of the default partitioning. */ + /** + * OS ID of the default partitioning. + */ osId: number } export type GetServerInstallRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID of the server to install. */ + /** + * Server ID of the server to install. + */ serverId: number } export type GetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: number } export type GetServiceRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the service. */ + /** + * ID of the service. + */ serviceId: number } export interface IPv6Block { - /** ID of the IPv6. */ + /** + * ID of the IPv6. + */ id: number - /** Address of the IPv6. */ + /** + * Address of the IPv6. + */ address: string - /** DUID of the IPv6. */ + /** + * DUID of the IPv6. + */ duid: string - /** DNS linked to the IPv6. */ + /** + * DNS linked to the IPv6. + */ nameservers: string[] - /** Classless InterDomain Routing notation of the IPv6. */ + /** + * Classless InterDomain Routing notation of the IPv6. + */ cidr: number - /** All IPv6 subnets. */ + /** + * All IPv6 subnets. + */ subnets: IPv6Block[] - /** The nameservers delegation status. */ + /** + * The nameservers delegation status. + */ delegationStatus: IPv6BlockDelegationStatus } export type IPv6BlockApiCreateIPv6BlockRequest = { - /** ID of the project. */ + /** + * ID of the project. + */ projectId?: string } export type IPv6BlockApiCreateIPv6BlockSubnetRequest = { - /** ID of the IPv6 block. */ + /** + * ID of the IPv6 block. + */ blockId: number - /** Address of the IPv6. */ + /** + * Address of the IPv6. + */ address: string - /** Classless InterDomain Routing notation of the IPv6. */ + /** + * Classless InterDomain Routing notation of the IPv6. + */ cidr: number } export type IPv6BlockApiDeleteIPv6BlockRequest = { - /** ID of the IPv6 block to delete. */ + /** + * ID of the IPv6 block to delete. + */ blockId: number } export type IPv6BlockApiGetIPv6BlockQuotasRequest = { - /** ID of the project. */ + /** + * ID of the project. + */ projectId?: string } export type IPv6BlockApiGetIPv6BlockRequest = { - /** ID of the project. */ + /** + * ID of the project. + */ projectId?: string } export type IPv6BlockApiListIPv6BlockSubnetsAvailableRequest = { - /** ID of the IPv6 block. */ + /** + * ID of the IPv6 block. + */ blockId: number } export type IPv6BlockApiUpdateIPv6BlockRequest = { - /** ID of the IPv6 block. */ + /** + * ID of the IPv6 block. + */ blockId: number - /** DNS to link to the IPv6. */ + /** + * DNS to link to the IPv6. + */ nameservers?: string[] } export type InstallServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to install. */ + /** + * Server ID to install. + */ serverId: number - /** OS ID to install on the server. */ + /** + * OS ID to install on the server. + */ osId: number - /** Hostname of the server. */ + /** + * Hostname of the server. + */ hostname: string - /** User to install on the server. */ + /** + * User to install on the server. + */ userLogin?: string - /** User password to install on the server. */ + /** + * User password to install on the server. + */ userPassword?: string - /** Panel password to install on the server. */ + /** + * Panel password to install on the server. + */ panelPassword?: string - /** Root password to install on the server. */ + /** + * Root password to install on the server. + */ rootPassword?: string - /** Partitions to install on the server. */ + /** + * Partitions to install on the server. + */ partitions?: InstallPartition[] - /** SSH key IDs authorized on the server. */ + /** + * SSH key IDs authorized on the server. + */ sshKeyIds?: string[] - /** Offer ID of license to install on server. */ + /** + * Offer ID of license to install on server. + */ licenseOfferId?: number - /** IP to link at the license to install on server. */ + /** + * IP to link at the license to install on server. + */ ipId?: number } @@ -1510,36 +2151,56 @@ export interface Invoice { } export type ListFailoverIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of failovers IP per page. */ + /** + * Number of failovers IP per page. + */ pageSize?: number - /** Order of the failovers IP. */ + /** + * Order of the failovers IP. + */ orderBy?: ListFailoverIPsRequestOrderBy - /** Filter failovers IP by project ID. */ + /** + * Filter failovers IP by project ID. + */ projectId?: string - /** Filter failovers IP which matching with this field. */ + /** + * Filter failovers IP which matching with this field. + */ search?: string /** - * True: return all failovers IP not attached on server false: return all - * failovers IP attached on server. + * True: return all failovers IP not attached on server +false: return all failovers IP attached on server. */ onlyAvailable?: boolean } export interface ListFailoverIPsResponse { - /** Total count of matching failovers IP. */ + /** + * Total count of matching failovers IP. + */ totalCount: number - /** List of failover IPs that match filters. */ + /** + * List of failover IPs that match filters. + */ failoverIps: FailoverIP[] } export interface ListIPv6BlockSubnetsAvailableResponse { - /** All available address and CIDR available in subnet. */ + /** + * All available address and CIDR available in subnet. + */ subnetAvailables: ListIPv6BlockSubnetsAvailableResponseSubnet[] - /** Total count of available subnets. */ + /** + * Total count of available subnets. + */ totalCount: number } @@ -1549,67 +2210,117 @@ export interface ListInvoicesResponse { } export interface ListIpsResponse { - /** Total count of authorized IPs. */ + /** + * Total count of authorized IPs. + */ totalCount: number - /** List of authorized IPs. */ + /** + * List of authorized IPs. + */ ips: RpnSanIp[] } export type ListOSRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of OS per page. */ + /** + * Number of OS per page. + */ pageSize?: number - /** Order of the OS. */ + /** + * Order of the OS. + */ orderBy?: ListOSRequestOrderBy - /** Type of the OS. */ + /** + * Type of the OS. + */ type?: OSType - /** Filter OS by compatible server ID. */ + /** + * Filter OS by compatible server ID. + */ serverId: number - /** Project ID. */ + /** + * Project ID. + */ projectId?: string } export interface ListOSResponse { - /** Total count of matching OS. */ + /** + * Total count of matching OS. + */ totalCount: number - /** OS that match filters. */ + /** + * OS that match filters. + */ os: OS[] } export type ListOffersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of offer per page. */ + /** + * Number of offer per page. + */ pageSize?: number - /** Order of the offers. */ + /** + * Order of the offers. + */ orderBy?: ListOffersRequestOrderBy - /** Filter on commercial range. */ + /** + * Filter on commercial range. + */ commercialRange?: string - /** Filter on catalog. */ + /** + * Filter on catalog. + */ catalog?: OfferCatalog - /** Project ID. */ + /** + * Project ID. + */ projectId?: string - /** Get the current failover IP offer. */ + /** + * Get the current failover IP offer. + */ isFailoverIp?: boolean - /** Get the current failover IP block offer. */ + /** + * Get the current failover IP block offer. + */ isFailoverBlock?: boolean - /** Filter offers depending on their datacenter. */ + /** + * Filter offers depending on their datacenter. + */ soldIn?: string[] - /** Set this filter to true to only return available offers. */ + /** + * Set this filter to true to only return available offers. + */ availableOnly?: boolean - /** Get the RPN SAN offers. */ + /** + * Get the RPN SAN offers. + */ isRpnSan?: boolean } export interface ListOffersResponse { - /** Total count of matching offers. */ + /** + * Total count of matching offers. + */ totalCount: number - /** Offers that match filters. */ + /** + * Offers that match filters. + */ offers: Offer[] } @@ -1619,179 +2330,293 @@ export interface ListRefundsResponse { } export interface ListRpnCapableSanServersResponse { - /** Total count of rpn capable san servers. */ + /** + * Total count of rpn capable san servers. + */ totalCount: number - /** List of san servers. */ + /** + * List of san servers. + */ sanServers: RpnSanServer[] } export interface ListRpnCapableServersResponse { - /** Total count of rpn capable servers. */ + /** + * Total count of rpn capable servers. + */ totalCount: number - /** List of servers. */ + /** + * List of servers. + */ servers: Server[] } export interface ListRpnGroupMembersResponse { - /** Total count of rpn v1 group members. */ + /** + * Total count of rpn v1 group members. + */ totalCount: number - /** List of rpn v1 group members. */ + /** + * List of rpn v1 group members. + */ members: RpnGroupMember[] } export interface ListRpnGroupsResponse { - /** Total count of rpn groups. */ + /** + * Total count of rpn groups. + */ totalCount: number - /** List of rpn v1 groups. */ + /** + * List of rpn v1 groups. + */ rpnGroups: RpnGroup[] } export interface ListRpnInvitesResponse { - /** Total count of invites. */ + /** + * Total count of invites. + */ totalCount: number - /** List of invites. */ + /** + * List of invites. + */ members: RpnGroupMember[] } export interface ListRpnSansResponse { - /** Total count of matching RPN SANs. */ + /** + * Total count of matching RPN SANs. + */ totalCount: number - /** List of RPN SANs that match filters. */ + /** + * List of RPN SANs that match filters. + */ rpnSans: RpnSanSummary[] } export interface ListRpnServerCapabilitiesResponse { - /** Total count of servers. */ + /** + * Total count of servers. + */ totalCount: number - /** List of servers and their RPN capabilities. */ + /** + * List of servers and their RPN capabilities. + */ servers: RpnServerCapability[] } export interface ListRpnV2CapableResourcesResponse { - /** Total count of matching rpn v2 capable resources. */ + /** + * Total count of matching rpn v2 capable resources. + */ totalCount: number - /** List of rpn v2 capable resources that match filters. */ + /** + * List of rpn v2 capable resources that match filters. + */ servers: Server[] } export interface ListRpnV2GroupLogsResponse { - /** Total count of matching rpn v2 logs. */ + /** + * Total count of matching rpn v2 logs. + */ totalCount: number - /** List of rpn v2 logs that match filters. */ + /** + * List of rpn v2 logs that match filters. + */ logs: Log[] } export interface ListRpnV2GroupsResponse { - /** Total count of matching rpn v2 groups. */ + /** + * Total count of matching rpn v2 groups. + */ totalCount: number - /** List of rpn v2 groups that match filters. */ + /** + * List of rpn v2 groups that match filters. + */ rpnGroups: RpnV2Group[] } export interface ListRpnV2MembersResponse { - /** Total count of matching rpn v2 group members. */ + /** + * Total count of matching rpn v2 group members. + */ totalCount: number - /** List of rpn v2 group members that match filters. */ + /** + * List of rpn v2 group members that match filters. + */ members: RpnV2Member[] } export type ListServerDisksRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID of the server disks. */ + /** + * Server ID of the server disks. + */ serverId: number - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of server disk per page. */ + /** + * Number of server disk per page. + */ pageSize?: number - /** Order of the server disks. */ + /** + * Order of the server disks. + */ orderBy?: ListServerDisksRequestOrderBy } export interface ListServerDisksResponse { - /** Total count of matching server disks. */ + /** + * Total count of matching server disks. + */ totalCount: number - /** Server disks that match filters. */ + /** + * Server disks that match filters. + */ disks: ServerDisk[] } export type ListServerEventsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID of the server events. */ + /** + * Server ID of the server events. + */ serverId: number - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of server event per page. */ + /** + * Number of server event per page. + */ pageSize?: number - /** Order of the server events. */ + /** + * Order of the server events. + */ orderBy?: ListServerEventsRequestOrderBy } export interface ListServerEventsResponse { - /** Total count of matching server events. */ + /** + * Total count of matching server events. + */ totalCount: number - /** Server events that match filters. */ + /** + * Server events that match filters. + */ events: ServerEvent[] } export type ListServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of server per page. */ + /** + * Number of server per page. + */ pageSize?: number - /** Order of the servers. */ + /** + * Order of the servers. + */ orderBy?: ListServersRequestOrderBy - /** Filter servers by project ID. */ + /** + * Filter servers by project ID. + */ projectId?: string - /** Filter servers by hostname. */ + /** + * Filter servers by hostname. + */ search?: string } export interface ListServersResponse { - /** Total count of matching servers. */ + /** + * Total count of matching servers. + */ totalCount: number - /** Servers that match filters. */ + /** + * Servers that match filters. + */ servers: ServerSummary[] } export type ListServicesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of service per page. */ + /** + * Number of service per page. + */ pageSize?: number - /** Order of the services. */ + /** + * Order of the services. + */ orderBy?: ListServicesRequestOrderBy - /** Project ID. */ + /** + * Project ID. + */ projectId?: string } export interface ListServicesResponse { - /** Total count of matching services. */ + /** + * Total count of matching services. + */ totalCount: number - /** Services that match filters. */ + /** + * Services that match filters. + */ services: Service[] } export type ListSubscribableServerOptionsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID of the subscribable server options. */ + /** + * Server ID of the subscribable server options. + */ serverId: number - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of subscribable server option per page. */ + /** + * Number of subscribable server option per page. + */ pageSize?: number } export interface ListSubscribableServerOptionsResponse { - /** Total count of matching subscribable server options. */ + /** + * Total count of matching subscribable server options. + */ totalCount: number - /** Server options that match filters. */ + /** + * Server options that match filters. + */ serverOptions: Offer[] } @@ -1834,14 +2659,20 @@ export interface OfferServiceLevelInfo { } export interface Raid { - /** Details about the RAID controller. */ + /** + * Details about the RAID controller. + */ raidArrays: RaidArray[] } export type RebootServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to reboot. */ + /** + * Server ID to reboot. + */ serverId: number } @@ -1857,332 +2688,543 @@ export interface Refund { } export interface Rescue { - /** OS ID of the rescue. */ + /** + * OS ID of the rescue. + */ osId: number - /** Login of the rescue. */ + /** + * Login of the rescue. + */ login: string - /** Password of the rescue. */ + /** + * Password of the rescue. + */ password: string - /** Protocol of the resuce. */ + /** + * Protocol of the resuce. + */ protocol: RescueProtocol } export type RpnApiGetRpnStatusRequest = { - /** A project ID. */ + /** + * A project ID. + */ projectId?: string - /** An RPN v1 group ID. */ + /** + * An RPN v1 group ID. + */ rpnv1GroupId?: number - /** An RPN v2 group ID. */ + /** + * An RPN v2 group ID. + */ rpnv2GroupId?: number } export type RpnApiListRpnServerCapabilitiesRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of servers per page. */ + /** + * Number of servers per page. + */ pageSize?: number - /** Order of the servers. */ + /** + * Order of the servers. + */ orderBy?: ListRpnServerCapabilitiesRequestOrderBy - /** Filter servers by project ID. */ + /** + * Filter servers by project ID. + */ projectId?: string } export type RpnSanApiAddIpRequest = { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ rpnSanId: number - /** An array of IP ID. */ + /** + * An array of IP ID. + */ ipIds: number[] } export type RpnSanApiCreateRpnSanRequest = { - /** Offer ID. */ + /** + * Offer ID. + */ offerId: number - /** Your project ID. */ + /** + * Your project ID. + */ projectId?: string } export type RpnSanApiDeleteRpnSanRequest = { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ rpnSanId: number } export type RpnSanApiGetRpnSanRequest = { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ rpnSanId: number } export type RpnSanApiListAvailableIpsRequest = { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ rpnSanId: number - /** Filter by IP type (server | rpnv2_subnet). */ + /** + * Filter by IP type (server | rpnv2_subnet). + */ type?: RpnSanIpType } export type RpnSanApiListIpsRequest = { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ rpnSanId: number - /** Filter by IP type (server | rpnv2_subnet). */ + /** + * Filter by IP type (server | rpnv2_subnet). + */ type?: RpnSanIpType } export type RpnSanApiListRpnSansRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of RPN SANs per page. */ + /** + * Number of RPN SANs per page. + */ pageSize?: number - /** Order of the RPN SANs. */ + /** + * Order of the RPN SANs. + */ orderBy?: ListRpnSansRequestOrderBy - /** Filter RPN SANs by project ID. */ + /** + * Filter RPN SANs by project ID. + */ projectId?: string } export type RpnSanApiRemoveIpRequest = { - /** RPN SAN ID. */ + /** + * RPN SAN ID. + */ rpnSanId: number - /** An array of IP ID. */ + /** + * An array of IP ID. + */ ipIds: number[] } export type RpnV1ApiAcceptRpnInviteRequest = { - /** The member ID. */ + /** + * The member ID. + */ memberId: number } export type RpnV1ApiAddRpnGroupMembersRequest = { - /** The rpn v1 group ID. */ + /** + * The rpn v1 group ID. + */ groupId: number - /** A collection of rpn v1 capable server IDs. */ + /** + * A collection of rpn v1 capable server IDs. + */ serverIds?: number[] - /** A collection of rpn v1 capable RPN SAN server IDs. */ + /** + * A collection of rpn v1 capable RPN SAN server IDs. + */ sanServerIds?: number[] } export type RpnV1ApiCreateRpnGroupRequest = { - /** Rpn v1 group name. */ + /** + * Rpn v1 group name. + */ name: string - /** A collection of rpn v1 capable servers. */ + /** + * A collection of rpn v1 capable servers. + */ serverIds?: number[] - /** A collection of rpn v1 capable rpn sans servers. */ + /** + * A collection of rpn v1 capable rpn sans servers. + */ sanServerIds?: number[] - /** A project ID. */ + /** + * A project ID. + */ projectId?: string } export type RpnV1ApiDeleteRpnGroupMembersRequest = { - /** The rpn v1 group ID. */ + /** + * The rpn v1 group ID. + */ groupId: number - /** A collection of rpn v1 group members IDs. */ + /** + * A collection of rpn v1 group members IDs. + */ memberIds: number[] } export type RpnV1ApiDeleteRpnGroupRequest = { - /** Rpn v1 group ID. */ + /** + * Rpn v1 group ID. + */ groupId: number } export type RpnV1ApiGetRpnGroupRequest = { - /** Rpn v1 group ID. */ + /** + * Rpn v1 group ID. + */ groupId: number } export type RpnV1ApiLeaveRpnGroupRequest = { - /** The RPN V1 group ID. */ + /** + * The RPN V1 group ID. + */ groupId: number - /** A project ID. */ + /** + * A project ID. + */ projectId?: string - /** A collection of rpn v1 group members IDs. */ + /** + * A collection of rpn v1 group members IDs. + */ memberIds: number[] } export type RpnV1ApiListRpnCapableSanServersRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn capable resources per page. */ + /** + * Number of rpn capable resources per page. + */ pageSize?: number - /** Order of the rpn capable resources. */ + /** + * Order of the rpn capable resources. + */ orderBy?: ListRpnCapableSanServersRequestOrderBy - /** Filter rpn capable resources by project ID. */ + /** + * Filter rpn capable resources by project ID. + */ projectId?: string } export type RpnV1ApiListRpnCapableServersRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn capable resources per page. */ + /** + * Number of rpn capable resources per page. + */ pageSize?: number - /** Order of the rpn capable resources. */ + /** + * Order of the rpn capable resources. + */ orderBy?: ListRpnCapableServersRequestOrderBy - /** Filter rpn capable resources by project ID. */ + /** + * Filter rpn capable resources by project ID. + */ projectId?: string } export type RpnV1ApiListRpnGroupMembersRequest = { - /** Filter rpn v1 group members by group ID. */ + /** + * Filter rpn v1 group members by group ID. + */ groupId: number - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn v1 group members per page. */ + /** + * Number of rpn v1 group members per page. + */ pageSize?: number - /** Order of the rpn v1 group members. */ + /** + * Order of the rpn v1 group members. + */ orderBy?: ListRpnGroupMembersRequestOrderBy - /** A project ID. */ + /** + * A project ID. + */ projectId?: string } export type RpnV1ApiListRpnGroupsRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn v1 groups per page. */ + /** + * Number of rpn v1 groups per page. + */ pageSize?: number - /** Order of the rpn v1 groups. */ + /** + * Order of the rpn v1 groups. + */ orderBy?: ListRpnGroupsRequestOrderBy - /** Filter rpn v1 groups by project ID. */ + /** + * Filter rpn v1 groups by project ID. + */ projectId?: string } export type RpnV1ApiListRpnInvitesRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn capable resources per page. */ + /** + * Number of rpn capable resources per page. + */ pageSize?: number - /** Order of the rpn capable resources. */ + /** + * Order of the rpn capable resources. + */ orderBy?: ListRpnInvitesRequestOrderBy - /** Filter rpn capable resources by project ID. */ + /** + * Filter rpn capable resources by project ID. + */ projectId?: string } export type RpnV1ApiRefuseRpnInviteRequest = { - /** The member ID. */ + /** + * The member ID. + */ memberId: number } export type RpnV1ApiRpnGroupInviteRequest = { - /** The RPN V1 group ID. */ + /** + * The RPN V1 group ID. + */ groupId: number - /** A collection of external server IDs. */ + /** + * A collection of external server IDs. + */ serverIds: number[] - /** A project ID. */ + /** + * A project ID. + */ projectId?: string } export type RpnV1ApiUpdateRpnGroupNameRequest = { - /** Rpn v1 group ID. */ + /** + * Rpn v1 group ID. + */ groupId: number - /** New rpn v1 group name. */ + /** + * New rpn v1 group name. + */ name?: string } export type RpnV2ApiAddRpnV2MembersRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number - /** A collection of server IDs. */ + /** + * A collection of server IDs. + */ servers: number[] } export type RpnV2ApiCreateRpnV2GroupRequest = { - /** Project ID of the RPN V2 group. */ + /** + * Project ID of the RPN V2 group. + */ projectId?: string - /** RPN V2 group type (qing / standard). */ + /** + * RPN V2 group type (qing / standard). + */ type?: RpnV2GroupType - /** RPN V2 group name. */ + /** + * RPN V2 group name. + */ name: string - /** A collection of server IDs. */ + /** + * A collection of server IDs. + */ servers: number[] } export type RpnV2ApiDeleteRpnV2GroupRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number } export type RpnV2ApiDeleteRpnV2MembersRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number - /** A collection of member IDs. */ + /** + * A collection of member IDs. + */ memberIds: number[] } export type RpnV2ApiDisableRpnV2GroupCompatibilityRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number } export type RpnV2ApiEnableRpnV2GroupCompatibilityRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number - /** RPN V1 group ID. */ + /** + * RPN V1 group ID. + */ rpnv1GroupId: number } export type RpnV2ApiGetRpnV2GroupRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number } export type RpnV2ApiListRpnV2CapableResourcesRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn v2 capable resources per page. */ + /** + * Number of rpn v2 capable resources per page. + */ pageSize?: number - /** Order of the rpn v2 capable resources. */ + /** + * Order of the rpn v2 capable resources. + */ orderBy?: ListRpnV2CapableResourcesRequestOrderBy - /** Filter rpn v2 capable resources by project ID. */ + /** + * Filter rpn v2 capable resources by project ID. + */ projectId?: string } export type RpnV2ApiListRpnV2GroupLogsRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn v2 group logs per page. */ + /** + * Number of rpn v2 group logs per page. + */ pageSize?: number - /** Order of the rpn v2 group logs. */ + /** + * Order of the rpn v2 group logs. + */ orderBy?: ListRpnV2GroupLogsRequestOrderBy } export type RpnV2ApiListRpnV2GroupsRequest = { - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn v2 groups per page. */ + /** + * Number of rpn v2 groups per page. + */ pageSize?: number - /** Order of the rpn v2 groups. */ + /** + * Order of the rpn v2 groups. + */ orderBy?: ListRpnV2GroupsRequestOrderBy - /** Filter rpn v2 groups by project ID. */ + /** + * Filter rpn v2 groups by project ID. + */ projectId?: string } export type RpnV2ApiListRpnV2MembersRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number - /** Page number. */ + /** + * Page number. + */ page?: number - /** Number of rpn v2 group members per page. */ + /** + * Number of rpn v2 group members per page. + */ pageSize?: number - /** Order of the rpn v2 group members. */ + /** + * Order of the rpn v2 group members. + */ orderBy?: ListRpnV2MembersRequestOrderBy - /** Filter members by type. */ + /** + * Filter members by type. + */ type?: ListRpnV2MembersRequestType } export type RpnV2ApiUpdateRpnV2GroupNameRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number - /** RPN V2 group name. */ + /** + * RPN V2 group name. + */ name?: string } export type RpnV2ApiUpdateRpnV2VlanForMembersRequest = { - /** RPN V2 group ID. */ + /** + * RPN V2 group ID. + */ groupId: number - /** RPN V2 member IDs. */ + /** + * RPN V2 member IDs. + */ memberIds: number[] - /** Min: 0. Max: 3967. */ + /** + * Min: 0. +Max: 3967. + */ vlan?: number } export interface ServerDefaultPartitioning { - /** Default partitions. */ + /** + * Default partitions. + */ partitions: Partition[] } @@ -2197,121 +3239,199 @@ export interface ServerInstall { } export type StartBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to start the BMC access. */ + /** + * ID of the server to start the BMC access. + */ serverId: number - /** The IP authorized to connect to the given server. */ + /** + * The IP authorized to connect to the given server. + */ ip: string } export type StartRescueRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to start rescue. */ + /** + * ID of the server to start rescue. + */ serverId: number - /** OS ID to use to start rescue. */ + /** + * OS ID to use to start rescue. + */ osId: number } export type StartServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to start. */ + /** + * Server ID to start. + */ serverId: number } export type StopBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to stop BMC access. */ + /** + * ID of the server to stop BMC access. + */ serverId: number } export type StopRescueRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server to stop rescue. */ + /** + * ID of the server to stop rescue. + */ serverId: number } export type StopServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to stop. */ + /** + * Server ID to stop. + */ serverId: number } export type SubscribeServerOptionRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to subscribe server option. */ + /** + * Server ID to subscribe server option. + */ serverId: number - /** Option ID to subscribe. */ + /** + * Option ID to subscribe. + */ optionId: number } export type SubscribeStorageOptionsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID of the storage options to subscribe. */ + /** + * Server ID of the storage options to subscribe. + */ serverId: number - /** Option IDs of the storage options to subscribe. */ + /** + * Option IDs of the storage options to subscribe. + */ optionsIds: number[] } export interface SubscribeStorageOptionsResponse { - /** Services subscribe storage options. */ + /** + * Services subscribe storage options. + */ services: Service[] } export type UpdateRaidRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the server. */ + /** + * ID of the server. + */ serverId: number - /** RAIDs to update. */ + /** + * RAIDs to update. + */ raidArrays: UpdatableRaidArray[] } export type UpdateReverseRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the IP. */ + /** + * ID of the IP. + */ ipId: number - /** Reverse to apply on the IP. */ + /** + * Reverse to apply on the IP. + */ reverse: string } export type UpdateServerBackupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to update backup. */ + /** + * Server ID to update backup. + */ serverId: number - /** Password of the server backup. */ + /** + * Password of the server backup. + */ password?: string - /** Autologin of the server backup. */ + /** + * Autologin of the server backup. + */ autologin?: boolean - /** Boolean to enable or disable ACL. */ + /** + * Boolean to enable or disable ACL. + */ aclEnabled?: boolean } export type UpdateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to update. */ + /** + * Server ID to update. + */ serverId: number - /** Hostname of the server to update. */ + /** + * Hostname of the server to update. + */ hostname?: string - /** Flag to enable or not the IPv6 of server. */ + /** + * Flag to enable or not the IPv6 of server. + */ enableIpv6?: boolean } export type UpdateServerTagsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Server ID to update the tags. */ + /** + * Server ID to update the tags. + */ serverId: number - /** Tags of server to update. */ + /** + * Tags of server to update. + */ tags?: string[] } diff --git a/packages/clients/src/api/domain/v2beta1/api.gen.ts b/packages/clients/src/api/domain/v2beta1/api.gen.ts index e701d1e3d..b388869bd 100644 --- a/packages/clients/src/api/domain/v2beta1/api.gen.ts +++ b/packages/clients/src/api/domain/v2beta1/api.gen.ts @@ -163,8 +163,8 @@ const jsonContentHeaders = { /** * Domains and DNS API. - * - * This API allows you to manage your domains, DNS zones and records. + +This API allows you to manage your domains, DNS zones and records. */ export class API extends ParentAPI { protected pageOfListDNSZones = (request: Readonly) => @@ -194,8 +194,7 @@ export class API extends ParentAPI { ) /** - * List DNS zones. Retrieve the list of DNS zones you can manage and filter - * DNS zones associated with specific domain names. + * List DNS zones. Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names. * * @param request - The request {@link ListDNSZonesRequest} * @returns A Promise of ListDNSZonesResponse @@ -204,8 +203,7 @@ export class API extends ParentAPI { enrichForPagination('dnsZones', this.pageOfListDNSZones, request) /** - * Create a DNS zone. Create a new DNS zone specified by the domain name, the - * subdomain and the Project ID. + * Create a DNS zone. Create a new DNS zone specified by the domain name, the subdomain and the Project ID. * * @param request - The request {@link CreateDNSZoneRequest} * @returns A Promise of DNSZone @@ -243,8 +241,7 @@ export class API extends ParentAPI { ) /** - * Clone a DNS zone. Clone an existing DNS zone with all its records into a - * new DNS zone. + * Clone a DNS zone. Clone an existing DNS zone with all its records into a new DNS zone. * * @param request - The request {@link CloneDNSZoneRequest} * @returns A Promise of DNSZone @@ -305,9 +302,8 @@ export class API extends ParentAPI { ) /** - * List records within a DNS zone. Retrieve a list of DNS records within a DNS - * zone that has default name servers. You can filter records by type and - * name. + * List records within a DNS zone. Retrieve a list of DNS records within a DNS zone that has default name servers. +You can filter records by type and name. * * @param request - The request {@link ListDNSZoneRecordsRequest} * @returns A Promise of ListDNSZoneRecordsResponse @@ -316,20 +312,15 @@ export class API extends ParentAPI { enrichForPagination('records', this.pageOfListDNSZoneRecords, request) /** - * Update records within a DNS zone. Update records within a DNS zone that has - * default name servers and perform several actions on your records. - * - * Actions include: - * - * - Add: allows you to add a new record or add a new IP to an existing A - * record, for example - * - Set: allows you to edit a record or edit an IP from an existing A record, - * for example - * - Delete: allows you to delete a record or delete an IP from an existing A - * record, for example - * - Clear: allows you to delete all records from a DNS zone - * - * All edits will be versioned. + * Update records within a DNS zone. Update records within a DNS zone that has default name servers and perform several actions on your records. + +Actions include: + - add: allows you to add a new record or add a new IP to an existing A record, for example + - set: allows you to edit a record or edit an IP from an existing A record, for example + - delete: allows you to delete a record or delete an IP from an existing A record, for example + - clear: allows you to delete all records from a DNS zone + +All edits will be versioned. * * @param request - The request {@link UpdateDNSZoneRecordsRequest} * @returns A Promise of UpdateDNSZoneRecordsResponse @@ -348,8 +339,7 @@ export class API extends ParentAPI { ) /** - * List name servers within a DNS zone. Retrieve a list of name servers within - * a DNS zone and their optional glue records. + * List name servers within a DNS zone. Retrieve a list of name servers within a DNS zone and their optional glue records. * * @param request - The request {@link ListDNSZoneNameserversRequest} * @returns A Promise of ListDNSZoneNameserversResponse @@ -365,8 +355,7 @@ export class API extends ParentAPI { ) /** - * Update name servers within a DNS zone. Update name servers within a DNS - * zone and set optional glue records. + * Update name servers within a DNS zone. Update name servers within a DNS zone and set optional glue records. * * @param request - The request {@link UpdateDNSZoneNameserversRequest} * @returns A Promise of UpdateDNSZoneNameserversResponse @@ -387,8 +376,8 @@ export class API extends ParentAPI { ) /** - * Clear records within a DNS zone. Delete all records within a DNS zone that - * has default name servers.
All edits will be versioned. + * Clear records within a DNS zone. Delete all records within a DNS zone that has default name servers.
+All edits will be versioned. * * @param request - The request {@link ClearDNSZoneRecordsRequest} * @returns A Promise of ClearDNSZoneRecordsResponse @@ -403,8 +392,7 @@ export class API extends ParentAPI { ) /** - * Export a raw DNS zone. Export a DNS zone with default name servers, in a - * specific format. + * Export a raw DNS zone. Export a DNS zone with default name servers, in a specific format. * * @param request - The request {@link ExportRawDNSZoneRequest} * @returns A Promise of Blob @@ -418,8 +406,7 @@ export class API extends ParentAPI { }) /** - * Import a raw DNS zone. Import and replace the format of records from a - * given provider, with default name servers. + * Import a raw DNS zone. Import and replace the format of records from a given provider, with default name servers. * * @param request - The request {@link ImportRawDNSZoneRequest} * @returns A Promise of ImportRawDNSZoneResponse @@ -438,8 +425,7 @@ export class API extends ParentAPI { ) /** - * Import a DNS zone from another provider. Import and replace the format of - * records from a given provider, with default name servers. + * Import a DNS zone from another provider. Import and replace the format of records from a given provider, with default name servers. * * @param request - The request {@link ImportProviderDNSZoneRequest} * @returns A Promise of ImportProviderDNSZoneResponse @@ -458,9 +444,8 @@ export class API extends ParentAPI { ) /** - * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the - * DNS zone and update the SOA serial. You can recreate the given DNS zone and - * its sub DNS zone if needed. + * Refresh a DNS zone. Refresh an SOA DNS zone to reload the records in the DNS zone and update the SOA serial. +You can recreate the given DNS zone and its sub DNS zone if needed. * * @param request - The request {@link RefreshDNSZoneRequest} * @returns A Promise of RefreshDNSZoneResponse @@ -498,8 +483,7 @@ export class API extends ParentAPI { /** * List versions of a DNS zone. Retrieve a list of a DNS zone's versions.
- * The maximum version count is 100. If the count reaches this limit, the - * oldest version will be deleted after each new modification. +The maximum version count is 100. If the count reaches this limit, the oldest version will be deleted after each new modification. * * @param request - The request {@link ListDNSZoneVersionsRequest} * @returns A Promise of ListDNSZoneVersionsResponse @@ -526,8 +510,7 @@ export class API extends ParentAPI { ) /** - * List records from a given version of a specific DNS zone. Retrieve a list - * of records from a specific DNS zone version. + * List records from a given version of a specific DNS zone. Retrieve a list of records from a specific DNS zone version. * * @param request - The request {@link ListDNSZoneVersionRecordsRequest} * @returns A Promise of ListDNSZoneVersionRecordsResponse @@ -542,8 +525,7 @@ export class API extends ParentAPI { ) /** - * Access differences from a specific DNS zone version. Access a previous DNS - * zone version to see the differences from another specific version. + * Access differences from a specific DNS zone version. Access a previous DNS zone version to see the differences from another specific version. * * @param request - The request {@link GetDNSZoneVersionDiffRequest} * @returns A Promise of GetDNSZoneVersionDiffResponse @@ -558,8 +540,7 @@ export class API extends ParentAPI { ) /** - * Restore a DNS zone version. Restore and activate a version of a specific - * DNS zone. + * Restore a DNS zone version. Restore and activate a version of a specific DNS zone. * * @param request - The request {@link RestoreDNSZoneVersionRequest} * @returns A Promise of RestoreDNSZoneVersionResponse @@ -576,8 +557,7 @@ export class API extends ParentAPI { ) /** - * Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If - * you do not have a certificate, the ouptut returns `no certificate found`. + * Get a DNS zone's TLS certificate. Get the DNS zone's TLS certificate. If you do not have a certificate, the ouptut returns `no certificate found`. * * @param request - The request {@link GetSSLCertificateRequest} * @returns A Promise of SSLCertificate @@ -614,8 +594,7 @@ export class API extends ParentAPI { ) /** - * Create or get the DNS zone's TLS certificate. Create a new TLS certificate - * or retrieve information about an existing TLS certificate. + * Create or get the DNS zone's TLS certificate. Create a new TLS certificate or retrieve information about an existing TLS certificate. * * @param request - The request {@link CreateSSLCertificateRequest} * @returns A Promise of SSLCertificate @@ -654,8 +633,7 @@ export class API extends ParentAPI { ) /** - * List a user's TLS certificates. List all the TLS certificates a user has - * created, specified by the user's Project ID and the DNS zone. + * List a user's TLS certificates. List all the TLS certificates a user has created, specified by the user's Project ID and the DNS zone. * * @param request - The request {@link ListSSLCertificatesRequest} * @returns A Promise of ListSSLCertificatesResponse @@ -664,9 +642,7 @@ export class API extends ParentAPI { enrichForPagination('certificates', this.pageOfListSSLCertificates, request) /** - * Delete a TLS certificate. Delete an existing TLS certificate specified by - * its DNS zone. Deleting a TLS certificate is permanent and cannot be - * undone. + * Delete a TLS certificate. Delete an existing TLS certificate specified by its DNS zone. Deleting a TLS certificate is permanent and cannot be undone. * * @param request - The request {@link DeleteSSLCertificateRequest} * @returns A Promise of DeleteSSLCertificateResponse @@ -681,8 +657,7 @@ export class API extends ParentAPI { ) /** - * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a - * given DNS zone to allow AXFR requests. + * Get the DNS zone's TSIG key. Retrieve information about the TSIG key of a given DNS zone to allow AXFR requests. * * @param request - The request {@link GetDNSZoneTsigKeyRequest} * @returns A Promise of GetDNSZoneTsigKeyResponse @@ -697,8 +672,7 @@ export class API extends ParentAPI { ) /** - * Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by - * its DNS zone. Deleting a TSIG key is permanent and cannot be undone. + * Delete the DNS zone's TSIG key. Delete an existing TSIG key specified by its DNS zone. Deleting a TSIG key is permanent and cannot be undone. * * @param request - The request {@link DeleteDNSZoneTsigKeyRequest} */ @@ -711,8 +685,8 @@ export class API extends ParentAPI { /** * Domains and DNS - Registrar API. - * - * Manage your domains and contacts. + +Manage your domains and contacts. */ export class RegistrarAPI extends ParentAPI { protected pageOfListTasks = ( @@ -740,8 +714,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * List tasks. List all operations performed on the account. You can filter - * the list of tasks by domain name. + * List tasks. List all operations performed on the account. +You can filter the list of tasks by domain name. * * @param request - The request {@link RegistrarApiListTasksRequest} * @returns A Promise of ListTasksResponse @@ -750,8 +724,8 @@ export class RegistrarAPI extends ParentAPI { enrichForPagination('tasks', this.pageOfListTasks, request) /** - * Purchase domains. Request the registration of domain names. You can provide - * a domain's already existing contact or a new contact. + * Purchase domains. Request the registration of domain names. +You can provide a domain's already existing contact or a new contact. * * @param request - The request {@link RegistrarApiBuyDomainsRequest} * @returns A Promise of OrderResponse @@ -789,8 +763,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Transfer a domain. Request the transfer of a domain from another registrar - * to Scaleway Domains and DNS. + * Transfer a domain. Request the transfer of a domain from another registrar to Scaleway Domains and DNS. * * @param request - The request {@link RegistrarApiTransferInDomainRequest} * @returns A Promise of OrderResponse @@ -813,13 +786,9 @@ export class RegistrarAPI extends ParentAPI { /** * Trade a domain's contact. Request to change a domain's contact owner.
- * If you specify the `organization_id` of the domain's new owner, the contact - * will change from the current owner's Scaleway account to the new owner's - * Scaleway account.
If the new owner's current contact information is - * not available, the first ever contact they have created for previous - * domains is taken into account to operate the change.
If the new owner - * has never created a contact to register domains before, an error message - * displays. +If you specify the `organization_id` of the domain's new owner, the contact will change from the current owner's Scaleway account to the new owner's Scaleway account.
+If the new owner's current contact information is not available, the first ever contact they have created for previous domains is taken into account to operate the change.
+If the new owner has never created a contact to register domains before, an error message displays. * * @param request - The request {@link RegistrarApiTradeDomainRequest} * @returns A Promise of OrderResponse @@ -838,11 +807,9 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Register an external domain. Request the registration of an external domain - * name. + * Register an external domain. Request the registration of an external domain name. * - * @param request - The request - * {@link RegistrarApiRegisterExternalDomainRequest} + * @param request - The request {@link RegistrarApiRegisterExternalDomainRequest} * @returns A Promise of RegisterExternalDomainResponse */ registerExternalDomain = ( @@ -881,13 +848,10 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Check if contacts are compatible with a domain or a TLD. Check whether - * contacts are compatible with a domain or a TLD. If contacts are not - * compatible with either the domain or the TLD, the information that needs to - * be corrected is returned. + * Check if contacts are compatible with a domain or a TLD. Check whether contacts are compatible with a domain or a TLD. +If contacts are not compatible with either the domain or the TLD, the information that needs to be corrected is returned. * - * @param request - The request - * {@link RegistrarApiCheckContactsCompatibilityRequest} + * @param request - The request {@link RegistrarApiCheckContactsCompatibilityRequest} * @returns A Promise of CheckContactsCompatibilityResponse */ checkContactsCompatibility = ( @@ -932,8 +896,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * List contacts. Retrieve the list of contacts and their associated domains - * and roles. You can filter the list by domain name. + * List contacts. Retrieve the list of contacts and their associated domains and roles. +You can filter the list by domain name. * * @param request - The request {@link RegistrarApiListContactsRequest} * @returns A Promise of ListContactsResponse @@ -942,8 +906,7 @@ export class RegistrarAPI extends ParentAPI { enrichForPagination('contacts', this.pageOfListContacts, request) /** - * Get a contact. Retrieve a contact's details from the registrar using the - * given contact's ID. + * Get a contact. Retrieve a contact's details from the registrar using the given contact's ID. * * @param request - The request {@link RegistrarApiGetContactRequest} * @returns A Promise of Contact @@ -1035,9 +998,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * List domains that can be renewed. Retrieve the list of domains you own that - * can be renewed. You can also see the maximum renewal duration in years for - * your domains that are renewable. + * List domains that can be renewed. Retrieve the list of domains you own that can be renewed. You can also see the maximum renewal duration in years for your domains that are renewable. * * @param request - The request {@link RegistrarApiListRenewableDomainsRequest} * @returns A Promise of ListRenewableDomainsResponse @@ -1047,8 +1008,7 @@ export class RegistrarAPI extends ParentAPI { ) => enrichForPagination('domains', this.pageOfListRenewableDomains, request) /** - * Get domain. Retrieve a specific domain and display the domain's - * information. + * Get domain. Retrieve a specific domain and display the domain's information. * * @param request - The request {@link RegistrarApiGetDomainRequest} * @returns A Promise of Domain @@ -1085,10 +1045,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Update a domain's contacts. Update contacts for a specific domain or create - * a new contact.
If you add the same contact for multiple roles (owner, - * administrative, technical), only one ID will be created and used for all of - * the roles. + * Update a domain's contacts. Update contacts for a specific domain or create a new contact.
+If you add the same contact for multiple roles (owner, administrative, technical), only one ID will be created and used for all of the roles. * * @param request - The request {@link RegistrarApiUpdateDomainRequest} * @returns A Promise of Domain @@ -1107,9 +1065,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Lock the transfer of a domain. Lock the transfer of a domain. This means - * that the domain cannot be transferred and the authorization code cannot be - * requested to your current registrar. + * Lock the transfer of a domain. Lock the transfer of a domain. This means that the domain cannot be transferred and the authorization code cannot be requested to your current registrar. * * @param request - The request {@link RegistrarApiLockDomainTransferRequest} * @returns A Promise of Domain @@ -1128,9 +1084,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Unlock the transfer of a domain. Unlock the transfer of a domain. This - * means that the domain can be transferred and the authorization code can be - * requested to your current registrar. + * Unlock the transfer of a domain. Unlock the transfer of a domain. This means that the domain can be transferred and the authorization code can be requested to your current registrar. * * @param request - The request {@link RegistrarApiUnlockDomainTransferRequest} * @returns A Promise of Domain @@ -1149,11 +1103,9 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Enable auto renew. Enable the `auto renew` feature for a domain. This means - * the domain will be automatically renewed before its expiry date. + * Enable auto renew. Enable the `auto renew` feature for a domain. This means the domain will be automatically renewed before its expiry date. * - * @param request - The request - * {@link RegistrarApiEnableDomainAutoRenewRequest} + * @param request - The request {@link RegistrarApiEnableDomainAutoRenewRequest} * @returns A Promise of Domain */ enableDomainAutoRenew = ( @@ -1170,11 +1122,9 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Disable auto renew. Disable the `auto renew` feature for a domain. This - * means the domain will not be renewed before its expiry date. + * Disable auto renew. Disable the `auto renew` feature for a domain. This means the domain will not be renewed before its expiry date. * - * @param request - The request - * {@link RegistrarApiDisableDomainAutoRenewRequest} + * @param request - The request {@link RegistrarApiDisableDomainAutoRenewRequest} * @returns A Promise of Domain */ disableDomainAutoRenew = ( @@ -1191,11 +1141,8 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Get a domain's authorization code. Retrieve the authorization code to - * tranfer an unlocked domain. The output returns an error if the domain is - * locked. Some TLDs may have a different procedure to retrieve the - * authorization code. In that case, the information displays in the message - * field. + * Get a domain's authorization code. Retrieve the authorization code to tranfer an unlocked domain. The output returns an error if the domain is locked. +Some TLDs may have a different procedure to retrieve the authorization code. In that case, the information displays in the message field. * * @param request - The request {@link RegistrarApiGetDomainAuthCodeRequest} * @returns A Promise of GetDomainAuthCodeResponse @@ -1212,9 +1159,7 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Update domain DNSSEC. If your domain uses another registrar and has the - * default Scaleway NS, you have to **update the DS record at your - * registrar**. + * Update domain DNSSEC. If your domain uses another registrar and has the default Scaleway NS, you have to **update the DS record at your registrar**. * * @param request - The request {@link RegistrarApiEnableDomainDNSSECRequest} * @returns A Promise of Domain @@ -1257,14 +1202,11 @@ export class RegistrarAPI extends ParentAPI { ) /** - * Search available domains. Search a domain or a maximum of 10 domains that - * are available. - * - * If the TLD list is empty or not set, the search returns the results from - * the most popular TLDs. + * Search available domains. Search a domain or a maximum of 10 domains that are available. + +If the TLD list is empty or not set, the search returns the results from the most popular TLDs. * - * @param request - The request - * {@link RegistrarApiSearchAvailableDomainsRequest} + * @param request - The request {@link RegistrarApiSearchAvailableDomainsRequest} * @returns A Promise of SearchAvailableDomainsResponse */ searchAvailableDomains = ( @@ -1313,8 +1255,7 @@ export class RegistrarAPI extends ParentAPI { enrichForPagination('tlds', this.pageOfListTlds, request) /** - * Create a hostname for a domain. Create a hostname for a domain with glue - * IPs. + * Create a hostname for a domain. Create a hostname for a domain with glue IPs. * * @param request - The request {@link RegistrarApiCreateDomainHostRequest} * @returns A Promise of Host diff --git a/packages/clients/src/api/domain/v2beta1/content.gen.ts b/packages/clients/src/api/domain/v2beta1/content.gen.ts index 8b21d2f73..2ed040f14 100644 --- a/packages/clients/src/api/domain/v2beta1/content.gen.ts +++ b/packages/clients/src/api/domain/v2beta1/content.gen.ts @@ -19,10 +19,7 @@ export const DOMAIN_FEATURE_TRANSIENT_STATUSES: DomainFeatureStatus[] = [ 'disabling', ] -/** - * Lists transient statutes of the enum - * {@link DomainRegistrationStatusTransferStatus}. - */ +/** Lists transient statutes of the enum {@link DomainRegistrationStatusTransferStatus}. */ export const DOMAIN_REGISTRATION_STATUS_TRANSFER_TRANSIENT_STATUSES: DomainRegistrationStatusTransferStatus[] = ['pending', 'processing'] diff --git a/packages/clients/src/api/domain/v2beta1/types.gen.ts b/packages/clients/src/api/domain/v2beta1/types.gen.ts index f1f8f90c7..e8e667d38 100644 --- a/packages/clients/src/api/domain/v2beta1/types.gen.ts +++ b/packages/clients/src/api/domain/v2beta1/types.gen.ts @@ -299,23 +299,23 @@ export interface DomainRecord { type: DomainRecordType comment?: string /** - * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', - * 'weightedConfig', 'viewConfig' could be set. + * + * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', 'weightedConfig', 'viewConfig' could be set. */ geoIpConfig?: DomainRecordGeoIPConfig /** - * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', - * 'weightedConfig', 'viewConfig' could be set. + * + * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', 'weightedConfig', 'viewConfig' could be set. */ httpServiceConfig?: DomainRecordHTTPServiceConfig /** - * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', - * 'weightedConfig', 'viewConfig' could be set. + * + * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', 'weightedConfig', 'viewConfig' could be set. */ weightedConfig?: DomainRecordWeightedConfig /** - * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', - * 'weightedConfig', 'viewConfig' could be set. + * + * One-of ('dynamicData'): at most one of 'geoIpConfig', 'httpServiceConfig', 'weightedConfig', 'viewConfig' could be set. */ viewConfig?: DomainRecordViewConfig id: string @@ -335,28 +335,28 @@ export interface ContactExtensionEU { export interface ContactExtensionFR { mode: ContactExtensionFRMode /** - * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', - * 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. + * + * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. */ individualInfo?: ContactExtensionFRIndividualInfo /** - * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', - * 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. + * + * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. */ dunsInfo?: ContactExtensionFRDunsInfo /** - * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', - * 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. + * + * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. */ associationInfo?: ContactExtensionFRAssociationInfo /** - * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', - * 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. + * + * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. */ trademarkInfo?: ContactExtensionFRTrademarkInfo /** - * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', - * 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. + * + * One-of ('modeFields'): at most one of 'individualInfo', 'dunsInfo', 'associationInfo', 'trademarkInfo', 'codeAuthAfnicInfo' could be set. */ codeAuthAfnicInfo?: ContactExtensionFRCodeAuthAfnicInfo } @@ -380,9 +380,15 @@ export interface TldOffer { export interface DSRecord { keyId: number algorithm: DSRecordAlgorithm - /** One-of ('type'): at most one of 'digest', 'publicKey' could be set. */ + /** + * + * One-of ('type'): at most one of 'digest', 'publicKey' could be set. + */ digest?: DSRecordDigest - /** One-of ('type'): at most one of 'digest', 'publicKey' could be set. */ + /** + * + * One-of ('type'): at most one of 'digest', 'publicKey' could be set. + */ publicKey?: DSRecordPublicKey } @@ -393,16 +399,28 @@ export interface RecordChangeAdd { export interface RecordChangeClear {} export interface RecordChangeDelete { - /** One-of ('identifier'): at most one of 'id', 'idFields' could be set. */ + /** + * + * One-of ('identifier'): at most one of 'id', 'idFields' could be set. + */ id?: string - /** One-of ('identifier'): at most one of 'id', 'idFields' could be set. */ + /** + * + * One-of ('identifier'): at most one of 'id', 'idFields' could be set. + */ idFields?: RecordIdentifier } export interface RecordChangeSet { - /** One-of ('identifier'): at most one of 'id', 'idFields' could be set. */ + /** + * + * One-of ('identifier'): at most one of 'id', 'idFields' could be set. + */ id?: string - /** One-of ('identifier'): at most one of 'id', 'idFields' could be set. */ + /** + * + * One-of ('identifier'): at most one of 'id', 'idFields' could be set. + */ idFields?: RecordIdentifier records: DomainRecord[] } @@ -432,7 +450,9 @@ export interface Contact { companyIdentificationCode: string lang: StdLanguageCode resale: boolean - /** @deprecated */ + /** + * @deprecated + */ questions?: ContactQuestion[] extensionFr?: ContactExtensionFR extensionEu?: ContactExtensionEU @@ -487,7 +507,9 @@ export interface NewContact { companyIdentificationCode?: string lang: StdLanguageCode resale: boolean - /** @deprecated */ + /** + * @deprecated + */ questions?: ContactQuestion[] extensionFr?: ContactExtensionFR extensionEu?: ContactExtensionEU @@ -521,23 +543,23 @@ export interface DomainDNSSEC { export interface RecordChange { /** - * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be - * set. + * + * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */ add?: RecordChangeAdd /** - * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be - * set. + * + * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */ set?: RecordChangeSet /** - * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be - * set. + * + * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */ delete?: RecordChangeDelete /** - * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be - * set. + * + * One-of ('change'): at most one of 'add', 'set', 'delete', 'clear' could be set. */ clear?: RecordChangeClear } @@ -589,15 +611,13 @@ export interface DomainSummary { isExternal: boolean status: DomainStatus /** - * One-of ('registrationStatus'): at most one of - * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be - * set. + * + * One-of ('registrationStatus'): at most one of 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set. */ externalDomainRegistrationStatus?: DomainRegistrationStatusExternalDomain /** - * One-of ('registrationStatus'): at most one of - * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be - * set. + * + * One-of ('registrationStatus'): at most one of 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set. */ transferRegistrationStatus?: DomainRegistrationStatusTransfer organizationId: string @@ -629,25 +649,45 @@ export interface SSLCertificate { } export interface Task { - /** The unique identifier of the task. */ + /** + * The unique identifier of the task. + */ id: string - /** The project ID associated to the task. */ + /** + * The project ID associated to the task. + */ projectId: string - /** The organization ID associated to the task. */ + /** + * The organization ID associated to the task. + */ organizationId: string - /** The domain name associated to the task. */ + /** + * The domain name associated to the task. + */ domain?: string - /** The type of the task. */ + /** + * The type of the task. + */ type: TaskType - /** The status of the task. */ + /** + * The status of the task. + */ status: TaskStatus - /** Start date of the task. */ + /** + * Start date of the task. + */ startedAt?: Date - /** Last update of the task. */ + /** + * Last update of the task. + */ updatedAt?: Date - /** Error message associated to the task. */ + /** + * Error message associated to the task. + */ message?: string - /** Human-friendly contact identifier used when the task concerns a contact. */ + /** + * Human-friendly contact identifier used when the task concerns a contact. + */ contactIdentifier?: string } @@ -675,29 +715,45 @@ export interface CheckContactsCompatibilityResponse { } export type ClearDNSZoneRecordsRequest = { - /** DNS zone to clear. */ + /** + * DNS zone to clear. + */ dnsZone: string } export interface ClearDNSZoneRecordsResponse {} export type CloneDNSZoneRequest = { - /** DNS zone to clone. */ + /** + * DNS zone to clone. + */ dnsZone: string - /** Destination DNS zone in which to clone the chosen DNS zone. */ + /** + * Destination DNS zone in which to clone the chosen DNS zone. + */ destDnsZone: string - /** Specifies whether or not the destination DNS zone will be overwritten. */ + /** + * Specifies whether or not the destination DNS zone will be overwritten. + */ overwrite: boolean - /** Project ID of the destination DNS zone. */ + /** + * Project ID of the destination DNS zone. + */ projectId?: string } export type CreateDNSZoneRequest = { - /** Domain in which to crreate the DNS zone. */ + /** + * Domain in which to crreate the DNS zone. + */ domain: string - /** Subdomain of the DNS zone to create. */ + /** + * Subdomain of the DNS zone to create. + */ subdomain: string - /** Project ID in which to create the DNS zone. */ + /** + * Project ID in which to create the DNS zone. + */ projectId?: string } @@ -707,9 +763,13 @@ export type CreateSSLCertificateRequest = { } export type DeleteDNSZoneRequest = { - /** DNS zone to delete. */ + /** + * DNS zone to delete. + */ dnsZone: string - /** Project ID of the DNS zone to delete. */ + /** + * Project ID of the DNS zone to delete. + */ projectId?: string } @@ -731,57 +791,85 @@ export interface Domain { domain: string organizationId: string projectId: string - /** Status of the automatic renewal of the domain. */ + /** + * Status of the automatic renewal of the domain. + */ autoRenewStatus: DomainFeatureStatus - /** Status of the DNSSEC configuration of the domain. */ + /** + * Status of the DNSSEC configuration of the domain. + */ dnssec?: DomainDNSSEC - /** List of the domain's EPP codes. */ + /** + * List of the domain's EPP codes. + */ eppCode: string[] - /** Date of expiration of the domain. */ + /** + * Date of expiration of the domain. + */ expiredAt?: Date - /** Domain's last modification date. */ + /** + * Domain's last modification date. + */ updatedAt?: Date registrar: string - /** Indicates whether Scaleway is the domain's registrar. */ + /** + * Indicates whether Scaleway is the domain's registrar. + */ isExternal: boolean - /** Status of the domain. */ + /** + * Status of the domain. + */ status: DomainStatus - /** List of the domain's DNS zones. */ + /** + * List of the domain's DNS zones. + */ dnsZones: DNSZone[] - /** Contact information of the domain's owner. */ + /** + * Contact information of the domain's owner. + */ ownerContact?: Contact - /** Contact information of the domain's technical contact. */ + /** + * Contact information of the domain's technical contact. + */ technicalContact?: Contact - /** Contact information of the domain's administrative contact. */ + /** + * Contact information of the domain's administrative contact. + */ administrativeContact?: Contact /** * Registration status of an external domain, if available. * - * One-of ('registrationStatus'): at most one of - * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be - * set. + * One-of ('registrationStatus'): at most one of 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set. */ externalDomainRegistrationStatus?: DomainRegistrationStatusExternalDomain /** * Status of a domain, when available for transfer. * - * One-of ('registrationStatus'): at most one of - * 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be - * set. + * One-of ('registrationStatus'): at most one of 'externalDomainRegistrationStatus', 'transferRegistrationStatus' could be set. */ transferRegistrationStatus?: DomainRegistrationStatusTransfer - /** Domain's TLD information. */ + /** + * Domain's TLD information. + */ tld?: Tld - /** List of Scaleway resources linked to the domain. */ + /** + * List of Scaleway resources linked to the domain. + */ linkedProducts: LinkedProduct[] - /** Indicates if a trade is ongoing. */ + /** + * Indicates if a trade is ongoing. + */ pendingTrade: boolean } export type ExportRawDNSZoneRequest = { - /** DNS zone to export. */ + /** + * DNS zone to export. + */ dnsZone: string - /** DNS zone format. */ + /** + * DNS zone format. + */ format?: RawFormat } @@ -813,7 +901,10 @@ export type GetSSLCertificateRequest = { export type ImportProviderDNSZoneRequest = { dnsZone: string - /** One-of ('provider'): at most one of 'onlineV1' could be set. */ + /** + * + * One-of ('provider'): at most one of 'onlineV1' could be set. + */ onlineV1?: ImportProviderDNSZoneRequestOnlineV1 } @@ -822,12 +913,18 @@ export interface ImportProviderDNSZoneResponse { } export type ImportRawDNSZoneRequest = { - /** DNS zone to import. */ + /** + * DNS zone to import. + */ dnsZone: string - /** @deprecated */ + /** + * @deprecated + */ content?: string projectId?: string - /** @deprecated */ + /** + * @deprecated + */ format?: RawFormat /** * Import a bind file format. @@ -853,102 +950,168 @@ export interface ListContactsResponse { } export type ListDNSZoneNameserversRequest = { - /** DNS zone on which to filter the returned DNS zone name servers. */ + /** + * DNS zone on which to filter the returned DNS zone name servers. + */ dnsZone: string - /** Project ID on which to filter the returned DNS zone name servers. */ + /** + * Project ID on which to filter the returned DNS zone name servers. + */ projectId?: string } export interface ListDNSZoneNameserversResponse { - /** DNS zone name servers returned. */ + /** + * DNS zone name servers returned. + */ ns: Nameserver[] } export type ListDNSZoneRecordsRequest = { - /** DNS zone on which to filter the returned DNS zone records. */ + /** + * DNS zone on which to filter the returned DNS zone records. + */ dnsZone: string - /** Project ID on which to filter the returned DNS zone records. */ + /** + * Project ID on which to filter the returned DNS zone records. + */ projectId?: string - /** Sort order of the returned DNS zone records. */ + /** + * Sort order of the returned DNS zone records. + */ orderBy?: ListDNSZoneRecordsRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of DNS zone records per page. */ + /** + * Maximum number of DNS zone records per page. + */ pageSize?: number - /** Name on which to filter the returned DNS zone records. */ + /** + * Name on which to filter the returned DNS zone records. + */ name: string - /** Record type on which to filter the returned DNS zone records. */ + /** + * Record type on which to filter the returned DNS zone records. + */ type?: DomainRecordType - /** Record ID on which to filter the returned DNS zone records. */ + /** + * Record ID on which to filter the returned DNS zone records. + */ id?: string } export interface ListDNSZoneRecordsResponse { - /** Total number of DNS zone records. */ + /** + * Total number of DNS zone records. + */ totalCount: number - /** Paginated returned DNS zone records. */ + /** + * Paginated returned DNS zone records. + */ records: DomainRecord[] } export type ListDNSZoneVersionRecordsRequest = { dnsZoneVersionId: string - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of DNS zones versions records per page. */ + /** + * Maximum number of DNS zones versions records per page. + */ pageSize?: number } export interface ListDNSZoneVersionRecordsResponse { - /** Total number of DNS zones versions records. */ + /** + * Total number of DNS zones versions records. + */ totalCount: number records: DomainRecord[] } export type ListDNSZoneVersionsRequest = { dnsZone: string - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of DNS zones versions per page. */ + /** + * Maximum number of DNS zones versions per page. + */ pageSize?: number } export interface ListDNSZoneVersionsResponse { - /** Total number of DNS zones versions. */ + /** + * Total number of DNS zones versions. + */ totalCount: number versions: DNSZoneVersion[] } export type ListDNSZonesRequest = { - /** Organization ID on which to filter the returned DNS zones. */ + /** + * Organization ID on which to filter the returned DNS zones. + */ organizationId?: string - /** Project ID on which to filter the returned DNS zones. */ + /** + * Project ID on which to filter the returned DNS zones. + */ projectId?: string - /** Sort order of the returned DNS zones. */ + /** + * Sort order of the returned DNS zones. + */ orderBy?: ListDNSZonesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of DNS zones to return per page. */ + /** + * Maximum number of DNS zones to return per page. + */ pageSize?: number - /** Domain on which to filter the returned DNS zones. */ + /** + * Domain on which to filter the returned DNS zones. + */ domain: string - /** @deprecated DNS zone on which to filter the returned DNS zones. */ + /** + * @deprecated DNS zone on which to filter the returned DNS zones. + */ dnsZone?: string - /** DNS zones on which to filter the returned DNS zones. */ + /** + * DNS zones on which to filter the returned DNS zones. + */ dnsZones?: string[] - /** Only list DNS zones created after this date. */ + /** + * Only list DNS zones created after this date. + */ createdAfter?: Date - /** Only list DNS zones created before this date. */ + /** + * Only list DNS zones created before this date. + */ createdBefore?: Date - /** Only list DNS zones updated after this date. */ + /** + * Only list DNS zones updated after this date. + */ updatedAfter?: Date - /** Only list DNS zones updated before this date. */ + /** + * Only list DNS zones updated before this date. + */ updatedBefore?: Date } export interface ListDNSZonesResponse { - /** Total number of DNS zones matching the requested criteria. */ + /** + * Total number of DNS zones matching the requested criteria. + */ totalCount: number - /** Paginated returned DNS zones. */ + /** + * Paginated returned DNS zones. + */ dnsZones: DNSZone[] } @@ -985,9 +1148,13 @@ export interface ListTasksResponse { } export interface ListTldsResponse { - /** Array of TLDs. */ + /** + * Array of TLDs. + */ tlds: Tld[] - /** Total count of TLDs returned. */ + /** + * Total count of TLDs returned. + */ totalCount: number } @@ -1000,16 +1167,24 @@ export interface OrderResponse { } export type RefreshDNSZoneRequest = { - /** DNS zone to refresh. */ + /** + * DNS zone to refresh. + */ dnsZone: string - /** Specifies whether or not to recreate the DNS zone. */ + /** + * Specifies whether or not to recreate the DNS zone. + */ recreateDnsZone: boolean - /** Specifies whether or not to recreate the sub DNS zone. */ + /** + * Specifies whether or not to recreate the sub DNS zone. + */ recreateSubDnsZone: boolean } export interface RefreshDNSZoneResponse { - /** DNS zones returned. */ + /** + * DNS zones returned. + */ dnsZones: DNSZone[] } @@ -1026,33 +1201,33 @@ export type RegistrarApiBuyDomainsRequest = { durationInYears: number projectId?: string /** - * One-of ('ownerContactType'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * + * One-of ('ownerContactType'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContactId?: string /** - * One-of ('ownerContactType'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * + * One-of ('ownerContactType'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContact?: NewContact /** - * One-of ('administrativeContactType'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactType'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContactId?: string /** - * One-of ('administrativeContactType'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactType'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContact?: NewContact /** - * One-of ('technicalContactType'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactType'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContactId?: string /** - * One-of ('technicalContactType'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactType'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContact?: NewContact } @@ -1061,33 +1236,33 @@ export type RegistrarApiCheckContactsCompatibilityRequest = { domains?: string[] tlds?: string[] /** - * One-of ('ownerContactType'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * + * One-of ('ownerContactType'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContactId?: string /** - * One-of ('ownerContactType'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * + * One-of ('ownerContactType'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContact?: NewContact /** - * One-of ('administrativeContactType'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactType'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContactId?: string /** - * One-of ('administrativeContactType'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactType'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContact?: NewContact /** - * One-of ('technicalContactType'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactType'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContactId?: string /** - * One-of ('technicalContactType'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactType'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContact?: NewContact } @@ -1184,13 +1359,21 @@ export type RegistrarApiListTasksRequest = { } export type RegistrarApiListTldsRequest = { - /** Array of TLDs to return. */ + /** + * Array of TLDs to return. + */ tlds?: string[] - /** Page number for the returned Projects. */ + /** + * Page number for the returned Projects. + */ page?: number - /** Maximum number of Project per page. */ + /** + * Maximum number of Project per page. + */ pageSize?: number - /** Sort order of the returned TLDs. */ + /** + * Sort order of the returned TLDs. + */ orderBy?: ListTldsRequestOrderBy } @@ -1210,11 +1393,17 @@ export type RegistrarApiRenewDomainsRequest = { } export type RegistrarApiSearchAvailableDomainsRequest = { - /** A list of domain to search, TLD is optional. */ + /** + * A list of domain to search, TLD is optional. + */ domains: string[] - /** Array of tlds to search on. */ + /** + * Array of tlds to search on. + */ tlds?: string[] - /** Search exact match. */ + /** + * Search exact match. + */ strictSearch: boolean } @@ -1222,13 +1411,13 @@ export type RegistrarApiTradeDomainRequest = { domain: string projectId?: string /** - * One-of ('newOwnerContactType'): at most one of 'newOwnerContactId', - * 'newOwnerContact' could be set. + * + * One-of ('newOwnerContactType'): at most one of 'newOwnerContactId', 'newOwnerContact' could be set. */ newOwnerContactId?: string /** - * One-of ('newOwnerContactType'): at most one of 'newOwnerContactId', - * 'newOwnerContact' could be set. + * + * One-of ('newOwnerContactType'): at most one of 'newOwnerContactId', 'newOwnerContact' could be set. */ newOwnerContact?: NewContact } @@ -1237,33 +1426,33 @@ export type RegistrarApiTransferInDomainRequest = { domains: TransferInDomainRequestTransferRequest[] projectId?: string /** - * One-of ('ownerContactType'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * + * One-of ('ownerContactType'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContactId?: string /** - * One-of ('ownerContactType'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * + * One-of ('ownerContactType'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContact?: NewContact /** - * One-of ('administrativeContactType'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactType'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContactId?: string /** - * One-of ('administrativeContactType'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactType'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContact?: NewContact /** - * One-of ('technicalContactType'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactType'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContactId?: string /** - * One-of ('technicalContactType'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactType'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContact?: NewContact } @@ -1287,7 +1476,9 @@ export type RegistrarApiUpdateContactRequest = { companyIdentificationCode?: string lang?: StdLanguageCode resale?: boolean - /** @deprecated */ + /** + * @deprecated + */ questions?: UpdateContactRequestQuestion[] extensionFr?: ContactExtensionFR extensionEu?: ContactExtensionEU @@ -1305,37 +1496,35 @@ export type RegistrarApiUpdateDomainHostRequest = { export type RegistrarApiUpdateDomainRequest = { domain: string /** - * One-of ('technicalContactInfo'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactInfo'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContactId?: string /** - * One-of ('technicalContactInfo'): at most one of 'technicalContactId', - * 'technicalContact' could be set. + * + * One-of ('technicalContactInfo'): at most one of 'technicalContactId', 'technicalContact' could be set. */ technicalContact?: NewContact /** * @deprecated * - * One-of ('ownerContactInfo'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * One-of ('ownerContactInfo'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContactId?: string /** * @deprecated * - * One-of ('ownerContactInfo'): at most one of 'ownerContactId', - * 'ownerContact' could be set. + * One-of ('ownerContactInfo'): at most one of 'ownerContactId', 'ownerContact' could be set. */ ownerContact?: NewContact /** - * One-of ('administrativeContactInfo'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactInfo'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContactId?: string /** - * One-of ('administrativeContactInfo'): at most one of - * 'administrativeContactId', 'administrativeContact' could be set. + * + * One-of ('administrativeContactInfo'): at most one of 'administrativeContactId', 'administrativeContact' could be set. */ administrativeContact?: NewContact } @@ -1347,48 +1536,71 @@ export type RestoreDNSZoneVersionRequest = { export interface RestoreDNSZoneVersionResponse {} export interface SearchAvailableDomainsResponse { - /** Array of available domains. */ + /** + * Array of available domains. + */ availableDomains: AvailableDomain[] } export type UpdateDNSZoneNameserversRequest = { - /** DNS zone in which to update the DNS zone name servers. */ + /** + * DNS zone in which to update the DNS zone name servers. + */ dnsZone: string - /** New DNS zone name servers. */ + /** + * New DNS zone name servers. + */ ns: Nameserver[] } export interface UpdateDNSZoneNameserversResponse { - /** DNS zone name servers returned. */ + /** + * DNS zone name servers returned. + */ ns: Nameserver[] } export type UpdateDNSZoneRecordsRequest = { - /** DNS zone in which to update the DNS zone records. */ + /** + * DNS zone in which to update the DNS zone records. + */ dnsZone: string - /** Changes made to the records. */ + /** + * Changes made to the records. + */ changes: RecordChange[] - /** Specifies whether or not to return all the records. */ + /** + * Specifies whether or not to return all the records. + */ returnAllRecords?: boolean /** - * Disable the creation of the target zone if it does not exist. Target zone - * creation is disabled by default. + * Disable the creation of the target zone if it does not exist. Target zone creation is disabled by default. */ disallowNewZoneCreation: boolean - /** Use the provided serial (0) instead of the auto-increment serial. */ + /** + * Use the provided serial (0) instead of the auto-increment serial. + */ serial?: number } export interface UpdateDNSZoneRecordsResponse { - /** DNS zone records returned. */ + /** + * DNS zone records returned. + */ records: DomainRecord[] } export type UpdateDNSZoneRequest = { - /** DNS zone to update. */ + /** + * DNS zone to update. + */ dnsZone: string - /** Name of the new DNS zone to create. */ + /** + * Name of the new DNS zone to create. + */ newDnsZone?: string - /** Project ID in which to create the new DNS zone. */ + /** + * Project ID in which to create the new DNS zone. + */ projectId?: string } diff --git a/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts b/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts index 60412b716..0b87cb722 100644 --- a/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/flexibleip/v1alpha1/api.gen.ts @@ -46,9 +46,8 @@ const jsonContentHeaders = { /** * Elastic Metal - Flexible IP API. - * - * This API allows you to manage your Elastic Metal servers' flexible public IP - * addresses. + +This API allows you to manage your Elastic Metal servers' flexible public IP addresses. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -62,8 +61,7 @@ export class API extends ParentAPI { ] /** - * Create a new flexible IP. Generate a new flexible IP within a given zone, - * specifying its configuration including Project ID and description. + * Create a new flexible IP. Generate a new flexible IP within a given zone, specifying its configuration including Project ID and description. * * @param request - The request {@link CreateFlexibleIPRequest} * @returns A Promise of FlexibleIP @@ -82,9 +80,7 @@ export class API extends ParentAPI { ) /** - * Get an existing flexible IP. Retrieve information about an existing - * flexible IP, specified by its ID and zone. Its full details, including - * Project ID, description and status, are returned in the response object. + * Get an existing flexible IP. Retrieve information about an existing flexible IP, specified by its ID and zone. Its full details, including Project ID, description and status, are returned in the response object. * * @param request - The request {@link GetFlexibleIPRequest} * @returns A Promise of FlexibleIP @@ -154,9 +150,7 @@ export class API extends ParentAPI { enrichForPagination('flexibleIps', this.pageOfListFlexibleIPs, request) /** - * Update an existing flexible IP. Update the parameters of an existing - * flexible IP, specified by its ID and zone. These parameters include tags - * and description. + * Update an existing flexible IP. Update the parameters of an existing flexible IP, specified by its ID and zone. These parameters include tags and description. * * @param request - The request {@link UpdateFlexibleIPRequest} * @returns A Promise of FlexibleIP @@ -175,9 +169,7 @@ export class API extends ParentAPI { ) /** - * Delete an existing flexible IP. Delete an existing flexible IP, specified - * by its ID and zone. Note that deleting a flexible IP is permanent and - * cannot be undone. + * Delete an existing flexible IP. Delete an existing flexible IP, specified by its ID and zone. Note that deleting a flexible IP is permanent and cannot be undone. * * @param request - The request {@link DeleteFlexibleIPRequest} */ @@ -188,8 +180,7 @@ export class API extends ParentAPI { }) /** - * Attach an existing flexible IP to a server. Attach an existing flexible IP - * to a specified Elastic Metal server. + * Attach an existing flexible IP to a server. Attach an existing flexible IP to a specified Elastic Metal server. * * @param request - The request {@link AttachFlexibleIPRequest} * @returns A Promise of AttachFlexibleIPsResponse @@ -208,8 +199,7 @@ export class API extends ParentAPI { ) /** - * Detach an existing flexible IP from a server. Detach an existing flexible - * IP from a specified Elastic Metal server. + * Detach an existing flexible IP from a server. Detach an existing flexible IP from a specified Elastic Metal server. * * @param request - The request {@link DetachFlexibleIPRequest} * @returns A Promise of DetachFlexibleIPsResponse @@ -228,8 +218,7 @@ export class API extends ParentAPI { ) /** - * Generate a virtual MAC address on an existing flexible IP. Generate a - * virtual MAC (Media Access Control) address on an existing flexible IP. + * Generate a virtual MAC address on an existing flexible IP. Generate a virtual MAC (Media Access Control) address on an existing flexible IP. * * @param request - The request {@link GenerateMACAddrRequest} * @returns A Promise of FlexibleIP @@ -248,9 +237,7 @@ export class API extends ParentAPI { ) /** - * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual - * MAC address from a given flexible IP to another flexible IP attached to the - * same server. + * Duplicate a virtual MAC address to another flexible IP. Duplicate a virtual MAC address from a given flexible IP to another flexible IP attached to the same server. * * @param request - The request {@link DuplicateMACAddrRequest} * @returns A Promise of FlexibleIP @@ -269,9 +256,7 @@ export class API extends ParentAPI { ) /** - * Relocate an existing virtual MAC address to a different flexible IP. - * Relocate a virtual MAC (Media Access Control) address from an existing - * flexible IP to a different flexible IP. + * Relocate an existing virtual MAC address to a different flexible IP. Relocate a virtual MAC (Media Access Control) address from an existing flexible IP to a different flexible IP. * * @param request - The request {@link MoveMACAddrRequest} * @returns A Promise of FlexibleIP @@ -290,8 +275,7 @@ export class API extends ParentAPI { ) /** - * Detach a given virtual MAC address from an existing flexible IP. Detach a - * given MAC (Media Access Control) address from an existing flexible IP. + * Detach a given virtual MAC address from an existing flexible IP. Detach a given MAC (Media Access Control) address from an existing flexible IP. * * @param request - The request {@link DeleteMACAddrRequest} */ diff --git a/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts b/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts index 65a98d145..7b7a4d100 100644 --- a/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts @@ -24,208 +24,316 @@ export type MACAddressStatus = export type MACAddressType = 'unknown_type' | 'vmware' | 'xen' | 'kvm' export interface MACAddress { - /** ID of the flexible IP. */ + /** + * ID of the flexible IP. + */ id: string - /** MAC address of the Virtual MAC. */ + /** + * MAC address of the Virtual MAC. + */ macAddress: string - /** Type of virtual MAC. */ + /** + * Type of virtual MAC. + */ macType: MACAddressType - /** Status of virtual MAC. */ + /** + * Status of virtual MAC. + */ status: MACAddressStatus - /** Date on which the virtual MAC was last updated. */ + /** + * Date on which the virtual MAC was last updated. + */ updatedAt?: Date - /** Date on which the virtual MAC was created. */ + /** + * Date on which the virtual MAC was created. + */ createdAt?: Date - /** MAC address IP Availability Zone. */ + /** + * MAC address IP Availability Zone. + */ zone: ScwZone } export interface FlexibleIP { - /** ID of the flexible IP. */ + /** + * ID of the flexible IP. + */ id: string - /** ID of the Organization the flexible IP is attached to. */ + /** + * ID of the Organization the flexible IP is attached to. + */ organizationId: string - /** ID of the Project the flexible IP is attached to. */ + /** + * ID of the Project the flexible IP is attached to. + */ projectId: string - /** Flexible IP description. */ + /** + * Flexible IP description. + */ description: string - /** Flexible IP tags. */ + /** + * Flexible IP tags. + */ tags: string[] - /** Date on which the flexible IP was last updated. */ + /** + * Date on which the flexible IP was last updated. + */ updatedAt?: Date - /** Date on which the flexible IP was created. */ + /** + * Date on which the flexible IP was created. + */ createdAt?: Date /** - * - Ready : flexible IP is created and ready to be attached to a server or to - * be associated with a virtual MAC. - * - Updating: flexible IP is being attached to a server or a virtual MAC - * operation is ongoing - * - Attached: flexible IP is attached to a server - * - Error: a flexible IP operation resulted in an error - * - Detaching: flexible IP is being detached from a server - * - Locked: the resource of the flexible IP is locked. + * - ready : flexible IP is created and ready to be attached to a server or to be associated with a virtual MAC. +- updating: flexible IP is being attached to a server or a virtual MAC operation is ongoing +- attached: flexible IP is attached to a server +- error: a flexible IP operation resulted in an error +- detaching: flexible IP is being detached from a server +- locked: the resource of the flexible IP is locked. */ status: FlexibleIPStatus - /** IP of the flexible IP. */ + /** + * IP of the flexible IP. + */ ipAddress: string - /** MAC address of the flexible IP. */ + /** + * MAC address of the flexible IP. + */ macAddress?: MACAddress - /** ID of the server linked to the flexible IP. */ + /** + * ID of the server linked to the flexible IP. + */ serverId?: string - /** Reverse DNS value. */ + /** + * Reverse DNS value. + */ reverse: string - /** Availability Zone of the flexible IP. */ + /** + * Availability Zone of the flexible IP. + */ zone: ScwZone } export type AttachFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * Multiple IDs can be provided, but note that flexible IPs must belong to the - * same MAC group (see details about MAC groups). + * Multiple IDs can be provided, but note that flexible IPs must belong to the same MAC group (see details about MAC groups). */ fipsIds: string[] - /** ID of the server on which to attach the flexible IPs. */ + /** + * ID of the server on which to attach the flexible IPs. + */ serverId: string } export interface AttachFlexibleIPsResponse { - /** Total count of flexible IPs that are being updated. */ + /** + * Total count of flexible IPs that are being updated. + */ totalCount: number - /** List of flexible IPs in an updating state. */ + /** + * List of flexible IPs in an updating state. + */ flexibleIps: FlexibleIP[] } export type CreateFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the project to associate with the Flexible IP. */ + /** + * ID of the project to associate with the Flexible IP. + */ projectId?: string - /** Flexible IP description (max. of 255 characters). */ + /** + * Flexible IP description (max. of 255 characters). + */ description: string - /** Tags to associate to the flexible IP. */ + /** + * Tags to associate to the flexible IP. + */ tags?: string[] - /** ID of the server to which the newly created flexible IP will be attached. */ + /** + * ID of the server to which the newly created flexible IP will be attached. + */ serverId?: string - /** Value of the reverse DNS. */ + /** + * Value of the reverse DNS. + */ reverse?: string - /** Defines whether the flexible IP has an IPv6 address. */ + /** + * Defines whether the flexible IP has an IPv6 address. + */ isIpv6: boolean } export type DeleteFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the flexible IP to delete. */ + /** + * ID of the flexible IP to delete. + */ fipId: string } export type DeleteMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * If the flexible IP belongs to a MAC group, the MAC will be removed from - * both the MAC group and flexible IP. + * If the flexible IP belongs to a MAC group, the MAC will be removed from both the MAC group and flexible IP. */ fipId: string } export type DetachFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * List of flexible IP IDs to detach from a server. Multiple IDs can be - * provided. Note that flexible IPs must belong to the same MAC group. + * List of flexible IP IDs to detach from a server. Multiple IDs can be provided. Note that flexible IPs must belong to the same MAC group. */ fipsIds: string[] } export interface DetachFlexibleIPsResponse { - /** Total count of flexible IPs that are being detached. */ + /** + * Total count of flexible IPs that are being detached. + */ totalCount: number - /** List of flexible IPs in a detaching state. */ + /** + * List of flexible IPs in a detaching state. + */ flexibleIps: FlexibleIP[] } export type DuplicateMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Note that the flexible IPs need to be attached to the same server. */ + /** + * Note that the flexible IPs need to be attached to the same server. + */ fipId: string - /** Note that flexible IPs need to be attached to the same server. */ + /** + * Note that flexible IPs need to be attached to the same server. + */ duplicateFromFipId: string } export type GenerateMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the flexible IP for which to generate a virtual MAC. */ + /** + * ID of the flexible IP for which to generate a virtual MAC. + */ fipId: string - /** TODO. */ + /** + * TODO. + */ macType: MACAddressType } export type GetFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the flexible IP. */ + /** + * ID of the flexible IP. + */ fipId: string } export type ListFlexibleIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Sort order of the returned flexible IPs. */ + /** + * Sort order of the returned flexible IPs. + */ orderBy?: ListFlexibleIPsRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of flexible IPs per page. */ + /** + * Maximum number of flexible IPs per page. + */ pageSize?: number /** - * Filter by tag, only flexible IPs with one or more matching tags will be - * returned. + * Filter by tag, only flexible IPs with one or more matching tags will be returned. */ tags?: string[] - /** Filter by status, only flexible IPs with this status will be returned. */ + /** + * Filter by status, only flexible IPs with this status will be returned. + */ status?: FlexibleIPStatus[] /** - * Filter by server IDs, only flexible IPs with these server IDs will be - * returned. + * Filter by server IDs, only flexible IPs with these server IDs will be returned. */ serverIds?: string[] /** - * Filter by Organization ID, only flexible IPs from this Organization will be - * returned. + * Filter by Organization ID, only flexible IPs from this Organization will be returned. */ organizationId?: string - /** Filter by Project ID, only flexible IPs from this Project will be returned. */ + /** + * Filter by Project ID, only flexible IPs from this Project will be returned. + */ projectId?: string } export interface ListFlexibleIPsResponse { - /** Total count of matching flexible IPs. */ + /** + * Total count of matching flexible IPs. + */ totalCount: number - /** List of all flexible IPs. */ + /** + * List of all flexible IPs. + */ flexibleIps: FlexibleIP[] } export type MoveMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone fipId: string dstFipId: string } export type UpdateFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID of the flexible IP to update. */ + /** + * ID of the flexible IP to update. + */ fipId: string - /** Flexible IP description (max. 255 characters). */ + /** + * Flexible IP description (max. 255 characters). + */ description?: string - /** Tags associated with the flexible IP. */ + /** + * Tags associated with the flexible IP. + */ tags?: string[] - /** Value of the reverse DNS. */ + /** + * Value of the reverse DNS. + */ reverse?: string } diff --git a/packages/clients/src/api/inference/v1/api.gen.ts b/packages/clients/src/api/inference/v1/api.gen.ts index 8ef9c9647..b6957c9ae 100644 --- a/packages/clients/src/api/inference/v1/api.gen.ts +++ b/packages/clients/src/api/inference/v1/api.gen.ts @@ -54,8 +54,8 @@ const jsonContentHeaders = { /** * Managed Inference API. - * - * This API allows you to handle your Managed Inference services. + +This API allows you to handle your Managed Inference services. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -131,8 +131,7 @@ export class API extends ParentAPI { ) /** - * Create a deployment. Create a new inference deployment related to a - * specific model. + * Create a deployment. Create a new inference deployment related to a specific model. * * @param request - The request {@link CreateDeploymentRequest} * @returns A Promise of Deployment @@ -185,8 +184,8 @@ export class API extends ParentAPI { ) /** - * Get the CA certificate. Get the CA certificate used for the deployment of - * private endpoints. The CA certificate will be returned as a PEM file. + * Get the CA certificate. Get the CA certificate used for the deployment of private endpoints. +The CA certificate will be returned as a PEM file. * * @param request - The request {@link GetDeploymentCertificateRequest} * @returns A Promise of Blob @@ -364,9 +363,7 @@ export class API extends ParentAPI { ) /** - * List available node types. List all available node types. By default, the - * node types returned in the list are ordered by creation date in ascending - * order, though this can be modified via the `order_by` field. + * List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListNodeTypesRequest} * @returns A Promise of ListNodeTypesResponse diff --git a/packages/clients/src/api/inference/v1/types.gen.ts b/packages/clients/src/api/inference/v1/types.gen.ts index c18e83ca7..9e2b24587 100644 --- a/packages/clients/src/api/inference/v1/types.gen.ts +++ b/packages/clients/src/api/inference/v1/types.gen.ts @@ -38,13 +38,16 @@ export type NodeTypeStock = | 'available' export interface ModelSupportedQuantization { - /** Number of bits for this supported quantization. */ + /** + * Number of bits for this supported quantization. + */ quantizationBits: number - /** Tells whether this quantization is allowed for this node type. */ + /** + * Tells whether this quantization is allowed for this node type. + */ allowed: boolean /** - * Maximum inference context size available for this node type and - * quantization. + * Maximum inference context size available for this node type and quantization. */ maxContextSize: number } @@ -56,50 +59,56 @@ export interface EndpointPrivateNetworkDetails { export interface EndpointPublicNetworkDetails {} export interface ModelSupportedNode { - /** Supported node type. */ + /** + * Supported node type. + */ nodeTypeName: string - /** Supported quantizations. */ + /** + * Supported quantizations. + */ quantizations: ModelSupportedQuantization[] } export interface DeploymentQuantization { /** - * The number of bits each model parameter should be quantized to. The - * quantization method is chosen based on this value. + * The number of bits each model parameter should be quantized to. The quantization method is chosen based on this value. */ bits: number } export interface Endpoint { - /** Unique identifier. */ + /** + * Unique identifier. + */ id: string /** - * For private endpoints, the URL will be accessible only from the Private - * Network. In addition, private endpoints will expose a CA certificate that - * can be used to verify the server's identity. This CA certificate can be - * retrieved using the `GetDeploymentCertificate` API call. + * For private endpoints, the URL will be accessible only from the Private Network. +In addition, private endpoints will expose a CA certificate that can be used to verify the server's identity. +This CA certificate can be retrieved using the `GetDeploymentCertificate` API call. */ url: string /** * Defines whether the endpoint is public. * - * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could - * be set. + * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could be set. */ publicNetwork?: EndpointPublicNetworkDetails /** * Details of the Private Network. * - * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could - * be set. + * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could be set. */ privateNetwork?: EndpointPrivateNetworkDetails - /** Defines whether the authentication is disabled. */ + /** + * Defines whether the authentication is disabled. + */ disableAuth: boolean } export interface ModelSupportInfo { - /** List of supported node types. */ + /** + * List of supported node types. + */ nodes: ModelSupportedNode[] } @@ -107,216 +116,330 @@ export interface EndpointSpec { /** * Set the endpoint as public. * - * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could - * be set. + * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could be set. */ publicNetwork?: EndpointPublicNetworkDetails /** * Private endpoints are only accessible from the Private Network. * - * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could - * be set. + * One-of ('details'): at most one of 'publicNetwork', 'privateNetwork' could be set. */ privateNetwork?: EndpointPrivateNetworkDetails /** - * By default, deployments are protected by IAM authentication. When setting - * this field to true, the authentication will be disabled. + * By default, deployments are protected by IAM authentication. +When setting this field to true, the authentication will be disabled. */ disableAuth: boolean } export interface ModelSource { url: string - /** One-of ('credentials'): at most one of 'secret' could be set. */ + /** + * + * One-of ('credentials'): at most one of 'secret' could be set. + */ secret?: string } export interface Deployment { - /** Unique identifier. */ + /** + * Unique identifier. + */ id: string - /** Name of the deployment. */ + /** + * Name of the deployment. + */ name: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** Status of the deployment. */ + /** + * Status of the deployment. + */ status: DeploymentStatus - /** List of tags applied to the deployment. */ + /** + * List of tags applied to the deployment. + */ tags: string[] - /** Node type of the deployment. */ + /** + * Node type of the deployment. + */ nodeTypeName: string - /** List of endpoints. */ + /** + * List of endpoints. + */ endpoints: Endpoint[] - /** Current size of the pool. */ + /** + * Current size of the pool. + */ size: number - /** Defines the minimum size of the pool. */ + /** + * Defines the minimum size of the pool. + */ minSize: number - /** Defines the maximum size of the pool. */ + /** + * Defines the maximum size of the pool. + */ maxSize: number - /** Displays information if your deployment is in error state. */ + /** + * Displays information if your deployment is in error state. + */ errorMessage?: string - /** ID of the model used for the deployment. */ + /** + * ID of the model used for the deployment. + */ modelId: string - /** Quantization parameters for this deployment. */ + /** + * Quantization parameters for this deployment. + */ quantization?: DeploymentQuantization - /** Name of the deployed model. */ + /** + * Name of the deployed model. + */ modelName: string - /** Creation date of the deployment. */ + /** + * Creation date of the deployment. + */ createdAt?: Date - /** Last modification date of the deployment. */ + /** + * Last modification date of the deployment. + */ updatedAt?: Date - /** Region of the deployment. */ + /** + * Region of the deployment. + */ region: ScwRegion } export interface Model { - /** Unique identifier. */ + /** + * Unique identifier. + */ id: string - /** Unique Name identifier. */ + /** + * Unique Name identifier. + */ name: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** List of tags applied to the model. */ + /** + * List of tags applied to the model. + */ tags: string[] - /** Status of the model. */ + /** + * Status of the model. + */ status: ModelStatus - /** Purpose of the model. */ + /** + * Purpose of the model. + */ description: string - /** Displays information if your model is in error state. */ + /** + * Displays information if your model is in error state. + */ errorMessage?: string - /** Defines whether the model has an end user license agreement. */ + /** + * Defines whether the model has an end user license agreement. + */ hasEula: boolean - /** Creation date of the model. */ + /** + * Creation date of the model. + */ createdAt?: Date - /** Last modification date of the model. */ + /** + * Last modification date of the model. + */ updatedAt?: Date - /** Region of the model. */ + /** + * Region of the model. + */ region: ScwRegion - /** Supported nodes types with quantization options and context lengths. */ + /** + * Supported nodes types with quantization options and context lengths. + */ nodesSupport: ModelSupportInfo[] - /** Size, in bits, of the model parameters. */ + /** + * Size, in bits, of the model parameters. + */ parameterSizeBits: number - /** Total size, in bytes, of the model files. */ + /** + * Total size, in bytes, of the model files. + */ sizeBytes: number } export interface NodeType { - /** Name of the node type. */ + /** + * Name of the node type. + */ name: string - /** Current stock status for the node type. */ + /** + * Current stock status for the node type. + */ stockStatus: NodeTypeStock - /** Current specs of the offer. */ + /** + * Current specs of the offer. + */ description: string - /** Number of virtual CPUs. */ + /** + * Number of virtual CPUs. + */ vcpus: number - /** Quantity of RAM. */ + /** + * Quantity of RAM. + */ memory: number - /** Quantity of GPU RAM. */ + /** + * Quantity of GPU RAM. + */ vram: number - /** The node type is currently disabled. */ + /** + * The node type is currently disabled. + */ disabled: boolean - /** The node type is currently in beta. */ + /** + * The node type is currently in beta. + */ beta: boolean - /** Creation date of the node type. */ + /** + * Creation date of the node type. + */ createdAt?: Date - /** Last modification date of the node type. */ + /** + * Last modification date of the node type. + */ updatedAt?: Date - /** Number of GPUs. */ + /** + * Number of GPUs. + */ gpus: number - /** Region of the node type. */ + /** + * Region of the node type. + */ region: ScwRegion } export type CreateDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the deployment. */ + /** + * Name of the deployment. + */ name?: string - /** ID of the Project to create the deployment in. */ + /** + * ID of the Project to create the deployment in. + */ projectId?: string - /** ID of the model to use. */ + /** + * ID of the model to use. + */ modelId: string /** - * If the model has an EULA, you must accept it before proceeding. The terms - * of the EULA can be retrieved using the `GetModelEula` API call. + * If the model has an EULA, you must accept it before proceeding. +The terms of the EULA can be retrieved using the `GetModelEula` API call. */ acceptEula?: boolean - /** Name of the node type to use. */ + /** + * Name of the node type to use. + */ nodeTypeName: string - /** List of tags to apply to the deployment. */ + /** + * List of tags to apply to the deployment. + */ tags?: string[] - /** Defines the minimum size of the pool. */ + /** + * Defines the minimum size of the pool. + */ minSize?: number - /** Defines the maximum size of the pool. */ + /** + * Defines the maximum size of the pool. + */ maxSize?: number - /** List of endpoints to create. */ + /** + * List of endpoints to create. + */ endpoints: EndpointSpec[] - /** Quantization settings to apply to this deployment. */ + /** + * Quantization settings to apply to this deployment. + */ quantization?: DeploymentQuantization } export type CreateEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to create the endpoint for. */ + /** + * ID of the deployment to create the endpoint for. + */ deploymentId: string - /** Specification of the endpoint. */ + /** + * Specification of the endpoint. + */ endpoint: EndpointSpec } export type CreateModelRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the model. */ + /** + * Name of the model. + */ name?: string - /** ID of the Project to import the model in. */ + /** + * ID of the Project to import the model in. + */ projectId?: string - /** Where to import the model from. */ + /** + * Where to import the model from. + */ source: ModelSource } export type DeleteDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to delete. */ + /** + * ID of the deployment to delete. + */ deploymentId: string } export type DeleteEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the endpoint to delete. */ + /** + * ID of the endpoint to delete. + */ endpointId: string } export type DeleteModelRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the model to delete. */ + /** + * ID of the model to delete. + */ modelId: string } export type GetDeploymentCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion deploymentId: string @@ -324,134 +447,191 @@ export type GetDeploymentCertificateRequest = { export type GetDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to get. */ + /** + * ID of the deployment to get. + */ deploymentId: string } export type GetModelRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the model to get. */ + /** + * ID of the model to get. + */ modelId: string } export type ListDeploymentsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of deployments to return per page. */ + /** + * Maximum number of deployments to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListDeploymentsRequestOrderBy - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Filter by deployment name. */ + /** + * Filter by deployment name. + */ name?: string - /** Filter by tags. */ + /** + * Filter by tags. + */ tags?: string[] } export interface ListDeploymentsResponse { - /** List of deployments on the current page. */ + /** + * List of deployments on the current page. + */ deployments: Deployment[] - /** Total number of deployments. */ + /** + * Total number of deployments. + */ totalCount: number } export type ListModelsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListModelsRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of models to return per page. */ + /** + * Maximum number of models to return per page. + */ pageSize?: number - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by model name. */ + /** + * Filter by model name. + */ name?: string - /** Filter by tags. */ + /** + * Filter by tags. + */ tags?: string[] } export interface ListModelsResponse { - /** List of models on the current page. */ + /** + * List of models on the current page. + */ models: Model[] - /** Total number of models. */ + /** + * Total number of models. + */ totalCount: number } export type ListNodeTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of node types to return per page. */ + /** + * Maximum number of node types to return per page. + */ pageSize?: number - /** Include disabled node types in the response. */ + /** + * Include disabled node types in the response. + */ includeDisabledTypes: boolean } export interface ListNodeTypesResponse { - /** List of node types. */ + /** + * List of node types. + */ nodeTypes: NodeType[] - /** Total number of node types. */ + /** + * Total number of node types. + */ totalCount: number } export type UpdateDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to update. */ + /** + * ID of the deployment to update. + */ deploymentId: string - /** Name of the deployment. */ + /** + * Name of the deployment. + */ name?: string - /** List of tags to apply to the deployment. */ + /** + * List of tags to apply to the deployment. + */ tags?: string[] - /** Defines the new minimum size of the pool. */ + /** + * Defines the new minimum size of the pool. + */ minSize?: number - /** Defines the new maximum size of the pool. */ + /** + * Defines the new maximum size of the pool. + */ maxSize?: number - /** Id of the model to set to the deployment. */ + /** + * Id of the model to set to the deployment. + */ modelId?: string - /** Quantization to use to the deployment. */ + /** + * Quantization to use to the deployment. + */ quantization?: DeploymentQuantization } export type UpdateEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the endpoint to update. */ + /** + * ID of the endpoint to update. + */ endpointId: string /** - * By default, deployments are protected by IAM authentication. When setting - * this field to true, the authentication will be disabled. + * By default, deployments are protected by IAM authentication. +When setting this field to true, the authentication will be disabled. */ disableAuth?: boolean } diff --git a/packages/clients/src/api/inference/v1beta1/api.gen.ts b/packages/clients/src/api/inference/v1beta1/api.gen.ts index 970328588..fb0337979 100644 --- a/packages/clients/src/api/inference/v1beta1/api.gen.ts +++ b/packages/clients/src/api/inference/v1beta1/api.gen.ts @@ -63,8 +63,8 @@ const jsonContentHeaders = { /** * Managed Inference API. - * - * This API allows you to manage your Inference services. + +This API allows you to manage your Inference services. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -140,8 +140,7 @@ export class API extends ParentAPI { ) /** - * Create a deployment. Create a new inference deployment related to a - * specific model. + * Create a deployment. Create a new inference deployment related to a specific model. * * @param request - The request {@link CreateDeploymentRequest} * @returns A Promise of Deployment @@ -194,8 +193,8 @@ export class API extends ParentAPI { ) /** - * Get the CA certificate. Get the CA certificate used for the deployment of - * private endpoints. The CA certificate will be returned as a PEM file. + * Get the CA certificate. Get the CA certificate used for the deployment of private endpoints. +The CA certificate will be returned as a PEM file. * * @param request - The request {@link GetDeploymentCertificateRequest} * @returns A Promise of Blob @@ -408,9 +407,7 @@ export class API extends ParentAPI { ) /** - * List available node types. List all available node types. By default, the - * node types returned in the list are ordered by creation date in ascending - * order, though this can be modified via the `order_by` field. + * List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListNodeTypesRequest} * @returns A Promise of ListNodeTypesResponse diff --git a/packages/clients/src/api/inference/v1beta1/types.gen.ts b/packages/clients/src/api/inference/v1beta1/types.gen.ts index c233648e1..4740a6151 100644 --- a/packages/clients/src/api/inference/v1beta1/types.gen.ts +++ b/packages/clients/src/api/inference/v1beta1/types.gen.ts @@ -31,44 +31,49 @@ export type NodeTypeStock = | 'available' export interface EndpointPrivateNetworkDetails { - /** ID of the Private Network. */ + /** + * ID of the Private Network. + */ privateNetworkId: string } export interface EndpointPublicAccessDetails {} export interface EndpointSpecPrivateNetwork { - /** ID of the Private Network. */ + /** + * ID of the Private Network. + */ privateNetworkId: string } export interface EndpointSpecPublic {} export interface Endpoint { - /** Unique identifier. */ + /** + * Unique identifier. + */ id: string /** - * For private endpoints, the URL will be accessible only from the Private - * Network. In addition, private endpoints will expose a CA certificate that - * can be used to verify the server's identity. This CA certificate can be - * retrieved using the `GetDeploymentCertificate` API call. + * For private endpoints, the URL will be accessible only from the Private Network. +In addition, private endpoints will expose a CA certificate that can be used to verify the server's identity. +This CA certificate can be retrieved using the `GetDeploymentCertificate` API call. */ url: string /** * Defines whether the endpoint is public. * - * One-of ('details'): at most one of 'publicAccess', 'privateNetwork' could - * be set. + * One-of ('details'): at most one of 'publicAccess', 'privateNetwork' could be set. */ publicAccess?: EndpointPublicAccessDetails /** * Details of the Private Network. * - * One-of ('details'): at most one of 'publicAccess', 'privateNetwork' could - * be set. + * One-of ('details'): at most one of 'publicAccess', 'privateNetwork' could be set. */ privateNetwork?: EndpointPrivateNetworkDetails - /** Defines whether the authentication is disabled. */ + /** + * Defines whether the authentication is disabled. + */ disableAuth: boolean } @@ -81,20 +86,27 @@ export interface ModelS3Model { export interface ACLRuleRequest { /** - * It can be specified as a single IP address or a range of IP addresses in - * CIDR notation. + * It can be specified as a single IP address or a range of IP addresses in CIDR notation. */ ip: string - /** Description of the ACL rule. */ + /** + * Description of the ACL rule. + */ description: string } export interface ACLRule { - /** Unique identifier. */ + /** + * Unique identifier. + */ id: string - /** Allowed IP address or CIDR range. */ + /** + * Allowed IP address or CIDR range. + */ ip: string - /** Description of the ACL rule. */ + /** + * Description of the ACL rule. + */ description: string } @@ -112,67 +124,119 @@ export interface EndpointSpec { */ privateNetwork?: EndpointSpecPrivateNetwork /** - * By default, deployments are protected by IAM authentication. When setting - * this field to true, the authentication will be disabled. + * By default, deployments are protected by IAM authentication. +When setting this field to true, the authentication will be disabled. */ disableAuth: boolean } export interface Deployment { - /** Unique identifier. */ + /** + * Unique identifier. + */ id: string - /** Name of the deployment. */ + /** + * Name of the deployment. + */ name: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** Status of the deployment. */ + /** + * Status of the deployment. + */ status: DeploymentStatus - /** List of tags applied to the deployment. */ + /** + * List of tags applied to the deployment. + */ tags: string[] - /** Node type of the deployment. */ + /** + * Node type of the deployment. + */ nodeType: string - /** List of endpoints. */ + /** + * List of endpoints. + */ endpoints: Endpoint[] - /** Current size of the pool. */ + /** + * Current size of the pool. + */ size: number - /** Defines the minimum size of the pool. */ + /** + * Defines the minimum size of the pool. + */ minSize: number - /** Defines the maximum size of the pool. */ + /** + * Defines the maximum size of the pool. + */ maxSize: number - /** Displays information if your deployment is in error state. */ + /** + * Displays information if your deployment is in error state. + */ errorMessage?: string - /** The inference model used for the deployment. */ + /** + * The inference model used for the deployment. + */ modelName: string - /** ID of the model used for the deployment. */ + /** + * ID of the model used for the deployment. + */ modelId: string - /** Creation date of the deployment. */ + /** + * Creation date of the deployment. + */ createdAt?: Date - /** Last modification date of the deployment. */ + /** + * Last modification date of the deployment. + */ updatedAt?: Date - /** Region of the deployment. */ + /** + * Region of the deployment. + */ region: ScwRegion } export interface Model { - /** Unique identifier. */ + /** + * Unique identifier. + */ id: string - /** Unique Name identifier. */ + /** + * Unique Name identifier. + */ name: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** Name of the model provider. */ + /** + * Name of the model provider. + */ provider: string - /** List of tags applied to the model. */ + /** + * List of tags applied to the model. + */ tags: string[] - /** Purpose of the model. */ + /** + * Purpose of the model. + */ description: string - /** Defines whether the model has an end user license agreement. */ + /** + * Defines whether the model has an end user license agreement. + */ hasEula: boolean - /** Creation date of the model. */ + /** + * Creation date of the model. + */ createdAt?: Date - /** Last modification date of the model. */ + /** + * Last modification date of the model. + */ updatedAt?: Date - /** Region of the model. */ + /** + * Region of the model. + */ region: ScwRegion /** * Object Storage URL pointing to the model source weight. @@ -180,138 +244,195 @@ export interface Model { * One-of ('source'): at most one of 's3Model' could be set. */ s3Model?: ModelS3Model - /** Defines whether the model is public or not. */ + /** + * Defines whether the model is public or not. + */ isPublic: boolean - /** Names of the node types compatible with the model. */ + /** + * Names of the node types compatible with the model. + */ compatibleNodeTypes: string[] - /** Quantization level of the model. */ + /** + * Quantization level of the model. + */ quantizationLevel: string } export interface NodeType { - /** Name of the node type. */ + /** + * Name of the node type. + */ name: string - /** Current stock status for the node type. */ + /** + * Current stock status for the node type. + */ stockStatus: NodeTypeStock - /** Current specs of the offer. */ + /** + * Current specs of the offer. + */ description: string - /** Number of virtual CPUs. */ + /** + * Number of virtual CPUs. + */ vcpus: number - /** Quantity of RAM. */ + /** + * Quantity of RAM. + */ memory: number - /** Quantity of GPU RAM. */ + /** + * Quantity of GPU RAM. + */ vram: number - /** The node type is currently disabled. */ + /** + * The node type is currently disabled. + */ disabled: boolean - /** The node type is currently in beta. */ + /** + * The node type is currently in beta. + */ beta: boolean - /** Creation date of the node type. */ + /** + * Creation date of the node type. + */ createdAt?: Date - /** Last modification date of the node type. */ + /** + * Last modification date of the node type. + */ updatedAt?: Date - /** Number of GPUs. */ + /** + * Number of GPUs. + */ gpus: number - /** Region of the node type. */ + /** + * Region of the node type. + */ region: ScwRegion } export type AddDeploymentACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to add ACL rules to. */ + /** + * ID of the deployment to add ACL rules to. + */ deploymentId: string - /** List of ACL rules to add. */ + /** + * List of ACL rules to add. + */ acls?: ACLRuleRequest[] } export interface AddDeploymentACLRulesResponse { - /** List of ACL rules added. */ + /** + * List of ACL rules added. + */ rules: ACLRule[] } export type CreateDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the deployment. */ + /** + * Name of the deployment. + */ name?: string - /** ID of the Project to create the deployment in. */ + /** + * ID of the Project to create the deployment in. + */ projectId?: string - /** Name of the model to use. */ + /** + * Name of the model to use. + */ modelName: string /** - * If the model has an EULA, you must accept it before proceeding. The terms - * of the EULA can be retrieved using the `GetModelEula` API call. + * If the model has an EULA, you must accept it before proceeding. +The terms of the EULA can be retrieved using the `GetModelEula` API call. */ acceptEula?: boolean - /** Name of the node type to use. */ + /** + * Name of the node type to use. + */ nodeType: string - /** List of tags to apply to the deployment. */ + /** + * List of tags to apply to the deployment. + */ tags?: string[] - /** Defines the minimum size of the pool. */ + /** + * Defines the minimum size of the pool. + */ minSize?: number - /** Defines the maximum size of the pool. */ + /** + * Defines the maximum size of the pool. + */ maxSize?: number - /** List of endpoints to create. */ + /** + * List of endpoints to create. + */ endpoints: EndpointSpec[] } export type CreateEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to create the endpoint for. */ + /** + * ID of the deployment to create the endpoint for. + */ deploymentId: string - /** Specification of the endpoint. */ + /** + * Specification of the endpoint. + */ endpoint: EndpointSpec } export type DeleteDeploymentACLRuleRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the ACL rule to delete. */ + /** + * ID of the ACL rule to delete. + */ aclId: string } export type DeleteDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to delete. */ + /** + * ID of the deployment to delete. + */ deploymentId: string } export type DeleteEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the endpoint to delete. */ + /** + * ID of the endpoint to delete. + */ endpointId: string } export interface Eula { - /** Content of the end user license agreement. */ + /** + * Content of the end user license agreement. + */ content: string } export type GetDeploymentCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion deploymentId: string @@ -319,18 +440,18 @@ export type GetDeploymentCertificateRequest = { export type GetDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to get. */ + /** + * ID of the deployment to get. + */ deploymentId: string } export type GetModelEulaRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion modelId: string @@ -338,158 +459,224 @@ export type GetModelEulaRequest = { export type GetModelRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the model to get. */ + /** + * ID of the model to get. + */ modelId: string } export type ListDeploymentACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to list ACL rules for. */ + /** + * ID of the deployment to list ACL rules for. + */ deploymentId: string - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of ACL rules to return per page. */ + /** + * Maximum number of ACL rules to return per page. + */ pageSize?: number } export interface ListDeploymentACLRulesResponse { - /** List of ACL rules on the current page. */ + /** + * List of ACL rules on the current page. + */ rules: ACLRule[] - /** Total number of ACL rules. */ + /** + * Total number of ACL rules. + */ totalCount: number } export type ListDeploymentsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of deployments to return per page. */ + /** + * Maximum number of deployments to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListDeploymentsRequestOrderBy - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Filter by deployment name. */ + /** + * Filter by deployment name. + */ name?: string - /** Filter by tags. */ + /** + * Filter by tags. + */ tags?: string[] } export interface ListDeploymentsResponse { - /** List of deployments on the current page. */ + /** + * List of deployments on the current page. + */ deployments: Deployment[] - /** Total number of deployments. */ + /** + * Total number of deployments. + */ totalCount: number } export type ListModelsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListModelsRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of models to return per page. */ + /** + * Maximum number of models to return per page. + */ pageSize?: number - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by model name. */ + /** + * Filter by model name. + */ name?: string - /** Filter by tags. */ + /** + * Filter by tags. + */ tags?: string[] } export interface ListModelsResponse { - /** List of models on the current page. */ + /** + * List of models on the current page. + */ models: Model[] - /** Total number of models. */ + /** + * Total number of models. + */ totalCount: number } export type ListNodeTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of node types to return per page. */ + /** + * Maximum number of node types to return per page. + */ pageSize?: number - /** Include disabled node types in the response. */ + /** + * Include disabled node types in the response. + */ includeDisabledTypes: boolean } export interface ListNodeTypesResponse { - /** List of node types. */ + /** + * List of node types. + */ nodeTypes: NodeType[] - /** Total number of node types. */ + /** + * Total number of node types. + */ totalCount: number } export type SetDeploymentACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to set ACL rules for. */ + /** + * ID of the deployment to set ACL rules for. + */ deploymentId: string - /** All existing ACL rules will be replaced by the new ones. */ + /** + * All existing ACL rules will be replaced by the new ones. + */ acls?: ACLRuleRequest[] } export interface SetDeploymentACLRulesResponse { - /** List of ACL rules that were set. */ + /** + * List of ACL rules that were set. + */ rules: ACLRule[] } export type UpdateDeploymentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the deployment to update. */ + /** + * ID of the deployment to update. + */ deploymentId: string - /** Name of the deployment. */ + /** + * Name of the deployment. + */ name?: string - /** List of tags to apply to the deployment. */ + /** + * List of tags to apply to the deployment. + */ tags?: string[] - /** Defines the new minimum size of the pool. */ + /** + * Defines the new minimum size of the pool. + */ minSize?: number - /** Defines the new maximum size of the pool. */ + /** + * Defines the new maximum size of the pool. + */ maxSize?: number } export type UpdateEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the endpoint to update. */ + /** + * ID of the endpoint to update. + */ endpointId: string /** - * By default, deployments are protected by IAM authentication. When setting - * this field to true, the authentication will be disabled. + * By default, deployments are protected by IAM authentication. +When setting this field to true, the authentication will be disabled. */ disableAuth?: boolean } diff --git a/packages/clients/src/api/instance/v1/api.gen.ts b/packages/clients/src/api/instance/v1/api.gen.ts index 5f2a374c7..832a5b784 100644 --- a/packages/clients/src/api/instance/v1/api.gen.ts +++ b/packages/clients/src/api/instance/v1/api.gen.ts @@ -241,8 +241,8 @@ const jsonContentHeaders = { /** * Instance API. - * - * This API allows you to manage your Instances. + +This API allows you to manage your Instances. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -280,8 +280,7 @@ export class API extends ParentAPI { ) /** - * List Instance types. List available Instance types and their technical - * details. + * List Instance types. List available Instance types and their technical details. * * @param request - The request {@link ListServersTypesRequest} * @returns A Promise of ListServersTypesResponse @@ -361,8 +360,7 @@ export class API extends ParentAPI { ) /** - * List all Instances. List all Instances in a specified Availability Zone, - * e.g. `fr-par-1`. + * List all Instances. List all Instances in a specified Availability Zone, e.g. `fr-par-1`. * * @param request - The request {@link ListServersRequest} * @returns A Promise of ListServersResponse @@ -436,8 +434,7 @@ export class API extends ParentAPI { ) /** - * List Instance actions. List all actions (e.g. power on, power off, reboot) - * that can currently be performed on an Instance. + * List Instance actions. List all actions (e.g. power on, power off, reboot) that can currently be performed on an Instance. * * @param request - The request {@link ListServerActionsRequest} * @returns A Promise of ListServerActionsResponse @@ -452,26 +449,22 @@ export class API extends ParentAPI { ) /** - * Perform action. Perform an action on an Instance. Available actions are: - * `poweron`: Start a stopped Instance. `poweroff`: Fully stop the Instance - * and release the hypervisor slot. `stop_in_place`: Stop the Instance, but - * keep the slot on the hypervisor. `reboot`: Stop the instance and restart - * it. `backup`: Create an image with all the volumes of an Instance. - * `terminate`: Delete the Instance along with its attached volumes, except - * for SBS volumes. `enable_routed_ip`: Migrate the Instance to the new - * network stack. - * - * The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and - * `scratch` volumes types, `sbs_volume` volumes type will only be detached. - * If you want to preserve your volumes, you should detach them before the - * Instance deletion or `terminate` action. - * - * The `backup` action can be done with: No `volumes` key in the body: an - * image is created with snapshots of all the server volumes, except for the - * `scratch` volumes types. `volumes` key in the body with a dictionary as - * value, in this dictionary volumes UUID as keys and empty dictionaries as - * values : an image is created with the snapshots of the volumes in `volumes` - * key. `scratch` volumes types can't be shapshotted. + * Perform action. Perform an action on an Instance. +Available actions are: +* `poweron`: Start a stopped Instance. +* `poweroff`: Fully stop the Instance and release the hypervisor slot. +* `stop_in_place`: Stop the Instance, but keep the slot on the hypervisor. +* `reboot`: Stop the instance and restart it. +* `backup`: Create an image with all the volumes of an Instance. +* `terminate`: Delete the Instance along with its attached volumes, except for SBS volumes. +* `enable_routed_ip`: Migrate the Instance to the new network stack. + +The `terminate` action will result in the deletion of `l_ssd`, `b_ssd` and `scratch` volumes types, `sbs_volume` volumes type will only be detached. +If you want to preserve your volumes, you should detach them before the Instance deletion or `terminate` action. + +The `backup` action can be done with: +* No `volumes` key in the body: an image is created with snapshots of all the server volumes, except for the `scratch` volumes types. +* `volumes` key in the body with a dictionary as value, in this dictionary volumes UUID as keys and empty dictionaries as values : an image is created with the snapshots of the volumes in `volumes` key. `scratch` volumes types can't be shapshotted. * * @param request - The request {@link ServerActionRequest} * @returns A Promise of ServerActionResponse @@ -516,12 +509,12 @@ export class API extends ParentAPI { }) /** - * Get Instance compatible types. Get compatible commercial types that can be - * used to update the Instance. The compatibility of an Instance offer is - * based on: the CPU architecture the OS type the required l_ssd storage size - * the required scratch storage size If the specified Instance offer is - * flagged as end of service, the best compatible offer is the first - * returned. + * Get Instance compatible types. Get compatible commercial types that can be used to update the Instance. The compatibility of an Instance offer is based on: +* the CPU architecture +* the OS type +* the required l_ssd storage size +* the required scratch storage size +If the specified Instance offer is flagged as end of service, the best compatible offer is the first returned. * * @param request - The request {@link GetServerCompatibleTypesRequest} * @returns A Promise of ServerCompatibleTypes @@ -607,8 +600,7 @@ export class API extends ParentAPI { ) /** - * Create an Instance image. Create an Instance image from the specified - * snapshot ID. + * Create an Instance image. Create an Instance image from the specified snapshot ID. * * @param request - The request {@link CreateImageRequest} * @returns A Promise of CreateImageResponse @@ -690,8 +682,7 @@ export class API extends ParentAPI { ) /** - * List snapshots. List all snapshots of an Organization in a specified - * Availability Zone. + * List snapshots. List all snapshots of an Organization in a specified Availability Zone. * * @param request - The request {@link ListSnapshotsRequest} * @returns A Promise of ListSnapshotsResponse @@ -700,9 +691,7 @@ export class API extends ParentAPI { enrichForPagination('snapshots', this.pageOfListSnapshots, request) /** - * Create a snapshot from a specified volume or from a QCOW2 file. Create a - * snapshot from a specified volume or from a QCOW2 file in a specified - * Availability Zone. + * Create a snapshot from a specified volume or from a QCOW2 file. Create a snapshot from a specified volume or from a QCOW2 file in a specified Availability Zone. * * @param request - The request {@link CreateSnapshotRequest} * @returns A Promise of CreateSnapshotResponse @@ -779,8 +768,7 @@ export class API extends ParentAPI { }) /** - * Export a snapshot. Export a snapshot to a specified Object Storage bucket - * in the same region. + * Export a snapshot. Export a snapshot to a specified Object Storage bucket in the same region. * * @param request - The request {@link ExportSnapshotRequest} * @returns A Promise of ExportSnapshotResponse @@ -822,8 +810,7 @@ export class API extends ParentAPI { ) /** - * List volumes. List volumes in the specified Availability Zone. You can - * filter the output by volume type. + * List volumes. List volumes in the specified Availability Zone. You can filter the output by volume type. * * @param request - The request {@link ListVolumesRequest} * @returns A Promise of ListVolumesResponse @@ -832,8 +819,7 @@ export class API extends ParentAPI { enrichForPagination('volumes', this.pageOfListVolumes, request) /** - * Create a volume. Create a volume of a specified type in an Availability - * Zone. + * Create a volume. Create a volume of a specified type in an Availability Zone. * * @param request - The request {@link CreateVolumeRequest} * @returns A Promise of CreateVolumeResponse @@ -867,9 +853,7 @@ export class API extends ParentAPI { ) /** - * Update a volume. Replace the name and/or size properties of a volume - * specified by its ID, with the specified value(s). Any volume name can be - * changed, however only `b_ssd` volumes can currently be increased in size. + * Update a volume. Replace the name and/or size properties of a volume specified by its ID, with the specified value(s). Any volume name can be changed, however only `b_ssd` volumes can currently be increased in size. * * @param request - The request {@link UpdateVolumeRequest} * @returns A Promise of UpdateVolumeResponse @@ -937,8 +921,7 @@ export class API extends ParentAPI { ) /** - * Create a security group. Create a security group with a specified name and - * description. + * Create a security group. Create a security group with a specified name and description. * * @param request - The request {@link CreateSecurityGroupRequest} * @returns A Promise of CreateSecurityGroupResponse @@ -957,8 +940,7 @@ export class API extends ParentAPI { ) /** - * Get a security group. Get the details of a security group with the - * specified ID. + * Get a security group. Get the details of a security group with the specified ID. * * @param request - The request {@link GetSecurityGroupRequest} * @returns A Promise of GetSecurityGroupResponse @@ -1016,8 +998,7 @@ export class API extends ParentAPI { ) /** - * Get default rules. Lists the default rules applied to all the security - * groups. + * Get default rules. Lists the default rules applied to all the security groups. * * @param request - The request {@link ListDefaultSecurityGroupRulesRequest} * @returns A Promise of ListSecurityGroupRulesResponse @@ -1079,10 +1060,7 @@ export class API extends ParentAPI { ) /** - * Update all the rules of a security group. Replaces the existing rules of - * the security group with the rules provided. This endpoint supports the - * update of existing rules, creation of new rules and deletion of existing - * rules when they are not passed in the request. + * Update all the rules of a security group. Replaces the existing rules of the security group with the rules provided. This endpoint supports the update of existing rules, creation of new rules and deletion of existing rules when they are not passed in the request. * * @param request - The request {@link SetSecurityGroupRulesRequest} * @returns A Promise of SetSecurityGroupRulesResponse @@ -1144,8 +1122,7 @@ export class API extends ParentAPI { ) /** - * Update security group rule. Update the properties of a rule from a - * specified security group. + * Update security group rule. Update the properties of a rule from a specified security group. * * @param request - The request {@link UpdateSecurityGroupRuleRequest} * @returns A Promise of UpdateSecurityGroupRuleResponse @@ -1190,8 +1167,7 @@ export class API extends ParentAPI { ) /** - * List placement groups. List all placement groups in a specified - * Availability Zone. + * List placement groups. List all placement groups in a specified Availability Zone. * * @param request - The request {@link ListPlacementGroupsRequest} * @returns A Promise of ListPlacementGroupsResponse @@ -1204,8 +1180,7 @@ export class API extends ParentAPI { ) /** - * Create a placement group. Create a new placement group in a specified - * Availability Zone. + * Create a placement group. Create a new placement group in a specified Availability Zone. * * @param request - The request {@link CreatePlacementGroupRequest} * @returns A Promise of CreatePlacementGroupResponse @@ -1260,8 +1235,7 @@ export class API extends ParentAPI { ) /** - * Update a placement group. Update one or more parameter of the specified - * placement group. + * Update a placement group. Update one or more parameter of the specified placement group. * * @param request - The request {@link UpdatePlacementGroupRequest} * @returns A Promise of UpdatePlacementGroupResponse @@ -1291,8 +1265,7 @@ export class API extends ParentAPI { }) /** - * Get placement group servers. Get all Instances belonging to the specified - * placement group. + * Get placement group servers. Get all Instances belonging to the specified placement group. * * @param request - The request {@link GetPlacementGroupServersRequest} * @returns A Promise of GetPlacementGroupServersResponse @@ -1309,8 +1282,7 @@ export class API extends ParentAPI { ) /** - * Set placement group servers. Set all Instances belonging to the specified - * placement group. + * Set placement group servers. Set all Instances belonging to the specified placement group. * * @param request - The request {@link SetPlacementGroupServersRequest} * @returns A Promise of SetPlacementGroupServersResponse @@ -1331,8 +1303,7 @@ export class API extends ParentAPI { ) /** - * Update placement group servers. Update all Instances belonging to the - * specified placement group. + * Update placement group servers. Update all Instances belonging to the specified placement group. * * @param request - The request {@link UpdatePlacementGroupServersRequest} * @returns A Promise of UpdatePlacementGroupServersResponse @@ -1388,8 +1359,7 @@ export class API extends ParentAPI { enrichForPagination('ips', this.pageOfListIps, request) /** - * Reserve a flexible IP. Reserve a flexible IP and attach it to the specified - * Instance. + * Reserve a flexible IP. Reserve a flexible IP and attach it to the specified Instance. * * @param request - The request {@link CreateIpRequest} * @returns A Promise of CreateIpResponse @@ -1423,8 +1393,7 @@ export class API extends ParentAPI { ) /** - * Update a flexible IP. Update a flexible IP in the specified zone with the - * specified ID. + * Update a flexible IP. Update a flexible IP in the specified zone with the specified ID. * * @param request - The request {@link UpdateIpRequest} * @returns A Promise of UpdateIpResponse @@ -1518,8 +1487,7 @@ export class API extends ParentAPI { ) /** - * Update a private NIC. Update one or more parameter(s) of a specified - * private NIC. + * Update a private NIC. Update one or more parameter(s) of a specified private NIC. * * @param request - The request {@link UpdatePrivateNICRequest} * @returns A Promise of PrivateNIC @@ -1562,23 +1530,11 @@ export class API extends ParentAPI { ) /** - * Get a volume or snapshot's migration plan. Given a volume or snapshot, - * returns the migration plan but does not perform the actual migration. To - * perform the migration, you have to call the [Migrate a volume and/or - * snapshots to - * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) - * endpoint afterward. The endpoint returns the resources that should be - * migrated together: - * - * - The volume and any snapshots created from the volume, if the call was made - * to plan a volume migration. - * - The base volume of the snapshot (if the volume is not deleted) and its - * related snapshots, if the call was made to plan a snapshot migration. The - * endpoint also returns the validation_key, which must be provided to the - * [Migrate a volume and/or snapshots to - * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) - * endpoint to confirm that all resources listed in the plan should be - * migrated. + * Get a volume or snapshot's migration plan. Given a volume or snapshot, returns the migration plan but does not perform the actual migration. To perform the migration, you have to call the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint afterward. +The endpoint returns the resources that should be migrated together: +- the volume and any snapshots created from the volume, if the call was made to plan a volume migration. +- the base volume of the snapshot (if the volume is not deleted) and its related snapshots, if the call was made to plan a snapshot migration. +The endpoint also returns the validation_key, which must be provided to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint to confirm that all resources listed in the plan should be migrated. * * @param request - The request {@link PlanBlockMigrationRequest} * @returns A Promise of MigrationPlan @@ -1597,12 +1553,7 @@ export class API extends ParentAPI { ) /** - * Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be - * used, the call to this endpoint must be preceded by a call to the [Get a - * volume or snapshot's migration - * plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To - * migrate all resources mentioned in the migration plan, the validation_key - * returned in the plan must be provided. + * Migrate a volume and/or snapshots to SBS (Scaleway Block Storage). To be used, the call to this endpoint must be preceded by a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. To migrate all resources mentioned in the migration plan, the validation_key returned in the plan must be provided. * * @param request - The request {@link ApplyBlockMigrationRequest} */ diff --git a/packages/clients/src/api/instance/v1/types.gen.ts b/packages/clients/src/api/instance/v1/types.gen.ts index cc59a2312..d4a31a905 100644 --- a/packages/clients/src/api/instance/v1/types.gen.ts +++ b/packages/clients/src/api/instance/v1/types.gen.ts @@ -148,36 +148,64 @@ export interface Bootscript { public: boolean title: string project: string - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone: ScwZone } export interface Volume { - /** Volume unique ID. */ + /** + * Volume unique ID. + */ id: string - /** Volume name. */ + /** + * Volume name. + */ name: string - /** @deprecated Show the volume NBD export URI. */ + /** + * @deprecated Show the volume NBD export URI. + */ exportUri?: string - /** Volume disk size. */ + /** + * Volume disk size. + */ size: number - /** Volume type. */ + /** + * Volume type. + */ volumeType: VolumeVolumeType - /** Volume creation date. */ + /** + * Volume creation date. + */ creationDate?: Date - /** Volume modification date. */ + /** + * Volume modification date. + */ modificationDate?: Date - /** Volume Organization ID. */ + /** + * Volume Organization ID. + */ organization: string - /** Volume Project ID. */ + /** + * Volume Project ID. + */ project: string - /** Volume tags. */ + /** + * Volume tags. + */ tags: string[] - /** Instance attached to the volume. */ + /** + * Instance attached to the volume. + */ server?: ServerSummary - /** Volume state. */ + /** + * Volume state. + */ state: VolumeState - /** Zone in which the volume is located. */ + /** + * Zone in which the volume is located. + */ zone: ScwZone } @@ -189,16 +217,24 @@ export interface VolumeSummary { } export interface ServerTypeNetworkInterface { - /** Maximum internal bandwidth in bits per seconds. */ + /** + * Maximum internal bandwidth in bits per seconds. + */ internalBandwidth?: number - /** Maximum internet bandwidth in bits per seconds. */ + /** + * Maximum internet bandwidth in bits per seconds. + */ internetBandwidth?: number } export interface ServerTypeVolumeConstraintSizes { - /** Minimum volume size in bytes. */ + /** + * Minimum volume size in bytes. + */ minSize: number - /** Maximum volume size in bytes. */ + /** + * Maximum volume size in bytes. + */ maxSize: number } @@ -208,7 +244,9 @@ export interface Image { arch: Arch creationDate?: Date modificationDate?: Date - /** @deprecated */ + /** + * @deprecated + */ defaultBootscript?: Bootscript extraVolumes: Record fromServer: string @@ -218,52 +256,76 @@ export interface Image { state: ImageState project: string tags: string[] - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone: ScwZone } export interface PlacementGroup { - /** Placement group unique ID. */ + /** + * Placement group unique ID. + */ id: string - /** Placement group name. */ + /** + * Placement group name. + */ name: string - /** Placement group Organization ID. */ + /** + * Placement group Organization ID. + */ organization: string - /** Placement group Project ID. */ + /** + * Placement group Project ID. + */ project: string - /** Placement group tags. */ + /** + * Placement group tags. + */ tags: string[] /** - * Select the failure mode when the placement cannot be respected, either - * optional or enforced. + * Select the failure mode when the placement cannot be respected, either optional or enforced. */ policyMode: PlacementGroupPolicyMode /** - * Select the behavior of the placement group, either low_latency (group) or - * max_availability (spread). + * Select the behavior of the placement group, either low_latency (group) or max_availability (spread). */ policyType: PlacementGroupPolicyType /** - * In the server endpoints the value is always false as it is deprecated. In - * the placement group endpoints the value is correct. + * In the server endpoints the value is always false as it is deprecated. +In the placement group endpoints the value is correct. */ policyRespected: boolean - /** Zone in which the placement group is located. */ + /** + * Zone in which the placement group is located. + */ zone: ScwZone } export interface PrivateNIC { - /** Private NIC unique ID. */ + /** + * Private NIC unique ID. + */ id: string - /** Instance to which the private NIC is attached. */ + /** + * Instance to which the private NIC is attached. + */ serverId: string - /** Private Network the private NIC is attached to. */ + /** + * Private Network the private NIC is attached to. + */ privateNetworkId: string - /** Private NIC MAC address. */ + /** + * Private NIC MAC address. + */ macAddress: string - /** Private NIC state. */ + /** + * Private NIC state. + */ state: PrivateNICState - /** Private NIC tags. */ + /** + * Private NIC tags. + */ tags: string[] } @@ -273,34 +335,60 @@ export interface SecurityGroupSummary { } export interface ServerIp { - /** Unique ID of the IP address. */ + /** + * Unique ID of the IP address. + */ id: string - /** Instance's public IP-Address. */ + /** + * Instance's public IP-Address. + */ address: string - /** Gateway's IP address. */ + /** + * Gateway's IP address. + */ gateway: string - /** CIDR netmask. */ + /** + * CIDR netmask. + */ netmask: string - /** IP address family (inet or inet6). */ + /** + * IP address family (inet or inet6). + */ family: ServerIpIpFamily - /** True if the IP address is dynamic. */ + /** + * True if the IP address is dynamic. + */ dynamic: boolean - /** Information about this address provisioning mode. */ + /** + * Information about this address provisioning mode. + */ provisioningMode: ServerIpProvisioningMode - /** Tags associated with the IP. */ + /** + * Tags associated with the IP. + */ tags: string[] - /** The ip_id of an IPAM ip if the ip is created from IPAM, null if not. */ + /** + * The ip_id of an IPAM ip if the ip is created from IPAM, null if not. + */ ipamId: string - /** IP address state. */ + /** + * IP address state. + */ state: ServerIpState } export interface ServerIpv6 { - /** Instance IPv6 IP-Address. */ + /** + * Instance IPv6 IP-Address. + */ address: string - /** IPv6 IP-addresses gateway. */ + /** + * IPv6 IP-addresses gateway. + */ gateway: string - /** IPv6 IP-addresses CIDR netmask. */ + /** + * IPv6 IP-addresses CIDR netmask. + */ netmask: string } @@ -320,7 +408,9 @@ export interface ServerMaintenance { export interface VolumeServer { id: string name?: string - /** @deprecated */ + /** + * @deprecated + */ exportUri?: string organization?: string server?: ServerSummary @@ -331,46 +421,72 @@ export interface VolumeServer { state?: VolumeServerState project?: string boot: boolean - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone: ScwZone } export interface SnapshotBaseVolume { - /** Volume ID on which the snapshot is based. */ + /** + * Volume ID on which the snapshot is based. + */ id: string - /** Volume name on which the snapshot is based on. */ + /** + * Volume name on which the snapshot is based on. + */ name: string } export interface ServerTypeCapabilities { - /** Defines whether the Instance supports block storage. */ + /** + * Defines whether the Instance supports block storage. + */ blockStorage?: boolean - /** List of supported boot types. */ + /** + * List of supported boot types. + */ bootTypes: BootType[] } export interface ServerTypeGPUInfo { - /** GPU manufacturer. */ + /** + * GPU manufacturer. + */ gpuManufacturer: string - /** GPU model name. */ + /** + * GPU model name. + */ gpuName: string - /** RAM of a single GPU, in bytes. */ + /** + * RAM of a single GPU, in bytes. + */ gpuMemory: number } export interface ServerTypeNetwork { - /** List of available network interfaces. */ + /** + * List of available network interfaces. + */ interfaces: ServerTypeNetworkInterface[] - /** Total maximum internal bandwidth in bits per seconds. */ + /** + * Total maximum internal bandwidth in bits per seconds. + */ sumInternalBandwidth?: number - /** Total maximum internet bandwidth in bits per seconds. */ + /** + * Total maximum internet bandwidth in bits per seconds. + */ sumInternetBandwidth?: number - /** True if IPv6 is enabled. */ + /** + * True if IPv6 is enabled. + */ ipv6Support: boolean } export interface ServerTypeVolumeConstraintsByType { - /** Local SSD volumes. */ + /** + * Local SSD volumes. + */ lSsd?: ServerTypeVolumeConstraintSizes } @@ -384,118 +500,167 @@ export interface VolumeTypeConstraints { } export interface Server { - /** Instance unique ID. */ + /** + * Instance unique ID. + */ id: string - /** Instance name. */ + /** + * Instance name. + */ name: string - /** Instance Organization ID. */ + /** + * Instance Organization ID. + */ organization: string - /** Instance Project ID. */ + /** + * Instance Project ID. + */ project: string - /** List of allowed actions on the Instance. */ + /** + * List of allowed actions on the Instance. + */ allowedActions: ServerAction[] - /** Tags associated with the Instance. */ + /** + * Tags associated with the Instance. + */ tags: string[] - /** Instance commercial type (eg. GP1-M). */ + /** + * Instance commercial type (eg. GP1-M). + */ commercialType: string - /** Instance creation date. */ + /** + * Instance creation date. + */ creationDate?: Date - /** True if a dynamic IPv4 is required. */ + /** + * True if a dynamic IPv4 is required. + */ dynamicIpRequired: boolean /** - * @deprecated True to configure the instance so it uses the routed IP mode. - * Use of `routed_ip_enabled` as `False` is deprecated. + * @deprecated True to configure the instance so it uses the routed IP mode. Use of `routed_ip_enabled` as `False` is deprecated. */ routedIpEnabled?: boolean /** - * @deprecated True if IPv6 is enabled (deprecated and always `False` when - * `routed_ip_enabled` is `True`). + * @deprecated True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`). */ enableIpv6?: boolean - /** Instance host name. */ + /** + * Instance host name. + */ hostname: string - /** Information about the Instance image. */ + /** + * Information about the Instance image. + */ image?: Image - /** Defines whether the Instance protection option is activated. */ + /** + * Defines whether the Instance protection option is activated. + */ protected: boolean /** - * Private IP address of the Instance (deprecated and always `null` when - * `routed_ip_enabled` is `True`). + * Private IP address of the Instance (deprecated and always `null` when `routed_ip_enabled` is `True`). */ privateIp?: string /** - * @deprecated Information about the public IP (deprecated in favor of - * `public_ips`). + * @deprecated Information about the public IP (deprecated in favor of `public_ips`). */ publicIp?: ServerIp - /** Information about all the public IPs attached to the server. */ + /** + * Information about all the public IPs attached to the server. + */ publicIps: ServerIp[] - /** The server's MAC address. */ + /** + * The server's MAC address. + */ macAddress: string - /** Instance modification date. */ + /** + * Instance modification date. + */ modificationDate?: Date - /** Instance state. */ + /** + * Instance state. + */ state: ServerState - /** Instance location. */ + /** + * Instance location. + */ location?: ServerLocation /** - * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is - * `True`). + * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`). */ ipv6?: ServerIpv6 - /** Instance boot type. */ + /** + * Instance boot type. + */ bootType: BootType - /** Instance volumes. */ + /** + * Instance volumes. + */ volumes: Record - /** Instance security group. */ + /** + * Instance security group. + */ securityGroup?: SecurityGroupSummary - /** Instance planned maintenance. */ + /** + * Instance planned maintenance. + */ maintenances: ServerMaintenance[] - /** Detailed information about the Instance state. */ + /** + * Detailed information about the Instance state. + */ stateDetail: string - /** Instance architecture. */ + /** + * Instance architecture. + */ arch: Arch - /** Instance placement group. */ + /** + * Instance placement group. + */ placementGroup?: PlacementGroup - /** Instance private NICs. */ + /** + * Instance private NICs. + */ privateNics: PrivateNIC[] - /** Zone in which the Instance is located. */ + /** + * Zone in which the Instance is located. + */ zone: ScwZone /** - * The public_key value of this key is used to encrypt the admin password. - * When set to an empty string, reset this value and - * admin_password_encrypted_value to an empty string so a new password may be - * generated. + * The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated. */ adminPasswordEncryptionSshKeyId?: string /** - * This value is reset when admin_password_encryption_ssh_key_id is set to an - * empty string. + * This value is reset when admin_password_encryption_ssh_key_id is set to an empty string. */ adminPasswordEncryptedValue?: string } export interface VolumeTemplate { - /** UUID of the volume. */ + /** + * UUID of the volume. + */ id: string - /** Name of the volume. */ + /** + * Name of the volume. + */ name: string - /** Disk size of the volume, must be a multiple of 512. */ + /** + * Disk size of the volume, must be a multiple of 512. + */ size: number - /** Type of the volume. */ + /** + * Type of the volume. + */ volumeType: VolumeVolumeType /** * @deprecated Organization ID of the volume. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Project ID of the volume. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string } @@ -512,50 +677,80 @@ export interface Ip { state: IpState prefix: string ipamId: string - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone: ScwZone } export interface SecurityGroup { - /** Security group unique ID. */ + /** + * Security group unique ID. + */ id: string - /** Security group name. */ + /** + * Security group name. + */ name: string - /** Security group description. */ + /** + * Security group description. + */ description: string /** - * True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please - * open a support ticket if you need to make it configurable. + * True if SMTP is blocked on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable. */ enableDefaultSecurity: boolean - /** Default inbound policy. */ + /** + * Default inbound policy. + */ inboundDefaultPolicy: SecurityGroupPolicy - /** Default outbound policy. */ + /** + * Default outbound policy. + */ outboundDefaultPolicy: SecurityGroupPolicy - /** Security group Organization ID. */ + /** + * Security group Organization ID. + */ organization: string - /** Security group Project ID. */ + /** + * Security group Project ID. + */ project: string - /** Security group tags. */ + /** + * Security group tags. + */ tags: string[] /** - * @deprecated True if it is your default security group for this Organization - * ID. + * @deprecated True if it is your default security group for this Organization ID. */ organizationDefault?: boolean - /** True if it is your default security group for this Project ID. */ + /** + * True if it is your default security group for this Project ID. + */ projectDefault: boolean - /** Security group creation date. */ + /** + * Security group creation date. + */ creationDate?: Date - /** Security group modification date. */ + /** + * Security group modification date. + */ modificationDate?: Date - /** List of Instances attached to this security group. */ + /** + * List of Instances attached to this security group. + */ servers: ServerSummary[] - /** Defines whether the security group is stateful. */ + /** + * Defines whether the security group is stateful. + */ stateful: boolean - /** Security group state. */ + /** + * Security group state. + */ state: SecurityGroupState - /** Zone in which the security group is located. */ + /** + * Zone in which the security group is located. + */ zone: ScwZone } @@ -569,74 +764,132 @@ export interface SecurityGroupRule { destPortTo?: number position: number editable: boolean - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone: ScwZone } export interface VolumeServerTemplate { - /** UUID of the volume. */ + /** + * UUID of the volume. + */ id?: string - /** Force the Instance to boot on this volume. */ + /** + * Force the Instance to boot on this volume. + */ boot?: boolean - /** Name of the volume. */ + /** + * Name of the volume. + */ name?: string - /** Disk size of the volume, must be a multiple of 512. */ + /** + * Disk size of the volume, must be a multiple of 512. + */ size?: number - /** Type of the volume. */ + /** + * Type of the volume. + */ volumeType: VolumeVolumeType - /** ID of the snapshot on which this volume will be based. */ + /** + * ID of the snapshot on which this volume will be based. + */ baseSnapshot?: string - /** Organization ID of the volume. */ + /** + * Organization ID of the volume. + */ organization?: string - /** Project ID of the volume. */ + /** + * Project ID of the volume. + */ project?: string } export interface Snapshot { - /** Snapshot ID. */ + /** + * Snapshot ID. + */ id: string - /** Snapshot name. */ + /** + * Snapshot name. + */ name: string - /** Snapshot Organization ID. */ + /** + * Snapshot Organization ID. + */ organization: string - /** Snapshot Project ID. */ + /** + * Snapshot Project ID. + */ project: string - /** Snapshot tags. */ + /** + * Snapshot tags. + */ tags: string[] - /** Snapshot volume type. */ + /** + * Snapshot volume type. + */ volumeType: VolumeVolumeType - /** Snapshot size. */ + /** + * Snapshot size. + */ size: number - /** Snapshot state. */ + /** + * Snapshot state. + */ state: SnapshotState - /** Volume on which the snapshot is based on. */ + /** + * Volume on which the snapshot is based on. + */ baseVolume?: SnapshotBaseVolume - /** Snapshot creation date. */ + /** + * Snapshot creation date. + */ creationDate?: Date - /** Snapshot modification date. */ + /** + * Snapshot modification date. + */ modificationDate?: Date - /** Snapshot zone. */ + /** + * Snapshot zone. + */ zone: ScwZone - /** Reason for the failed snapshot import. */ + /** + * Reason for the failed snapshot import. + */ errorReason?: string } export interface Task { - /** Unique ID of the task. */ + /** + * Unique ID of the task. + */ id: string - /** Description of the task. */ + /** + * Description of the task. + */ description: string - /** Progress of the task in percent. */ + /** + * Progress of the task in percent. + */ progress: number - /** Task start date. */ + /** + * Task start date. + */ startedAt?: Date - /** Task end date. */ + /** + * Task end date. + */ terminatedAt?: Date - /** Task status. */ + /** + * Task status. + */ status: TaskStatus hrefFrom: string hrefResult: string - /** Zone in which the task is excecuted. */ + /** + * Zone in which the task is excecuted. + */ zone: ScwZone } @@ -651,21 +904,31 @@ export interface Dashboard { securityGroupsCount: number ipsUnused: number volumesLSsdCount: number - /** @deprecated */ + /** + * @deprecated + */ volumesBSsdCount?: number volumesLSsdTotalSize: number - /** @deprecated */ + /** + * @deprecated + */ volumesBSsdTotalSize?: number privateNicsCount: number placementGroupsCount: number } export interface PlacementGroupServer { - /** Instance UUID. */ + /** + * Instance UUID. + */ id: string - /** Instance name. */ + /** + * Instance name. + */ name: string - /** Defines whether the placement group policy is respected (either 1 or 0). */ + /** + * Defines whether the placement group policy is respected (either 1 or 0). + */ policyRespected: boolean } @@ -674,38 +937,65 @@ export interface GetServerTypesAvailabilityResponseAvailability { } export interface ServerType { - /** @deprecated Estimated monthly price, for a 30 days month, in Euro. */ + /** + * @deprecated Estimated monthly price, for a 30 days month, in Euro. + */ monthlyPrice?: number - /** Hourly price in Euro. */ + /** + * Hourly price in Euro. + */ hourlyPrice: number - /** Alternative Instance name, if any. */ + /** + * Alternative Instance name, if any. + */ altNames: string[] - /** Additional volume constraints. */ + /** + * Additional volume constraints. + */ perVolumeConstraint?: ServerTypeVolumeConstraintsByType - /** Initial volume constraints. */ + /** + * Initial volume constraints. + */ volumesConstraint?: ServerTypeVolumeConstraintSizes - /** Number of CPU. */ + /** + * Number of CPU. + */ ncpus: number - /** Number of GPU. */ + /** + * Number of GPU. + */ gpu?: number - /** Available RAM in bytes. */ + /** + * Available RAM in bytes. + */ ram: number - /** GPU information. */ + /** + * GPU information. + */ gpuInfo?: ServerTypeGPUInfo - /** CPU architecture. */ + /** + * CPU architecture. + */ arch: Arch - /** Network available for the Instance. */ + /** + * Network available for the Instance. + */ network?: ServerTypeNetwork - /** Capabilities. */ + /** + * Capabilities. + */ capabilities?: ServerTypeCapabilities - /** Maximum available scratch storage. */ + /** + * Maximum available scratch storage. + */ scratchStorageMaxSize?: number /** - * The maximum bandwidth allocated to block storage access (in bytes per - * second). + * The maximum bandwidth allocated to block storage access (in bytes per second). */ blockBandwidth?: number - /** True if this Instance type has reached end of service. */ + /** + * True if this Instance type has reached end of service. + */ endOfService: boolean } @@ -717,53 +1007,59 @@ export interface VolumeType { export interface ServerActionRequestVolumeBackupTemplate { /** - * Overrides the `volume_type` of the snapshot for this volume. If omitted, - * the volume type of the original volume will be used. + * Overrides the `volume_type` of the snapshot for this volume. +If omitted, the volume type of the original volume will be used. */ volumeType: SnapshotVolumeType } export interface SetSecurityGroupRulesRequestRule { /** - * UUID of the security rule to update. If no value is provided, a new rule - * will be created. + * UUID of the security rule to update. If no value is provided, a new rule will be created. */ id?: string - /** Action to apply when the rule matches a packet. */ + /** + * Action to apply when the rule matches a packet. + */ action: SecurityGroupRuleAction - /** Protocol family this rule applies to. */ + /** + * Protocol family this rule applies to. + */ protocol: SecurityGroupRuleProtocol - /** Direction the rule applies to. */ + /** + * Direction the rule applies to. + */ direction: SecurityGroupRuleDirection - /** Range of IP addresses these rules apply to. */ + /** + * Range of IP addresses these rules apply to. + */ ipRange: string /** - * Beginning of the range of ports this rule applies to (inclusive). This - * value will be set to null if protocol is ICMP or ANY. + * Beginning of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY. */ destPortFrom?: number /** - * End of the range of ports this rule applies to (inclusive). This value will - * be set to null if protocol is ICMP or ANY, or if it is equal to - * dest_port_from. + * End of the range of ports this rule applies to (inclusive). This value will be set to null if protocol is ICMP or ANY, or if it is equal to dest_port_from. */ destPortTo?: number /** - * Position of this rule in the security group rules list. If several rules - * are passed with the same position, the resulting order is undefined. + * Position of this rule in the security group rules list. If several rules are passed with the same position, the resulting order is undefined. */ position: number /** - * Indicates if this rule is editable. Rules with the value false will be - * ignored. + * Indicates if this rule is editable. Rules with the value false will be ignored. */ editable?: boolean - /** Zone of the rule. This field is ignored. */ + /** + * Zone of the rule. This field is ignored. + */ zone?: ScwZone } export interface VolumeImageUpdateTemplate { - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ id: string } @@ -773,37 +1069,32 @@ export interface SecurityGroupTemplate { } export type ApplyBlockMigrationRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * The volume to migrate, along with potentially other resources, according to - * the migration plan generated with a call to the [Get a volume or snapshot's - * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) - * endpoint. + * The volume to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. * * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set. */ volumeId?: string /** - * The snapshot to migrate, along with potentially other resources, according - * to the migration plan generated with a call to the [Get a volume or - * snapshot's migration - * plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. + * The snapshot to migrate, along with potentially other resources, according to the migration plan generated with a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint. * * One-of ('resource'): at most one of 'volumeId', 'snapshotId' could be set. */ snapshotId?: string /** - * A value to be retrieved from a call to the [Get a volume or snapshot's - * migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) - * endpoint, to confirm that the volume and/or snapshots specified in said - * plan should be migrated. + * A value to be retrieved from a call to the [Get a volume or snapshot's migration plan](#path-volumes-get-a-volume-or-snapshots-migration-plan) endpoint, to confirm that the volume and/or snapshots specified in said plan should be migrated. */ validationKey: string } export type AttachServerVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone serverId: string volumeId: string @@ -816,39 +1107,53 @@ export interface AttachServerVolumeResponse { } export type CheckBlockMigrationOrganizationQuotasRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone organization?: string } export type CreateImageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Name of the image. */ + /** + * Name of the image. + */ name?: string - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ rootVolume: string - /** Architecture of the image. */ + /** + * Architecture of the image. + */ arch: Arch - /** Additional volumes of the image. */ + /** + * Additional volumes of the image. + */ extraVolumes?: Record /** * @deprecated Organization ID of the image. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Project ID of the image. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string - /** Tags of the image. */ + /** + * Tags of the image. + */ tags?: string[] - /** True to create a public image. */ + /** + * True to create a public image. + */ public?: boolean } @@ -857,27 +1162,33 @@ export interface CreateImageResponse { } export type CreateIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** * @deprecated Organization ID in which the IP is reserved. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Project ID in which the IP is reserved. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string - /** Tags of the IP. */ + /** + * Tags of the IP. + */ tags?: string[] - /** UUID of the Instance you want to attach the IP to. */ + /** + * UUID of the Instance you want to attach the IP to. + */ server?: string - /** IP type to reserve (either 'routed_ipv4' or 'routed_ipv6'). */ + /** + * IP type to reserve (either 'routed_ipv4' or 'routed_ipv6'). + */ type?: IpType } @@ -886,29 +1197,37 @@ export interface CreateIpResponse { } export type CreatePlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Name of the placement group. */ + /** + * Name of the placement group. + */ name?: string /** * @deprecated Organization ID of the placement group. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Project ID of the placement group. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string - /** Tags of the placement group. */ + /** + * Tags of the placement group. + */ tags?: string[] - /** Operating mode of the placement group. */ + /** + * Operating mode of the placement group. + */ policyMode?: PlacementGroupPolicyMode - /** Policy type of the placement group. */ + /** + * Policy type of the placement group. + */ policyType?: PlacementGroupPolicyType } @@ -917,19 +1236,28 @@ export interface CreatePlacementGroupResponse { } export type CreatePrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance the private NIC will be attached to. */ + /** + * UUID of the Instance the private NIC will be attached to. + */ serverId: string - /** UUID of the private network where the private NIC will be attached. */ + /** + * UUID of the private network where the private NIC will be attached. + */ privateNetworkId: string - /** Private NIC tags. */ + /** + * Private NIC tags. + */ tags?: string[] - /** @deprecated Ip_ids defined from IPAM. */ + /** + * @deprecated Ip_ids defined from IPAM. + */ ipIds?: string[] /** - * UUID of IPAM ips, to be attached to the instance in the requested private - * network. + * UUID of IPAM ips, to be attached to the instance in the requested private network. */ ipamIpIds?: string[] } @@ -939,53 +1267,60 @@ export interface CreatePrivateNICResponse { } export type CreateSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Name of the security group. */ + /** + * Name of the security group. + */ name?: string - /** Description of the security group. */ + /** + * Description of the security group. + */ description: string /** * @deprecated Organization ID the security group belongs to. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Project ID the security group belong to. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string - /** Tags of the security group. */ + /** + * Tags of the security group. + */ tags?: string[] /** - * @deprecated Defines whether this security group becomes the default - * security group for new Instances. + * @deprecated Defines whether this security group becomes the default security group for new Instances. * - * One-of ('defaultIdentifier'): at most one of 'organizationDefault', - * 'projectDefault' could be set. + * One-of ('defaultIdentifier'): at most one of 'organizationDefault', 'projectDefault' could be set. */ organizationDefault?: boolean /** - * Whether this security group becomes the default security group for new - * Instances. + * Whether this security group becomes the default security group for new Instances. * - * One-of ('defaultIdentifier'): at most one of 'organizationDefault', - * 'projectDefault' could be set. + * One-of ('defaultIdentifier'): at most one of 'organizationDefault', 'projectDefault' could be set. */ projectDefault?: boolean - /** Whether the security group is stateful or not. */ + /** + * Whether the security group is stateful or not. + */ stateful: boolean - /** Default policy for inbound rules. */ + /** + * Default policy for inbound rules. + */ inboundDefaultPolicy?: SecurityGroupPolicy - /** Default policy for outbound rules. */ + /** + * Default policy for outbound rules. + */ outboundDefaultPolicy?: SecurityGroupPolicy /** - * True to block SMTP on IPv4 and IPv6. This feature is read only, please open - * a support ticket if you need to make it configurable. + * True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable. */ enableDefaultSecurity?: boolean } @@ -995,21 +1330,33 @@ export interface CreateSecurityGroupResponse { } export type CreateSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group. */ + /** + * UUID of the security group. + */ securityGroupId: string protocol: SecurityGroupRuleProtocol direction: SecurityGroupRuleDirection action: SecurityGroupRuleAction ipRange: string - /** Beginning of the range of ports to apply this rule to (inclusive). */ + /** + * Beginning of the range of ports to apply this rule to (inclusive). + */ destPortFrom?: number - /** End of the range of ports to apply this rule to (inclusive). */ + /** + * End of the range of ports to apply this rule to (inclusive). + */ destPortTo?: number - /** Position of this rule in the security group rules list. */ + /** + * Position of this rule in the security group rules list. + */ position: number - /** Indicates if this rule is editable (will be ignored). */ + /** + * Indicates if this rule is editable (will be ignored). + */ editable: boolean } @@ -1018,55 +1365,77 @@ export interface CreateSecurityGroupRuleResponse { } export type CreateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Instance name. */ + /** + * Instance name. + */ name?: string - /** Define if a dynamic IPv4 is required for the Instance. */ + /** + * Define if a dynamic IPv4 is required for the Instance. + */ dynamicIpRequired?: boolean /** - * @deprecated If true, configure the Instance so it uses the new routed IP - * mode. + * @deprecated If true, configure the Instance so it uses the new routed IP mode. */ routedIpEnabled?: boolean - /** Define the Instance commercial type (i.e. GP1-S). */ + /** + * Define the Instance commercial type (i.e. GP1-S). + */ commercialType: string - /** Instance image ID or label. */ + /** + * Instance image ID or label. + */ image?: string - /** Volumes attached to the server. */ + /** + * Volumes attached to the server. + */ volumes?: Record /** - * @deprecated True if IPv6 is enabled on the server (deprecated and always - * `False` when `routed_ip_enabled` is `True`). + * @deprecated True if IPv6 is enabled on the server (deprecated and always `False` when `routed_ip_enabled` is `True`). */ enableIpv6?: boolean - /** @deprecated ID of the reserved IP to attach to the Instance. */ + /** + * @deprecated ID of the reserved IP to attach to the Instance. + */ publicIp?: string - /** A list of reserved IP IDs to attach to the Instance. */ + /** + * A list of reserved IP IDs to attach to the Instance. + */ publicIps?: string[] - /** Boot type to use. */ + /** + * Boot type to use. + */ bootType?: BootType /** * @deprecated Instance Organization ID. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Instance Project ID. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string - /** Instance tags. */ + /** + * Instance tags. + */ tags?: string[] - /** Security group ID. */ + /** + * Security group ID. + */ securityGroup?: string - /** Placement group ID if Instance must be part of a placement group. */ + /** + * Placement group ID if Instance must be part of a placement group. + */ placementGroup?: string - /** The public_key value of this key is used to encrypt the admin password. */ + /** + * The public_key value of this key is used to encrypt the admin password. + */ adminPasswordEncryptionSshKeyId?: string } @@ -1075,38 +1444,50 @@ export interface CreateServerResponse { } export type CreateSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId?: string - /** Tags of the snapshot. */ + /** + * Tags of the snapshot. + */ tags?: string[] /** * @deprecated Organization ID of the snapshot. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Project ID of the snapshot. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string /** - * Overrides the volume_type of the snapshot. If omitted, the volume type of - * the original volume will be used. + * Overrides the volume_type of the snapshot. +If omitted, the volume type of the original volume will be used. */ volumeType?: SnapshotVolumeType - /** Bucket name for snapshot imports. */ + /** + * Bucket name for snapshot imports. + */ bucket?: string - /** Object key for snapshot imports. */ + /** + * Object key for snapshot imports. + */ key?: string - /** Imported snapshot size, must be a multiple of 512. */ + /** + * Imported snapshot size, must be a multiple of 512. + */ size?: number } @@ -1116,27 +1497,33 @@ export interface CreateSnapshotResponse { } export type CreateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Volume name. */ + /** + * Volume name. + */ name?: string /** * @deprecated Volume Organization ID. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ organization?: string /** * Volume Project ID. * - * One-of ('projectIdentifier'): at most one of 'project', 'organization' - * could be set. + * One-of ('projectIdentifier'): at most one of 'project', 'organization' could be set. */ project?: string - /** Volume tags. */ + /** + * Volume tags. + */ tags?: string[] - /** Volume type. */ + /** + * Volume type. + */ volumeType?: VolumeVolumeType /** * Volume disk size, must be a multiple of 512. @@ -1157,80 +1544,122 @@ export interface CreateVolumeResponse { } export type DeleteImageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the image you want to delete. */ + /** + * UUID of the image you want to delete. + */ imageId: string } export type DeleteIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** ID or address of the IP to delete. */ + /** + * ID or address of the IP to delete. + */ ip: string } export type DeletePlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the placement group you want to delete. */ + /** + * UUID of the placement group you want to delete. + */ placementGroupId: string } export type DeletePrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Instance to which the private NIC is attached. */ + /** + * Instance to which the private NIC is attached. + */ serverId: string - /** Private NIC unique ID. */ + /** + * Private NIC unique ID. + */ privateNicId: string } export type DeleteSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group you want to delete. */ + /** + * UUID of the security group you want to delete. + */ securityGroupId: string } export type DeleteSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone securityGroupId: string securityGroupRuleId: string } export type DeleteServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone serverId: string } export type DeleteServerUserDataRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance. */ + /** + * UUID of the Instance. + */ serverId: string - /** Key of the user data to delete. */ + /** + * Key of the user data to delete. + */ key: string } export type DeleteSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot you want to delete. */ + /** + * UUID of the snapshot you want to delete. + */ snapshotId: string } export type DeleteVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume you want to delete. */ + /** + * UUID of the volume you want to delete. + */ volumeId: string } export type DetachServerVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone serverId: string volumeId: string @@ -1241,13 +1670,21 @@ export interface DetachServerVolumeResponse { } export type ExportSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Snapshot ID. */ + /** + * Snapshot ID. + */ snapshotId: string - /** Object Storage bucket name. */ + /** + * Object Storage bucket name. + */ bucket: string - /** Object key. */ + /** + * Object key. + */ key: string } @@ -1256,7 +1693,9 @@ export interface ExportSnapshotResponse { } export type GetDashboardRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone organization?: string project?: string @@ -1267,9 +1706,13 @@ export interface GetDashboardResponse { } export type GetImageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the image you want to get. */ + /** + * UUID of the image you want to get. + */ imageId: string } @@ -1278,9 +1721,13 @@ export interface GetImageResponse { } export type GetIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** IP ID or address to get. */ + /** + * IP ID or address to get. + */ ip: string } @@ -1289,9 +1736,13 @@ export interface GetIpResponse { } export type GetPlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the placement group you want to get. */ + /** + * UUID of the placement group you want to get. + */ placementGroupId: string } @@ -1300,23 +1751,35 @@ export interface GetPlacementGroupResponse { } export type GetPlacementGroupServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the placement group you want to get. */ + /** + * UUID of the placement group you want to get. + */ placementGroupId: string } export interface GetPlacementGroupServersResponse { - /** Instances attached to the placement group. */ + /** + * Instances attached to the placement group. + */ servers: PlacementGroupServer[] } export type GetPrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Instance to which the private NIC is attached. */ + /** + * Instance to which the private NIC is attached. + */ serverId: string - /** Private NIC unique ID. */ + /** + * Private NIC unique ID. + */ privateNicId: string } @@ -1325,9 +1788,13 @@ export interface GetPrivateNICResponse { } export type GetSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group you want to get. */ + /** + * UUID of the security group you want to get. + */ securityGroupId: string } @@ -1336,7 +1803,9 @@ export interface GetSecurityGroupResponse { } export type GetSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone securityGroupId: string securityGroupRuleId: string @@ -1347,16 +1816,24 @@ export interface GetSecurityGroupRuleResponse { } export type GetServerCompatibleTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance you want to get. */ + /** + * UUID of the Instance you want to get. + */ serverId: string } export type GetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance you want to get. */ + /** + * UUID of the Instance you want to get. + */ serverId: string } @@ -1365,27 +1842,36 @@ export interface GetServerResponse { } export type GetServerTypesAvailabilityRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number } export interface GetServerTypesAvailabilityResponse { - /** Map of server types. */ + /** + * Map of server types. + */ servers: Record totalCount: number } export type GetSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot you want to get. */ + /** + * UUID of the snapshot you want to get. + */ snapshotId: string } @@ -1394,9 +1880,13 @@ export interface GetSnapshotResponse { } export type GetVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume you want to get. */ + /** + * UUID of the volume you want to get. + */ volumeId: string } @@ -1405,12 +1895,16 @@ export interface GetVolumeResponse { } export type ListDefaultSecurityGroupRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone } export type ListImagesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone organization?: string perPage?: number @@ -1423,93 +1917,124 @@ export type ListImagesRequest = { } export interface ListImagesResponse { - /** Total number of images. */ + /** + * Total number of images. + */ totalCount: number - /** List of images. */ + /** + * List of images. + */ images: Image[] } export type ListIpsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Project ID in which the IPs are reserved. */ + /** + * Project ID in which the IPs are reserved. + */ project?: string - /** Organization ID in which the IPs are reserved. */ + /** + * Organization ID in which the IPs are reserved. + */ organization?: string /** - * Filter IPs with these exact tags (to filter with several tags, use commas - * to separate them). + * Filter IPs with these exact tags (to filter with several tags, use commas to separate them). */ tags?: string[] - /** Filter on the IP address (Works as a LIKE operation on the IP address). */ + /** + * Filter on the IP address (Works as a LIKE operation on the IP address). + */ name?: string /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number /** - * Filter on the IP Mobility IP type (whose value should be either - * 'routed_ipv4' or 'routed_ipv6'). + * Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6'). */ type?: string } export interface ListIpsResponse { - /** Total number of ips. */ + /** + * Total number of ips. + */ totalCount: number - /** List of ips. */ + /** + * List of ips. + */ ips: Ip[] } export type ListPlacementGroupsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number - /** List only placement groups of this Organization ID. */ + /** + * List only placement groups of this Organization ID. + */ organization?: string - /** List only placement groups of this Project ID. */ + /** + * List only placement groups of this Project ID. + */ project?: string /** - * List placement groups with these exact tags (to filter with several tags, - * use commas to separate them). + * List placement groups with these exact tags (to filter with several tags, use commas to separate them). */ tags?: string[] /** - * Filter placement groups by name (for eg. "cluster1" will return - * "cluster100" and "cluster1" but not "foo"). + * Filter placement groups by name (for eg. "cluster1" will return "cluster100" and "cluster1" but not "foo"). */ name?: string } export interface ListPlacementGroupsResponse { - /** Total number of placement groups. */ + /** + * Total number of placement groups. + */ totalCount: number - /** List of placement groups. */ + /** + * List of placement groups. + */ placementGroups: PlacementGroup[] } export type ListPrivateNICsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Instance to which the private NIC is attached. */ + /** + * Instance to which the private NIC is attached. + */ serverId: string - /** Private NIC tags. */ + /** + * Private NIC tags. + */ tags?: string[] /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number } @@ -1519,60 +2044,85 @@ export interface ListPrivateNICsResponse { } export type ListSecurityGroupRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group. */ + /** + * UUID of the security group. + */ securityGroupId: string /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number } export interface ListSecurityGroupRulesResponse { - /** Total number of security groups. */ + /** + * Total number of security groups. + */ totalCount: number - /** List of security rules. */ + /** + * List of security rules. + */ rules: SecurityGroupRule[] } export type ListSecurityGroupsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Name of the security group. */ + /** + * Name of the security group. + */ name?: string - /** Security group Organization ID. */ + /** + * Security group Organization ID. + */ organization?: string - /** Security group Project ID. */ + /** + * Security group Project ID. + */ project?: string /** - * List security groups with these exact tags (to filter with several tags, - * use commas to separate them). + * List security groups with these exact tags (to filter with several tags, use commas to separate them). */ tags?: string[] - /** Filter security groups with this value for project_default. */ + /** + * Filter security groups with this value for project_default. + */ projectDefault?: boolean /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number } export interface ListSecurityGroupsResponse { - /** Total number of security groups. */ + /** + * Total number of security groups. + */ totalCount: number - /** List of security groups. */ + /** + * List of security groups. + */ securityGroups: SecurityGroup[] } export type ListServerActionsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone serverId: string } @@ -1582,9 +2132,13 @@ export interface ListServerActionsResponse { } export type ListServerUserDataRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance. */ + /** + * UUID of the Instance. + */ serverId: string } @@ -1593,175 +2147,238 @@ export interface ListServerUserDataResponse { } export type ListServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number - /** List only Instances of this Organization ID. */ + /** + * List only Instances of this Organization ID. + */ organization?: string - /** List only Instances of this Project ID. */ + /** + * List only Instances of this Project ID. + */ project?: string /** - * Filter Instances by name (eg. "server1" will return "server100" and - * "server1" but not "foo"). + * Filter Instances by name (eg. "server1" will return "server100" and "server1" but not "foo"). */ name?: string - /** @deprecated List Instances by private_ip. */ + /** + * @deprecated List Instances by private_ip. + */ privateIp?: string - /** List Instances that are not attached to a public IP. */ + /** + * List Instances that are not attached to a public IP. + */ withoutIp?: boolean - /** List Instances by IP (both private_ip and public_ip are supported). */ + /** + * List Instances by IP (both private_ip and public_ip are supported). + */ withIp?: string - /** List Instances of this commercial type. */ + /** + * List Instances of this commercial type. + */ commercialType?: string - /** List Instances in this state. */ + /** + * List Instances in this state. + */ state?: ServerState /** - * List Instances with these exact tags (to filter with several tags, use - * commas to separate them). + * List Instances with these exact tags (to filter with several tags, use commas to separate them). */ tags?: string[] - /** List Instances in this Private Network. */ + /** + * List Instances in this Private Network. + */ privateNetwork?: string - /** Define the order of the returned servers. */ + /** + * Define the order of the returned servers. + */ order?: ListServersRequestOrder /** - * List Instances from the given Private Networks (use commas to separate - * them). + * List Instances from the given Private Networks (use commas to separate them). */ privateNetworks?: string[] - /** List Instances associated with the given private NIC MAC address. */ + /** + * List Instances associated with the given private NIC MAC address. + */ privateNicMacAddress?: string - /** List Instances from these server ids (use commas to separate them). */ + /** + * List Instances from these server ids (use commas to separate them). + */ servers?: string[] } export interface ListServersResponse { - /** Total number of Instances. */ + /** + * Total number of Instances. + */ totalCount: number - /** List of Instances. */ + /** + * List of Instances. + */ servers: Server[] } export type ListServersTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone perPage?: number page?: number } export interface ListServersTypesResponse { - /** Total number of Instance types. */ + /** + * Total number of Instance types. + */ totalCount: number - /** List of Instance types. */ + /** + * List of Instance types. + */ servers: Record } export type ListSnapshotsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** List snapshots only for this Organization ID. */ + /** + * List snapshots only for this Organization ID. + */ organization?: string - /** List snapshots only for this Project ID. */ + /** + * List snapshots only for this Project ID. + */ project?: string /** - * Number of snapshots returned per page (positive integer lower or equal to - * 100). + * Number of snapshots returned per page (positive integer lower or equal to 100). */ perPage?: number - /** Page to be returned. */ + /** + * Page to be returned. + */ page?: number - /** List snapshots of the requested name. */ + /** + * List snapshots of the requested name. + */ name?: string - /** List snapshots that have the requested tag. */ + /** + * List snapshots that have the requested tag. + */ tags?: string - /** List snapshots originating only from this volume. */ + /** + * List snapshots originating only from this volume. + */ baseVolumeId?: string } export interface ListSnapshotsResponse { - /** Total number of snapshots. */ + /** + * Total number of snapshots. + */ totalCount: number - /** List of snapshots. */ + /** + * List of snapshots. + */ snapshots: Snapshot[] } export type ListVolumesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Filter by volume type. */ + /** + * Filter by volume type. + */ volumeType?: VolumeVolumeType /** - * A positive integer lower or equal to 100 to select the number of items to - * return. + * A positive integer lower or equal to 100 to select the number of items to return. */ perPage?: number - /** A positive integer to choose the page to return. */ + /** + * A positive integer to choose the page to return. + */ page?: number - /** Filter volume by Organization ID. */ + /** + * Filter volume by Organization ID. + */ organization?: string - /** Filter volume by Project ID. */ + /** + * Filter volume by Project ID. + */ project?: string /** - * Filter volumes with these exact tags (to filter with several tags, use - * commas to separate them). + * Filter volumes with these exact tags (to filter with several tags, use commas to separate them). */ tags?: string[] /** - * Filter volume by name (for eg. "vol" will return "myvolume" but not - * "data"). + * Filter volume by name (for eg. "vol" will return "myvolume" but not "data"). */ name?: string } export interface ListVolumesResponse { - /** Total number of volumes. */ + /** + * Total number of volumes. + */ totalCount: number - /** List of volumes. */ + /** + * List of volumes. + */ volumes: Volume[] } export type ListVolumesTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone perPage?: number page?: number } export interface ListVolumesTypesResponse { - /** Total number of volume types. */ + /** + * Total number of volume types. + */ totalCount: number - /** Map of volume types. */ + /** + * Map of volume types. + */ volumes: Record } export interface MigrationPlan { /** - * A volume which will be migrated to SBS together with the snapshots, if - * present. + * A volume which will be migrated to SBS together with the snapshots, if present. */ volume?: Volume /** - * A list of snapshots which will be migrated to SBS together and with the - * volume, if present. + * A list of snapshots which will be migrated to SBS together and with the volume, if present. */ snapshots: Snapshot[] /** - * A value to be passed to the call to the [Migrate a volume and/or snapshots - * to - * SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) - * endpoint, to confirm that the execution of the plan is being requested. + * A value to be passed to the call to the [Migrate a volume and/or snapshots to SBS](#path-volumes-migrate-a-volume-andor-snapshots-to-sbs-scaleway-block-storage) endpoint, to confirm that the execution of the plan is being requested. */ validationKey: string } export type PlanBlockMigrationRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone /** * The volume for which the migration plan will be generated. @@ -1778,25 +2395,31 @@ export type PlanBlockMigrationRequest = { } export type ServerActionRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance. */ + /** + * UUID of the Instance. + */ serverId: string - /** Action to perform on the Instance. */ + /** + * Action to perform on the Instance. + */ action?: ServerAction /** - * Name of the backup you want to create. This field should only be specified - * when performing a backup action. + * Name of the backup you want to create. +This field should only be specified when performing a backup action. */ name?: string /** - * For each volume UUID, the snapshot parameters of the volume. This field - * should only be specified when performing a backup action. + * For each volume UUID, the snapshot parameters of the volume. +This field should only be specified when performing a backup action. */ volumes?: Record /** - * Disable IPv6 on the Instance while performing migration to routed IPs. This - * field should only be specified when performing a enable_routed_ip action. + * Disable IPv6 on the Instance while performing migration to routed IPs. +This field should only be specified when performing a enable_routed_ip action. */ disableIpv6?: boolean } @@ -1806,19 +2429,25 @@ export interface ServerActionResponse { } export interface ServerCompatibleTypes { - /** Instance compatible types. */ + /** + * Instance compatible types. + */ compatibleTypes: string[] } export type SetImageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone id: string name: string arch?: Arch creationDate?: Date modificationDate?: Date - /** @deprecated */ + /** + * @deprecated + */ defaultBootscript?: Bootscript extraVolumes?: Record fromServer: string @@ -1831,7 +2460,9 @@ export type SetImageRequest = { } export type SetPlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone placementGroupId: string name: string @@ -1847,25 +2478,39 @@ export interface SetPlacementGroupResponse { } export type SetPlacementGroupServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the placement group you want to set. */ + /** + * UUID of the placement group you want to set. + */ placementGroupId: string - /** An array of the Instances' UUIDs you want to configure. */ + /** + * An array of the Instances' UUIDs you want to configure. + */ servers: string[] } export interface SetPlacementGroupServersResponse { - /** Instances attached to the placement group. */ + /** + * Instances attached to the placement group. + */ servers: PlacementGroupServer[] } export type SetSecurityGroupRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group to update the rules on. */ + /** + * UUID of the security group to update the rules on. + */ securityGroupId: string - /** List of rules to update in the security group. */ + /** + * List of rules to update in the security group. + */ rules?: SetSecurityGroupRulesRequestRule[] } @@ -1874,22 +2519,33 @@ export interface SetSecurityGroupRulesResponse { } export type UpdateImageRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the image. */ + /** + * UUID of the image. + */ imageId: string - /** Name of the image. */ + /** + * Name of the image. + */ name?: string - /** Architecture of the image. */ + /** + * Architecture of the image. + */ arch?: Arch /** - * Additional snapshots of the image, with extra_volumeKey being the position - * of the snapshot in the image. + * Additional snapshots of the image, with extra_volumeKey being the position of the snapshot in the image. */ extraVolumes?: Record - /** Tags of the image. */ + /** + * Tags of the image. + */ tags?: string[] - /** True to set the image as public. */ + /** + * True to set the image as public. + */ public?: boolean } @@ -1898,15 +2554,25 @@ export interface UpdateImageResponse { } export type UpdateIpRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** IP ID or IP address. */ + /** + * IP ID or IP address. + */ ip: string - /** Reverse domain name. */ + /** + * Reverse domain name. + */ reverse?: string | null - /** Should have no effect. */ + /** + * Should have no effect. + */ type?: IpType - /** An array of keywords you want to tag this IP with. */ + /** + * An array of keywords you want to tag this IP with. + */ tags?: string[] server?: string | null } @@ -1916,17 +2582,29 @@ export interface UpdateIpResponse { } export type UpdatePlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the placement group. */ + /** + * UUID of the placement group. + */ placementGroupId: string - /** Name of the placement group. */ + /** + * Name of the placement group. + */ name?: string - /** Tags of the placement group. */ + /** + * Tags of the placement group. + */ tags?: string[] - /** Operating mode of the placement group. */ + /** + * Operating mode of the placement group. + */ policyMode?: PlacementGroupPolicyMode - /** Policy type of the placement group. */ + /** + * Policy type of the placement group. + */ policyType?: PlacementGroupPolicyType } @@ -1935,55 +2613,90 @@ export interface UpdatePlacementGroupResponse { } export type UpdatePlacementGroupServersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the placement group you want to update. */ + /** + * UUID of the placement group you want to update. + */ placementGroupId: string - /** An array of the Instances' UUIDs you want to configure. */ + /** + * An array of the Instances' UUIDs you want to configure. + */ servers: string[] } export interface UpdatePlacementGroupServersResponse { - /** Instances attached to the placement group. */ + /** + * Instances attached to the placement group. + */ servers: PlacementGroupServer[] } export type UpdatePrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance the private NIC will be attached to. */ + /** + * UUID of the Instance the private NIC will be attached to. + */ serverId: string - /** Private NIC unique ID. */ + /** + * Private NIC unique ID. + */ privateNicId: string - /** Tags used to select private NIC/s. */ + /** + * Tags used to select private NIC/s. + */ tags?: string[] } export type UpdateSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group. */ + /** + * UUID of the security group. + */ securityGroupId: string - /** Name of the security group. */ + /** + * Name of the security group. + */ name?: string - /** Description of the security group. */ + /** + * Description of the security group. + */ description?: string /** - * True to block SMTP on IPv4 and IPv6. This feature is read only, please open - * a support ticket if you need to make it configurable. + * True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable. */ enableDefaultSecurity?: boolean - /** Default inbound policy. */ + /** + * Default inbound policy. + */ inboundDefaultPolicy?: SecurityGroupPolicy - /** Tags of the security group. */ + /** + * Tags of the security group. + */ tags?: string[] - /** @deprecated Please use project_default instead. */ + /** + * @deprecated Please use project_default instead. + */ organizationDefault?: boolean - /** True use this security group for future Instances created in this project. */ + /** + * True use this security group for future Instances created in this project. + */ projectDefault?: boolean - /** Default outbound policy. */ + /** + * Default outbound policy. + */ outboundDefaultPolicy?: SecurityGroupPolicy - /** True to set the security group as stateful. */ + /** + * True to set the security group as stateful. + */ stateful?: boolean } @@ -1992,31 +2705,45 @@ export interface UpdateSecurityGroupResponse { } export type UpdateSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group. */ + /** + * UUID of the security group. + */ securityGroupId: string - /** UUID of the rule. */ + /** + * UUID of the rule. + */ securityGroupRuleId: string - /** Protocol family this rule applies to. */ + /** + * Protocol family this rule applies to. + */ protocol?: SecurityGroupRuleProtocol - /** Direction the rule applies to. */ + /** + * Direction the rule applies to. + */ direction?: SecurityGroupRuleDirection - /** Action to apply when the rule matches a packet. */ + /** + * Action to apply when the rule matches a packet. + */ action?: SecurityGroupRuleAction - /** Range of IP addresses these rules apply to. */ + /** + * Range of IP addresses these rules apply to. + */ ipRange?: string /** - * Beginning of the range of ports this rule applies to (inclusive). If 0 is - * provided, unset the parameter. + * Beginning of the range of ports this rule applies to (inclusive). If 0 is provided, unset the parameter. */ destPortFrom?: number /** - * End of the range of ports this rule applies to (inclusive). If 0 is - * provided, unset the parameter. + * End of the range of ports this rule applies to (inclusive). If 0 is provided, unset the parameter. */ destPortTo?: number - /** Position of this rule in the security group rules list. */ + /** + * Position of this rule in the security group rules list. + */ position?: number } @@ -2025,49 +2752,57 @@ export interface UpdateSecurityGroupRuleResponse { } export type UpdateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Instance. */ + /** + * UUID of the Instance. + */ serverId: string - /** Name of the Instance. */ + /** + * Name of the Instance. + */ name?: string bootType?: BootType - /** Tags of the Instance. */ + /** + * Tags of the Instance. + */ tags?: string[] volumes?: Record dynamicIpRequired?: boolean /** - * @deprecated True to configure the instance so it uses the new routed IP - * mode (once this is set to True you cannot set it back to False). + * @deprecated True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False). */ routedIpEnabled?: boolean - /** A list of reserved IP IDs to attach to the Instance. */ + /** + * A list of reserved IP IDs to attach to the Instance. + */ publicIps?: string[] - /** @deprecated */ + /** + * @deprecated + */ enableIpv6?: boolean protected?: boolean securityGroup?: SecurityGroupTemplate - /** Placement group ID if Instance must be part of a placement group. */ + /** + * Placement group ID if Instance must be part of a placement group. + */ placementGroup?: string | null - /** Instance private NICs. */ + /** + * Instance private NICs. + */ privateNics?: string[] /** * Warning: This field has some restrictions: - * - * - Cannot be changed if the Instance is not in `stopped` state. - * - Cannot be changed if the Instance is in a placement group. - * - Cannot be changed from/to a Windows offer to/from a Linux offer. - * - Local storage requirements of the target commercial_types must be fulfilled - * (i.e. if an Instance has 80GB of local storage, it can be changed into a - * GP1-XS, which has a maximum of 150GB, but it cannot be changed into a - * DEV1-S, which has only 20GB). +- Cannot be changed if the Instance is not in `stopped` state. +- Cannot be changed if the Instance is in a placement group. +- Cannot be changed from/to a Windows offer to/from a Linux offer. +- Local storage requirements of the target commercial_types must be fulfilled (i.e. if an Instance has 80GB of local storage, it can be changed into a GP1-XS, which has a maximum of 150GB, but it cannot be changed into a DEV1-S, which has only 20GB). */ commercialType?: string /** - * The public_key value of this key is used to encrypt the admin password. - * When set to an empty string, reset this value and - * admin_password_encrypted_value to an empty string so a new password may be - * generated. + * The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated. */ adminPasswordEncryptionSshKeyId?: string } @@ -2077,13 +2812,21 @@ export interface UpdateServerResponse { } export type UpdateSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** Tags of the snapshot. */ + /** + * Tags of the snapshot. + */ tags?: string[] } @@ -2092,15 +2835,25 @@ export interface UpdateSnapshotResponse { } export type UpdateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the volume. */ + /** + * UUID of the volume. + */ volumeId: string - /** Volume name. */ + /** + * Volume name. + */ name?: string - /** Tags of the volume. */ + /** + * Tags of the volume. + */ tags?: string[] - /** Volume disk size, must be a multiple of 512. */ + /** + * Volume disk size, must be a multiple of 512. + */ size?: number } diff --git a/packages/clients/src/api/instance/v1/types.private.gen.ts b/packages/clients/src/api/instance/v1/types.private.gen.ts index 63bd7b030..4551ab627 100644 --- a/packages/clients/src/api/instance/v1/types.private.gen.ts +++ b/packages/clients/src/api/instance/v1/types.private.gen.ts @@ -34,40 +34,69 @@ export interface SetImageResponse { } export type SetSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the security group. */ + /** + * UUID of the security group. + */ id: string - /** Name of the security group. */ + /** + * Name of the security group. + */ name: string - /** Tags of the security group. */ + /** + * Tags of the security group. + */ tags?: string[] - /** Creation date of the security group (will be ignored). */ + /** + * Creation date of the security group (will be ignored). + */ creationDate?: Date - /** Modification date of the security group (will be ignored). */ + /** + * Modification date of the security group (will be ignored). + */ modificationDate?: Date - /** Description of the security group. */ + /** + * Description of the security group. + */ description: string /** - * True to block SMTP on IPv4 and IPv6. This feature is read only, please open - * a support ticket if you need to make it configurable. + * True to block SMTP on IPv4 and IPv6. This feature is read only, please open a support ticket if you need to make it configurable. */ enableDefaultSecurity: boolean - /** Default inbound policy. */ + /** + * Default inbound policy. + */ inboundDefaultPolicy?: SecurityGroupPolicy - /** Default outbound policy. */ + /** + * Default outbound policy. + */ outboundDefaultPolicy?: SecurityGroupPolicy - /** Security groups Organization ID. */ + /** + * Security groups Organization ID. + */ organization?: string - /** Security group Project ID. */ + /** + * Security group Project ID. + */ project?: string - /** @deprecated Please use project_default instead. */ + /** + * @deprecated Please use project_default instead. + */ organizationDefault?: boolean - /** True use this security group for future Instances created in this project. */ + /** + * True use this security group for future Instances created in this project. + */ projectDefault: boolean - /** Instances attached to this security group. */ + /** + * Instances attached to this security group. + */ servers?: ServerSummary[] - /** True to set the security group as stateful. */ + /** + * True to set the security group as stateful. + */ stateful: boolean } @@ -76,7 +105,9 @@ export interface SetSecurityGroupResponse { } export type SetSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone securityGroupId: string securityGroupRuleId: string @@ -96,89 +127,128 @@ export interface SetSecurityGroupRuleResponse { } export type SetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Instance unique ID. */ + /** + * Instance unique ID. + */ id: string - /** Instance name. */ + /** + * Instance name. + */ name: string - /** Instance Organization ID. */ + /** + * Instance Organization ID. + */ organization?: string - /** Instance Project ID. */ + /** + * Instance Project ID. + */ project?: string - /** Provide a list of allowed actions on the server. */ + /** + * Provide a list of allowed actions on the server. + */ allowedActions?: ServerAction[] - /** Tags associated with the Instance. */ + /** + * Tags associated with the Instance. + */ tags?: string[] - /** Instance commercial type (eg. GP1-M). */ + /** + * Instance commercial type (eg. GP1-M). + */ commercialType: string - /** Instance creation date. */ + /** + * Instance creation date. + */ creationDate?: Date - /** True if a dynamic IPv4 is required. */ + /** + * True if a dynamic IPv4 is required. + */ dynamicIpRequired: boolean /** - * @deprecated True to configure the instance so it uses the new routed IP - * mode (once this is set to True you cannot set it back to False). + * @deprecated True to configure the instance so it uses the new routed IP mode (once this is set to True you cannot set it back to False). */ routedIpEnabled?: boolean /** - * @deprecated True if IPv6 is enabled (deprecated and always `False` when - * `routed_ip_enabled` is `True`). + * @deprecated True if IPv6 is enabled (deprecated and always `False` when `routed_ip_enabled` is `True`). */ enableIpv6?: boolean - /** Instance host name. */ + /** + * Instance host name. + */ hostname: string - /** Provide information on the Instance image. */ + /** + * Provide information on the Instance image. + */ image?: Image - /** Instance protection option is activated. */ + /** + * Instance protection option is activated. + */ protected: boolean /** - * @deprecated Instance private IP address (deprecated and always `null` when - * `routed_ip_enabled` is `True`). + * @deprecated Instance private IP address (deprecated and always `null` when `routed_ip_enabled` is `True`). */ privateIp?: string /** - * @deprecated Information about the public IP (deprecated in favor of - * `public_ips`). + * @deprecated Information about the public IP (deprecated in favor of `public_ips`). */ publicIp?: ServerIp - /** Information about all the public IPs attached to the server. */ + /** + * Information about all the public IPs attached to the server. + */ publicIps?: ServerIp[] - /** Instance modification date. */ + /** + * Instance modification date. + */ modificationDate?: Date - /** Instance state. */ + /** + * Instance state. + */ state?: ServerState - /** Instance location. */ + /** + * Instance location. + */ location?: ServerLocation /** - * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is - * `True`). + * @deprecated Instance IPv6 address (deprecated when `routed_ip_enabled` is `True`). */ ipv6?: ServerIpv6 - /** Instance boot type. */ + /** + * Instance boot type. + */ bootType?: BootType - /** Instance volumes. */ + /** + * Instance volumes. + */ volumes?: Record - /** Instance security group. */ + /** + * Instance security group. + */ securityGroup?: SecurityGroupSummary - /** Instance planned maintenances. */ + /** + * Instance planned maintenances. + */ maintenances?: ServerMaintenance[] - /** Instance state_detail. */ + /** + * Instance state_detail. + */ stateDetail: string /** - * Instance architecture (refers to the CPU architecture used for the - * Instance, e.g. x86_64, arm64). + * Instance architecture (refers to the CPU architecture used for the Instance, e.g. x86_64, arm64). */ arch?: Arch - /** Instance placement group. */ + /** + * Instance placement group. + */ placementGroup?: PlacementGroup - /** Instance private NICs. */ + /** + * Instance private NICs. + */ privateNics?: PrivateNIC[] /** - * The public_key value of this key is used to encrypt the admin password. - * When set to an empty string, reset this value and - * admin_password_encrypted_value to an empty string so a new password may be - * generated. + * The public_key value of this key is used to encrypt the admin password. When set to an empty string, reset this value and admin_password_encrypted_value to an empty string so a new password may be generated. */ adminPasswordEncryptionSshKeyId?: string } @@ -188,7 +258,9 @@ export interface SetServerResponse { } export type SetSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone snapshotId: string id: string diff --git a/packages/clients/src/api/interlink/v1beta1/api.gen.ts b/packages/clients/src/api/interlink/v1beta1/api.gen.ts index 3d8348729..2b15f7bc3 100644 --- a/packages/clients/src/api/interlink/v1beta1/api.gen.ts +++ b/packages/clients/src/api/interlink/v1beta1/api.gen.ts @@ -71,9 +71,8 @@ const jsonContentHeaders = { /** * InterLink API. - * - * This API allows you to manage your Scaleway InterLink, to connect your - * on-premises infrastructure with your Scaleway VPC. + +This API allows you to manage your Scaleway InterLink, to connect your on-premises infrastructure with your Scaleway VPC. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -110,10 +109,7 @@ export class API extends ParentAPI { ) /** - * List dedicated connections. For self-hosted users, list their dedicated - * physical connections in a given region. By default, the connections - * returned in the list are ordered by name in ascending order, though this - * can be modified via the `order_by` field. + * List dedicated connections. For self-hosted users, list their dedicated physical connections in a given region. By default, the connections returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListDedicatedConnectionsRequest} * @returns A Promise of ListDedicatedConnectionsResponse @@ -128,9 +124,7 @@ export class API extends ParentAPI { ) /** - * Get a dedicated connection. For self-hosted users, get a dedicated physical - * connection corresponding to the given ID. The response object includes - * information such as the connection's name, status and total bandwidth. + * Get a dedicated connection. For self-hosted users, get a dedicated physical connection corresponding to the given ID. The response object includes information such as the connection's name, status and total bandwidth. * * @param request - The request {@link GetDedicatedConnectionRequest} * @returns A Promise of DedicatedConnection @@ -189,9 +183,7 @@ export class API extends ParentAPI { ) /** - * List available partners. List all available partners. By default, the - * partners returned in the list are ordered by name in ascending order, - * though this can be modified via the `order_by` field. + * List available partners. List all available partners. By default, the partners returned in the list are ordered by name in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListPartnersRequest} * @returns A Promise of ListPartnersResponse @@ -200,9 +192,7 @@ export class API extends ParentAPI { enrichForPagination('partners', this.pageOfListPartners, request) /** - * Get a partner. Get a partner for the given partner IP. The response object - * includes information such as the partner's name, email address and portal - * URL. + * Get a partner. Get a partner for the given partner IP. The response object includes information such as the partner's name, email address and portal URL. * * @param request - The request {@link GetPartnerRequest} * @returns A Promise of Partner @@ -239,8 +229,7 @@ export class API extends ParentAPI { ) /** - * List PoPs. List all available PoPs (locations) for a given region. By - * default, the results are returned in ascending alphabetical order by name. + * List PoPs. List all available PoPs (locations) for a given region. By default, the results are returned in ascending alphabetical order by name. * * @param request - The request {@link ListPopsRequest} * @returns A Promise of ListPopsResponse @@ -249,8 +238,7 @@ export class API extends ParentAPI { enrichForPagination('pops', this.pageOfListPops, request) /** - * Get a PoP. Get a PoP for the given PoP ID. The response object includes the - * PoP's name and information about its physical location. + * Get a PoP. Get a PoP for the given PoP ID. The response object includes the PoP's name and information about its physical location. * * @param request - The request {@link GetPopRequest} * @returns A Promise of Pop @@ -297,8 +285,7 @@ export class API extends ParentAPI { ) /** - * List links. List all your links (InterLink connections). A number of - * filters are available, including Project ID, name, tags and status. + * List links. List all your links (InterLink connections). A number of filters are available, including Project ID, name, tags and status. * * @param request - The request {@link ListLinksRequest} * @returns A Promise of ListLinksResponse @@ -307,9 +294,7 @@ export class API extends ParentAPI { enrichForPagination('links', this.pageOfListLinks, request) /** - * Get a link. Get a link (InterLink session / logical InterLink resource) for - * the given link ID. The response object includes information about the - * link's various configuration details. + * Get a link. Get a link (InterLink session / logical InterLink resource) for the given link ID. The response object includes information about the link's various configuration details. * * @param request - The request {@link GetLinkRequest} * @returns A Promise of Link @@ -346,11 +331,7 @@ export class API extends ParentAPI { ) /** - * Create a link. Create a link (InterLink session / logical InterLink - * resource) in a given PoP, specifying its various configuration details. - * Links can either be hosted (faciliated by partners' shared physical - * connections) or self-hosted (for users who have purchased a dedicated - * physical connection). + * Create a link. Create a link (InterLink session / logical InterLink resource) in a given PoP, specifying its various configuration details. Links can either be hosted (faciliated by partners' shared physical connections) or self-hosted (for users who have purchased a dedicated physical connection). * * @param request - The request {@link CreateLinkRequest} * @returns A Promise of Link @@ -369,8 +350,7 @@ export class API extends ParentAPI { ) /** - * Update a link. Update an existing link, specified by its link ID. Only its - * name and tags can be updated. + * Update a link. Update an existing link, specified by its link ID. Only its name and tags can be updated. * * @param request - The request {@link UpdateLinkRequest} * @returns A Promise of Link @@ -389,11 +369,7 @@ export class API extends ParentAPI { ) /** - * Delete a link. Delete an existing link, specified by its link ID. Note that - * as well as deleting the link here on the Scaleway side, it is also - * necessary to request deletion from the partner on their side. Only when - * this action has been carried out on both sides will the resource be - * completely deleted. + * Delete a link. Delete an existing link, specified by its link ID. Note that as well as deleting the link here on the Scaleway side, it is also necessary to request deletion from the partner on their side. Only when this action has been carried out on both sides will the resource be completely deleted. * * @param request - The request {@link DeleteLinkRequest} * @returns A Promise of Link @@ -408,9 +384,7 @@ export class API extends ParentAPI { ) /** - * Attach a VPC. Attach a VPC to an existing link. This facilitates - * communication between the resources in your Scaleway VPC, and your - * on-premises infrastructure. + * Attach a VPC. Attach a VPC to an existing link. This facilitates communication between the resources in your Scaleway VPC, and your on-premises infrastructure. * * @param request - The request {@link AttachVpcRequest} * @returns A Promise of Link @@ -446,10 +420,7 @@ export class API extends ParentAPI { ) /** - * Attach a routing policy. Attach a routing policy to an existing link. As - * all routes across the link are blocked by default, you must attach a - * routing policy to set IP prefix filters for allowed routes, facilitating - * traffic flow. + * Attach a routing policy. Attach a routing policy to an existing link. As all routes across the link are blocked by default, you must attach a routing policy to set IP prefix filters for allowed routes, facilitating traffic flow. * * @param request - The request {@link AttachRoutingPolicyRequest} * @returns A Promise of Link @@ -468,9 +439,7 @@ export class API extends ParentAPI { ) /** - * Detach a routing policy. Detach a routing policy from an existing link. - * Without a routing policy, all routes across the link are blocked by - * default. + * Detach a routing policy. Detach a routing policy from an existing link. Without a routing policy, all routes across the link are blocked by default. * * @param request - The request {@link DetachRoutingPolicyRequest} * @returns A Promise of Link @@ -487,12 +456,7 @@ export class API extends ParentAPI { ) /** - * Enable route propagation. Enable all allowed prefixes (defined in a routing - * policy) to be announced in the BGP session. This allows traffic to flow - * between the attached VPC and the on-premises infrastructure along the - * announced routes. Note that by default, even when route propagation is - * enabled, all routes are blocked. It is essential to attach a routing policy - * to define the ranges of routes to announce. + * Enable route propagation. Enable all allowed prefixes (defined in a routing policy) to be announced in the BGP session. This allows traffic to flow between the attached VPC and the on-premises infrastructure along the announced routes. Note that by default, even when route propagation is enabled, all routes are blocked. It is essential to attach a routing policy to define the ranges of routes to announce. * * @param request - The request {@link EnableRoutePropagationRequest} * @returns A Promise of Link @@ -509,9 +473,7 @@ export class API extends ParentAPI { ) /** - * Disable route propagation. Prevent any prefixes from being announced in the - * BGP session. Traffic will not be able to flow over the InterLink until - * route propagation is re-enabled. + * Disable route propagation. Prevent any prefixes from being announced in the BGP session. Traffic will not be able to flow over the InterLink until route propagation is re-enabled. * * @param request - The request {@link DisableRoutePropagationRequest} * @returns A Promise of Link @@ -553,9 +515,7 @@ export class API extends ParentAPI { ) /** - * List routing policies. List all routing policies in a given region. A - * routing policy can be attached to one or multiple links (InterLink - * connections). + * List routing policies. List all routing policies in a given region. A routing policy can be attached to one or multiple links (InterLink connections). * * @param request - The request {@link ListRoutingPoliciesRequest} * @returns A Promise of ListRoutingPoliciesResponse @@ -568,9 +528,7 @@ export class API extends ParentAPI { ) /** - * Get routing policy. Get a routing policy for the given routing policy ID. - * The response object gives information including the policy's name, tags and - * prefix filters. + * Get routing policy. Get a routing policy for the given routing policy ID. The response object gives information including the policy's name, tags and prefix filters. * * @param request - The request {@link GetRoutingPolicyRequest} * @returns A Promise of RoutingPolicy @@ -585,9 +543,7 @@ export class API extends ParentAPI { ) /** - * Create a routing policy. Create a routing policy. Routing policies allow - * you to set IP prefix filters to define the incoming route announcements to - * accept from the peer, and the outgoing routes to announce to the peer. + * Create a routing policy. Create a routing policy. Routing policies allow you to set IP prefix filters to define the incoming route announcements to accept from the peer, and the outgoing routes to announce to the peer. * * @param request - The request {@link CreateRoutingPolicyRequest} * @returns A Promise of RoutingPolicy @@ -606,9 +562,7 @@ export class API extends ParentAPI { ) /** - * Update a routing policy. Update an existing routing policy, specified by - * its routing policy ID. Its name, tags and incoming/outgoing prefix filters - * can be updated. + * Update a routing policy. Update an existing routing policy, specified by its routing policy ID. Its name, tags and incoming/outgoing prefix filters can be updated. * * @param request - The request {@link UpdateRoutingPolicyRequest} * @returns A Promise of RoutingPolicy @@ -627,8 +581,7 @@ export class API extends ParentAPI { ) /** - * Delete a routing policy. Delete an existing routing policy, specified by - * its routing policy ID. + * Delete a routing policy. Delete an existing routing policy, specified by its routing policy ID. * * @param request - The request {@link DeleteRoutingPolicyRequest} */ diff --git a/packages/clients/src/api/interlink/v1beta1/types.gen.ts b/packages/clients/src/api/interlink/v1beta1/types.gen.ts index a9a2e152f..7467e5803 100644 --- a/packages/clients/src/api/interlink/v1beta1/types.gen.ts +++ b/packages/clients/src/api/interlink/v1beta1/types.gen.ts @@ -60,98 +60,157 @@ export type ListRoutingPoliciesRequestOrderBy = | 'name_desc' export interface BgpConfig { - /** AS Number of the BGP peer. */ + /** + * AS Number of the BGP peer. + */ asn: number - /** IPv4 address of the BGP peer. */ + /** + * IPv4 address of the BGP peer. + */ ipv4: string - /** IPv6 address of the BGP peer. */ + /** + * IPv6 address of the BGP peer. + */ ipv6: string } export interface PartnerHost { - /** ID of the partner facilitating the link. */ + /** + * ID of the partner facilitating the link. + */ partnerId: string - /** Used to identify a link from a user or partner's point of view. */ + /** + * Used to identify a link from a user or partner's point of view. + */ pairingKey: string /** - * Reason given by partner to explain why they did not approve the request for - * a hosted link. + * Reason given by partner to explain why they did not approve the request for a hosted link. */ disapprovedReason?: string } export interface SelfHost { - /** Dedicated physical connection supporting the link. */ + /** + * Dedicated physical connection supporting the link. + */ connectionId: string } export interface DedicatedConnection { - /** Unique identifier of the dedicated connection. */ + /** + * Unique identifier of the dedicated connection. + */ id: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** Organization ID. */ + /** + * Organization ID. + */ organizationId: string - /** Status of the dedicated connection. */ + /** + * Status of the dedicated connection. + */ status: DedicatedConnectionStatus - /** Name of the dedicated connection. */ + /** + * Name of the dedicated connection. + */ name: string - /** List of tags associated with the dedicated connection. */ + /** + * List of tags associated with the dedicated connection. + */ tags: string[] - /** ID of the PoP where the dedicated connection is located. */ + /** + * ID of the PoP where the dedicated connection is located. + */ popId: string - /** Bandwidth size of the dedicated connection. */ + /** + * Bandwidth size of the dedicated connection. + */ bandwidthMbps: number - /** Size of the links supported on this dedicated connection. */ + /** + * Size of the links supported on this dedicated connection. + */ availableLinkBandwidths: number[] - /** Creation date of the dedicated connection. */ + /** + * Creation date of the dedicated connection. + */ createdAt?: Date - /** Last modification date of the dedicated connection. */ + /** + * Last modification date of the dedicated connection. + */ updatedAt?: Date /** - * Demarcation details required by the data center to set up the supporting - * Cross Connect. This generally includes the physical space in the facility, - * the cabinet or rack the connection should land in, the patch panel to go - * in, the port designation, and the media type. + * Demarcation details required by the data center to set up the supporting Cross Connect. This generally includes the physical space in the facility, the cabinet or rack the connection should land in, the patch panel to go in, the port designation, and the media type. */ demarcationInfo?: string - /** Region of the dedicated connection. */ + /** + * Region of the dedicated connection. + */ region: ScwRegion } export interface Link { - /** Unique identifier of the link. */ + /** + * Unique identifier of the link. + */ id: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** Organization ID. */ + /** + * Organization ID. + */ organizationId: string - /** Name of the link. */ + /** + * Name of the link. + */ name: string - /** List of tags associated with the link. */ + /** + * List of tags associated with the link. + */ tags: string[] - /** ID of the PoP where the link's corresponding connection is located. */ + /** + * ID of the PoP where the link's corresponding connection is located. + */ popId: string - /** Rate limited bandwidth of the link. */ + /** + * Rate limited bandwidth of the link. + */ bandwidthMbps: number - /** Status of the link. */ + /** + * Status of the link. + */ status: LinkStatus - /** Status of the link's BGP IPv4 session. */ + /** + * Status of the link's BGP IPv4 session. + */ bgpV4Status: BgpStatus - /** Status of the link's BGP IPv6 session. */ + /** + * Status of the link's BGP IPv6 session. + */ bgpV6Status: BgpStatus - /** ID of the Scaleway VPC attached to the link. */ + /** + * ID of the Scaleway VPC attached to the link. + */ vpcId?: string - /** ID of the routing policy attached to the link. */ + /** + * ID of the routing policy attached to the link. + */ routingPolicyId?: string /** - * Defines whether route propagation is enabled or not. To enable or disable - * route propagation, use the dedicated endpoint. + * Defines whether route propagation is enabled or not. To enable or disable route propagation, use the dedicated endpoint. */ enableRoutePropagation: boolean - /** Creation date of the link. */ + /** + * Creation date of the link. + */ createdAt?: Date - /** Last modification date of the link. */ + /** + * Last modification date of the link. + */ updatedAt?: Date /** * Partner host information. @@ -165,139 +224,196 @@ export interface Link { * One-of ('hostInfo'): at most one of 'partner', 'self' could be set. */ self?: SelfHost - /** VLAN of the link. */ + /** + * VLAN of the link. + */ vlan: number - /** BGP configuration on Scaleway's side. */ + /** + * BGP configuration on Scaleway's side. + */ scwBgpConfig?: BgpConfig - /** BGP configuration on peer's side (on-premises or other hosting provider). */ + /** + * BGP configuration on peer's side (on-premises or other hosting provider). + */ peerBgpConfig?: BgpConfig - /** Region of the link. */ + /** + * Region of the link. + */ region: ScwRegion } export interface Partner { - /** Unique identifier of the partner. */ + /** + * Unique identifier of the partner. + */ id: string - /** Name of the partner. */ + /** + * Name of the partner. + */ name: string - /** Contact email address of partner. */ + /** + * Contact email address of partner. + */ contactEmail: string - /** Image URL of the partner's logo. */ + /** + * Image URL of the partner's logo. + */ logoUrl: string - /** URL of the partner's portal. */ + /** + * URL of the partner's portal. + */ portalUrl: string - /** Creation date of the partner. */ + /** + * Creation date of the partner. + */ createdAt?: Date - /** Last modification date of the partner. */ + /** + * Last modification date of the partner. + */ updatedAt?: Date } export interface Pop { - /** Unique identifier of the PoP. */ + /** + * Unique identifier of the PoP. + */ id: string - /** Name of the PoP. It is the common reference of Hosting DC (ex: TH2). */ + /** + * Name of the PoP. It is the common reference of Hosting DC (ex: TH2). + */ name: string /** - * Name of the PoP's hosting provider, e.g. Telehouse for TH2 or OpCore for - * DC3. + * Name of the PoP's hosting provider, e.g. Telehouse for TH2 or OpCore for DC3. */ hostingProviderName: string - /** Physical address of the PoP. */ + /** + * Physical address of the PoP. + */ address: string - /** City where PoP is located. */ + /** + * City where PoP is located. + */ city: string - /** Image URL of the PoP's logo. */ + /** + * Image URL of the PoP's logo. + */ logoUrl: string /** - * Available bandwidth in Mbits/s for future hosted links from available - * connections in this PoP. + * Available bandwidth in Mbits/s for future hosted links from available connections in this PoP. */ availableLinkBandwidthsMbps: number[] - /** Region of the PoP. */ + /** + * Region of the PoP. + */ region: ScwRegion } export interface RoutingPolicy { - /** Unique identifier of the routing policy. */ + /** + * Unique identifier of the routing policy. + */ id: string - /** Project ID. */ + /** + * Project ID. + */ projectId: string - /** Organization ID. */ + /** + * Organization ID. + */ organizationId: string - /** Name of the routing policy. */ + /** + * Name of the routing policy. + */ name: string - /** List of tags associated with the routing policy. */ + /** + * List of tags associated with the routing policy. + */ tags: string[] /** - * IP prefixes to accept from the peer (ranges of route announcements to - * accept). + * IP prefixes to accept from the peer (ranges of route announcements to accept). */ prefixFilterIn: string[] - /** IP prefix filters to advertise to the peer (ranges of routes to advertise). */ + /** + * IP prefix filters to advertise to the peer (ranges of routes to advertise). + */ prefixFilterOut: string[] - /** Creation date of the routing policy. */ + /** + * Creation date of the routing policy. + */ createdAt?: Date - /** Last modification date of the routing policy. */ + /** + * Last modification date of the routing policy. + */ updatedAt?: Date - /** Region of the routing policy. */ + /** + * Region of the routing policy. + */ region: ScwRegion } export type AttachRoutingPolicyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link to attach a routing policy to. */ + /** + * ID of the link to attach a routing policy to. + */ linkId: string - /** ID of the routing policy to be attached. */ + /** + * ID of the routing policy to be attached. + */ routingPolicyId: string } export type AttachVpcRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link to attach VPC to. */ + /** + * ID of the link to attach VPC to. + */ linkId: string - /** ID of the VPC to attach. */ + /** + * ID of the VPC to attach. + */ vpcId: string } export type CreateLinkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project to create the link in. */ + /** + * ID of the Project to create the link in. + */ projectId?: string - /** Name of the link. */ + /** + * Name of the link. + */ name: string - /** List of tags to apply to the link. */ + /** + * List of tags to apply to the link. + */ tags?: string[] - /** PoP (location) where the link will be created. */ + /** + * PoP (location) where the link will be created. + */ popId: string /** - * Desired bandwidth for the link. Must be compatible with available link - * bandwidths and remaining bandwidth capacity of the connection. + * Desired bandwidth for the link. Must be compatible with available link bandwidths and remaining bandwidth capacity of the connection. */ bandwidthMbps: number /** - * If set, creates a self-hosted link using this dedicated physical - * connection. As the customer, specify the ID of the physical connection you - * already have for this link. + * If set, creates a self-hosted link using this dedicated physical connection. As the customer, specify the ID of the physical connection you already have for this link. * * One-of ('host'): at most one of 'connectionId', 'partnerId' could be set. */ connectionId?: string /** - * If set, creates a hosted link on a partner's connection. Specify the ID of - * the chosen partner, who already has a shared connection with available - * bandwidth. + * If set, creates a hosted link on a partner's connection. Specify the ID of the chosen partner, who already has a shared connection with available bandwidth. * * One-of ('host'): at most one of 'connectionId', 'partnerId' could be set. */ @@ -306,300 +422,416 @@ export type CreateLinkRequest = { export type CreateRoutingPolicyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project to create the routing policy in. */ + /** + * ID of the Project to create the routing policy in. + */ projectId?: string - /** Name of the routing policy. */ + /** + * Name of the routing policy. + */ name: string - /** List of tags to apply to the routing policy. */ + /** + * List of tags to apply to the routing policy. + */ tags?: string[] /** - * IP prefixes to accept from the peer (ranges of route announcements to - * accept). + * IP prefixes to accept from the peer (ranges of route announcements to accept). */ prefixFilterIn?: string[] - /** IP prefix filters to advertise to the peer (ranges of routes to advertise). */ + /** + * IP prefix filters to advertise to the peer (ranges of routes to advertise). + */ prefixFilterOut?: string[] } export type DeleteLinkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link to delete. */ + /** + * ID of the link to delete. + */ linkId: string } export type DeleteRoutingPolicyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the routing policy to delete. */ + /** + * ID of the routing policy to delete. + */ routingPolicyId: string } export type DetachRoutingPolicyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link to detach a routing policy from. */ + /** + * ID of the link to detach a routing policy from. + */ linkId: string } export type DetachVpcRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link to detach the VPC from. */ + /** + * ID of the link to detach the VPC from. + */ linkId: string } export type DisableRoutePropagationRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link on which to disable route propagation. */ + /** + * ID of the link on which to disable route propagation. + */ linkId: string } export type EnableRoutePropagationRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link on which to enable route propagation. */ + /** + * ID of the link on which to enable route propagation. + */ linkId: string } export type GetDedicatedConnectionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of connection to get. */ + /** + * ID of connection to get. + */ connectionId: string } export type GetLinkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link to get. */ + /** + * ID of the link to get. + */ linkId: string } export type GetPartnerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of partner to get. */ + /** + * ID of partner to get. + */ partnerId: string } export type GetPopRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of PoP to get. */ + /** + * ID of PoP to get. + */ popId: string } export type GetRoutingPolicyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the routing policy to get. */ + /** + * ID of the routing policy to get. + */ routingPolicyId: string } export type ListDedicatedConnectionsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListDedicatedConnectionsRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of connections to return per page. */ + /** + * Maximum number of connections to return per page. + */ pageSize?: number - /** Project ID to filter for. */ + /** + * Project ID to filter for. + */ projectId?: string - /** Organization ID to filter for. */ + /** + * Organization ID to filter for. + */ organizationId?: string - /** Link name to filter for. */ + /** + * Link name to filter for. + */ name?: string - /** Tags to filter for. */ + /** + * Tags to filter for. + */ tags?: string[] - /** Connection status to filter for. */ + /** + * Connection status to filter for. + */ status?: DedicatedConnectionStatus - /** Filter for dedicated connections with this bandwidth size. */ + /** + * Filter for dedicated connections with this bandwidth size. + */ bandwidthMbps?: number - /** Filter for dedicated connections present in this PoP. */ + /** + * Filter for dedicated connections present in this PoP. + */ popId?: string } export interface ListDedicatedConnectionsResponse { - /** List of connections on current page. */ + /** + * List of connections on current page. + */ connections: DedicatedConnection[] - /** Total number of connections returned. */ + /** + * Total number of connections returned. + */ totalCount: number } export type ListLinksRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListLinksRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of links to return per page. */ + /** + * Maximum number of links to return per page. + */ pageSize?: number - /** Project ID to filter for. */ + /** + * Project ID to filter for. + */ projectId?: string - /** Organization ID to filter for. */ + /** + * Organization ID to filter for. + */ organizationId?: string - /** Link name to filter for. */ + /** + * Link name to filter for. + */ name?: string - /** Tags to filter for. */ + /** + * Tags to filter for. + */ tags?: string[] - /** Link status to filter for. */ + /** + * Link status to filter for. + */ status?: LinkStatus - /** BGP IPv4 status to filter for. */ + /** + * BGP IPv4 status to filter for. + */ bgpV4Status?: BgpStatus - /** BGP IPv6 status to filter for. */ + /** + * BGP IPv6 status to filter for. + */ bgpV6Status?: BgpStatus - /** Filter for links attached to this PoP (via connections). */ + /** + * Filter for links attached to this PoP (via connections). + */ popId?: string - /** Filter for link bandwidth (in Mbps). */ + /** + * Filter for link bandwidth (in Mbps). + */ bandwidthMbps?: number - /** Filter for links hosted by this partner. */ + /** + * Filter for links hosted by this partner. + */ partnerId?: string - /** Filter for links attached to this VPC. */ + /** + * Filter for links attached to this VPC. + */ vpcId?: string - /** Filter for links using this routing policy. */ + /** + * Filter for links using this routing policy. + */ routingPolicyId?: string - /** Filter for the link with this pairing_key. */ + /** + * Filter for the link with this pairing_key. + */ pairingKey?: string - /** Filter for hosted or self-hosted links. */ + /** + * Filter for hosted or self-hosted links. + */ kind?: LinkKind - /** Filter for links self-hosted on this connection. */ + /** + * Filter for links self-hosted on this connection. + */ connectionId?: string } export interface ListLinksResponse { - /** List of links on the current page. */ + /** + * List of links on the current page. + */ links: Link[] - /** Total number of links. */ + /** + * Total number of links. + */ totalCount: number } export type ListPartnersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListPartnersRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of partners to return per page. */ + /** + * Maximum number of partners to return per page. + */ pageSize?: number - /** Filter for partners present (offering a connection) in one of these PoPs. */ + /** + * Filter for partners present (offering a connection) in one of these PoPs. + */ popIds?: string[] } export interface ListPartnersResponse { - /** List of partners on current page. */ + /** + * List of partners on current page. + */ partners: Partner[] - /** Total number of partners returned. */ + /** + * Total number of partners returned. + */ totalCount: number } export type ListPopsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListPopsRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of PoPs to return per page. */ + /** + * Maximum number of PoPs to return per page. + */ pageSize?: number - /** PoP name to filter for. */ + /** + * PoP name to filter for. + */ name?: string - /** Hosting provider name to filter for. */ + /** + * Hosting provider name to filter for. + */ hostingProviderName?: string - /** Filter for PoPs hosting an available shared connection from this partner. */ + /** + * Filter for PoPs hosting an available shared connection from this partner. + */ partnerId?: string /** - * Filter for PoPs with a shared connection allowing this bandwidth size. Note - * that we cannot guarantee that PoPs returned will have available capacity. + * Filter for PoPs with a shared connection allowing this bandwidth size. Note that we cannot guarantee that PoPs returned will have available capacity. */ linkBandwidthMbps?: number /** - * Filter for PoPs with a dedicated connection available for self-hosted - * links. + * Filter for PoPs with a dedicated connection available for self-hosted links. */ dedicatedAvailable?: boolean } export interface ListPopsResponse { - /** List of PoPs on the current page. */ + /** + * List of PoPs on the current page. + */ pops: Pop[] - /** Total number of PoPs. */ + /** + * Total number of PoPs. + */ totalCount: number } export type ListRoutingPoliciesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListRoutingPoliciesRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of routing policies to return per page. */ + /** + * Maximum number of routing policies to return per page. + */ pageSize?: number - /** Project ID to filter for. */ + /** + * Project ID to filter for. + */ projectId?: string - /** Organization ID to filter for. */ + /** + * Organization ID to filter for. + */ organizationId?: string - /** Routing policy name to filter for. */ + /** + * Routing policy name to filter for. + */ name?: string - /** Tags to filter for. */ + /** + * Tags to filter for. + */ tags?: string[] } @@ -610,38 +842,46 @@ export interface ListRoutingPoliciesResponse { export type UpdateLinkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the link to update. */ + /** + * ID of the link to update. + */ linkId: string - /** Name of the link. */ + /** + * Name of the link. + */ name?: string - /** List of tags to apply to the link. */ + /** + * List of tags to apply to the link. + */ tags?: string[] } export type UpdateRoutingPolicyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the routing policy to update. */ + /** + * ID of the routing policy to update. + */ routingPolicyId: string - /** Name of the routing policy. */ + /** + * Name of the routing policy. + */ name?: string - /** List of tags to apply to the routing policy. */ + /** + * List of tags to apply to the routing policy. + */ tags?: string[] /** - * IP prefixes to accept from the peer (ranges of route announcements to - * accept). + * IP prefixes to accept from the peer (ranges of route announcements to accept). */ prefixFilterIn?: string[] /** - * IP prefix filters for routes to advertise to the peer (ranges of routes to - * advertise). + * IP prefix filters for routes to advertise to the peer (ranges of routes to advertise). */ prefixFilterOut?: string[] } diff --git a/packages/clients/src/api/iot/v1/api.gen.ts b/packages/clients/src/api/iot/v1/api.gen.ts index 4668cfbc2..456a61c3a 100644 --- a/packages/clients/src/api/iot/v1/api.gen.ts +++ b/packages/clients/src/api/iot/v1/api.gen.ts @@ -103,8 +103,8 @@ const jsonContentHeaders = { /** * IoT Hub API. - * - * This API allows you to manage your IoT hubs and devices. + +This API allows you to manage your IoT hubs and devices. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -131,9 +131,7 @@ export class API extends ParentAPI { ) /** - * List hubs. List all Hubs in the specified zone. By default, returned Hubs - * are ordered by creation date in ascending order, though this can be - * modified via the `order_by` field. + * List hubs. List all Hubs in the specified zone. By default, returned Hubs are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListHubsRequest} * @returns A Promise of ListHubsResponse @@ -142,8 +140,7 @@ export class API extends ParentAPI { enrichForPagination('hubs', this.pageOfListHubs, request) /** - * Create a hub. Create a new Hub in the targeted region, specifying its - * configuration including name and product plan. + * Create a hub. Create a new Hub in the targeted region, specifying its configuration including name and product plan. * * @param request - The request {@link CreateHubRequest} * @returns A Promise of Hub @@ -162,9 +159,7 @@ export class API extends ParentAPI { ) /** - * Get a hub. Retrieve information about an existing IoT Hub, specified by its - * Hub ID. Its full details, including name, status and endpoint, are returned - * in the response object. + * Get a hub. Retrieve information about an existing IoT Hub, specified by its Hub ID. Its full details, including name, status and endpoint, are returned in the response object. * * @param request - The request {@link GetHubRequest} * @returns A Promise of Hub @@ -199,8 +194,7 @@ export class API extends ParentAPI { ) /** - * Update a hub. Update the parameters of an existing IoT Hub, specified by - * its Hub ID. + * Update a hub. Update the parameters of an existing IoT Hub, specified by its Hub ID. * * @param request - The request {@link UpdateHubRequest} * @returns A Promise of Hub @@ -253,8 +247,7 @@ export class API extends ParentAPI { ) /** - * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting - * a Hub is permanent, and cannot be undone. + * Delete a hub. Delete an existing IoT Hub, specified by its Hub ID. Deleting a Hub is permanent, and cannot be undone. * * @param request - The request {@link DeleteHubRequest} */ @@ -266,8 +259,7 @@ export class API extends ParentAPI { }) /** - * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by - * its Hub ID. + * Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by its Hub ID. * * @deprecated * @param request - The request {@link GetHubMetricsRequest} @@ -284,8 +276,7 @@ export class API extends ParentAPI { ) /** - * Set the certificate authority of a hub. Set a particular PEM-encoded - * certificate, specified by the Hub ID. + * Set the certificate authority of a hub. Set a particular PEM-encoded certificate, specified by the Hub ID. * * @param request - The request {@link SetHubCARequest} * @returns A Promise of Hub @@ -304,8 +295,7 @@ export class API extends ParentAPI { ) /** - * Get the certificate authority of a hub. Get information for a particular - * PEM-encoded certificate, specified by the Hub ID. + * Get the certificate authority of a hub. Get information for a particular PEM-encoded certificate, specified by the Hub ID. * * @param request - The request {@link GetHubCARequest} * @returns A Promise of GetHubCAResponse @@ -341,9 +331,7 @@ export class API extends ParentAPI { ) /** - * List devices. List all devices in the specified region. By default, - * returned devices are ordered by creation date in ascending order, though - * this can be modified via the `order_by` field. + * List devices. List all devices in the specified region. By default, returned devices are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListDevicesRequest} * @returns A Promise of ListDevicesResponse @@ -371,9 +359,7 @@ export class API extends ParentAPI { ) /** - * Get a device. Retrieve information about an existing device, specified by - * its device ID. Its full details, including name, status and ID, are - * returned in the response object. + * Get a device. Retrieve information about an existing device, specified by its device ID. Its full details, including name, status and ID, are returned in the response object. * * @param request - The request {@link GetDeviceRequest} * @returns A Promise of Device @@ -388,8 +374,7 @@ export class API extends ParentAPI { ) /** - * Update a device. Update the parameters of an existing device, specified by - * its device ID. + * Update a device. Update the parameters of an existing device, specified by its device ID. * * @param request - The request {@link UpdateDeviceRequest} * @returns A Promise of Device @@ -442,8 +427,7 @@ export class API extends ParentAPI { ) /** - * Renew a device certificate. Renew the certificate of an existing device, - * specified by its device ID. + * Renew a device certificate. Renew the certificate of an existing device, specified by its device ID. * * @param request - The request {@link RenewDeviceCertificateRequest} * @returns A Promise of RenewDeviceCertificateResponse @@ -460,8 +444,7 @@ export class API extends ParentAPI { ) /** - * Set a custom certificate on a device. Switch the existing certificate of a - * given device with an EM-encoded custom certificate. + * Set a custom certificate on a device. Switch the existing certificate of a given device with an EM-encoded custom certificate. * * @param request - The request {@link SetDeviceCertificateRequest} * @returns A Promise of SetDeviceCertificateResponse @@ -480,9 +463,7 @@ export class API extends ParentAPI { ) /** - * Get a device's certificate. Get information for a particular PEM-encoded - * certificate, specified by the device ID. The response returns full details - * of the device, including its type of certificate. + * Get a device's certificate. Get information for a particular PEM-encoded certificate, specified by the device ID. The response returns full details of the device, including its type of certificate. * * @param request - The request {@link GetDeviceCertificateRequest} * @returns A Promise of GetDeviceCertificateResponse @@ -497,8 +478,7 @@ export class API extends ParentAPI { ) /** - * Remove a device. Remove a specific device from the specific Hub it is - * attached to. + * Remove a device. Remove a specific device from the specific Hub it is attached to. * * @param request - The request {@link DeleteDeviceRequest} */ @@ -509,8 +489,7 @@ export class API extends ParentAPI { }) /** - * Get a device's metrics. Get the metrics of an existing device, specified by - * its device ID. + * Get a device's metrics. Get the metrics of an existing device, specified by its device ID. * * @deprecated * @param request - The request {@link GetDeviceMetricsRequest} @@ -546,9 +525,7 @@ export class API extends ParentAPI { ) /** - * List routes. List all routes in the specified region. By default, returned - * routes are ordered by creation date in ascending order, though this can be - * modified via the `order_by` field. + * List routes. List all routes in the specified region. By default, returned routes are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListRoutesRequest} * @returns A Promise of ListRoutesResponse @@ -558,16 +535,15 @@ export class API extends ParentAPI { /** * Create a route. Multiple kinds of routes can be created, such as: - * - * - Database Route Create a route that will record subscribed MQTT messages - * into your database. You need to manage the database by yourself. - * - REST Route. Create a route that will call a REST API on received subscribed - * MQTT messages. - * - Amazon S3 Routes. Create a route that will put subscribed MQTT messages - * into an Object Storage bucket. You need to create the bucket yourself and - * grant write access. Granting can be done with s3cmd (`s3cmd setacl - * s3:// - * --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`). +- Database Route + Create a route that will record subscribed MQTT messages into your database. + You need to manage the database by yourself. +- REST Route. + Create a route that will call a REST API on received subscribed MQTT messages. +- Amazon S3 Routes. + Create a route that will put subscribed MQTT messages into an Object Storage bucket. + You need to create the bucket yourself and grant write access. + Granting can be done with s3cmd (`s3cmd setacl s3:// --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`). * * @param request - The request {@link CreateRouteRequest} * @returns A Promise of Route @@ -586,8 +562,7 @@ export class API extends ParentAPI { ) /** - * Update a route. Update the parameters of an existing route, specified by - * its route ID. + * Update a route. Update the parameters of an existing route, specified by its route ID. * * @param request - The request {@link UpdateRouteRequest} * @returns A Promise of Route @@ -606,9 +581,7 @@ export class API extends ParentAPI { ) /** - * Get a route. Get information for a particular route, specified by the route - * ID. The response returns full details of the route, including its type, the - * topic it subscribes to and its configuration. + * Get a route. Get information for a particular route, specified by the route ID. The response returns full details of the route, including its type, the topic it subscribes to and its configuration. * * @param request - The request {@link GetRouteRequest} * @returns A Promise of Route @@ -623,8 +596,7 @@ export class API extends ParentAPI { ) /** - * Delete a route. Delete an existing route, specified by its route ID. - * Deleting a route is permanent, and cannot be undone. + * Delete a route. Delete an existing route, specified by its route ID. Deleting a route is permanent, and cannot be undone. * * @param request - The request {@link DeleteRouteRequest} */ @@ -666,9 +638,7 @@ export class API extends ParentAPI { enrichForPagination('networks', this.pageOfListNetworks, request) /** - * Create a new network. Create a new network for an existing hub. Beside the - * default network, you can add networks for different data providers. - * Possible network types are Sigfox and REST. + * Create a new network. Create a new network for an existing hub. Beside the default network, you can add networks for different data providers. Possible network types are Sigfox and REST. * * @param request - The request {@link CreateNetworkRequest} * @returns A Promise of CreateNetworkResponse @@ -687,9 +657,7 @@ export class API extends ParentAPI { ) /** - * Retrieve a specific network. Retrieve an existing network, specified by its - * network ID. The response returns full details of the network, including its - * type, the topic prefix and its endpoint. + * Retrieve a specific network. Retrieve an existing network, specified by its network ID. The response returns full details of the network, including its type, the topic prefix and its endpoint. * * @param request - The request {@link GetNetworkRequest} * @returns A Promise of Network @@ -704,8 +672,7 @@ export class API extends ParentAPI { ) /** - * Delete a Network. Delete an existing network, specified by its network ID. - * Deleting a network is permanent, and cannot be undone. + * Delete a Network. Delete an existing network, specified by its network ID. Deleting a network is permanent, and cannot be undone. * * @param request - The request {@link DeleteNetworkRequest} */ diff --git a/packages/clients/src/api/iot/v1/types.gen.ts b/packages/clients/src/api/iot/v1/types.gen.ts index 7d3048006..49edda646 100644 --- a/packages/clients/src/api/iot/v1/types.gen.ts +++ b/packages/clients/src/api/iot/v1/types.gen.ts @@ -82,22 +82,24 @@ export type RouteS3ConfigS3Strategy = 'unknown' | 'per_topic' | 'per_message' export interface DeviceMessageFiltersRule { /** - * If set to `accept`, all topics in the topics list will be allowed, with all - * other topics being denied. If set to `reject`, all topics in the topics - * list will be denied, with all other topics being allowed. + * If set to `accept`, all topics in the topics list will be allowed, with all other topics being denied. +If set to `reject`, all topics in the topics list will be denied, with all other topics being allowed. */ policy: DeviceMessageFiltersRulePolicy /** - * List of topics to accept or reject. It must be valid MQTT topics and up to - * 65535 characters. + * List of topics to accept or reject. It must be valid MQTT topics and up to 65535 characters. */ topics?: string[] } export interface DeviceMessageFilters { - /** Filtering rule to restrict topics the device can publish to. */ + /** + * Filtering rule to restrict topics the device can publish to. + */ publish?: DeviceMessageFiltersRule - /** Filtering rule to restrict topics the device can subscribe to. */ + /** + * Filtering rule to restrict topics the device can subscribe to. + */ subscribe?: DeviceMessageFiltersRule } @@ -111,57 +113,88 @@ export interface Certificate { } export interface Device { - /** Device ID, also used as MQTT Client ID or username. */ + /** + * Device ID, also used as MQTT Client ID or username. + */ id: string - /** Device name. */ + /** + * Device name. + */ name: string - /** Device description. */ + /** + * Device description. + */ description: string - /** Device status. */ + /** + * Device status. + */ status: DeviceStatus - /** Hub ID. */ + /** + * Hub ID. + */ hubId: string - /** Last connection/activity date of a device. */ + /** + * Last connection/activity date of a device. + */ lastActivityAt?: Date - /** Defines whether the device is connected to the Hub. */ + /** + * Defines whether the device is connected to the Hub. + */ isConnected: boolean /** - * Defines whether to allow the device to connect to the Hub without TLS - * mutual authentication. + * Defines whether to allow the device to connect to the Hub without TLS mutual authentication. */ allowInsecure: boolean /** - * Defines whether to allow multiple physical devices to connect to the Hub - * with this device's credentials. + * Defines whether to allow multiple physical devices to connect to the Hub with this device's credentials. */ allowMultipleConnections: boolean - /** Filter-sets to restrict the topics the device can publish/subscribe to. */ + /** + * Filter-sets to restrict the topics the device can publish/subscribe to. + */ messageFilters?: DeviceMessageFilters /** - * Assigning a custom certificate allows a device to authenticate using that - * specific certificate without checking the Hub's CA certificate. + * Assigning a custom certificate allows a device to authenticate using that specific certificate without checking the Hub's CA certificate. */ hasCustomCertificate: boolean - /** Date at which the device was added. */ + /** + * Date at which the device was added. + */ createdAt?: Date - /** Date at which the device was last modified. */ + /** + * Date at which the device was last modified. + */ updatedAt?: Date } export interface Network { - /** Network ID. */ + /** + * Network ID. + */ id: string - /** Network name. */ + /** + * Network name. + */ name: string - /** Type of network to connect with. */ + /** + * Type of network to connect with. + */ type: NetworkNetworkType - /** Endpoint to use for interacting with the network. */ + /** + * Endpoint to use for interacting with the network. + */ endpoint: string - /** Hub ID to connect the Network to. */ + /** + * Hub ID to connect the Network to. + */ hubId: string - /** Date at which the network was created. */ + /** + * Date at which the network was created. + */ createdAt?: Date - /** This prefix will be prepended to all topics for this Network. */ + /** + * This prefix will be prepended to all topics for this Network. + */ topicPrefix: string } @@ -189,130 +222,181 @@ export interface CreateRouteRequestS3Config { } export interface Hub { - /** Hub ID. */ + /** + * Hub ID. + */ id: string - /** Hub name. */ + /** + * Hub name. + */ name: string - /** Current status of the Hub. */ + /** + * Current status of the Hub. + */ status: HubStatus - /** Hub feature set. */ + /** + * Hub feature set. + */ productPlan: HubProductPlan - /** Defines whether the hub has been enabled. */ + /** + * Defines whether the hub has been enabled. + */ enabled: boolean - /** Number of registered devices. */ + /** + * Number of registered devices. + */ deviceCount: number - /** Number of currently connected devices. */ + /** + * Number of currently connected devices. + */ connectedDeviceCount: number /** - * Devices should be connected to this host. Port may be 1883 (MQTT), 8883 - * (MQTT over TLS), 80 (MQTT over Websocket) or 443 (MQTT over Websocket over - * TLS). + * Devices should be connected to this host. Port may be 1883 (MQTT), 8883 (MQTT over TLS), 80 (MQTT over Websocket) or 443 (MQTT over Websocket over TLS). */ endpoint: string - /** Defines whether to disable Hub events. */ + /** + * Defines whether to disable Hub events. + */ disableEvents: boolean - /** Hub events topic prefix. */ + /** + * Hub events topic prefix. + */ eventsTopicPrefix: string - /** Region of the Hub. */ + /** + * Region of the Hub. + */ region: ScwRegion - /** Hub creation date. */ + /** + * Hub creation date. + */ createdAt?: Date - /** Hub last modification date. */ + /** + * Hub last modification date. + */ updatedAt?: Date - /** Project owning the resource. */ + /** + * Project owning the resource. + */ projectId: string - /** Organization owning the resource. */ + /** + * Organization owning the resource. + */ organizationId: string /** - * When an unknown device connects to your hub using a valid certificate - * chain, it will be automatically provisioned inside your Hub. The Hub uses - * the common name of the device certifcate to find out if a device with the - * same name already exists. This setting can only be enabled on a hub with a - * custom certificate authority. + * When an unknown device connects to your hub using a valid certificate chain, it will be automatically provisioned inside your Hub. The Hub uses the common name of the device certifcate to find out if a device with the same name already exists. This setting can only be enabled on a hub with a custom certificate authority. */ enableDeviceAutoProvisioning: boolean /** - * Flag is automatically set to `false` after Hub creation, as Hub - * certificates are managed by Scaleway. Once a custom certificate authority - * is set, the flag will be set to `true`. + * Flag is automatically set to `false` after Hub creation, as Hub certificates are managed by Scaleway. Once a custom certificate authority is set, the flag will be set to `true`. */ hasCustomCa: boolean /** * BETA - not implemented yet. * - * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be - * set. + * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be set. */ twinsGraphiteConfig?: HubTwinsGraphiteConfig } export interface RouteSummary { - /** Route ID. */ + /** + * Route ID. + */ id: string - /** Route name. */ + /** + * Route name. + */ name: string - /** Hub ID of the route. */ + /** + * Hub ID of the route. + */ hubId: string /** - * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters. + * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters. */ topic: string - /** Route type. */ + /** + * Route type. + */ type: RouteRouteType - /** Date at which the route was created. */ + /** + * Date at which the route was created. + */ createdAt?: Date - /** Date at which the route was last updated. */ + /** + * Date at which the route was last updated. + */ updatedAt?: Date } export interface ListTwinDocumentsResponseDocumentSummary { - /** Name of the document. */ + /** + * Name of the document. + */ documentName: string } export interface RouteDatabaseConfig { /** - * Database engine the route will connect to. If not specified, the default - * database will be 'PostgreSQL'. + * Database engine the route will connect to. If not specified, the default database will be 'PostgreSQL'. */ engine: RouteDatabaseConfigEngine - /** Database host. */ + /** + * Database host. + */ host: string - /** Database port. */ + /** + * Database port. + */ port: number - /** Database name. */ + /** + * Database name. + */ dbname: string - /** Database username. Make sure this account can execute the provided query. */ + /** + * Database username. Make sure this account can execute the provided query. + */ username: string - /** Database password. */ + /** + * Database password. + */ password: string /** - * SQL query to be executed ($TOPIC and $PAYLOAD variables are available, see - * documentation). + * SQL query to be executed ($TOPIC and $PAYLOAD variables are available, see documentation). */ query: string } export interface RouteRestConfig { - /** HTTP verb used to call REST URI. */ + /** + * HTTP verb used to call REST URI. + */ verb: RouteRestConfigHttpVerb - /** URI of the REST endpoint. */ + /** + * URI of the REST endpoint. + */ uri: string - /** HTTP call extra headers. */ + /** + * HTTP call extra headers. + */ headers: Record } export interface RouteS3Config { - /** Region of the Amazon S3 route's destination bucket (e.g., 'fr-par'). */ + /** + * Region of the Amazon S3 route's destination bucket (e.g., 'fr-par'). + */ bucketRegion: string - /** Destination bucket name of the Amazon S3 route. */ + /** + * Destination bucket name of the Amazon S3 route. + */ bucketName: string - /** Optional string to prefix object names with. */ + /** + * Optional string to prefix object names with. + */ objectPrefix: string /** - * How the Amazon S3 route's objects will be created: one per topic or one per - * message. + * How the Amazon S3 route's objects will be created: one per topic or one per message. */ strategy: RouteS3ConfigS3Strategy } @@ -342,284 +426,326 @@ export interface UpdateRouteRequestS3Config { export type CreateDeviceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device name. */ + /** + * Device name. + */ name?: string - /** Hub ID of the device. */ + /** + * Hub ID of the device. + */ hubId: string /** - * Defines whether to allow plain and server-authenticated SSL connections in - * addition to mutually-authenticated ones. + * Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones. */ allowInsecure: boolean /** - * Defines whether to allow multiple physical devices to connect with this - * device's credentials. + * Defines whether to allow multiple physical devices to connect with this device's credentials. */ allowMultipleConnections: boolean /** - * Filter-sets to authorize or deny the device to publish/subscribe to - * specific topics. + * Filter-sets to authorize or deny the device to publish/subscribe to specific topics. */ messageFilters?: DeviceMessageFilters - /** Device description. */ + /** + * Device description. + */ description?: string } export interface CreateDeviceResponse { - /** Information related to the created device. */ + /** + * Information related to the created device. + */ device?: Device - /** Device certificate. */ + /** + * Device certificate. + */ certificate?: Certificate } export type CreateHubRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hub name (up to 255 characters). */ + /** + * Hub name (up to 255 characters). + */ name?: string /** - * Project/Organization ID to filter for, only Hubs from this - * Project/Organization will be returned. + * Project/Organization ID to filter for, only Hubs from this Project/Organization will be returned. */ projectId?: string - /** Hub product plan. */ + /** + * Hub product plan. + */ productPlan: HubProductPlan - /** Disable Hub events. */ + /** + * Disable Hub events. + */ disableEvents?: boolean - /** Topic prefix (default '$SCW/events') of Hub events. */ + /** + * Topic prefix (default '$SCW/events') of Hub events. + */ eventsTopicPrefix?: string /** * BETA - not implemented yet. * - * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be - * set. + * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be set. */ twinsGraphiteConfig?: HubTwinsGraphiteConfig } export type CreateNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Network name. */ + /** + * Network name. + */ name?: string - /** Type of network to connect with. */ + /** + * Type of network to connect with. + */ type: NetworkNetworkType - /** Hub ID to connect the Network to. */ + /** + * Hub ID to connect the Network to. + */ hubId: string - /** Topic prefix for the Network. */ + /** + * Topic prefix for the Network. + */ topicPrefix: string } export interface CreateNetworkResponse { - /** Information related to the created network. */ + /** + * Information related to the created network. + */ network?: Network - /** Endpoint Key to keep secret. This cannot be retrieved later. */ + /** + * Endpoint Key to keep secret. This cannot be retrieved later. + */ secret: string } export type CreateRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Route name. */ + /** + * Route name. + */ name?: string - /** Hub ID of the route. */ + /** + * Hub ID of the route. + */ hubId: string /** - * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters. + * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters. */ topic: string /** * If creating Amazon S3 Routes, Amazon S3-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ s3Config?: CreateRouteRequestS3Config /** * If creating Database Route, DB-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ dbConfig?: CreateRouteRequestDatabaseConfig /** * If creating Rest Route, Rest-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ restConfig?: CreateRouteRequestRestConfig } export type DeleteDeviceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string } export type DeleteHubRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hub ID. */ + /** + * Hub ID. + */ hubId: string /** - * Defines whether to force the deletion of devices added to this Hub or - * reject the operation. + * Defines whether to force the deletion of devices added to this Hub or reject the operation. */ deleteDevices?: boolean } export type DeleteNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Network ID. */ + /** + * Network ID. + */ networkId: string } export type DeleteRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Route ID. */ + /** + * Route ID. + */ routeId: string } export type DeleteTwinDocumentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Twin ID. */ + /** + * Twin ID. + */ twinId: string - /** Name of the document. */ + /** + * Name of the document. + */ documentName: string } export type DeleteTwinDocumentsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Twin ID. */ + /** + * Twin ID. + */ twinId: string } export type DisableDeviceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string } export type DisableHubRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hub ID. */ + /** + * Hub ID. + */ hubId: string } export type EnableDeviceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string } export type EnableHubRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hub ID. */ + /** + * Hub ID. + */ hubId: string } export type GetDeviceCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string } export interface GetDeviceCertificateResponse { - /** Information related to the created device. */ + /** + * Information related to the created device. + */ device?: Device - /** Device certificate. */ + /** + * Device certificate. + */ certificatePem: string } export type GetDeviceMetricsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string - /** Start date used to compute the best scale for the returned metrics. */ + /** + * Start date used to compute the best scale for the returned metrics. + */ startDate?: Date } export interface GetDeviceMetricsResponse { - /** Metrics for a device over the requested period. */ + /** + * Metrics for a device over the requested period. + */ metrics: TimeSeries[] } export type GetDeviceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string } export type GetHubCARequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion hubId: string @@ -631,298 +757,394 @@ export interface GetHubCAResponse { export type GetHubMetricsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hub ID. */ + /** + * Hub ID. + */ hubId: string - /** Start date used to compute the best scale for returned metrics. */ + /** + * Start date used to compute the best scale for returned metrics. + */ startDate?: Date } export interface GetHubMetricsResponse { - /** Metrics for a Hub over the requested period. */ + /** + * Metrics for a Hub over the requested period. + */ metrics: TimeSeries[] } export type GetHubRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hub ID. */ + /** + * Hub ID. + */ hubId: string } export type GetNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Network ID. */ + /** + * Network ID. + */ networkId: string } export type GetRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Route ID. */ + /** + * Route ID. + */ routeId: string } export type GetTwinDocumentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Twin ID. */ + /** + * Twin ID. + */ twinId: string - /** Name of the document. */ + /** + * Name of the document. + */ documentName: string } export type ListDevicesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of devices to return within a page. Maximum value is 100. */ + /** + * Number of devices to return within a page. Maximum value is 100. + */ pageSize?: number - /** Ordering of requested devices. */ + /** + * Ordering of requested devices. + */ orderBy?: ListDevicesRequestOrderBy - /** Name to filter for, only devices with this name will be returned. */ + /** + * Name to filter for, only devices with this name will be returned. + */ name?: string - /** Hub ID to filter for, only devices attached to this Hub will be returned. */ + /** + * Hub ID to filter for, only devices attached to this Hub will be returned. + */ hubId?: string - /** Defines wheter to filter the allow_insecure flag. */ + /** + * Defines wheter to filter the allow_insecure flag. + */ allowInsecure?: boolean - /** Device status (enabled, disabled, etc.). */ + /** + * Device status (enabled, disabled, etc.). + */ status?: DeviceStatus } export interface ListDevicesResponse { - /** Total number of devices. */ + /** + * Total number of devices. + */ totalCount: number - /** Page of devices. */ + /** + * Page of devices. + */ devices: Device[] } export type ListHubsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of Hubs to return within a page. Maximum value is 100. */ + /** + * Number of Hubs to return within a page. Maximum value is 100. + */ pageSize?: number - /** Sort order of Hubs in the response. */ + /** + * Sort order of Hubs in the response. + */ orderBy?: ListHubsRequestOrderBy - /** Only list Hubs of this Project ID. */ + /** + * Only list Hubs of this Project ID. + */ projectId?: string - /** Only list Hubs of this Organization ID. */ + /** + * Only list Hubs of this Organization ID. + */ organizationId?: string - /** Hub name. */ + /** + * Hub name. + */ name?: string } export interface ListHubsResponse { - /** Total number of Hubs. */ + /** + * Total number of Hubs. + */ totalCount: number - /** A page of hubs. */ + /** + * A page of hubs. + */ hubs: Hub[] } export type ListNetworksRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of networks to return. The maximum value is 100. */ + /** + * Number of networks to return. The maximum value is 100. + */ pageSize?: number - /** Ordering of requested routes. */ + /** + * Ordering of requested routes. + */ orderBy?: ListNetworksRequestOrderBy - /** Network name to filter for. */ + /** + * Network name to filter for. + */ name?: string - /** Hub ID to filter for. */ + /** + * Hub ID to filter for. + */ hubId?: string - /** Topic prefix to filter for. */ + /** + * Topic prefix to filter for. + */ topicPrefix?: string } export interface ListNetworksResponse { - /** Total number of Networks. */ + /** + * Total number of Networks. + */ totalCount: number - /** Page of networks. */ + /** + * Page of networks. + */ networks: Network[] } export type ListRoutesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of routes to return within a page. Maximum value is 100. */ + /** + * Number of routes to return within a page. Maximum value is 100. + */ pageSize?: number - /** Ordering of requested routes. */ + /** + * Ordering of requested routes. + */ orderBy?: ListRoutesRequestOrderBy - /** Hub ID to filter for. */ + /** + * Hub ID to filter for. + */ hubId?: string - /** Route name to filter for. */ + /** + * Route name to filter for. + */ name?: string } export interface ListRoutesResponse { - /** Total number of routes. */ + /** + * Total number of routes. + */ totalCount: number - /** Page of routes. */ + /** + * Page of routes. + */ routes: RouteSummary[] } export type ListTwinDocumentsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Twin ID. */ + /** + * Twin ID. + */ twinId: string } export interface ListTwinDocumentsResponse { - /** List of the twin document. */ + /** + * List of the twin document. + */ documents: ListTwinDocumentsResponseDocumentSummary[] } export type PatchTwinDocumentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Twin ID. */ + /** + * Twin ID. + */ twinId: string - /** Name of the document. */ + /** + * Name of the document. + */ documentName: string /** - * If set, ensures that the current version of the document matches before - * persisting the update. + * If set, ensures that the current version of the document matches before persisting the update. */ version?: number /** - * A json data that will be applied on the document's current data. Patching - * rules: The patch goes recursively through the patch objects. If the patch - * object property is null, it is removed from the final object. If the patch - * object property is a value (number, strings, bool, arrays), it is replaced. - * If the patch object property is an object, the previous rules will be - * applied recursively on it. + * A json data that will be applied on the document's current data. +Patching rules: +* The patch goes recursively through the patch objects. +* If the patch object property is null, it is removed from the final object. +* If the patch object property is a value (number, strings, bool, arrays), it is replaced. +* If the patch object property is an object, the previous rules will be applied recursively on it. */ data?: Record } export type PutTwinDocumentRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Twin ID. */ + /** + * Twin ID. + */ twinId: string - /** Name of the document. */ + /** + * Name of the document. + */ documentName: string /** - * If set, ensures that the current version of the document matches before - * persisting the update. + * If set, ensures that the current version of the document matches before persisting the update. */ version?: number - /** New data that will replace the contents of the document. */ + /** + * New data that will replace the contents of the document. + */ data?: Record } export type RenewDeviceCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string } export interface RenewDeviceCertificateResponse { - /** Information related to the created device. */ + /** + * Information related to the created device. + */ device?: Device - /** Device certificate. */ + /** + * Device certificate. + */ certificate?: Certificate } export interface Route { - /** Route ID. */ + /** + * Route ID. + */ id: string - /** Route name. */ + /** + * Route name. + */ name: string - /** Hub ID of the route. */ + /** + * Hub ID of the route. + */ hubId: string /** - * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters. + * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters. */ topic: string - /** Route type. */ + /** + * Route type. + */ type: RouteRouteType - /** Date at which the route was created. */ + /** + * Date at which the route was created. + */ createdAt?: Date /** * When using Amazon S3 Routes, Amazon S3-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ s3Config?: RouteS3Config /** * When using Database Route, DB-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ dbConfig?: RouteDatabaseConfig /** * When using Rest Route, Rest-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ restConfig?: RouteRestConfig - /** Date at which the route was last updated. */ + /** + * Date at which the route was last updated. + */ updatedAt?: Date } export type SetDeviceCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string - /** PEM-encoded custom certificate. */ + /** + * PEM-encoded custom certificate. + */ certificatePem: string } @@ -933,120 +1155,143 @@ export interface SetDeviceCertificateResponse { export type SetHubCARequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hub ID. */ + /** + * Hub ID. + */ hubId: string - /** CA's PEM-encoded certificate. */ + /** + * CA's PEM-encoded certificate. + */ caCertPem: string /** - * Challenge is a PEM-encoded certificate that acts as proof of possession of - * the CA. It must be signed by the CA, and have a Common Name equal to the - * Hub ID. + * Challenge is a PEM-encoded certificate that acts as proof of possession of the CA. It must be signed by the CA, and have a Common Name equal to the Hub ID. */ challengeCertPem: string } export interface TwinDocument { - /** Parent twin ID of the document. */ + /** + * Parent twin ID of the document. + */ twinId: string - /** Name of the document. */ + /** + * Name of the document. + */ documentName: string - /** New version of the document. */ + /** + * New version of the document. + */ version: number - /** New data related to the document. */ + /** + * New data related to the document. + */ data?: Record } export type UpdateDeviceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Device ID. */ + /** + * Device ID. + */ deviceId: string - /** Description for the device. */ + /** + * Description for the device. + */ description?: string /** - * Defines whether to allow plain and server-authenticated SSL connections in - * addition to mutually-authenticated ones. + * Defines whether to allow plain and server-authenticated SSL connections in addition to mutually-authenticated ones. */ allowInsecure?: boolean /** - * Defines whether to allow multiple physical devices to connect with this - * device's credentials. + * Defines whether to allow multiple physical devices to connect with this device's credentials. */ allowMultipleConnections?: boolean - /** Filter-sets to restrict the topics the device can publish/subscribe to. */ + /** + * Filter-sets to restrict the topics the device can publish/subscribe to. + */ messageFilters?: DeviceMessageFilters - /** Change Hub for this device, additional fees may apply, see IoT Hub pricing. */ + /** + * Change Hub for this device, additional fees may apply, see IoT Hub pricing. + */ hubId?: string } export type UpdateHubRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Hub you want to update. */ + /** + * ID of the Hub you want to update. + */ hubId: string - /** Hub name (up to 255 characters). */ + /** + * Hub name (up to 255 characters). + */ name?: string - /** Hub product plan. */ + /** + * Hub product plan. + */ productPlan?: HubProductPlan - /** Disable Hub events. */ + /** + * Disable Hub events. + */ disableEvents?: boolean - /** Topic prefix of Hub events. */ + /** + * Topic prefix of Hub events. + */ eventsTopicPrefix?: string - /** Enable device auto provisioning. */ + /** + * Enable device auto provisioning. + */ enableDeviceAutoProvisioning?: boolean /** * BETA - not implemented yet. * - * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be - * set. + * One-of ('twinsDbConfig'): at most one of 'twinsGraphiteConfig' could be set. */ twinsGraphiteConfig?: HubTwinsGraphiteConfig } export type UpdateRouteRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Route id. */ + /** + * Route id. + */ routeId: string - /** Route name. */ + /** + * Route name. + */ name?: string /** - * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters. + * Topic the route subscribes to. It must be a valid MQTT topic and up to 65535 characters. */ topic?: string /** * When updating Amazon S3 Route, Amazon S3-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ s3Config?: UpdateRouteRequestS3Config /** * When updating Database Route, DB-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ dbConfig?: UpdateRouteRequestDatabaseConfig /** * When updating Rest Route, Rest-specific configuration fields. * - * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' - * could be set. + * One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig' could be set. */ restConfig?: UpdateRouteRequestRestConfig } diff --git a/packages/clients/src/api/ipam/v1/api.gen.ts b/packages/clients/src/api/ipam/v1/api.gen.ts index 9b1c2d78e..14c48afac 100644 --- a/packages/clients/src/api/ipam/v1/api.gen.ts +++ b/packages/clients/src/api/ipam/v1/api.gen.ts @@ -38,9 +38,8 @@ const jsonContentHeaders = { /** * IPAM API. - * - * This API allows you to manage your Scaleway IP addresses with our IP Address - * Management tool. + +This API allows you to manage your Scaleway IP addresses with our IP Address Management tool. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -51,8 +50,7 @@ export class API extends ParentAPI { ] /** - * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs - * can only be reserved from a Private Network. + * Reserve a new IP. Reserve a new IP from the specified source. Currently IPs can only be reserved from a Private Network. * * @param request - The request {@link BookIPRequest} * @returns A Promise of IP @@ -71,8 +69,7 @@ export class API extends ParentAPI { ) /** - * Release an IP. Release an IP not currently attached to a resource, and - * returns it to the available IP pool. + * Release an IP. Release an IP not currently attached to a resource, and returns it to the available IP pool. * * @param request - The request {@link ReleaseIPRequest} */ @@ -166,11 +163,7 @@ export class API extends ParentAPI { ) /** - * List existing IPs. List existing IPs in the specified region using various - * filters. For example, you can filter for IPs within a specified Private - * Network, or for public IPs within a specified Project. By default, the IPs - * returned in the list are ordered by creation date in ascending order, - * though this can be modified via the order_by field. + * List existing IPs. List existing IPs in the specified region using various filters. For example, you can filter for IPs within a specified Private Network, or for public IPs within a specified Project. By default, the IPs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. * * @param request - The request {@link ListIPsRequest} * @returns A Promise of ListIPsResponse @@ -179,12 +172,7 @@ export class API extends ParentAPI { enrichForPagination('ips', this.pageOfListIPs, request) /** - * Attach IP to custom resource. Attach an existing reserved IP from a Private - * Network subnet to a custom, named resource via its MAC address. An example - * of a custom resource is a virtual machine hosted on an Elastic Metal - * server. Do not use this method for attaching IP addresses to standard - * Scaleway resources as it will fail - see the relevant product API for an - * equivalent method. + * Attach IP to custom resource. Attach an existing reserved IP from a Private Network subnet to a custom, named resource via its MAC address. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for attaching IP addresses to standard Scaleway resources as it will fail - see the relevant product API for an equivalent method. * * @param request - The request {@link AttachIPRequest} * @returns A Promise of IP @@ -203,11 +191,7 @@ export class API extends ParentAPI { ) /** - * Detach IP from a custom resource. Detach a private IP from a custom - * resource. An example of a custom resource is a virtual machine hosted on an - * Elastic Metal server. Do not use this method for detaching IP addresses - * from standard Scaleway resources (e.g. Instances, Load Balancers) as it - * will fail - see the relevant product API for an equivalent method. + * Detach IP from a custom resource. Detach a private IP from a custom resource. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this method for detaching IP addresses from standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method. * * @param request - The request {@link DetachIPRequest} * @returns A Promise of IP @@ -226,12 +210,7 @@ export class API extends ParentAPI { ) /** - * Move IP to a custom resource. Move an existing reserved private IP from one - * custom resource (e.g. a virtual machine hosted on an Elastic Metal server) - * to another custom resource. This will detach it from the first resource, - * and attach it to the second. Do not use this method for moving IP addresses - * between standard Scaleway resources (e.g. Instances, Load Balancers) as it - * will fail - see the relevant product API for an equivalent method. + * Move IP to a custom resource. Move an existing reserved private IP from one custom resource (e.g. a virtual machine hosted on an Elastic Metal server) to another custom resource. This will detach it from the first resource, and attach it to the second. Do not use this method for moving IP addresses between standard Scaleway resources (e.g. Instances, Load Balancers) as it will fail - see the relevant product API for an equivalent method. * * @param request - The request {@link MoveIPRequest} * @returns A Promise of IP diff --git a/packages/clients/src/api/ipam/v1/types.gen.ts b/packages/clients/src/api/ipam/v1/types.gen.ts index ddbf64ca7..c61e67583 100644 --- a/packages/clients/src/api/ipam/v1/types.gen.ts +++ b/packages/clients/src/api/ipam/v1/types.gen.ts @@ -34,23 +34,32 @@ export type ResourceType = | 'serverless_function' export interface Resource { - /** Type of resource the IP is attached to. */ + /** + * Type of resource the IP is attached to. + */ type: ResourceType - /** ID of the resource the IP is attached to. */ + /** + * ID of the resource the IP is attached to. + */ id: string - /** MAC of the resource the IP is attached to. */ + /** + * MAC of the resource the IP is attached to. + */ macAddress?: string /** - * When the IP is in a Private Network, then a DNS record is available to - * resolve the resource name to this IP. + * When the IP is in a Private Network, then a DNS record is available to resolve the resource name to this IP. */ name?: string } export interface Reverse { - /** Reverse domain name. */ + /** + * Reverse domain name. + */ hostname: string - /** IP corresponding to the hostname. */ + /** + * IP corresponding to the hostname. + */ address?: string } @@ -58,218 +67,243 @@ export interface Source { /** * This source is global. * - * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' - * could be set. + * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set. */ zonal?: string /** * This source is specific. * - * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' - * could be set. + * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set. */ privateNetworkId?: string /** * This source is specific. * - * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' - * could be set. + * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set. */ subnetId?: string } export interface CustomResource { - /** MAC address of the custom resource. */ + /** + * MAC address of the custom resource. + */ macAddress: string /** - * When the resource is in a Private Network, a DNS record is available to - * resolve the resource name. + * When the resource is in a Private Network, a DNS record is available to resolve the resource name. */ name?: string } export interface IP { - /** IP ID. */ + /** + * IP ID. + */ id: string - /** IPv4 or IPv6 address in CIDR notation. */ + /** + * IPv4 or IPv6 address in CIDR notation. + */ address: string - /** Scaleway Project the IP belongs to. */ + /** + * Scaleway Project the IP belongs to. + */ projectId: string - /** Defines whether the IP is an IPv6 (false = IPv4). */ + /** + * Defines whether the IP is an IPv6 (false = IPv4). + */ isIpv6: boolean - /** Date the IP was reserved. */ + /** + * Date the IP was reserved. + */ createdAt?: Date - /** Date the IP was last modified. */ + /** + * Date the IP was last modified. + */ updatedAt?: Date - /** Source pool where the IP was reserved in. */ + /** + * Source pool where the IP was reserved in. + */ source?: Source - /** Resource which the IP is attached to. */ + /** + * Resource which the IP is attached to. + */ resource?: Resource - /** Tags for the IP. */ + /** + * Tags for the IP. + */ tags: string[] - /** Array of reverses associated with the IP. */ + /** + * Array of reverses associated with the IP. + */ reverses: Reverse[] - /** Region of the IP. */ + /** + * Region of the IP. + */ region: ScwRegion - /** Zone of the IP, if zonal. */ + /** + * Zone of the IP, if zonal. + */ zone?: ScwZone } export type AttachIPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP ID. */ + /** + * IP ID. + */ ipId: string - /** Custom resource to be attached to the IP. */ + /** + * Custom resource to be attached to the IP. + */ resource: CustomResource } export type BookIPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** - * When creating an IP in a Private Network, the Project must match the - * Private Network's Project. + * When creating an IP in a Private Network, the Project must match the Private Network's Project. */ projectId?: string /** - * Source in which to reserve the IP. Not all sources are available for - * reservation. + * Source in which to reserve the IP. Not all sources are available for reservation. */ source: Source - /** Request an IPv6 instead of an IPv4. */ + /** + * Request an IPv6 instead of an IPv4. + */ isIpv6: boolean /** - * The requested address should not include the subnet mask (/suffix). Note - * that only the Private Network source allows you to pick a specific IP. If - * the requested IP is already reserved, then the call will fail. + * The requested address should not include the subnet mask (/suffix). Note that only the Private Network source allows you to pick a specific IP. If the requested IP is already reserved, then the call will fail. */ address?: string - /** Tags for the IP. */ + /** + * Tags for the IP. + */ tags?: string[] /** - * Custom resource to attach to the IP being reserved. An example of a custom - * resource is a virtual machine hosted on an Elastic Metal server. Do not use - * this for attaching IP addresses to standard Scaleway resources, as it will - * fail - instead, see the relevant product API for an equivalent method. + * Custom resource to attach to the IP being reserved. An example of a custom resource is a virtual machine hosted on an Elastic Metal server. Do not use this for attaching IP addresses to standard Scaleway resources, as it will fail - instead, see the relevant product API for an equivalent method. */ resource?: CustomResource } export type DetachIPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP ID. */ + /** + * IP ID. + */ ipId: string - /** Custom resource currently attached to the IP. */ + /** + * Custom resource currently attached to the IP. + */ resource: CustomResource } export type GetIPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP ID. */ + /** + * IP ID. + */ ipId: string } export type ListIPsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Sort order of the returned IPs. */ + /** + * Sort order of the returned IPs. + */ orderBy?: ListIPsRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of IPs to return per page. */ + /** + * Maximum number of IPs to return per page. + */ pageSize?: number /** - * Project ID to filter for. Only IPs belonging to this Project will be - * returned. + * Project ID to filter for. Only IPs belonging to this Project will be returned. */ projectId?: string /** - * Zone to filter for. Only IPs that are zonal, and in this zone, will be - * returned. + * Zone to filter for. Only IPs that are zonal, and in this zone, will be returned. * - * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' - * could be set. + * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set. */ zonal?: string /** * Only IPs that are private, and in this Private Network, will be returned. * - * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' - * could be set. + * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set. */ privateNetworkId?: string /** * Only IPs inside this exact subnet will be returned. * - * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' - * could be set. + * One-of ('source'): at most one of 'zonal', 'privateNetworkId', 'subnetId' could be set. */ subnetId?: string - /** Only IPs owned by resources in this VPC will be returned. */ + /** + * Only IPs owned by resources in this VPC will be returned. + */ vpcId?: string - /** Defines whether to filter only for IPs which are attached to a resource. */ + /** + * Defines whether to filter only for IPs which are attached to a resource. + */ attached?: boolean /** - * Attached resource name to filter for, only IPs attached to a resource with - * this string within their name will be returned. + * Attached resource name to filter for, only IPs attached to a resource with this string within their name will be returned. */ resourceName?: string /** - * Resource ID to filter for. Only IPs attached to this resource will be - * returned. + * Resource ID to filter for. Only IPs attached to this resource will be returned. */ resourceId?: string /** - * Resource IDs to filter for. Only IPs attached to at least one of these - * resources will be returned. + * Resource IDs to filter for. Only IPs attached to at least one of these resources will be returned. */ resourceIds?: string[] /** - * Resource type to filter for. Only IPs attached to this type of resource - * will be returned. + * Resource type to filter for. Only IPs attached to this type of resource will be returned. */ resourceType?: ResourceType /** - * Resource types to filter for. Only IPs attached to these types of resources - * will be returned. + * Resource types to filter for. Only IPs attached to these types of resources will be returned. */ resourceTypes?: ResourceType[] /** - * MAC address to filter for. Only IPs attached to a resource with this MAC - * address will be returned. + * MAC address to filter for. Only IPs attached to a resource with this MAC address will be returned. */ macAddress?: string /** - * Tags to filter for, only IPs with one or more matching tags will be - * returned. + * Tags to filter for, only IPs with one or more matching tags will be returned. */ tags?: string[] /** - * Organization ID to filter for. Only IPs belonging to this Organization will - * be returned. + * Organization ID to filter for. Only IPs belonging to this Organization will be returned. */ organizationId?: string - /** Defines whether to filter only for IPv4s or IPv6s. */ + /** + * Defines whether to filter only for IPv4s or IPv6s. + */ isIpv6?: boolean - /** IP IDs to filter for. Only IPs with these UUIDs will be returned. */ + /** + * IP IDs to filter for. Only IPs with these UUIDs will be returned. + */ ipIds?: string[] } @@ -280,32 +314,37 @@ export interface ListIPsResponse { export type MoveIPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP ID. */ + /** + * IP ID. + */ ipId: string - /** Custom resource currently attached to the IP. */ + /** + * Custom resource currently attached to the IP. + */ fromResource: CustomResource - /** Custom resource to be attached to the IP. */ + /** + * Custom resource to be attached to the IP. + */ toResource?: CustomResource } export type ReleaseIPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP ID. */ + /** + * IP ID. + */ ipId: string } export type ReleaseIPSetRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion ipIds?: string[] @@ -313,17 +352,19 @@ export type ReleaseIPSetRequest = { export type UpdateIPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** IP ID. */ + /** + * IP ID. + */ ipId: string - /** Tags for the IP. */ + /** + * Tags for the IP. + */ tags?: string[] /** - * Array of reverse domain names associated with an IP in the subnet of the - * current IP. + * Array of reverse domain names associated with an IP in the subnet of the current IP. */ reverses?: Reverse[] } diff --git a/packages/clients/src/api/jobs/v1alpha1/api.gen.ts b/packages/clients/src/api/jobs/v1alpha1/api.gen.ts index 22c2ee37f..6333acba7 100644 --- a/packages/clients/src/api/jobs/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/jobs/v1alpha1/api.gen.ts @@ -59,8 +59,8 @@ const jsonContentHeaders = { /** * Serverless Jobs API. - * - * This API allows you to manage your Serverless Jobs. + +This API allows you to manage your Serverless Jobs. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -139,8 +139,7 @@ export class API extends ParentAPI { ) /** - * Update an existing job definition associated with the specified unique - * identifier. + * Update an existing job definition associated with the specified unique identifier. * * @param request - The request {@link UpdateJobDefinitionRequest} * @returns A Promise of JobDefinition @@ -170,8 +169,7 @@ export class API extends ParentAPI { }) /** - * Run an existing job definition by its unique identifier. This will create a - * new job run. + * Run an existing job definition by its unique identifier. This will create a new job run. * * @param request - The request {@link StartJobDefinitionRequest} * @returns A Promise of StartJobDefinitionResponse diff --git a/packages/clients/src/api/jobs/v1alpha1/types.gen.ts b/packages/clients/src/api/jobs/v1alpha1/types.gen.ts index d7a83a663..f2144c072 100644 --- a/packages/clients/src/api/jobs/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/jobs/v1alpha1/types.gen.ts @@ -27,11 +27,12 @@ export interface SecretFile { } export interface CronSchedule { - /** UNIX cron schedule to run job (e.g., '* * * * *'). */ + /** + * UNIX cron schedule to run job (e.g., '* * * * *'). + */ schedule: string /** - * Timezone for the cron schedule, in tz database format (e.g., - * 'Europe/Paris'). + * Timezone for the cron schedule, in tz database format (e.g., 'Europe/Paris'). */ timezone: string } @@ -44,18 +45,30 @@ export interface CreateJobDefinitionRequestCronScheduleConfig { export interface CreateJobDefinitionSecretsRequestSecretConfig { secretManagerId: string secretManagerVersion: string - /** One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set. */ + /** + * + * One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set. + */ path?: string - /** One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set. */ + /** + * + * One-of ('pathOrEnvVar'): at most one of 'path', 'envVarName' could be set. + */ envVarName?: string } export interface Secret { - /** UUID of the secret reference within the job. */ + /** + * UUID of the secret reference within the job. + */ secretId: string - /** UUID of the secret in Secret Manager. */ + /** + * UUID of the secret in Secret Manager. + */ secretManagerId: string - /** Version of the secret in Secret Manager. */ + /** + * Version of the secret in Secret Manager. + */ secretManagerVersion: string /** * File secret mounted inside the job. @@ -87,8 +100,7 @@ export interface JobDefinition { cronSchedule?: CronSchedule localStorageCapacity: number /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region: ScwRegion } @@ -110,8 +122,7 @@ export interface JobRun { localStorageCapacity: number startedAt?: Date /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region: ScwRegion } @@ -128,112 +139,143 @@ export interface UpdateJobDefinitionRequestCronScheduleConfig { export type CreateJobDefinitionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the job definition. */ + /** + * Name of the job definition. + */ name?: string - /** CPU limit of the job. */ + /** + * CPU limit of the job. + */ cpuLimit: number - /** Memory limit of the job (in MiB). */ + /** + * Memory limit of the job (in MiB). + */ memoryLimit: number - /** Local storage capacity of the job (in MiB). */ + /** + * Local storage capacity of the job (in MiB). + */ localStorageCapacity?: number - /** Image to use for the job. */ + /** + * Image to use for the job. + */ imageUri: string /** - * Startup command. If empty or not defined, the image's default command is - * used. + * Startup command. If empty or not defined, the image's default command is used. */ command: string - /** UUID of the Scaleway Project containing the job. */ + /** + * UUID of the Scaleway Project containing the job. + */ projectId?: string - /** Environment variables of the job. */ + /** + * Environment variables of the job. + */ environmentVariables?: Record - /** Description of the job. */ + /** + * Description of the job. + */ description: string - /** Timeout of the job in seconds. */ + /** + * Timeout of the job in seconds. + */ jobTimeout?: string - /** Configure a cron for the job. */ + /** + * Configure a cron for the job. + */ cronSchedule?: CreateJobDefinitionRequestCronScheduleConfig } export type CreateJobDefinitionSecretsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition. */ + /** + * UUID of the job definition. + */ jobDefinitionId: string - /** List of secrets to inject into the job. */ + /** + * List of secrets to inject into the job. + */ secrets: CreateJobDefinitionSecretsRequestSecretConfig[] } export interface CreateJobDefinitionSecretsResponse { - /** List of secrets created. */ + /** + * List of secrets created. + */ secrets: Secret[] } export type DeleteJobDefinitionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition to delete. */ + /** + * UUID of the job definition to delete. + */ jobDefinitionId: string } export type DeleteJobDefinitionSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition. */ + /** + * UUID of the job definition. + */ jobDefinitionId: string - /** UUID of the secret reference within the job. */ + /** + * UUID of the secret reference within the job. + */ secretId: string } export type GetJobDefinitionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition to get. */ + /** + * UUID of the job definition to get. + */ jobDefinitionId: string } export type GetJobDefinitionSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition. */ + /** + * UUID of the job definition. + */ jobDefinitionId: string - /** UUID of the secret reference within the job. */ + /** + * UUID of the secret reference within the job. + */ secretId: string } export type GetJobRunRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job run to get. */ + /** + * UUID of the job run to get. + */ jobRunId: string } export type GetJobsLimitsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion } @@ -244,25 +286,29 @@ export interface JobsLimits { export type ListJobDefinitionSecretsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition. */ + /** + * UUID of the job definition. + */ jobDefinitionId: string } export interface ListJobDefinitionSecretsResponse { - /** List of secret references within a job definition. */ + /** + * List of secret references within a job definition. + */ secrets: Secret[] - /** Total count of secret references within a job definition. */ + /** + * Total count of secret references within a job definition. + */ totalCount: number } export type ListJobDefinitionsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion page?: number @@ -279,8 +325,7 @@ export interface ListJobDefinitionsResponse { export type ListJobRunsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion page?: number @@ -299,8 +344,7 @@ export interface ListJobRunsResponse { export type ListJobsResourcesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion } @@ -311,17 +355,24 @@ export interface ListJobsResourcesResponse { export type StartJobDefinitionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition to start. */ + /** + * UUID of the job definition to start. + */ jobDefinitionId: string - /** Contextual startup command for this specific job run. */ + /** + * Contextual startup command for this specific job run. + */ command?: string - /** Contextual environment variables for this specific job run. */ + /** + * Contextual environment variables for this specific job run. + */ environmentVariables?: Record - /** Number of jobs to run. */ + /** + * Number of jobs to run. + */ replicas?: number } @@ -331,65 +382,88 @@ export interface StartJobDefinitionResponse { export type StopJobRunRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job run to stop. */ + /** + * UUID of the job run to stop. + */ jobRunId: string } export type UpdateJobDefinitionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition to update. */ + /** + * UUID of the job definition to update. + */ jobDefinitionId: string - /** Name of the job definition. */ + /** + * Name of the job definition. + */ name?: string - /** CPU limit of the job. */ + /** + * CPU limit of the job. + */ cpuLimit?: number - /** Memory limit of the job (in MiB). */ + /** + * Memory limit of the job (in MiB). + */ memoryLimit?: number - /** Local storage capacity of the job (in MiB). */ + /** + * Local storage capacity of the job (in MiB). + */ localStorageCapacity?: number - /** Image to use for the job. */ + /** + * Image to use for the job. + */ imageUri?: string - /** Startup command. */ + /** + * Startup command. + */ command?: string - /** Environment variables of the job. */ + /** + * Environment variables of the job. + */ environmentVariables?: Record - /** Description of the job. */ + /** + * Description of the job. + */ description?: string - /** Timeout of the job in seconds. */ + /** + * Timeout of the job in seconds. + */ jobTimeout?: string cronSchedule?: UpdateJobDefinitionRequestCronScheduleConfig } export type UpdateJobDefinitionSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the job definition. */ + /** + * UUID of the job definition. + */ jobDefinitionId: string - /** UUID of the secret reference within the job. */ + /** + * UUID of the secret reference within the job. + */ secretId: string - /** Version of the secret in Secret Manager. */ + /** + * Version of the secret in Secret Manager. + */ secretManagerVersion?: string /** - * Path of the secret to mount inside the job (either `path` or `env_var_name` - * must be set). + * Path of the secret to mount inside the job (either `path` or `env_var_name` must be set). * * One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set. */ path?: string /** - * Environment variable name used to expose the secret inside the job (either - * `path` or `env_var_name` must be set). + * Environment variable name used to expose the secret inside the job (either `path` or `env_var_name` must be set). * * One-of ('secretConfig'): at most one of 'path', 'envVarName' could be set. */ diff --git a/packages/clients/src/api/k8s/v1/api.gen.ts b/packages/clients/src/api/k8s/v1/api.gen.ts index 47150407b..913a8996f 100644 --- a/packages/clients/src/api/k8s/v1/api.gen.ts +++ b/packages/clients/src/api/k8s/v1/api.gen.ts @@ -100,8 +100,8 @@ const jsonContentHeaders = { /** * Kubernetes API. - * - * This API allows you to manage Kubernetes Kapsule and Kosmos clusters. + +This API allows you to manage Kubernetes Kapsule and Kosmos clusters. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -202,9 +202,7 @@ export class API extends ParentAPI { ) /** - * Update a Cluster. Update information on a specific Kubernetes cluster. You - * can update details such as its name, description, tags and configuration. - * To upgrade a cluster, you will need to use the dedicated endpoint. + * Update a Cluster. Update information on a specific Kubernetes cluster. You can update details such as its name, description, tags and configuration. To upgrade a cluster, you will need to use the dedicated endpoint. * * @param request - The request {@link UpdateClusterRequest} * @returns A Promise of Cluster @@ -223,9 +221,7 @@ export class API extends ParentAPI { ) /** - * Delete a Cluster. Delete a specific Kubernetes cluster and all its - * associated pools and nodes, and possibly its associated Load Balancers or - * Block Volumes. + * Delete a Cluster. Delete a specific Kubernetes cluster and all its associated pools and nodes, and possibly its associated Load Balancers or Block Volumes. * * @param request - The request {@link DeleteClusterRequest} * @returns A Promise of Cluster @@ -244,8 +240,7 @@ export class API extends ParentAPI { ) /** - * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its - * associated pools to a specific and supported Kubernetes version. + * Upgrade a Cluster. Upgrade a specific Kubernetes cluster and possibly its associated pools to a specific and supported Kubernetes version. * * @param request - The request {@link UpgradeClusterRequest} * @returns A Promise of Cluster @@ -264,9 +259,7 @@ export class API extends ParentAPI { ) /** - * Change the Cluster type. Change the type of a specific Kubernetes cluster. - * To see the possible values you can enter for the `type` field, [list - * available cluster types](#list-available-cluster-types-for-a-cluster). + * Change the Cluster type. Change the type of a specific Kubernetes cluster. To see the possible values you can enter for the `type` field, [list available cluster types](#list-available-cluster-types-for-a-cluster). * * @param request - The request {@link SetClusterTypeRequest} * @returns A Promise of Cluster @@ -285,11 +278,7 @@ export class API extends ParentAPI { ) /** - * List available versions for a Cluster. List the versions that a specific - * Kubernetes cluster is allowed to upgrade to. Results will include every - * patch version greater than the current patch, as well as one minor version - * ahead of the current version. Any upgrade skipping a minor version will not - * work. + * List available versions for a Cluster. List the versions that a specific Kubernetes cluster is allowed to upgrade to. Results will include every patch version greater than the current patch, as well as one minor version ahead of the current version. Any upgrade skipping a minor version will not work. * * @param request - The request {@link ListClusterAvailableVersionsRequest} * @returns A Promise of ListClusterAvailableVersionsResponse @@ -306,8 +295,7 @@ export class API extends ParentAPI { ) /** - * List available cluster types for a cluster. List the cluster types that a - * specific Kubernetes cluster is allowed to switch to. + * List available cluster types for a cluster. List the cluster types that a specific Kubernetes cluster is allowed to switch to. * * @param request - The request {@link ListClusterAvailableTypesRequest} * @returns A Promise of ListClusterAvailableTypesResponse @@ -334,10 +322,7 @@ export class API extends ParentAPI { }) /** - * Reset the admin token of a Cluster. Reset the admin token for a specific - * Kubernetes cluster. This will revoke the old admin token (which will not be - * usable afterwards) and create a new one. Note that you will need to - * download the kubeconfig again to keep interacting with the cluster. + * Reset the admin token of a Cluster. Reset the admin token for a specific Kubernetes cluster. This will revoke the old admin token (which will not be usable afterwards) and create a new one. Note that you will need to download the kubeconfig again to keep interacting with the cluster. * * @param request - The request {@link ResetClusterAdminTokenRequest} */ @@ -350,10 +335,8 @@ export class API extends ParentAPI { }) /** - * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with - * Scaleway Block Storage (SBS) and migrate all existing - * PersistentVolumes/VolumeSnapshotContents to SBS. Make sure to have the - * necessary Quota before running this command. + * Migrate a cluster to SBS CSI. Enable the latest CSI compatible with Scaleway Block Storage (SBS) and migrate all existing PersistentVolumes/VolumeSnapshotContents to SBS. +Make sure to have the necessary Quota before running this command. * * @param request - The request {@link MigrateClusterToSBSCSIRequest} * @returns A Promise of Cluster @@ -465,8 +448,7 @@ export class API extends ParentAPI { ) /** - * List Pools in a Cluster. List all the existing pools for a specific - * Kubernetes cluster. + * List Pools in a Cluster. List all the existing pools for a specific Kubernetes cluster. * * @param request - The request {@link ListPoolsRequest} * @returns A Promise of ListPoolsResponse @@ -475,8 +457,7 @@ export class API extends ParentAPI { enrichForPagination('pools', this.pageOfListPools, request) /** - * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes - * cluster. + * Create a new Pool in a Cluster. Create a new pool in a specific Kubernetes cluster. * * @param request - The request {@link CreatePoolRequest} * @returns A Promise of Pool @@ -495,8 +476,7 @@ export class API extends ParentAPI { ) /** - * Get a Pool in a Cluster. Retrieve details about a specific pool in a - * Kubernetes cluster. + * Get a Pool in a Cluster. Retrieve details about a specific pool in a Kubernetes cluster. * * @param request - The request {@link GetPoolRequest} * @returns A Promise of Pool @@ -531,9 +511,8 @@ export class API extends ParentAPI { ) /** - * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific - * pool. Note that it only works if the targeted version matches the cluster's - * version. This will drain and replace the nodes in that pool. + * Upgrade a Pool in a Cluster. Upgrade the Kubernetes version of a specific pool. Note that it only works if the targeted version matches the cluster's version. +This will drain and replace the nodes in that pool. * * @param request - The request {@link UpgradePoolRequest} * @returns A Promise of Pool @@ -552,9 +531,7 @@ export class API extends ParentAPI { ) /** - * Update a Pool in a Cluster. Update the attributes of a specific pool, such - * as its desired size, autoscaling settings, and tags. To upgrade a pool, you - * will need to use the dedicated endpoint. + * Update a Pool in a Cluster. Update the attributes of a specific pool, such as its desired size, autoscaling settings, and tags. To upgrade a pool, you will need to use the dedicated endpoint. * * @param request - The request {@link UpdatePoolRequest} * @returns A Promise of Pool @@ -573,8 +550,7 @@ export class API extends ParentAPI { ) /** - * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note - * that all the pool's nodes will also be deleted. + * Delete a Pool in a Cluster. Delete a specific pool from a cluster. Note that all the pool's nodes will also be deleted. * * @param request - The request {@link DeletePoolRequest} * @returns A Promise of Pool @@ -589,9 +565,7 @@ export class API extends ParentAPI { ) /** - * Fetch node metadata. Rerieve metadata to instantiate a Kapsule/Kosmos node. - * This method is not intended to be called by end users but rather - * programmatically by the node-installer. + * Fetch node metadata. Rerieve metadata to instantiate a Kapsule/Kosmos node. This method is not intended to be called by end users but rather programmatically by the node-installer. * * @param request - The request {@link GetNodeMetadataRequest} * @returns A Promise of NodeMetadata @@ -606,9 +580,7 @@ export class API extends ParentAPI { ) /** - * Authenticate Kosmos external node. Creates a newer Kosmos node and returns - * its token. This method is not intended to be called by end users but rather - * programmatically by the node-installer. + * Authenticate Kosmos external node. Creates a newer Kosmos node and returns its token. This method is not intended to be called by end users but rather programmatically by the node-installer. * * @param request - The request {@link AuthExternalNodeRequest} * @returns A Promise of ExternalNodeAuth @@ -625,9 +597,7 @@ export class API extends ParentAPI { ) /** - * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is - * not intended to be called by end users but rather programmatically by the - * kapsule-node-agent. + * Create a Kosmos node. Retrieve metadata for a Kosmos node. This method is not intended to be called by end users but rather programmatically by the kapsule-node-agent. * * @param request - The request {@link CreateExternalNodeRequest} * @returns A Promise of ExternalNode @@ -664,8 +634,7 @@ export class API extends ParentAPI { ) /** - * List Nodes in a Cluster. List all the existing nodes for a specific - * Kubernetes cluster. + * List Nodes in a Cluster. List all the existing nodes for a specific Kubernetes cluster. * * @param request - The request {@link ListNodesRequest} * @returns A Promise of ListNodesResponse @@ -709,11 +678,7 @@ export class API extends ParentAPI { ) /** - * Replace a Node in a Cluster. Replace a specific Node. The node will first - * be drained and pods will be rescheduled onto another node. Note that when - * there is not enough space to reschedule all the pods (such as in a one-node - * cluster, or with specific constraints), disruption of your applications may - * occur. + * Replace a Node in a Cluster. Replace a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur. * * @deprecated * @param request - The request {@link ReplaceNodeRequest} @@ -731,11 +696,7 @@ export class API extends ParentAPI { ) /** - * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be - * drained and pods will be rescheduled onto another node. Note that when - * there is not enough space to reschedule all the pods (such as in a one-node - * cluster, or with specific constraints), disruption of your applications may - * occur. + * Reboot a Node in a Cluster. Reboot a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur. * * @param request - The request {@link RebootNodeRequest} * @returns A Promise of Node @@ -752,11 +713,7 @@ export class API extends ParentAPI { ) /** - * Delete a Node in a Cluster. Delete a specific Node. The node will first be - * drained and pods will be rescheduled onto another node. Note that when - * there is not enough space to reschedule all the pods (such as in a one-node - * cluster, or with specific constraints), disruption of your applications may - * occur. + * Delete a Node in a Cluster. Delete a specific Node. The node will first be drained and pods will be rescheduled onto another node. Note that when there is not enough space to reschedule all the pods (such as in a one-node cluster, or with specific constraints), disruption of your applications may occur. * * @param request - The request {@link DeleteNodeRequest} * @returns A Promise of Node @@ -775,8 +732,7 @@ export class API extends ParentAPI { ) /** - * List all available Versions. List all available versions for the creation - * of a new Kubernetes cluster. + * List all available Versions. List all available versions for the creation of a new Kubernetes cluster. * * @param request - The request {@link ListVersionsRequest} * @returns A Promise of ListVersionsResponse @@ -824,8 +780,7 @@ export class API extends ParentAPI { ) /** - * List cluster types. List available cluster types and their technical - * details. + * List cluster types. List available cluster types and their technical details. * * @param request - The request {@link ListClusterTypesRequest} * @returns A Promise of ListClusterTypesResponse diff --git a/packages/clients/src/api/k8s/v1/types.gen.ts b/packages/clients/src/api/k8s/v1/types.gen.ts index 31fb35817..af0951866 100644 --- a/packages/clients/src/api/k8s/v1/types.gen.ts +++ b/packages/clients/src/api/k8s/v1/types.gen.ts @@ -118,9 +118,13 @@ export type PoolVolumeType = export type Runtime = 'unknown_runtime' | 'docker' | 'containerd' | 'crio' export interface MaintenanceWindow { - /** Start time of the two-hour maintenance window. */ + /** + * Start time of the two-hour maintenance window. + */ startHour: number - /** Day of the week for the maintenance window. */ + /** + * Day of the week for the maintenance window. + */ day: MaintenanceWindowDayOfTheWeek } @@ -130,178 +134,196 @@ export interface PoolUpgradePolicy { } export interface CreateClusterRequestPoolConfigUpgradePolicy { - /** The maximum number of nodes that can be not ready at the same time. */ + /** + * The maximum number of nodes that can be not ready at the same time. + */ maxUnavailable?: number - /** The maximum number of nodes to be created during the upgrade. */ + /** + * The maximum number of nodes to be created during the upgrade. + */ maxSurge?: number } export interface ClusterAutoUpgrade { - /** Defines whether auto upgrade is enabled for the cluster. */ + /** + * Defines whether auto upgrade is enabled for the cluster. + */ enabled: boolean - /** Maintenance window of the cluster auto upgrades. */ + /** + * Maintenance window of the cluster auto upgrades. + */ maintenanceWindow?: MaintenanceWindow } export interface ClusterAutoscalerConfig { - /** Disable the cluster autoscaler. */ + /** + * Disable the cluster autoscaler. + */ scaleDownDisabled: boolean - /** How long after scale up the scale down evaluation resumes. */ + /** + * How long after scale up the scale down evaluation resumes. + */ scaleDownDelayAfterAdd: string - /** Type of resource estimator to be used in scale up. */ + /** + * Type of resource estimator to be used in scale up. + */ estimator: AutoscalerEstimator - /** Type of node group expander to be used in scale up. */ + /** + * Type of node group expander to be used in scale up. + */ expander: AutoscalerExpander /** - * Ignore DaemonSet pods when calculating resource utilization for scaling - * down. + * Ignore DaemonSet pods when calculating resource utilization for scaling down. */ ignoreDaemonsetsUtilization: boolean - /** Detect similar node groups and balance the number of nodes between them. */ + /** + * Detect similar node groups and balance the number of nodes between them. + */ balanceSimilarNodeGroups: boolean /** - * Pods with priority below cutoff will be expendable. They can be killed - * without any consideration during scale down and they won't cause scale up. - * Pods with null priority (PodPriority disabled) are non expendable. + * Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff: number - /** How long a node should be unneeded before it is eligible to be scaled down. */ + /** + * How long a node should be unneeded before it is eligible to be scaled down. + */ scaleDownUnneededTime: string /** - * Node utilization level, defined as a sum of requested resources divided by - * capacity, below which a node can be considered for scale down. + * Node utilization level, defined as a sum of requested resources divided by capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold: number /** - * Maximum number of seconds the cluster autoscaler waits for pod termination - * when trying to scale down a node. + * Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. */ maxGracefulTerminationSec: number } export interface ClusterOpenIDConnectConfig { /** - * URL of the provider which allows the API server to discover public signing - * keys. Only URLs using the `https://` scheme are accepted. This is typically - * the provider's discovery URL without a path, for example - * "https://accounts.google.com" or "https://login.salesforce.com". + * URL of the provider which allows the API server to discover public signing keys. Only URLs using the `https://` scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com". */ issuerUrl: string - /** A client ID that all tokens must be issued for. */ + /** + * A client ID that all tokens must be issued for. + */ clientId: string /** - * JWT claim to use as the user name. The default is `sub`, which is expected - * to be the end user's unique identifier. Admins can choose other claims, - * such as `email` or `name`, depending on their provider. However, claims - * other than `email` will be prefixed with the issuer URL to prevent name - * collision. + * JWT claim to use as the user name. The default is `sub`, which is expected to be the end user's unique identifier. Admins can choose other claims, such as `email` or `name`, depending on their provider. However, claims other than `email` will be prefixed with the issuer URL to prevent name collision. */ usernameClaim: string /** - * Prefix prepended to username claims to prevent name collision (such as - * `system:` users). For example, the value `oidc:` will create usernames like - * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a - * value other than `email`, the prefix defaults to `( Issuer URL )#` where `( - * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to - * disable all prefixing. + * Prefix prepended to username claims to prevent name collision (such as `system:` users). For example, the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag is not provided and `username_claim` is a value other than `email`, the prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The value `-` can be used to disable all prefixing. */ usernamePrefix: string - /** JWT claim to use as the user's group. */ + /** + * JWT claim to use as the user's group. + */ groupsClaim: string[] /** - * Prefix prepended to group claims to prevent name collision (such as - * `system:` groups). For example, the value `oidc:` will create group names - * like `oidc:engineering` and `oidc:infra`. + * Prefix prepended to group claims to prevent name collision (such as `system:` groups). For example, the value `oidc:` will create group names like `oidc:engineering` and `oidc:infra`. */ groupsPrefix: string /** - * Multiple key=value pairs describing a required claim in the ID token. If - * set, the claims are verified to be present in the ID token with a matching - * value. + * Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value. */ requiredClaim: string[] } export interface Pool { - /** Pool ID. */ + /** + * Pool ID. + */ id: string - /** Cluster ID of the pool. */ + /** + * Cluster ID of the pool. + */ clusterId: string - /** Date on which the pool was created. */ + /** + * Date on which the pool was created. + */ createdAt?: Date - /** Date on which the pool was last updated. */ + /** + * Date on which the pool was last updated. + */ updatedAt?: Date - /** Pool name. */ + /** + * Pool name. + */ name: string - /** Pool status. */ + /** + * Pool status. + */ status: PoolStatus - /** Pool version. */ + /** + * Pool version. + */ version: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Nodes with - * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). - * 'external' is a special node type used to provision instances from other - * cloud providers in a Kosmos Cluster. + * Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster. */ nodeType: string - /** Defines whether the autoscaling feature is enabled for the pool. */ + /** + * Defines whether the autoscaling feature is enabled for the pool. + */ autoscaling: boolean - /** Size (number of nodes) of the pool. */ + /** + * Size (number of nodes) of the pool. + */ size: number /** - * Defines the minimum size of the pool. Note that this field is only used - * when autoscaling is enabled on the pool. + * Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool. */ minSize: number /** - * Defines the maximum size of the pool. Note that this field is only used - * when autoscaling is enabled on the pool. + * Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool. */ maxSize: number - /** Customization of the container runtime is available for each pool. */ + /** + * Customization of the container runtime is available for each pool. + */ containerRuntime: Runtime - /** Defines whether the autohealing feature is enabled for the pool. */ + /** + * Defines whether the autohealing feature is enabled for the pool. + */ autohealing: boolean /** - * Tags associated with the pool, see [managing - * tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags). + * Tags associated with the pool, see [managing tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags). */ tags: string[] /** - * Placement group ID in which all the nodes of the pool will be created, - * placement groups are limited to 20 instances. + * Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. */ placementGroupId?: string /** - * Kubelet arguments to be used by this pool. Note that this feature is - * experimental. + * Kubelet arguments to be used by this pool. Note that this feature is experimental. */ kubeletArgs: Record - /** Pool upgrade policy. */ + /** + * Pool upgrade policy. + */ upgradePolicy?: PoolUpgradePolicy - /** Zone in which the pool's nodes will be spawned. */ + /** + * Zone in which the pool's nodes will be spawned. + */ zone: ScwZone /** - * - `l_ssd` is a local block storage which means your system is stored locally - * on your node's hypervisor. This type is not available for all node types - * `sbs-5k` is a remote block storage which means your system is stored on a - * centralized and resilient cluster with 5k IOPS limits `sbs-15k` is a - * faster remote block storage which means your system is stored on a - * centralized and resilient cluster with 15k IOPS limits `b_ssd` is the - * legacy remote block storage which means your system is stored on a - * centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` - * instead. + * * `l_ssd` is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types + * `sbs-5k` is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits + * `sbs-15k` is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits + * `b_ssd` is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` instead. */ rootVolumeType: PoolVolumeType - /** System volume disk size. */ + /** + * System volume disk size. + */ rootVolumeSize?: number /** - * Defines if the public IP should be removed from Nodes. To use this feature, - * your Cluster must have an attached Private Network set up with a Public - * Gateway. + * Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway. */ publicIpDisabled: boolean - /** Cluster region of the pool. */ + /** + * Cluster region of the pool. + */ region: ScwRegion } @@ -318,12 +340,16 @@ export interface ACLRuleRequest { * One-of ('allowed'): at most one of 'ip', 'scalewayRanges' could be set. */ scalewayRanges?: boolean - /** Description of the ACL. */ + /** + * Description of the ACL. + */ description: string } export interface ACLRule { - /** ID of the ACL rule. */ + /** + * ID of the ACL rule. + */ id: string /** * IP subnet to allow. @@ -337,161 +363,163 @@ export interface ACLRule { * One-of ('allowed'): at most one of 'ip', 'scalewayRanges' could be set. */ scalewayRanges?: boolean - /** Description of the ACL. */ + /** + * Description of the ACL. + */ description: string } export interface CreateClusterRequestAutoUpgrade { - /** Defines whether auto upgrade is enabled for the cluster. */ + /** + * Defines whether auto upgrade is enabled for the cluster. + */ enable: boolean - /** Maintenance window of the cluster auto upgrades. */ + /** + * Maintenance window of the cluster auto upgrades. + */ maintenanceWindow?: MaintenanceWindow } export interface CreateClusterRequestAutoscalerConfig { - /** Disable the cluster autoscaler. */ + /** + * Disable the cluster autoscaler. + */ scaleDownDisabled?: boolean - /** How long after scale up the scale down evaluation resumes. */ + /** + * How long after scale up the scale down evaluation resumes. + */ scaleDownDelayAfterAdd?: string - /** Type of resource estimator to be used in scale up. */ + /** + * Type of resource estimator to be used in scale up. + */ estimator: AutoscalerEstimator - /** Type of node group expander to be used in scale up. */ + /** + * Type of node group expander to be used in scale up. + */ expander: AutoscalerExpander /** - * Ignore DaemonSet pods when calculating resource utilization for scaling - * down. + * Ignore DaemonSet pods when calculating resource utilization for scaling down. */ ignoreDaemonsetsUtilization?: boolean - /** Detect similar node groups and balance the number of nodes between them. */ + /** + * Detect similar node groups and balance the number of nodes between them. + */ balanceSimilarNodeGroups?: boolean /** - * Pods with priority below cutoff will be expendable. They can be killed - * without any consideration during scale down and they won't cause scale up. - * Pods with null priority (PodPriority disabled) are non expendable. + * Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff?: number - /** How long a node should be unneeded before it is eligible to be scaled down. */ + /** + * How long a node should be unneeded before it is eligible to be scaled down. + */ scaleDownUnneededTime?: string /** - * Node utilization level, defined as a sum of requested resources divided by - * capacity, below which a node can be considered for scale down. + * Node utilization level, defined as a sum of requested resources divided by capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold?: number /** - * Maximum number of seconds the cluster autoscaler waits for pod termination - * when trying to scale down a node. + * Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. */ maxGracefulTerminationSec?: number } export interface CreateClusterRequestOpenIDConnectConfig { /** - * URL of the provider which allows the API server to discover public signing - * keys. Only URLs using the `https://` scheme are accepted. This is typically - * the provider's discovery URL without a path, for example - * "https://accounts.google.com" or "https://login.salesforce.com". + * URL of the provider which allows the API server to discover public signing keys. Only URLs using the `https://` scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com". */ issuerUrl: string - /** A client ID that all tokens must be issued for. */ + /** + * A client ID that all tokens must be issued for. + */ clientId: string /** - * JWT claim to use as the user name. The default is `sub`, which is expected - * to be the end user's unique identifier. Admins can choose other claims, - * such as `email` or `name`, depending on their provider. However, claims - * other than `email` will be prefixed with the issuer URL to prevent name - * collision. + * JWT claim to use as the user name. The default is `sub`, which is expected to be the end user's unique identifier. Admins can choose other claims, such as `email` or `name`, depending on their provider. However, claims other than `email` will be prefixed with the issuer URL to prevent name collision. */ usernameClaim?: string /** - * Prefix prepended to username claims to prevent name collision (such as - * `system:` users). For example, the value `oidc:` will create usernames like - * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a - * value other than `email`, the prefix defaults to `( Issuer URL )#` where `( - * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to - * disable all prefixing. + * Prefix prepended to username claims to prevent name collision (such as `system:` users). For example, the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag is not provided and `username_claim` is a value other than `email`, the prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The value `-` can be used to disable all prefixing. */ usernamePrefix?: string - /** JWT claim to use as the user's group. */ + /** + * JWT claim to use as the user's group. + */ groupsClaim?: string[] /** - * Prefix prepended to group claims to prevent name collision (such as - * `system:` groups). For example, the value `oidc:` will create group names - * like `oidc:engineering` and `oidc:infra`. + * Prefix prepended to group claims to prevent name collision (such as `system:` groups). For example, the value `oidc:` will create group names like `oidc:engineering` and `oidc:infra`. */ groupsPrefix?: string /** - * Multiple key=value pairs describing a required claim in the ID token. If - * set, the claims are verified to be present in the ID token with a matching - * value. + * Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value. */ requiredClaim?: string[] } export interface CreateClusterRequestPoolConfig { - /** Name of the pool. */ + /** + * Name of the pool. + */ name: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Nodes with - * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). - * 'external' is a special node type used to provision instances from other - * cloud providers in a Kosmos Cluster. + * Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster. */ nodeType: string /** - * Placement group ID in which all the nodes of the pool will be created, - * placement groups are limited to 20 instances. + * Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. */ placementGroupId?: string - /** Defines whether the autoscaling feature is enabled for the pool. */ + /** + * Defines whether the autoscaling feature is enabled for the pool. + */ autoscaling: boolean - /** Size (number of nodes) of the pool. */ + /** + * Size (number of nodes) of the pool. + */ size: number /** - * Defines the minimum size of the pool. Note that this field is only used - * when autoscaling is enabled on the pool. + * Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool. */ minSize?: number /** - * Defines the maximum size of the pool. Note that this field is only used - * when autoscaling is enabled on the pool. + * Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool. */ maxSize?: number - /** Customization of the container runtime is available for each pool. */ + /** + * Customization of the container runtime is available for each pool. + */ containerRuntime: Runtime - /** Defines whether the autohealing feature is enabled for the pool. */ + /** + * Defines whether the autohealing feature is enabled for the pool. + */ autohealing: boolean /** - * Tags associated with the pool, see [managing - * tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags). + * Tags associated with the pool, see [managing tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags). */ tags: string[] /** - * Kubelet arguments to be used by this pool. Note that this feature is - * experimental. + * Kubelet arguments to be used by this pool. Note that this feature is experimental. */ kubeletArgs: Record - /** Pool upgrade policy. */ + /** + * Pool upgrade policy. + */ upgradePolicy?: CreateClusterRequestPoolConfigUpgradePolicy - /** Zone in which the pool's nodes will be spawned. */ + /** + * Zone in which the pool's nodes will be spawned. + */ zone: ScwZone /** - * - `l_ssd` is a local block storage which means your system is stored locally - * on your node's hypervisor. This type is not available for all node types - * `sbs-5k` is a remote block storage which means your system is stored on a - * centralized and resilient cluster with 5k IOPS limits `sbs-15k` is a - * faster remote block storage which means your system is stored on a - * centralized and resilient cluster with 15k IOPS limits `b_ssd` is the - * legacy remote block storage which means your system is stored on a - * centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` - * instead. + * * `l_ssd` is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types + * `sbs-5k` is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits + * `sbs-15k` is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits + * `b_ssd` is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` instead. */ rootVolumeType: PoolVolumeType - /** System volume disk size. */ + /** + * System volume disk size. + */ rootVolumeSize?: number /** - * Defines if the public IP should be removed from Nodes. To use this feature, - * your Cluster must have an attached Private Network set up with a Public - * Gateway. + * Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway. */ publicIpDisabled: boolean } @@ -508,152 +536,246 @@ export interface ExternalNodeCoreV1Taint { } export interface ClusterType { - /** Cluster type name. */ + /** + * Cluster type name. + */ name: string - /** Cluster type availability. */ + /** + * Cluster type availability. + */ availability: ClusterTypeAvailability - /** Maximum number of nodes supported by the offer. */ + /** + * Maximum number of nodes supported by the offer. + */ maxNodes: number - /** Time period during which you can no longer switch to a lower offer. */ + /** + * Time period during which you can no longer switch to a lower offer. + */ commitmentDelay?: string - /** Value of the Service Level Agreement of the offer. */ + /** + * Value of the Service Level Agreement of the offer. + */ sla: number - /** Resiliency offered by the offer. */ + /** + * Resiliency offered by the offer. + */ resiliency: ClusterTypeResiliency - /** Max RAM allowed for the control plane. */ + /** + * Max RAM allowed for the control plane. + */ memory: number - /** Returns information if this offer uses dedicated resources. */ + /** + * Returns information if this offer uses dedicated resources. + */ dedicated: boolean /** - * True if the offer allows activation of the audit log functionality. Please - * note that audit logs are sent to Cockpit. + * True if the offer allows activation of the audit log functionality. Please note that audit logs are sent to Cockpit. */ auditLogsSupported: boolean - /** Maximum amount of data that can be stored in etcd for the offer. */ + /** + * Maximum amount of data that can be stored in etcd for the offer. + */ maxEtcdSize: number } export interface Version { - /** Name of the Kubernetes version. */ + /** + * Name of the Kubernetes version. + */ name: string - /** Label of the Kubernetes version. */ + /** + * Label of the Kubernetes version. + */ label: string - /** Region in which this version is available. */ + /** + * Region in which this version is available. + */ region: ScwRegion - /** Supported Container Network Interface (CNI) plugins for this version. */ + /** + * Supported Container Network Interface (CNI) plugins for this version. + */ availableCnis: CNI[] - /** Supported container runtimes for this version. */ + /** + * Supported container runtimes for this version. + */ availableContainerRuntimes: Runtime[] - /** Supported feature gates for this version. */ + /** + * Supported feature gates for this version. + */ availableFeatureGates: string[] - /** Supported admission plugins for this version. */ + /** + * Supported admission plugins for this version. + */ availableAdmissionPlugins: string[] - /** Supported kubelet arguments for this version. */ + /** + * Supported kubelet arguments for this version. + */ availableKubeletArgs: Record } export interface Cluster { - /** Cluster ID. */ + /** + * Cluster ID. + */ id: string - /** Cluster type. */ + /** + * Cluster type. + */ type: string - /** Cluster name. */ + /** + * Cluster name. + */ name: string - /** Status of the cluster. */ + /** + * Status of the cluster. + */ status: ClusterStatus - /** Kubernetes version of the cluster. */ + /** + * Kubernetes version of the cluster. + */ version: string - /** Region in which the cluster is deployed. */ + /** + * Region in which the cluster is deployed. + */ region: ScwRegion - /** ID of the Organization owning the cluster. */ + /** + * ID of the Organization owning the cluster. + */ organizationId: string - /** ID of the Project owning the cluster. */ + /** + * ID of the Project owning the cluster. + */ projectId: string - /** Tags associated with the cluster. */ + /** + * Tags associated with the cluster. + */ tags: string[] - /** Container Network Interface (CNI) plugin running in the cluster. */ + /** + * Container Network Interface (CNI) plugin running in the cluster. + */ cni: CNI - /** Cluster description. */ + /** + * Cluster description. + */ description: string - /** Kubernetes API server URL of the cluster. */ + /** + * Kubernetes API server URL of the cluster. + */ clusterUrl: string - /** Wildcard DNS resolving all the ready cluster nodes. */ + /** + * Wildcard DNS resolving all the ready cluster nodes. + */ dnsWildcard: string - /** Date on which the cluster was created. */ + /** + * Date on which the cluster was created. + */ createdAt?: Date - /** Date on which the cluster was last updated. */ + /** + * Date on which the cluster was last updated. + */ updatedAt?: Date - /** Autoscaler config for the cluster. */ + /** + * Autoscaler config for the cluster. + */ autoscalerConfig?: ClusterAutoscalerConfig - /** Auto upgrade Kubernetes version of the cluster. */ + /** + * Auto upgrade Kubernetes version of the cluster. + */ autoUpgrade?: ClusterAutoUpgrade - /** Defines whether a new Kubernetes version is available. */ + /** + * Defines whether a new Kubernetes version is available. + */ upgradeAvailable: boolean - /** List of enabled feature gates. */ + /** + * List of enabled feature gates. + */ featureGates: string[] - /** List of enabled admission plugins. */ + /** + * List of enabled admission plugins. + */ admissionPlugins: string[] /** - * This configuration enables to update the OpenID Connect configuration of - * the Kubernetes API server. + * This configuration enables to update the OpenID Connect configuration of the Kubernetes API server. */ openIdConnectConfig?: ClusterOpenIDConnectConfig /** - * Additional Subject Alternative Names for the Kubernetes API server - * certificate. + * Additional Subject Alternative Names for the Kubernetes API server certificate. */ apiserverCertSans: string[] - /** Private network ID for internal cluster communication. */ + /** + * Private network ID for internal cluster communication. + */ privateNetworkId?: string - /** Date on which it will be possible to switch to a smaller offer. */ + /** + * Date on which it will be possible to switch to a smaller offer. + */ commitmentEndsAt?: Date /** - * @deprecated Defines whether the SBS-enabled CSI starting from v0.3 is - * installed on the cluster. + * @deprecated Defines whether the SBS-enabled CSI starting from v0.3 is installed on the cluster. */ sbsCsiEnabled?: boolean - /** @deprecated Defines whether ACL is available on the cluster. */ + /** + * @deprecated Defines whether ACL is available on the cluster. + */ aclAvailable?: boolean /** - * IAM group that nodes are members of (this field might be empty during early - * stage of cluster creation). + * IAM group that nodes are members of (this field might be empty during early stage of cluster creation). */ iamNodesGroupId: string } export interface Node { - /** Node ID. */ + /** + * Node ID. + */ id: string - /** Pool ID of the node. */ + /** + * Pool ID of the node. + */ poolId: string - /** Cluster ID of the node. */ + /** + * Cluster ID of the node. + */ clusterId: string /** - * Underlying instance ID. It is prefixed by instance type and location - * information (see - * https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderID). + * Underlying instance ID. It is prefixed by instance type and location information (see https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderID). */ providerId: string - /** Cluster region of the node. */ + /** + * Cluster region of the node. + */ region: ScwRegion - /** Name of the node. */ + /** + * Name of the node. + */ name: string - /** @deprecated Public IPv4 address of the node. */ + /** + * @deprecated Public IPv4 address of the node. + */ publicIpV4?: string - /** @deprecated Public IPv6 address of the node. */ + /** + * @deprecated Public IPv6 address of the node. + */ publicIpV6?: string /** - * @deprecated Conditions of the node. These conditions contain the Node - * Problem Detector conditions, as well as some in house conditions. + * @deprecated Conditions of the node. These conditions contain the Node Problem Detector conditions, as well as some in house conditions. */ conditions?: Record - /** Status of the node. */ + /** + * Status of the node. + */ status: NodeStatus - /** Details of the error, if any occurred when managing the node. */ + /** + * Details of the error, if any occurred when managing the node. + */ errorMessage?: string - /** Date on which the node was created. */ + /** + * Date on which the node was created. + */ createdAt?: Date - /** Date on which the node was last updated. */ + /** + * Date on which the node was last updated. + */ updatedAt?: Date } @@ -664,87 +786,86 @@ export interface NodeMetadataCoreV1Taint { } export interface UpdateClusterRequestAutoUpgrade { - /** Defines whether auto upgrade is enabled for the cluster. */ + /** + * Defines whether auto upgrade is enabled for the cluster. + */ enable?: boolean - /** Maintenance window of the cluster auto upgrades. */ + /** + * Maintenance window of the cluster auto upgrades. + */ maintenanceWindow?: MaintenanceWindow } export interface UpdateClusterRequestAutoscalerConfig { - /** Disable the cluster autoscaler. */ + /** + * Disable the cluster autoscaler. + */ scaleDownDisabled?: boolean - /** How long after scale up the scale down evaluation resumes. */ + /** + * How long after scale up the scale down evaluation resumes. + */ scaleDownDelayAfterAdd?: string - /** Type of resource estimator to be used in scale up. */ + /** + * Type of resource estimator to be used in scale up. + */ estimator: AutoscalerEstimator - /** Type of node group expander to be used in scale up. */ + /** + * Type of node group expander to be used in scale up. + */ expander: AutoscalerExpander /** - * Ignore DaemonSet pods when calculating resource utilization for scaling - * down. + * Ignore DaemonSet pods when calculating resource utilization for scaling down. */ ignoreDaemonsetsUtilization?: boolean - /** Detect similar node groups and balance the number of nodes between them. */ + /** + * Detect similar node groups and balance the number of nodes between them. + */ balanceSimilarNodeGroups?: boolean /** - * Pods with priority below cutoff will be expendable. They can be killed - * without any consideration during scale down and they won't cause scale up. - * Pods with null priority (PodPriority disabled) are non expendable. + * Pods with priority below cutoff will be expendable. They can be killed without any consideration during scale down and they won't cause scale up. Pods with null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff?: number - /** How long a node should be unneeded before it is eligible to be scaled down. */ + /** + * How long a node should be unneeded before it is eligible to be scaled down. + */ scaleDownUnneededTime?: string /** - * Node utilization level, defined as a sum of requested resources divided by - * capacity, below which a node can be considered for scale down. + * Node utilization level, defined as a sum of requested resources divided by capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold?: number /** - * Maximum number of seconds the cluster autoscaler waits for pod termination - * when trying to scale down a node. + * Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. */ maxGracefulTerminationSec?: number } export interface UpdateClusterRequestOpenIDConnectConfig { /** - * URL of the provider which allows the API server to discover public signing - * keys. Only URLs using the `https://` scheme are accepted. This is typically - * the provider's discovery URL without a path, for example - * "https://accounts.google.com" or "https://login.salesforce.com". + * URL of the provider which allows the API server to discover public signing keys. Only URLs using the `https://` scheme are accepted. This is typically the provider's discovery URL without a path, for example "https://accounts.google.com" or "https://login.salesforce.com". */ issuerUrl?: string - /** A client ID that all tokens must be issued for. */ + /** + * A client ID that all tokens must be issued for. + */ clientId?: string /** - * JWT claim to use as the user name. The default is `sub`, which is expected - * to be the end user's unique identifier. Admins can choose other claims, - * such as `email` or `name`, depending on their provider. However, claims - * other than `email` will be prefixed with the issuer URL to prevent name - * collision. + * JWT claim to use as the user name. The default is `sub`, which is expected to be the end user's unique identifier. Admins can choose other claims, such as `email` or `name`, depending on their provider. However, claims other than `email` will be prefixed with the issuer URL to prevent name collision. */ usernameClaim?: string /** - * Prefix prepended to username claims to prevent name collision (such as - * `system:` users). For example, the value `oidc:` will create usernames like - * `oidc:jane.doe`. If this flag is not provided and `username_claim` is a - * value other than `email`, the prefix defaults to `( Issuer URL )#` where `( - * Issuer URL )` is the value of `issuer_url`. The value `-` can be used to - * disable all prefixing. + * Prefix prepended to username claims to prevent name collision (such as `system:` users). For example, the value `oidc:` will create usernames like `oidc:jane.doe`. If this flag is not provided and `username_claim` is a value other than `email`, the prefix defaults to `( Issuer URL )#` where `( Issuer URL )` is the value of `issuer_url`. The value `-` can be used to disable all prefixing. */ usernamePrefix?: string - /** JWT claim to use as the user's group. */ + /** + * JWT claim to use as the user's group. + */ groupsClaim?: string[] /** - * Prefix prepended to group claims to prevent name collision (such as - * `system:` groups). For example, the value `oidc:` will create group names - * like `oidc:engineering` and `oidc:infra`. + * Prefix prepended to group claims to prevent name collision (such as `system:` groups). For example, the value `oidc:` will create group names like `oidc:engineering` and `oidc:infra`. */ groupsPrefix?: string /** - * Multiple key=value pairs describing a required claim in the ID token. If - * set, the claims are verified to be present in the ID token with a matching - * value. + * Multiple key=value pairs describing a required claim in the ID token. If set, the claims are verified to be present in the ID token with a matching value. */ requiredClaim?: string[] } @@ -756,107 +877,115 @@ export interface UpdatePoolRequestUpgradePolicy { export type AddClusterACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster whose ACLs will be added. */ + /** + * ID of the cluster whose ACLs will be added. + */ clusterId: string - /** ACLs to add. */ + /** + * ACLs to add. + */ acls?: ACLRuleRequest[] } export interface AddClusterACLRulesResponse { - /** ACLs that were added. */ + /** + * ACLs that were added. + */ rules: ACLRule[] } export type AuthExternalNodeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Pool the node will be attached to. */ + /** + * Pool the node will be attached to. + */ poolId: string } export type CreateClusterRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** * @deprecated Organization ID in which the cluster will be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Project ID in which the cluster will be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string /** - * Type of the cluster. See [list available cluster - * types](#list-available-cluster-types-for-a-cluster) for a list of valid - * types. + * Type of the cluster. See [list available cluster types](#list-available-cluster-types-for-a-cluster) for a list of valid types. */ type: string - /** Cluster name. */ + /** + * Cluster name. + */ name?: string - /** Cluster description. */ + /** + * Cluster description. + */ description: string - /** Tags associated with the cluster. */ + /** + * Tags associated with the cluster. + */ tags?: string[] - /** Kubernetes version of the cluster. */ + /** + * Kubernetes version of the cluster. + */ version: string - /** Container Network Interface (CNI) plugin running in the cluster. */ + /** + * Container Network Interface (CNI) plugin running in the cluster. + */ cni: CNI - /** Pools created along with the cluster. */ + /** + * Pools created along with the cluster. + */ pools?: CreateClusterRequestPoolConfig[] /** - * Autoscaler configuration for the cluster. It allows you to set (to an - * extent) your preferred autoscaler configuration, which is an implementation - * of the cluster-autoscaler - * (https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/). + * Autoscaler configuration for the cluster. It allows you to set (to an extent) your preferred autoscaler configuration, which is an implementation of the cluster-autoscaler (https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/). */ autoscalerConfig?: CreateClusterRequestAutoscalerConfig /** - * Auto upgrade configuration of the cluster. This configuration enables to - * set a specific 2-hour time window in which the cluster can be automatically - * updated to the latest patch version. + * Auto upgrade configuration of the cluster. This configuration enables to set a specific 2-hour time window in which the cluster can be automatically updated to the latest patch version. */ autoUpgrade?: CreateClusterRequestAutoUpgrade - /** List of feature gates to enable. */ + /** + * List of feature gates to enable. + */ featureGates?: string[] - /** List of admission plugins to enable. */ + /** + * List of admission plugins to enable. + */ admissionPlugins?: string[] /** - * OpenID Connect configuration of the cluster. This configuration enables to - * update the OpenID Connect configuration of the Kubernetes API server. + * OpenID Connect configuration of the cluster. This configuration enables to update the OpenID Connect configuration of the Kubernetes API server. */ openIdConnectConfig?: CreateClusterRequestOpenIDConnectConfig /** - * Additional Subject Alternative Names for the Kubernetes API server - * certificate. + * Additional Subject Alternative Names for the Kubernetes API server certificate. */ apiserverCertSans?: string[] /** - * Private network ID for internal cluster communication (cannot be changed - * later). + * Private network ID for internal cluster communication (cannot be changed later). */ privateNetworkId?: string } export type CreateExternalNodeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion poolId: string @@ -864,130 +993,135 @@ export type CreateExternalNodeRequest = { export type CreatePoolRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Cluster ID to which the pool will be attached. */ + /** + * Cluster ID to which the pool will be attached. + */ clusterId: string - /** Pool name. */ + /** + * Pool name. + */ name?: string /** - * Node type is the type of Scaleway Instance wanted for the pool. Nodes with - * insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). - * 'external' is a special node type used to provision instances from other - * cloud providers in a Kosmos Cluster. + * Node type is the type of Scaleway Instance wanted for the pool. Nodes with insufficient memory are not eligible (DEV1-S, PLAY2-PICO, STARDUST). 'external' is a special node type used to provision instances from other cloud providers in a Kosmos Cluster. */ nodeType: string /** - * Placement group ID in which all the nodes of the pool will be created, - * placement groups are limited to 20 instances. + * Placement group ID in which all the nodes of the pool will be created, placement groups are limited to 20 instances. */ placementGroupId?: string - /** Defines whether the autoscaling feature is enabled for the pool. */ + /** + * Defines whether the autoscaling feature is enabled for the pool. + */ autoscaling: boolean - /** Size (number of nodes) of the pool. */ + /** + * Size (number of nodes) of the pool. + */ size: number /** - * Defines the minimum size of the pool. Note that this field is only used - * when autoscaling is enabled on the pool. + * Defines the minimum size of the pool. Note that this field is only used when autoscaling is enabled on the pool. */ minSize?: number /** - * Defines the maximum size of the pool. Note that this field is only used - * when autoscaling is enabled on the pool. + * Defines the maximum size of the pool. Note that this field is only used when autoscaling is enabled on the pool. */ maxSize?: number - /** Customization of the container runtime is available for each pool. */ + /** + * Customization of the container runtime is available for each pool. + */ containerRuntime?: Runtime - /** Defines whether the autohealing feature is enabled for the pool. */ + /** + * Defines whether the autohealing feature is enabled for the pool. + */ autohealing: boolean /** - * Tags associated with the pool, see [managing - * tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags). + * Tags associated with the pool, see [managing tags](https://www.scaleway.com/en/docs/containers/kubernetes/api-cli/managing-tags). */ tags?: string[] /** - * Kubelet arguments to be used by this pool. Note that this feature is - * experimental. + * Kubelet arguments to be used by this pool. Note that this feature is experimental. */ kubeletArgs?: Record - /** Pool upgrade policy. */ + /** + * Pool upgrade policy. + */ upgradePolicy?: CreatePoolRequestUpgradePolicy - /** Zone in which the pool's nodes will be spawned. */ + /** + * Zone in which the pool's nodes will be spawned. + */ zone?: ScwZone /** - * - `l_ssd` is a local block storage which means your system is stored locally - * on your node's hypervisor. This type is not available for all node types - * `sbs-5k` is a remote block storage which means your system is stored on a - * centralized and resilient cluster with 5k IOPS limits `sbs-15k` is a - * faster remote block storage which means your system is stored on a - * centralized and resilient cluster with 15k IOPS limits `b_ssd` is the - * legacy remote block storage which means your system is stored on a - * centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` - * instead. + * * `l_ssd` is a local block storage which means your system is stored locally on your node's hypervisor. This type is not available for all node types + * `sbs-5k` is a remote block storage which means your system is stored on a centralized and resilient cluster with 5k IOPS limits + * `sbs-15k` is a faster remote block storage which means your system is stored on a centralized and resilient cluster with 15k IOPS limits + * `b_ssd` is the legacy remote block storage which means your system is stored on a centralized and resilient cluster. Consider using `sbs-5k` or `sbs-15k` instead. */ rootVolumeType?: PoolVolumeType - /** System volume disk size. */ + /** + * System volume disk size. + */ rootVolumeSize?: number /** - * Defines if the public IP should be removed from Nodes. To use this feature, - * your Cluster must have an attached Private Network set up with a Public - * Gateway. + * Defines if the public IP should be removed from Nodes. To use this feature, your Cluster must have an attached Private Network set up with a Public Gateway. */ publicIpDisabled: boolean } export type DeleteACLRuleRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the ACL rule to delete. */ + /** + * ID of the ACL rule to delete. + */ aclId: string } export type DeleteClusterRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster to delete. */ + /** + * ID of the cluster to delete. + */ clusterId: string /** - * Defines whether all volumes (including retain volume type), empty Private - * Networks and Load Balancers with a name starting with the cluster ID will - * also be deleted. + * Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted. */ withAdditionalResources: boolean } export type DeleteNodeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the node to replace. */ + /** + * ID of the node to replace. + */ nodeId: string /** - * Skip draining node from its workload (Note: this parameter is currently - * inactive). + * Skip draining node from its workload (Note: this parameter is currently inactive). */ skipDrain: boolean - /** Add a new node after the deletion of this node. */ + /** + * Add a new node after the deletion of this node. + */ replace: boolean } export type DeletePoolRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the pool to delete. */ + /** + * ID of the pool to delete. + */ poolId: string } @@ -1015,259 +1149,329 @@ export interface ExternalNodeAuth { export type GetClusterKubeConfigRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Cluster ID for which to download the kubeconfig. */ + /** + * Cluster ID for which to download the kubeconfig. + */ clusterId: string - /** Hide the legacy token from the kubeconfig. */ + /** + * Hide the legacy token from the kubeconfig. + */ redacted?: boolean } export type GetClusterRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the requested cluster. */ + /** + * ID of the requested cluster. + */ clusterId: string } export type GetNodeMetadataRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion } export type GetNodeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the requested node. */ + /** + * ID of the requested node. + */ nodeId: string } export type GetPoolRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the requested pool. */ + /** + * ID of the requested pool. + */ poolId: string } export type GetVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Requested version name. */ + /** + * Requested version name. + */ versionName: string } export type ListClusterACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster whose ACLs will be listed. */ + /** + * ID of the cluster whose ACLs will be listed. + */ clusterId: string - /** Page number for the returned ACLs. */ + /** + * Page number for the returned ACLs. + */ page?: number - /** Maximum number of ACLs per page. */ + /** + * Maximum number of ACLs per page. + */ pageSize?: number } export interface ListClusterACLRulesResponse { - /** Total number of ACLs that exist for the cluster. */ + /** + * Total number of ACLs that exist for the cluster. + */ totalCount: number - /** Paginated returned ACLs. */ + /** + * Paginated returned ACLs. + */ rules: ACLRule[] } export type ListClusterAvailableTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Cluster ID for which the available Kubernetes types will be listed. */ + /** + * Cluster ID for which the available Kubernetes types will be listed. + */ clusterId: string } export interface ListClusterAvailableTypesResponse { - /** Available cluster types for the cluster. */ + /** + * Available cluster types for the cluster. + */ clusterTypes: ClusterType[] - /** Total number of types. */ + /** + * Total number of types. + */ totalCount: number } export type ListClusterAvailableVersionsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Cluster ID for which the available Kubernetes versions will be listed. */ + /** + * Cluster ID for which the available Kubernetes versions will be listed. + */ clusterId: string } export interface ListClusterAvailableVersionsResponse { - /** Available Kubernetes versions for the cluster. */ + /** + * Available Kubernetes versions for the cluster. + */ versions: Version[] } export type ListClusterTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Page number, from the paginated results, to return for cluster-types. */ + /** + * Page number, from the paginated results, to return for cluster-types. + */ page?: number - /** Maximum number of clusters per page. */ + /** + * Maximum number of clusters per page. + */ pageSize?: number } export interface ListClusterTypesResponse { - /** Total number of cluster-types. */ + /** + * Total number of cluster-types. + */ totalCount: number - /** Paginated returned cluster-types. */ + /** + * Paginated returned cluster-types. + */ clusterTypes: ClusterType[] } export type ListClustersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Organization ID on which to filter the returned clusters. */ + /** + * Organization ID on which to filter the returned clusters. + */ organizationId?: string - /** Project ID on which to filter the returned clusters. */ + /** + * Project ID on which to filter the returned clusters. + */ projectId?: string - /** Sort order of returned clusters. */ + /** + * Sort order of returned clusters. + */ orderBy?: ListClustersRequestOrderBy - /** Page number to return for clusters, from the paginated results. */ + /** + * Page number to return for clusters, from the paginated results. + */ page?: number - /** Maximum number of clusters per page. */ + /** + * Maximum number of clusters per page. + */ pageSize?: number /** - * Name to filter on, only clusters containing this substring in their name - * will be returned. + * Name to filter on, only clusters containing this substring in their name will be returned. */ name?: string - /** Status to filter on, only clusters with this status will be returned. */ + /** + * Status to filter on, only clusters with this status will be returned. + */ status?: ClusterStatus - /** Type to filter on, only clusters with this type will be returned. */ + /** + * Type to filter on, only clusters with this type will be returned. + */ type?: string /** - * Private Network ID to filter on, only clusters within this Private Network - * will be returned. + * Private Network ID to filter on, only clusters within this Private Network will be returned. */ privateNetworkId?: string } export interface ListClustersResponse { - /** Total number of clusters. */ + /** + * Total number of clusters. + */ totalCount: number - /** Paginated returned clusters. */ + /** + * Paginated returned clusters. + */ clusters: Cluster[] } export type ListNodesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Cluster ID from which the nodes will be listed from. */ + /** + * Cluster ID from which the nodes will be listed from. + */ clusterId: string - /** Pool ID on which to filter the returned nodes. */ + /** + * Pool ID on which to filter the returned nodes. + */ poolId?: string - /** Sort order of the returned nodes. */ + /** + * Sort order of the returned nodes. + */ orderBy?: ListNodesRequestOrderBy - /** Page number for the returned nodes. */ + /** + * Page number for the returned nodes. + */ page?: number - /** Maximum number of nodes per page. */ + /** + * Maximum number of nodes per page. + */ pageSize?: number /** - * Name to filter on, only nodes containing this substring in their name will - * be returned. + * Name to filter on, only nodes containing this substring in their name will be returned. */ name?: string - /** Status to filter on, only nodes with this status will be returned. */ + /** + * Status to filter on, only nodes with this status will be returned. + */ status?: NodeStatus } export interface ListNodesResponse { - /** Total number of nodes. */ + /** + * Total number of nodes. + */ totalCount: number - /** Paginated returned nodes. */ + /** + * Paginated returned nodes. + */ nodes: Node[] } export type ListPoolsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster whose pools will be listed. */ + /** + * ID of the cluster whose pools will be listed. + */ clusterId: string - /** Sort order of returned pools. */ + /** + * Sort order of returned pools. + */ orderBy?: ListPoolsRequestOrderBy - /** Page number for the returned pools. */ + /** + * Page number for the returned pools. + */ page?: number - /** Maximum number of pools per page. */ + /** + * Maximum number of pools per page. + */ pageSize?: number /** - * Name to filter on, only pools containing this substring in their name will - * be returned. + * Name to filter on, only pools containing this substring in their name will be returned. */ name?: string - /** Status to filter on, only pools with this status will be returned. */ + /** + * Status to filter on, only pools with this status will be returned. + */ status?: PoolStatus } export interface ListPoolsResponse { - /** Total number of pools that exists for the cluster. */ + /** + * Total number of pools that exists for the cluster. + */ totalCount: number - /** Paginated returned pools. */ + /** + * Paginated returned pools. + */ pools: Pool[] } export type ListVersionsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion } export interface ListVersionsResponse { - /** Available Kubernetes versions. */ + /** + * Available Kubernetes versions. + */ versions: Version[] } export type MigrateClusterToSBSCSIRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** - * Cluster ID for which the latest CSI compatible with Scaleway Block Storage - * will be enabled. + * Cluster ID for which the latest CSI compatible with Scaleway Block Storage will be enabled. */ clusterId: string } @@ -1289,161 +1493,194 @@ export interface NodeMetadata { export type RebootNodeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the node to reboot. */ + /** + * ID of the node to reboot. + */ nodeId: string } export type ReplaceNodeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the node to replace. */ + /** + * ID of the node to replace. + */ nodeId: string } export type ResetClusterAdminTokenRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Cluster ID on which the admin token will be renewed. */ + /** + * Cluster ID on which the admin token will be renewed. + */ clusterId: string } export type SetClusterACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster whose ACLs will be set. */ + /** + * ID of the cluster whose ACLs will be set. + */ clusterId: string - /** ACLs to set. */ + /** + * ACLs to set. + */ acls?: ACLRuleRequest[] } export interface SetClusterACLRulesResponse { - /** ACLs that were set. */ + /** + * ACLs that were set. + */ rules: ACLRule[] } export type SetClusterTypeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster to migrate from one type to another. */ + /** + * ID of the cluster to migrate from one type to another. + */ clusterId: string /** - * Type of the cluster. Note that some migrations are not possible (please - * refer to product documentation). + * Type of the cluster. Note that some migrations are not possible (please refer to product documentation). */ type: string } export type UpdateClusterRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster to update. */ + /** + * ID of the cluster to update. + */ clusterId: string - /** New external name for the cluster. */ + /** + * New external name for the cluster. + */ name?: string - /** New description for the cluster. */ + /** + * New description for the cluster. + */ description?: string - /** New tags associated with the cluster. */ + /** + * New tags associated with the cluster. + */ tags?: string[] - /** New autoscaler config for the cluster. */ + /** + * New autoscaler config for the cluster. + */ autoscalerConfig?: UpdateClusterRequestAutoscalerConfig /** - * New auto upgrade configuration for the cluster. Note that all fields needs - * to be set. + * New auto upgrade configuration for the cluster. Note that all fields needs to be set. */ autoUpgrade?: UpdateClusterRequestAutoUpgrade - /** List of feature gates to enable. */ + /** + * List of feature gates to enable. + */ featureGates?: string[] - /** List of admission plugins to enable. */ + /** + * List of admission plugins to enable. + */ admissionPlugins?: string[] /** - * OpenID Connect configuration of the cluster. This configuration enables to - * update the OpenID Connect configuration of the Kubernetes API server. + * OpenID Connect configuration of the cluster. This configuration enables to update the OpenID Connect configuration of the Kubernetes API server. */ openIdConnectConfig?: UpdateClusterRequestOpenIDConnectConfig /** - * Additional Subject Alternative Names for the Kubernetes API server - * certificate. + * Additional Subject Alternative Names for the Kubernetes API server certificate. */ apiserverCertSans?: string[] } export type UpdatePoolRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the pool to update. */ + /** + * ID of the pool to update. + */ poolId: string - /** New value for the pool autoscaling enablement. */ + /** + * New value for the pool autoscaling enablement. + */ autoscaling?: boolean - /** New desired pool size. */ + /** + * New desired pool size. + */ size?: number - /** New minimum size for the pool. */ + /** + * New minimum size for the pool. + */ minSize?: number - /** New maximum size for the pool. */ + /** + * New maximum size for the pool. + */ maxSize?: number - /** New value for the pool autohealing enablement. */ + /** + * New value for the pool autohealing enablement. + */ autohealing?: boolean - /** New tags associated with the pool. */ + /** + * New tags associated with the pool. + */ tags?: string[] /** - * New Kubelet arguments to be used by this pool. Note that this feature is - * experimental. + * New Kubelet arguments to be used by this pool. Note that this feature is experimental. */ kubeletArgs?: Record - /** New upgrade policy for the pool. */ + /** + * New upgrade policy for the pool. + */ upgradePolicy?: UpdatePoolRequestUpgradePolicy } export type UpgradeClusterRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the cluster to upgrade. */ + /** + * ID of the cluster to upgrade. + */ clusterId: string /** - * New Kubernetes version of the cluster. Note that the version should either - * be a higher patch version of the same minor version or the direct minor - * version after the current one. + * New Kubernetes version of the cluster. Note that the version should either be a higher patch version of the same minor version or the direct minor version after the current one. */ version: string /** - * Defines whether pools will also be upgraded once the control plane is - * upgraded. + * Defines whether pools will also be upgraded once the control plane is upgraded. */ upgradePools: boolean } export type UpgradePoolRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the pool to upgrade. */ + /** + * ID of the pool to upgrade. + */ poolId: string - /** New Kubernetes version for the pool. */ + /** + * New Kubernetes version for the pool. + */ version: string } diff --git a/packages/clients/src/api/key_manager/v1alpha1/api.gen.ts b/packages/clients/src/api/key_manager/v1alpha1/api.gen.ts index 2d254dd1c..da40495e6 100644 --- a/packages/clients/src/api/key_manager/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/key_manager/v1alpha1/api.gen.ts @@ -49,9 +49,8 @@ const jsonContentHeaders = { /** * Key Manager API. - * - * This API allows you to create, manage and use cryptographic keys in a - * centralized and secure service. + +This API allows you to create, manage and use cryptographic keys in a centralized and secure service. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -62,10 +61,7 @@ export class API extends ParentAPI { ] /** - * Create a key. Create a key in a given region specified by the `region` - * parameter. Keys only support symmetric encryption. You can use keys to - * encrypt or decrypt arbitrary payloads, or to generate data encryption keys. - * **Data encryption keys are not stored in Key Manager**. + * Create a key. Create a key in a given region specified by the `region` parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**. * * @param request - The request {@link CreateKeyRequest} * @returns A Promise of Key @@ -84,8 +80,7 @@ export class API extends ParentAPI { ) /** - * Get key metadata. Retrieve metadata for a specified key using the `region` - * and `key_id` parameters. + * Get key metadata. Retrieve metadata for a specified key using the `region` and `key_id` parameters. * * @param request - The request {@link GetKeyRequest} * @returns A Promise of Key @@ -100,8 +95,7 @@ export class API extends ParentAPI { ) /** - * Update a key. Modify a key's metadata including name, description and tags, - * specified by the `key_id` and `region` parameters. + * Update a key. Modify a key's metadata including name, description and tags, specified by the `key_id` and `region` parameters. * * @param request - The request {@link UpdateKeyRequest} * @returns A Promise of Key @@ -120,9 +114,7 @@ export class API extends ParentAPI { ) /** - * Delete a key. Permanently delete a key specified by the `region` and - * `key_id` parameters. This action is irreversible. Any data encrypted with - * this key, including data encryption keys, will no longer be decipherable. + * Delete a key. Permanently delete a key specified by the `region` and `key_id` parameters. This action is irreversible. Any data encrypted with this key, including data encryption keys, will no longer be decipherable. * * @param request - The request {@link DeleteKeyRequest} */ @@ -133,10 +125,7 @@ export class API extends ParentAPI { }) /** - * Rotate a key. Generate a new version of an existing key with new key - * material. Previous key versions remain usable to decrypt previously - * encrypted data, but the key's new version will be used for subsequent - * encryption operations and data key generation. + * Rotate a key. Generate a new version of an existing key with new key material. Previous key versions remain usable to decrypt previously encrypted data, but the key's new version will be used for subsequent encryption operations and data key generation. * * @param request - The request {@link RotateKeyRequest} * @returns A Promise of Key @@ -153,9 +142,7 @@ export class API extends ParentAPI { ) /** - * Apply key protection. Apply protection to a given key specified by the - * `key_id` parameter. Applying key protection means that your key can be used - * and modified, but it cannot be deleted. + * Apply key protection. Apply protection to a given key specified by the `key_id` parameter. Applying key protection means that your key can be used and modified, but it cannot be deleted. * * @param request - The request {@link ProtectKeyRequest} * @returns A Promise of Key @@ -172,9 +159,7 @@ export class API extends ParentAPI { ) /** - * Remove key protection. Remove key protection from a given key specified by - * the `key_id` parameter. Removing key protection means that your key can be - * deleted anytime. + * Remove key protection. Remove key protection from a given key specified by the `key_id` parameter. Removing key protection means that your key can be deleted anytime. * * @param request - The request {@link UnprotectKeyRequest} * @returns A Promise of Key @@ -191,9 +176,7 @@ export class API extends ParentAPI { ) /** - * Enable key. Enable a given key to be used for cryptographic operations. - * Enabling a key allows you to make a disabled key usable again. You must - * specify the `region` and `key_id` parameters. + * Enable key. Enable a given key to be used for cryptographic operations. Enabling a key allows you to make a disabled key usable again. You must specify the `region` and `key_id` parameters. * * @param request - The request {@link EnableKeyRequest} * @returns A Promise of Key @@ -210,9 +193,7 @@ export class API extends ParentAPI { ) /** - * Disable key. Disable a given key, preventing it to be used for - * cryptographic operations. Disabling a key renders it unusable. You must - * specify the `region` and `key_id` parameters. + * Disable key. Disable a given key, preventing it to be used for cryptographic operations. Disabling a key renders it unusable. You must specify the `region` and `key_id` parameters. * * @param request - The request {@link DisableKeyRequest} * @returns A Promise of Key @@ -250,9 +231,7 @@ export class API extends ParentAPI { ) /** - * List keys. Retrieve a list of keys across all Projects in an Organization - * or within a specific Project. You must specify the `region`, and either the - * `organization_id` or the `project_id`. + * List keys. Retrieve a list of keys across all Projects in an Organization or within a specific Project. You must specify the `region`, and either the `organization_id` or the `project_id`. * * @param request - The request {@link ListKeysRequest} * @returns A Promise of ListKeysResponse @@ -261,15 +240,9 @@ export class API extends ParentAPI { enrichForPagination('keys', this.pageOfListKeys, request) /** - * Create a data encryption key. Create a new data encryption key for - * cryptographic operations outside of Key Manager. The data encryption key is - * encrypted and must be decrypted using the key you have created in Key - * Manager. - * - * The data encryption key is returned in plaintext and ciphertext but it - * should only be stored in its encrypted form (ciphertext). Key Manager does - * not store your data encryption key. To retrieve your key's plaintext, use - * the `Decrypt` method with your key's ID and ciphertext. + * Create a data encryption key. Create a new data encryption key for cryptographic operations outside of Key Manager. The data encryption key is encrypted and must be decrypted using the key you have created in Key Manager. + +The data encryption key is returned in plaintext and ciphertext but it should only be stored in its encrypted form (ciphertext). Key Manager does not store your data encryption key. To retrieve your key's plaintext, use the `Decrypt` method with your key's ID and ciphertext. * * @param request - The request {@link GenerateDataKeyRequest} * @returns A Promise of DataKey @@ -288,10 +261,7 @@ export class API extends ParentAPI { ) /** - * Encrypt a payload. Encrypt a payload using an existing key, specified by - * the `key_id` parameter. Only keys with a usage set to - * `symmetric_encryption` are supported by this method. The maximum payload - * size that can be encrypted is 64 KB of plaintext. + * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. Only keys with a usage set to `symmetric_encryption` are supported by this method. The maximum payload size that can be encrypted is 64 KB of plaintext. * * @param request - The request {@link EncryptRequest} * @returns A Promise of EncryptResponse @@ -310,10 +280,7 @@ export class API extends ParentAPI { ) /** - * Decrypt an encrypted payload. Decrypt an encrypted payload using an - * existing key, specified by the `key_id` parameter. The maximum payload size - * that can be decrypted is equivalent to the encrypted output of 64 KB of - * data (around 131 KB). + * Decrypt an encrypted payload. Decrypt an encrypted payload using an existing key, specified by the `key_id` parameter. The maximum payload size that can be decrypted is equivalent to the encrypted output of 64 KB of data (around 131 KB). * * @param request - The request {@link DecryptRequest} * @returns A Promise of DecryptResponse @@ -332,9 +299,7 @@ export class API extends ParentAPI { ) /** - * Import key material. Import externally generated key material into Key - * Manager to derive a new cryptographic key. The key's origin must be - * `external`. + * Import key material. Import externally generated key material into Key Manager to derive a new cryptographic key. The key's origin must be `external`. * * @param request - The request {@link ImportKeyMaterialRequest} * @returns A Promise of Key @@ -353,9 +318,7 @@ export class API extends ParentAPI { ) /** - * Delete key material. Delete previously imported key material. This renders - * the associated cryptographic key unusable for any operation. The key's - * origin must be `external`. + * Delete key material. Delete previously imported key material. This renders the associated cryptographic key unusable for any operation. The key's origin must be `external`. * * @param request - The request {@link DeleteKeyMaterialRequest} */ diff --git a/packages/clients/src/api/key_manager/v1alpha1/types.gen.ts b/packages/clients/src/api/key_manager/v1alpha1/types.gen.ts index 7d57c107d..3cdacb7a8 100644 --- a/packages/clients/src/api/key_manager/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/key_manager/v1alpha1/types.gen.ts @@ -28,18 +28,18 @@ export type ListKeysRequestOrderBy = export interface KeyRotationPolicy { /** - * Time interval between two key rotations. The minimum duration is 24 hours - * and the maximum duration is 1 year (876000 hours). + * Time interval between two key rotations. The minimum duration is 24 hours and the maximum duration is 1 year (876000 hours). */ rotationPeriod?: string - /** Timestamp indicating the next scheduled rotation. */ + /** + * Timestamp indicating the next scheduled rotation. + */ nextRotationAt?: Date } export interface KeyUsage { /** - * See the `Key.Algorithm.SymmetricEncryption` enum for a description of - * values. + * See the `Key.Algorithm.SymmetricEncryption` enum for a description of values. * * One-of ('usage'): at most one of 'symmetricEncryption' could be set. */ @@ -47,303 +47,385 @@ export interface KeyUsage { } export interface Key { - /** ID of the key. */ + /** + * ID of the key. + */ id: string - /** ID of the Project containing the key. */ + /** + * ID of the Project containing the key. + */ projectId: string - /** Name of the key. */ + /** + * Name of the key. + */ name: string /** - * Keys with a usage set to `symmetric_encryption` can encrypt and decrypt - * data using the `AES-256-GCM` key algorithm. Key Manager currently only - * supports `AES-256-GCM`. + * Keys with a usage set to `symmetric_encryption` can encrypt and decrypt data using the `AES-256-GCM` key algorithm. Key Manager currently only supports `AES-256-GCM`. */ usage?: KeyUsage - /** See the `Key.State` enum for a description of possible values. */ + /** + * See the `Key.State` enum for a description of possible values. + */ state: KeyState - /** The rotation count tracks the number of times the key has been rotated. */ + /** + * The rotation count tracks the number of times the key has been rotated. + */ rotationCount: number - /** Key creation date. */ + /** + * Key creation date. + */ createdAt?: Date - /** Key last modification date. */ + /** + * Key last modification date. + */ updatedAt?: Date - /** Returns `true` if key protection is applied to the key. */ + /** + * Returns `true` if key protection is applied to the key. + */ protected: boolean - /** Returns `true` if the key is locked. */ + /** + * Returns `true` if the key is locked. + */ locked: boolean - /** Description of the key. */ + /** + * Description of the key. + */ description?: string - /** List of the key's tags. */ + /** + * List of the key's tags. + */ tags: string[] - /** Key last rotation date. */ + /** + * Key last rotation date. + */ rotatedAt?: Date - /** Key rotation policy. */ + /** + * Key rotation policy. + */ rotationPolicy?: KeyRotationPolicy - /** Refer to the `Key.Origin` enum for a description of values. */ + /** + * Refer to the `Key.Origin` enum for a description of values. + */ origin: KeyOrigin - /** Region where the key is stored. */ + /** + * Region where the key is stored. + */ region: ScwRegion } export type CreateKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project containing the key. */ + /** + * ID of the Project containing the key. + */ projectId?: string - /** (Optional) Name of the key. */ + /** + * (Optional) Name of the key. + */ name?: string /** - * See the `Key.Algorithm.SymmetricEncryption` enum for a description of - * values. + * See the `Key.Algorithm.SymmetricEncryption` enum for a description of values. */ usage?: KeyUsage - /** (Optional) Description of the key. */ + /** + * (Optional) Description of the key. + */ description?: string - /** (Optional) List of the key's tags. */ + /** + * (Optional) List of the key's tags. + */ tags?: string[] - /** If not specified, no rotation policy will be applied to the key. */ + /** + * If not specified, no rotation policy will be applied to the key. + */ rotationPolicy?: KeyRotationPolicy - /** Default value is `false`. */ + /** + * Default value is `false`. + */ unprotected: boolean - /** Refer to the `Key.Origin` enum for a description of values. */ + /** + * Refer to the `Key.Origin` enum for a description of values. + */ origin?: KeyOrigin } export interface DataKey { - /** ID of the data encryption key. */ + /** + * ID of the data encryption key. + */ keyId: string - /** Symmetric encryption algorithm of the data encryption key (`AES-256-GCM`). */ + /** + * Symmetric encryption algorithm of the data encryption key (`AES-256-GCM`). + */ algorithm: DataKeyAlgorithmSymmetricEncryption /** - * Your data encryption key's ciphertext can be stored safely. It can only be - * decrypted through the keys you create in Key Manager, using the relevant - * key ID. + * Your data encryption key's ciphertext can be stored safely. It can only be decrypted through the keys you create in Key Manager, using the relevant key ID. */ ciphertext: string /** - * (Optional) Your data encryption key's plaintext allows you to use the key - * immediately upon creation. It must neither be stored or shared. + * (Optional) Your data encryption key's plaintext allows you to use the key immediately upon creation. It must neither be stored or shared. */ plaintext?: string - /** Data encryption key creation date. */ + /** + * Data encryption key creation date. + */ createdAt?: Date } export type DecryptRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to decrypt. */ + /** + * ID of the key to decrypt. + */ keyId: string - /** Data size must be between 1 and 131071 bytes. */ + /** + * Data size must be between 1 and 131071 bytes. + */ ciphertext: string - /** The additional data must match the value passed in the encryption request. */ + /** + * The additional data must match the value passed in the encryption request. + */ associatedData?: string } export interface DecryptResponse { - /** ID of the key used for decryption. */ + /** + * ID of the key used for decryption. + */ keyId: string - /** Key's decrypted data. */ + /** + * Key's decrypted data. + */ plaintext: string /** - * If the data was already encrypted with the latest key rotation, no output - * will be returned in the response object. + * If the data was already encrypted with the latest key rotation, no output will be returned in the response object. */ ciphertext?: string } export type DeleteKeyMaterialRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key of which to delete the key material. */ + /** + * ID of the key of which to delete the key material. + */ keyId: string } export type DeleteKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to delete. */ + /** + * ID of the key to delete. + */ keyId: string } export type DisableKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to disable. */ + /** + * ID of the key to disable. + */ keyId: string } export type EnableKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to enable. */ + /** + * ID of the key to enable. + */ keyId: string } export type EncryptRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to encrypt. */ + /** + * ID of the key to encrypt. + */ keyId: string - /** Data size must be between 1 and 65535 bytes. */ + /** + * Data size must be between 1 and 65535 bytes. + */ plaintext: string /** - * Additional data which will not be encrypted, but authenticated and appended - * to the encrypted payload. + * Additional data which will not be encrypted, but authenticated and appended to the encrypted payload. */ associatedData?: string } export interface EncryptResponse { - /** ID of the key used for encryption. */ + /** + * ID of the key used for encryption. + */ keyId: string - /** Key's encrypted data. */ + /** + * Key's encrypted data. + */ ciphertext: string } export type GenerateDataKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key. */ + /** + * ID of the key. + */ keyId: string /** - * See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of - * values. + * See the `DataKey.Algorithm.SymmetricEncryption` enum for a description of values. */ algorithm?: DataKeyAlgorithmSymmetricEncryption /** - * Default value is `false`, meaning that the plaintext is returned. Set it to - * `true` if you do not wish the plaintext to be returned in the response - * object. + * Default value is `false`, meaning that the plaintext is returned. +Set it to `true` if you do not wish the plaintext to be returned in the response object. */ withoutPlaintext: boolean } export type GetKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to target. */ + /** + * ID of the key to target. + */ keyId: string } export type ImportKeyMaterialRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** The key's origin must be `external`. */ + /** + * The key's origin must be `external`. + */ keyId: string /** - * The key material The key material is a random sequence of bytes used to - * derive a cryptographic key. + * The key material The key material is a random sequence of bytes used to derive a cryptographic key. */ keyMaterial: string /** - * A salt is random data added to key material to ensure unique derived keys, - * even if the input is similar. It helps strengthen security when the key - * material has low randomness (low entropy). + * A salt is random data added to key material to ensure unique derived keys, even if the input is similar. It helps strengthen security when the key material has low randomness (low entropy). */ salt?: string } export type ListKeysRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** (Optional) Filter by Organization ID. */ + /** + * (Optional) Filter by Organization ID. + */ organizationId?: string - /** (Optional) Filter by Project ID. */ + /** + * (Optional) Filter by Project ID. + */ projectId?: string orderBy?: ListKeysRequestOrderBy page?: number pageSize?: number - /** (Optional) List of tags to filter on. */ + /** + * (Optional) List of tags to filter on. + */ tags?: string[] - /** (Optional) Filter by key name. */ + /** + * (Optional) Filter by key name. + */ name?: string } export interface ListKeysResponse { - /** Single page of keys matching the requested criteria. */ + /** + * Single page of keys matching the requested criteria. + */ keys: Key[] - /** Total count of keys matching the requested criteria. */ + /** + * Total count of keys matching the requested criteria. + */ totalCount: number } export type ProtectKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to apply key protection to. */ + /** + * ID of the key to apply key protection to. + */ keyId: string } export type RotateKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to rotate. */ + /** + * ID of the key to rotate. + */ keyId: string } export type UnprotectKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to remove key protection from. */ + /** + * ID of the key to remove key protection from. + */ keyId: string } export type UpdateKeyRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the key to update. */ + /** + * ID of the key to update. + */ keyId: string - /** (Optional) Updated name of the key. */ + /** + * (Optional) Updated name of the key. + */ name?: string - /** (Optional) Updated description of the key. */ + /** + * (Optional) Updated description of the key. + */ description?: string - /** (Optional) Updated list of the key's tags. */ + /** + * (Optional) Updated list of the key's tags. + */ tags?: string[] - /** If not specified, the key's existing rotation policy applies. */ + /** + * If not specified, the key's existing rotation policy applies. + */ rotationPolicy?: KeyRotationPolicy } diff --git a/packages/clients/src/api/marketplace/v2/api.gen.ts b/packages/clients/src/api/marketplace/v2/api.gen.ts index 6b80a9f17..b9c86ae89 100644 --- a/packages/clients/src/api/marketplace/v2/api.gen.ts +++ b/packages/clients/src/api/marketplace/v2/api.gen.ts @@ -38,9 +38,8 @@ import type { /** * Marketplace API. - * - * This API allows you to find available images for use when launching a - * Scaleway Instance. + +This API allows you to find available images for use when launching a Scaleway Instance. */ export class API extends ParentAPI { protected pageOfListImages = (request: Readonly) => @@ -64,8 +63,7 @@ export class API extends ParentAPI { ) /** - * List marketplace images. List all available images on the marketplace, - * their UUID, CPU architecture and description. + * List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description. * * @param request - The request {@link ListImagesRequest} * @returns A Promise of ListImagesResponse @@ -74,8 +72,7 @@ export class API extends ParentAPI { enrichForPagination('images', this.pageOfListImages, request) /** - * Get a specific marketplace image. Get detailed information about a - * marketplace image, specified by its `image_id` (UUID format). + * Get a specific marketplace image. Get detailed information about a marketplace image, specified by its `image_id` (UUID format). * * @param request - The request {@link GetImageRequest} * @returns A Promise of Image @@ -108,8 +105,7 @@ export class API extends ParentAPI { ) /** - * List versions of an Image. Get a list of all available version of an image, - * specified by its `image_id` (UUID format). + * List versions of an Image. Get a list of all available version of an image, specified by its `image_id` (UUID format). * * @param request - The request {@link ListVersionsRequest} * @returns A Promise of ListVersionsResponse @@ -118,9 +114,7 @@ export class API extends ParentAPI { enrichForPagination('versions', this.pageOfListVersions, request) /** - * Get a specific image version. Get information such as the name, creation - * date, last update and published date for an image version specified by its - * `version_id` (UUID format). + * Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its `version_id` (UUID format). * * @param request - The request {@link GetVersionRequest} * @returns A Promise of Version @@ -163,10 +157,7 @@ export class API extends ParentAPI { ) /** - * List local images from a specific image or version. List information about - * local images in a specific Availability Zone, specified by its `image_id` - * (UUID format), `version_id` (UUID format) or `image_label`. Only one of - * these three parameters may be set. + * List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its `image_id` (UUID format), `version_id` (UUID format) or `image_label`. Only one of these three parameters may be set. * * @param request - The request {@link ListLocalImagesRequest} * @returns A Promise of ListLocalImagesResponse @@ -175,10 +166,7 @@ export class API extends ParentAPI { enrichForPagination('localImages', this.pageOfListLocalImages, request) /** - * Get a specific local image by ID. Get detailed information about a local - * image, including compatible commercial types, supported architecture, - * labels and the Availability Zone of the image, specified by its - * `local_image_id` (UUID format). + * Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its `local_image_id` (UUID format). * * @param request - The request {@link GetLocalImageRequest} * @returns A Promise of LocalImage @@ -211,8 +199,7 @@ export class API extends ParentAPI { ) /** - * List existing image categories. Get a list of all existing categories. The - * output can be paginated. + * List existing image categories. Get a list of all existing categories. The output can be paginated. * * @param request - The request {@link ListCategoriesRequest} * @returns A Promise of ListCategoriesResponse @@ -221,8 +208,7 @@ export class API extends ParentAPI { enrichForPagination('categories', this.pageOfListCategories, request) /** - * Get a specific category. Get information about a specific category of the - * marketplace catalog, specified by its `category_id` (UUID format). + * Get a specific category. Get information about a specific category of the marketplace catalog, specified by its `category_id` (UUID format). * * @param request - The request {@link GetCategoryRequest} * @returns A Promise of Category diff --git a/packages/clients/src/api/marketplace/v2/types.gen.ts b/packages/clients/src/api/marketplace/v2/types.gen.ts index 8c11b7a1a..d9d42ed61 100644 --- a/packages/clients/src/api/marketplace/v2/types.gen.ts +++ b/packages/clients/src/api/marketplace/v2/types.gen.ts @@ -27,54 +27,92 @@ export interface Category { } export interface Image { - /** UUID of this image. */ + /** + * UUID of this image. + */ id: string - /** Name of the image. */ + /** + * Name of the image. + */ name: string - /** Text description of this image. */ + /** + * Text description of this image. + */ description: string - /** URL of this image's logo. */ + /** + * URL of this image's logo. + */ logo: string - /** List of categories this image belongs to. */ + /** + * List of categories this image belongs to. + */ categories: string[] - /** Creation date of this image. */ + /** + * Creation date of this image. + */ createdAt?: Date - /** Date of the last modification of this image. */ + /** + * Date of the last modification of this image. + */ updatedAt?: Date - /** Expiration date of this image. */ + /** + * Expiration date of this image. + */ validUntil?: Date /** - * Typically an identifier for a distribution (ex. "ubuntu_focal"). This label - * can be used in the image field of the server creation request. + * Typically an identifier for a distribution (ex. "ubuntu_focal"). +This label can be used in the image field of the server creation request. */ label: string } export interface LocalImage { - /** Version you will typically use to define an image in an API call. */ + /** + * Version you will typically use to define an image in an API call. + */ id: string - /** List of all commercial types that are compatible with this local image. */ + /** + * List of all commercial types that are compatible with this local image. + */ compatibleCommercialTypes: string[] - /** Supported architecture for this local image. */ + /** + * Supported architecture for this local image. + */ arch: string - /** Availability Zone where this local image is available. */ + /** + * Availability Zone where this local image is available. + */ zone: ScwZone - /** This label can be used in the image field of the server creation request. */ + /** + * This label can be used in the image field of the server creation request. + */ label: string - /** Type of this local image. */ + /** + * Type of this local image. + */ type: LocalImageType } export interface Version { - /** UUID of this version. */ + /** + * UUID of this version. + */ id: string - /** Name of this version. */ + /** + * Name of this version. + */ name: string - /** Creation date of this image version. */ + /** + * Creation date of this image version. + */ createdAt?: Date - /** Date of the last modification of this version. */ + /** + * Date of the last modification of this version. + */ updatedAt?: Date - /** Date this version was officially published. */ + /** + * Date this version was officially published. + */ publishedAt?: Date } @@ -83,7 +121,9 @@ export type GetCategoryRequest = { } export type GetImageRequest = { - /** Display the image name. */ + /** + * Display the image name. + */ imageId: string } @@ -107,19 +147,28 @@ export interface ListCategoriesResponse { export type ListImagesRequest = { /** - * A positive integer lower or equal to 100 to select the number of items to - * display. + * A positive integer lower or equal to 100 to select the number of items to display. */ pageSize?: number - /** A positive integer to choose the page to display. */ + /** + * A positive integer to choose the page to display. + */ page?: number - /** Ordering to use. */ + /** + * Ordering to use. + */ orderBy?: ListImagesRequestOrderBy - /** Choose for which machine architecture to return images. */ + /** + * Choose for which machine architecture to return images. + */ arch?: string - /** Choose the category of images to get. */ + /** + * Choose the category of images to get. + */ category?: string - /** Choose to include end-of-life images. */ + /** + * Choose to include end-of-life images. + */ includeEol: boolean } @@ -130,38 +179,42 @@ export interface ListImagesResponse { export type ListLocalImagesRequest = { /** - * A positive integer lower or equal to 100 to select the number of items to - * display. + * A positive integer lower or equal to 100 to select the number of items to display. */ pageSize?: number - /** A positive integer to choose the page to display. */ + /** + * A positive integer to choose the page to display. + */ page?: number - /** Ordering to use. */ + /** + * Ordering to use. + */ orderBy?: ListLocalImagesRequestOrderBy - /** Filter local images available on this Availability Zone. */ + /** + * Filter local images available on this Availability Zone. + */ zone?: ScwZone /** * Filter by image id. * - * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could - * be set. + * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could be set. */ imageId?: string /** * Filter by version id. * - * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could - * be set. + * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could be set. */ versionId?: string /** * Filter by image label. * - * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could - * be set. + * One-of ('scope'): at most one of 'imageId', 'versionId', 'imageLabel' could be set. */ imageLabel?: string - /** Filter by type. */ + /** + * Filter by type. + */ type?: LocalImageType } diff --git a/packages/clients/src/api/mnq/v1beta1/api.gen.ts b/packages/clients/src/api/mnq/v1beta1/api.gen.ts index 21cf03b28..e984146a9 100644 --- a/packages/clients/src/api/mnq/v1beta1/api.gen.ts +++ b/packages/clients/src/api/mnq/v1beta1/api.gen.ts @@ -74,8 +74,8 @@ const jsonContentHeaders = { /** * NATS API. - * - * This API allows you to manage Scaleway NATS accounts. + +This API allows you to manage Scaleway NATS accounts. */ export class NatsAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -103,10 +103,7 @@ export class NatsAPI extends ParentAPI { ) /** - * Delete a NATS account. Delete a NATS account, specified by its NATS account - * ID. Note that deleting a NATS account is irreversible, and any credentials, - * streams, consumer and stored messages belonging to this NATS account will - * also be deleted. + * Delete a NATS account. Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted. * * @param request - The request {@link NatsApiDeleteNatsAccountRequest} */ @@ -117,8 +114,7 @@ export class NatsAPI extends ParentAPI { }) /** - * Update the name of a NATS account. Update the name of a NATS account, - * specified by its NATS account ID. + * Update the name of a NATS account. Update the name of a NATS account, specified by its NATS account ID. * * @param request - The request {@link NatsApiUpdateNatsAccountRequest} * @returns A Promise of NatsAccount @@ -137,9 +133,7 @@ export class NatsAPI extends ParentAPI { ) /** - * Get a NATS account. Retrieve information about an existing NATS account - * identified by its NATS account ID. Its full details, including name and - * endpoint, are returned in the response. + * Get a NATS account. Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response. * * @param request - The request {@link NatsApiGetNatsAccountRequest} * @returns A Promise of NatsAccount @@ -174,10 +168,7 @@ export class NatsAPI extends ParentAPI { ) /** - * List NATS accounts. List all NATS accounts in the specified region, for a - * Scaleway Organization or Project. By default, the NATS accounts returned in - * the list are ordered by creation date in ascending order, though this can - * be modified via the `order_by` field. + * List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link NatsApiListNatsAccountsRequest} * @returns A Promise of ListNatsAccountsResponse @@ -186,8 +177,7 @@ export class NatsAPI extends ParentAPI { enrichForPagination('natsAccounts', this.pageOfListNatsAccounts, request) /** - * Create NATS credentials. Create a set of credentials for a NATS account, - * specified by its NATS account ID. + * Create NATS credentials. Create a set of credentials for a NATS account, specified by its NATS account ID. * * @param request - The request {@link NatsApiCreateNatsCredentialsRequest} * @returns A Promise of NatsCredentials @@ -211,10 +201,7 @@ export class NatsAPI extends ParentAPI { ) /** - * Delete NATS credentials. Delete a set of credentials, specified by their - * credentials ID. Deleting credentials is irreversible and cannot be undone. - * The credentials can no longer be used to access the NATS account, and - * active connections using this credentials will be closed. + * Delete NATS credentials. Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed. * * @param request - The request {@link NatsApiDeleteNatsCredentialsRequest} */ @@ -227,10 +214,7 @@ export class NatsAPI extends ParentAPI { }) /** - * Get NATS credentials. Retrieve an existing set of credentials, identified - * by the `nats_credentials_id`. The credentials themselves are NOT returned, - * only their metadata (NATS account ID, credentials name, etc), are returned - * in the response. + * Get NATS credentials. Retrieve an existing set of credentials, identified by the `nats_credentials_id`. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response. * * @param request - The request {@link NatsApiGetNatsCredentialsRequest} * @returns A Promise of NatsCredentials @@ -266,10 +250,7 @@ export class NatsAPI extends ParentAPI { ) /** - * List NATS credentials. List existing credentials in the specified NATS - * account. The response contains only the metadata for the credentials, not - * the credentials themselves, which are only returned after a **Create - * Credentials** call. + * List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a **Create Credentials** call. * * @param request - The request {@link NatsApiListNatsCredentialsRequest} * @returns A Promise of ListNatsCredentialsResponse @@ -286,18 +267,15 @@ export class NatsAPI extends ParentAPI { /** * Topics and Events API. - * - * This API allows you to manage your Scaleway Topics and Events. + +This API allows you to manage your Scaleway Topics and Events. */ export class SnsAPI extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: ScwRegion[] = ['fr-par', 'nl-ams'] /** - * Activate Topics and Events. Activate Topics and Events for the specified - * Project ID. Topics and Events must be activated before any usage. - * Activating Topics and Events does not trigger any billing, and you can - * deactivate at any time. + * Activate Topics and Events. Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time. * * @param request - The request {@link SnsApiActivateSnsRequest} * @returns A Promise of SnsInfo @@ -316,9 +294,7 @@ export class SnsAPI extends ParentAPI { ) /** - * Get Topics and Events info. Retrieve the Topics and Events information of - * the specified Project ID. Informations include the activation status and - * the Topics and Events API endpoint URL. + * Get Topics and Events info. Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL. * * @param request - The request {@link SnsApiGetSnsInfoRequest} * @returns A Promise of SnsInfo @@ -337,9 +313,7 @@ export class SnsAPI extends ParentAPI { ) /** - * Deactivate Topics and Events. Deactivate Topics and Events for the - * specified Project ID. You must delete all topics and credentials before - * this call or you need to set the force_delete parameter. + * Deactivate Topics and Events. Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter. * * @param request - The request {@link SnsApiDeactivateSnsRequest} * @returns A Promise of SnsInfo @@ -358,9 +332,7 @@ export class SnsAPI extends ParentAPI { ) /** - * Create Topics and Events credentials. Create a set of credentials for - * Topics and Events, specified by a Project ID. Credentials give the bearer - * access to topics, and the level of permissions can be defined granularly. + * Create Topics and Events credentials. Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly. * * @param request - The request {@link SnsApiCreateSnsCredentialsRequest} * @returns A Promise of SnsCredentials @@ -384,10 +356,7 @@ export class SnsAPI extends ParentAPI { ) /** - * Delete Topics and Events credentials. Delete a set of Topics and Events - * credentials, specified by their credentials ID. Deleting credentials is - * irreversible and cannot be undone. The credentials can then no longer be - * used to access Topics and Events. + * Delete Topics and Events credentials. Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events. * * @param request - The request {@link SnsApiDeleteSnsCredentialsRequest} */ @@ -400,8 +369,7 @@ export class SnsAPI extends ParentAPI { }) /** - * Update Topics and Events credentials. Update a set of Topics and Events - * credentials. You can update the credentials' name, or their permissions. + * Update Topics and Events credentials. Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions. * * @param request - The request {@link SnsApiUpdateSnsCredentialsRequest} * @returns A Promise of SnsCredentials @@ -425,9 +393,7 @@ export class SnsAPI extends ParentAPI { ) /** - * Get Topics and Events credentials. Retrieve an existing set of credentials, - * identified by the `credentials_id`. The credentials themselves, as well as - * their metadata (name, project ID etc), are returned in the response. + * Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. * * @param request - The request {@link SnsApiGetSnsCredentialsRequest} * @returns A Promise of SnsCredentials @@ -462,9 +428,7 @@ export class SnsAPI extends ParentAPI { ) /** - * List Topics and Events credentials. List existing Topics and Events - * credentials in the specified region. The response contains only the - * metadata for the credentials, not the credentials themselves. + * List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. * * @param request - The request {@link SnsApiListSnsCredentialsRequest} * @returns A Promise of ListSnsCredentialsResponse @@ -481,18 +445,15 @@ export class SnsAPI extends ParentAPI { /** * Queues API. - * - * This API allows you to manage your Scaleway Queues. + +This API allows you to manage your Scaleway Queues. */ export class SqsAPI extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: ScwRegion[] = ['fr-par', 'nl-ams'] /** - * Activate Queues. Activate Queues for the specified Project ID. Queues must - * be activated before any usage such as creating credentials and queues. - * Activating Queues does not trigger any billing, and you can deactivate at - * any time. + * Activate Queues. Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time. * * @param request - The request {@link SqsApiActivateSqsRequest} * @returns A Promise of SqsInfo @@ -511,9 +472,7 @@ export class SqsAPI extends ParentAPI { ) /** - * Get Queues info. Retrieve the Queues information of the specified Project - * ID. Informations include the activation status and the Queues API endpoint - * URL. + * Get Queues info. Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL. * * @param request - The request {@link SqsApiGetSqsInfoRequest} * @returns A Promise of SqsInfo @@ -532,9 +491,7 @@ export class SqsAPI extends ParentAPI { ) /** - * Deactivate Queues. Deactivate Queues for the specified Project ID. You must - * delete all queues and credentials before this call or you need to set the - * force_delete parameter. + * Deactivate Queues. Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter. * * @param request - The request {@link SqsApiDeactivateSqsRequest} * @returns A Promise of SqsInfo @@ -553,9 +510,7 @@ export class SqsAPI extends ParentAPI { ) /** - * Create Queues credentials. Create a set of credentials for Queues, - * specified by a Project ID. Credentials give the bearer access to queues, - * and the level of permissions can be defined granularly. + * Create Queues credentials. Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly. * * @param request - The request {@link SqsApiCreateSqsCredentialsRequest} * @returns A Promise of SqsCredentials @@ -579,9 +534,7 @@ export class SqsAPI extends ParentAPI { ) /** - * Delete Queues credentials. Delete a set of Queues credentials, specified by - * their credentials ID. Deleting credentials is irreversible and cannot be - * undone. The credentials can then no longer be used to access Queues. + * Delete Queues credentials. Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues. * * @param request - The request {@link SqsApiDeleteSqsCredentialsRequest} */ @@ -594,8 +547,7 @@ export class SqsAPI extends ParentAPI { }) /** - * Update Queues credentials. Update a set of Queues credentials. You can - * update the credentials' name, or their permissions. + * Update Queues credentials. Update a set of Queues credentials. You can update the credentials' name, or their permissions. * * @param request - The request {@link SqsApiUpdateSqsCredentialsRequest} * @returns A Promise of SqsCredentials @@ -619,9 +571,7 @@ export class SqsAPI extends ParentAPI { ) /** - * Get Queues credentials. Retrieve an existing set of credentials, identified - * by the `credentials_id`. The credentials themselves, as well as their - * metadata (name, project ID etc), are returned in the response. + * Get Queues credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response. * * @param request - The request {@link SqsApiGetSqsCredentialsRequest} * @returns A Promise of SqsCredentials @@ -656,9 +606,7 @@ export class SqsAPI extends ParentAPI { ) /** - * List Queues credentials. List existing Queues credentials in the specified - * region. The response contains only the metadata for the credentials, not - * the credentials themselves. + * List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves. * * @param request - The request {@link SqsApiListSqsCredentialsRequest} * @returns A Promise of ListSqsCredentialsResponse diff --git a/packages/clients/src/api/mnq/v1beta1/types.gen.ts b/packages/clients/src/api/mnq/v1beta1/types.gen.ts index 8260e8768..962db50d8 100644 --- a/packages/clients/src/api/mnq/v1beta1/types.gen.ts +++ b/packages/clients/src/api/mnq/v1beta1/types.gen.ts @@ -39,486 +39,659 @@ export type SnsInfoStatus = 'unknown_status' | 'enabled' | 'disabled' export type SqsInfoStatus = 'unknown_status' | 'enabled' | 'disabled' export interface File { - /** File name. */ + /** + * File name. + */ name: string - /** File content. */ + /** + * File content. + */ content: string } export interface SnsPermissions { /** - * Defines whether the credentials bearer can publish messages to the service - * (publish to Topics and Events topics). + * Defines whether the credentials bearer can publish messages to the service (publish to Topics and Events topics). */ canPublish?: boolean /** - * Defines whether the credentials bearer can receive messages from the - * service (configure subscriptions). + * Defines whether the credentials bearer can receive messages from the service (configure subscriptions). */ canReceive?: boolean /** - * Defines whether the credentials bearer can manage the associated Topics and - * Events topics or subscriptions. + * Defines whether the credentials bearer can manage the associated Topics and Events topics or subscriptions. */ canManage?: boolean } export interface SqsPermissions { /** - * Defines whether the credentials bearer can publish messages to the service - * (send messages to Queues queues). + * Defines whether the credentials bearer can publish messages to the service (send messages to Queues queues). */ canPublish?: boolean /** - * Defines whether the credentials bearer can receive messages from Queues - * queues. + * Defines whether the credentials bearer can receive messages from Queues queues. */ canReceive?: boolean /** - * Defines whether the credentials bearer can manage the associated Queues - * queues. + * Defines whether the credentials bearer can manage the associated Queues queues. */ canManage?: boolean } export interface NatsAccount { - /** NATS account ID. */ + /** + * NATS account ID. + */ id: string - /** NATS account name. */ + /** + * NATS account name. + */ name: string - /** Endpoint of the NATS service for this account. */ + /** + * Endpoint of the NATS service for this account. + */ endpoint: string - /** Project ID of the Project containing the NATS account. */ + /** + * Project ID of the Project containing the NATS account. + */ projectId: string - /** Region where the NATS account is deployed. */ + /** + * Region where the NATS account is deployed. + */ region: ScwRegion - /** NATS account creation date. */ + /** + * NATS account creation date. + */ createdAt?: Date - /** NATS account last modification date. */ + /** + * NATS account last modification date. + */ updatedAt?: Date } export interface NatsCredentials { - /** ID of the credentials. */ + /** + * ID of the credentials. + */ id: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name: string - /** NATS account containing the credentials. */ + /** + * NATS account containing the credentials. + */ natsAccountId: string - /** NATS credentials creation date. */ + /** + * NATS credentials creation date. + */ createdAt?: Date - /** NATS credentials last modification date. */ + /** + * NATS credentials last modification date. + */ updatedAt?: Date /** - * Object containing the credentials file (Only returned by **Create Nats - * Credentials** call). + * Object containing the credentials file (Only returned by **Create Nats Credentials** call). */ credentials?: File - /** Checksum of the credentials file. */ + /** + * Checksum of the credentials file. + */ checksum: string } export interface SnsCredentials { - /** ID of the credentials. */ + /** + * ID of the credentials. + */ id: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name: string - /** Project ID of the Project containing the credentials. */ + /** + * Project ID of the Project containing the credentials. + */ projectId: string - /** Region where the credentials exists. */ + /** + * Region where the credentials exists. + */ region: ScwRegion - /** Credentials creation date. */ + /** + * Credentials creation date. + */ createdAt?: Date - /** Credentials last modification date. */ + /** + * Credentials last modification date. + */ updatedAt?: Date - /** Access key ID. */ + /** + * Access key ID. + */ accessKey: string /** - * Secret key ID (Only returned by **Create Topics and Events Credentials** - * call). + * Secret key ID (Only returned by **Create Topics and Events Credentials** call). */ secretKey: string - /** Checksum of the Secret key. */ + /** + * Checksum of the Secret key. + */ secretChecksum: string - /** Permissions associated with these credentials. */ + /** + * Permissions associated with these credentials. + */ permissions?: SnsPermissions } export interface SqsCredentials { - /** ID of the credentials. */ + /** + * ID of the credentials. + */ id: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name: string - /** Project ID of the Project containing the credentials. */ + /** + * Project ID of the Project containing the credentials. + */ projectId: string - /** Region where the credentials exists. */ + /** + * Region where the credentials exists. + */ region: ScwRegion - /** Credentials creation date. */ + /** + * Credentials creation date. + */ createdAt?: Date - /** Credentials last modification date. */ + /** + * Credentials last modification date. + */ updatedAt?: Date - /** Access key ID. */ + /** + * Access key ID. + */ accessKey: string - /** Secret key ID (Only returned by **Create Queues Credentials** call). */ + /** + * Secret key ID (Only returned by **Create Queues Credentials** call). + */ secretKey: string - /** Checksum of the Secret key. */ + /** + * Checksum of the Secret key. + */ secretChecksum: string - /** Permissions associated with these credentials. */ + /** + * Permissions associated with these credentials. + */ permissions?: SqsPermissions } export interface ListNatsAccountsResponse { - /** Total count of existing NATS accounts (matching any filters specified). */ + /** + * Total count of existing NATS accounts (matching any filters specified). + */ totalCount: number - /** NATS accounts on this page. */ + /** + * NATS accounts on this page. + */ natsAccounts: NatsAccount[] } export interface ListNatsCredentialsResponse { - /** Total count of existing credentials (matching any filters specified). */ + /** + * Total count of existing credentials (matching any filters specified). + */ totalCount: number - /** Credentials on this page. */ + /** + * Credentials on this page. + */ natsCredentials: NatsCredentials[] } export interface ListSnsCredentialsResponse { - /** Total count of existing credentials (matching any filters specified). */ + /** + * Total count of existing credentials (matching any filters specified). + */ totalCount: number - /** Topics and Events credentials on this page. */ + /** + * Topics and Events credentials on this page. + */ snsCredentials: SnsCredentials[] } export interface ListSqsCredentialsResponse { - /** Total count of existing credentials (matching any filters specified). */ + /** + * Total count of existing credentials (matching any filters specified). + */ totalCount: number - /** Queues credentials on this page. */ + /** + * Queues credentials on this page. + */ sqsCredentials: SqsCredentials[] } export type NatsApiCreateNatsAccountRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** NATS account name. */ + /** + * NATS account name. + */ name?: string - /** Project containing the NATS account. */ + /** + * Project containing the NATS account. + */ projectId?: string } export type NatsApiCreateNatsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** NATS account containing the credentials. */ + /** + * NATS account containing the credentials. + */ natsAccountId: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name?: string } export type NatsApiDeleteNatsAccountRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the NATS account to delete. */ + /** + * ID of the NATS account to delete. + */ natsAccountId: string } export type NatsApiDeleteNatsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the credentials to delete. */ + /** + * ID of the credentials to delete. + */ natsCredentialsId: string } export type NatsApiGetNatsAccountRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the NATS account to get. */ + /** + * ID of the NATS account to get. + */ natsAccountId: string } export type NatsApiGetNatsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the credentials to get. */ + /** + * ID of the credentials to get. + */ natsCredentialsId: string } export type NatsApiListNatsAccountsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Include only NATS accounts in this Project. */ + /** + * Include only NATS accounts in this Project. + */ projectId?: string - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of NATS accounts to return per page. */ + /** + * Maximum number of NATS accounts to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListNatsAccountsRequestOrderBy } export type NatsApiListNatsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Include only NATS accounts in this Project. */ + /** + * Include only NATS accounts in this Project. + */ projectId?: string - /** Include only credentials for this NATS account. */ + /** + * Include only credentials for this NATS account. + */ natsAccountId?: string - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of credentials to return per page. */ + /** + * Maximum number of credentials to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListNatsCredentialsRequestOrderBy } export type NatsApiUpdateNatsAccountRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the NATS account to update. */ + /** + * ID of the NATS account to update. + */ natsAccountId: string - /** NATS account name. */ + /** + * NATS account name. + */ name?: string } export type SnsApiActivateSnsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project on which to activate the Topics and Events service. */ + /** + * Project on which to activate the Topics and Events service. + */ projectId?: string } export type SnsApiCreateSnsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project containing the Topics and Events credentials. */ + /** + * Project containing the Topics and Events credentials. + */ projectId?: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name?: string - /** Permissions associated with these credentials. */ + /** + * Permissions associated with these credentials. + */ permissions?: SnsPermissions } export type SnsApiDeactivateSnsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project on which to deactivate the Topics and Events service. */ + /** + * Project on which to deactivate the Topics and Events service. + */ projectId?: string } export type SnsApiDeleteSnsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the credentials to delete. */ + /** + * ID of the credentials to delete. + */ snsCredentialsId: string } export type SnsApiGetSnsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Topics and Events credentials to get. */ + /** + * ID of the Topics and Events credentials to get. + */ snsCredentialsId: string } export type SnsApiGetSnsInfoRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project to retrieve Topics and Events info from. */ + /** + * Project to retrieve Topics and Events info from. + */ projectId?: string } export type SnsApiListSnsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Include only Topics and Events credentials in this Project. */ + /** + * Include only Topics and Events credentials in this Project. + */ projectId?: string - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of credentials to return per page. */ + /** + * Maximum number of credentials to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListSnsCredentialsRequestOrderBy } export type SnsApiUpdateSnsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Topics and Events credentials to update. */ + /** + * ID of the Topics and Events credentials to update. + */ snsCredentialsId: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name?: string - /** Permissions associated with these credentials. */ + /** + * Permissions associated with these credentials. + */ permissions?: SnsPermissions } export interface SnsInfo { - /** Project ID of the Project containing the service. */ + /** + * Project ID of the Project containing the service. + */ projectId: string - /** Region of the service. */ + /** + * Region of the service. + */ region: ScwRegion - /** Topics and Events creation date. */ + /** + * Topics and Events creation date. + */ createdAt?: Date - /** Topics and Events last modification date. */ + /** + * Topics and Events last modification date. + */ updatedAt?: Date - /** Topics and Events activation status. */ + /** + * Topics and Events activation status. + */ status: SnsInfoStatus - /** Endpoint of the Topics and Events service for this region and project. */ + /** + * Endpoint of the Topics and Events service for this region and project. + */ snsEndpointUrl: string } export type SqsApiActivateSqsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project on which to activate the Queues service. */ + /** + * Project on which to activate the Queues service. + */ projectId?: string } export type SqsApiCreateSqsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project containing the Queues credentials. */ + /** + * Project containing the Queues credentials. + */ projectId?: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name?: string - /** Permissions associated with these credentials. */ + /** + * Permissions associated with these credentials. + */ permissions?: SqsPermissions } export type SqsApiDeactivateSqsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project on which to deactivate the Queues service. */ + /** + * Project on which to deactivate the Queues service. + */ projectId?: string } export type SqsApiDeleteSqsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the credentials to delete. */ + /** + * ID of the credentials to delete. + */ sqsCredentialsId: string } export type SqsApiGetSqsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Queues credentials to get. */ + /** + * ID of the Queues credentials to get. + */ sqsCredentialsId: string } export type SqsApiGetSqsInfoRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Project to retrieve Queues info from. */ + /** + * Project to retrieve Queues info from. + */ projectId?: string } export type SqsApiListSqsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Include only Queues credentials in this Project. */ + /** + * Include only Queues credentials in this Project. + */ projectId?: string - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Maximum number of credentials to return per page. */ + /** + * Maximum number of credentials to return per page. + */ pageSize?: number - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListSqsCredentialsRequestOrderBy } export type SqsApiUpdateSqsCredentialsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Queues credentials to update. */ + /** + * ID of the Queues credentials to update. + */ sqsCredentialsId: string - /** Name of the credentials. */ + /** + * Name of the credentials. + */ name?: string - /** Permissions associated with these credentials. */ + /** + * Permissions associated with these credentials. + */ permissions?: SqsPermissions } export interface SqsInfo { - /** Project ID of the Project containing the service. */ + /** + * Project ID of the Project containing the service. + */ projectId: string - /** Region of the service. */ + /** + * Region of the service. + */ region: ScwRegion - /** Queues creation date. */ + /** + * Queues creation date. + */ createdAt?: Date - /** Queues last modification date. */ + /** + * Queues last modification date. + */ updatedAt?: Date - /** Queues activation status. */ + /** + * Queues activation status. + */ status: SqsInfoStatus - /** Endpoint of the Queues service for this region and project. */ + /** + * Endpoint of the Queues service for this region and project. + */ sqsEndpointUrl: string } diff --git a/packages/clients/src/api/mongodb/v1alpha1/api.gen.ts b/packages/clients/src/api/mongodb/v1alpha1/api.gen.ts index 013992437..9ab0d099e 100644 --- a/packages/clients/src/api/mongodb/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/mongodb/v1alpha1/api.gen.ts @@ -73,8 +73,8 @@ const jsonContentHeaders = { /** * Managed MongoDB®. - * - * This API allows you to manage your Managed Databases for MongoDB®. + +This API allows you to manage your Managed Databases for MongoDB®. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -160,13 +160,7 @@ export class API extends ParentAPI { ) /** - * List MongoDB® Database Instances. List all MongoDB® Database Instances in - * the specified region. By default, the MongoDB® Database Instances returned - * in the list are ordered by creation date in ascending order, though this - * can be modified via the order_by field. You can define additional - * parameters for your query, such as `tags` and `name`. For the `name` - * parameter, the value you include will be checked against the whole name - * string to see if it includes the string you put in the parameter. + * List MongoDB® Database Instances. List all MongoDB® Database Instances in the specified region. By default, the MongoDB® Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. * * @param request - The request {@link ListInstancesRequest} * @returns A Promise of ListInstancesResponse @@ -175,10 +169,7 @@ export class API extends ParentAPI { enrichForPagination('instances', this.pageOfListInstances, request) /** - * Get a MongoDB® Database Instance. Retrieve information about a given - * MongoDB® Database Instance, specified by the `region` and `instance_id` - * parameters. Its full details, including name, status, IP address and port, - * are returned in the response object. + * Get a MongoDB® Database Instance. Retrieve information about a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. * * @param request - The request {@link GetInstanceRequest} * @returns A Promise of Instance @@ -215,8 +206,7 @@ export class API extends ParentAPI { ) /** - * Create a MongoDB® Database Instance. Create a new MongoDB® Database - * Instance. + * Create a MongoDB® Database Instance. Create a new MongoDB® Database Instance. * * @param request - The request {@link CreateInstanceRequest} * @returns A Promise of Instance @@ -235,8 +225,7 @@ export class API extends ParentAPI { ) /** - * Update a MongoDB® Database Instance. Update the parameters of a MongoDB® - * Database Instance. + * Update a MongoDB® Database Instance. Update the parameters of a MongoDB® Database Instance. * * @param request - The request {@link UpdateInstanceRequest} * @returns A Promise of Instance @@ -255,10 +244,7 @@ export class API extends ParentAPI { ) /** - * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database - * Instance, specified by the `region` and `instance_id` parameters. Deleting - * a MongoDB® Database Instance is permanent, and cannot be undone. Note that - * upon deletion all your data will be lost. + * Delete a MongoDB® Database Instance. Delete a given MongoDB® Database Instance, specified by the `region` and `instance_id` parameters. Deleting a MongoDB® Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. * * @param request - The request {@link DeleteInstanceRequest} * @returns A Promise of Instance @@ -273,8 +259,7 @@ export class API extends ParentAPI { ) /** - * Upgrade a Database Instance. Upgrade your current Database Instance - * specifications like volume size. + * Upgrade a Database Instance. Upgrade your current Database Instance specifications like volume size. * * @param request - The request {@link UpgradeInstanceRequest} * @returns A Promise of Instance @@ -293,8 +278,7 @@ export class API extends ParentAPI { ) /** - * Get the certificate of a Database Instance. Retrieve the certificate of a - * given Database Instance, specified by the `instance_id` parameter. + * Get the certificate of a Database Instance. Retrieve the certificate of a given Database Instance, specified by the `instance_id` parameter. * * @param request - The request {@link GetInstanceCertificateRequest} * @returns A Promise of Blob @@ -308,9 +292,7 @@ export class API extends ParentAPI { }) /** - * Create a Database Instance snapshot. Create a new snapshot of a Database - * Instance. You must define the `name` and `instance_id` parameters in the - * request. + * Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` and `instance_id` parameters in the request. * * @param request - The request {@link CreateSnapshotRequest} * @returns A Promise of Snapshot @@ -329,9 +311,7 @@ export class API extends ParentAPI { ) /** - * Get a Database Instance snapshot. Retrieve information about a given - * snapshot of a Database Instance. You must specify, in the endpoint, the - * `snapshot_id` parameter of the snapshot you want to retrieve. + * Get a Database Instance snapshot. Retrieve information about a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to retrieve. * * @param request - The request {@link GetSnapshotRequest} * @returns A Promise of Snapshot @@ -368,9 +348,7 @@ export class API extends ParentAPI { ) /** - * Update a Database Instance snapshot. Update the parameters of a snapshot of - * a Database Instance. You can update the `name` and `expires_at` - * parameters. + * Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters. * * @param request - The request {@link UpdateSnapshotRequest} * @returns A Promise of Snapshot @@ -389,11 +367,7 @@ export class API extends ParentAPI { ) /** - * Restore a Database Instance snapshot. Restore a given snapshot of a - * Database Instance. You must specify, in the endpoint, the `snapshot_id` - * parameter of the snapshot you want to restore, the `instance_name` of the - * new Database Instance, `node_type` of the new Database Instance and - * `node_number` of the new Database Instance. + * Restore a Database Instance snapshot. Restore a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to restore, the `instance_name` of the new Database Instance, `node_type` of the new Database Instance and `node_number` of the new Database Instance. * * @param request - The request {@link RestoreSnapshotRequest} * @returns A Promise of Instance @@ -435,11 +409,7 @@ export class API extends ParentAPI { ) /** - * List snapshots. List snapshots. You can include the `instance_id` or - * `project_id` in your query to get the list of snapshots for specific - * Database Instances and/or Projects. By default, the details returned in the - * list are ordered by creation date in ascending order, though this can be - * modified via the `order_by` field. + * List snapshots. List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListSnapshotsRequest} * @returns A Promise of ListSnapshotsResponse @@ -448,9 +418,7 @@ export class API extends ParentAPI { enrichForPagination('snapshots', this.pageOfListSnapshots, request) /** - * Delete a Database Instance snapshot. Delete a given snapshot of a Database - * Instance. You must specify, in the endpoint, the `snapshot_id` parameter of - * the snapshot you want to delete. + * Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `snapshot_id` parameter of the snapshot you want to delete. * * @param request - The request {@link DeleteSnapshotRequest} * @returns A Promise of Snapshot @@ -483,8 +451,7 @@ export class API extends ParentAPI { ) /** - * List users of a Database Instance. List all users of a given Database - * Instance. + * List users of a Database Instance. List all users of a given Database Instance. * * @param request - The request {@link ListUsersRequest} * @returns A Promise of ListUsersResponse @@ -493,9 +460,7 @@ export class API extends ParentAPI { enrichForPagination('users', this.pageOfListUsers, request) /** - * Create an user on a Database Instance. Create an user on a Database - * Instance. You must define the `name`, `password` of the user and - * `instance_id` parameters in the request. + * Create an user on a Database Instance. Create an user on a Database Instance. You must define the `name`, `password` of the user and `instance_id` parameters in the request. * * @param request - The request {@link CreateUserRequest} * @returns A Promise of User @@ -514,9 +479,7 @@ export class API extends ParentAPI { ) /** - * Update a user on a Database Instance. Update the parameters of a user on a - * Database Instance. You can update the `password` parameter, but you cannot - * change the name of the user. + * Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the `password` parameter, but you cannot change the name of the user. * * @param request - The request {@link UpdateUserRequest} * @returns A Promise of User @@ -535,8 +498,7 @@ export class API extends ParentAPI { ) /** - * Delete a user on a Database Instance. Delete an existing user on a Database - * Instance. + * Delete a user on a Database Instance. Delete an existing user on a Database Instance. * * @param request - The request {@link DeleteUserRequest} */ @@ -562,10 +524,7 @@ export class API extends ParentAPI { ) /** - * Delete a Database Instance endpoint. Delete the endpoint of a Database - * Instance. You must specify the `endpoint_id` parameter of the endpoint you - * want to delete. Note that you might need to update any environment - * configurations that point to the deleted endpoint. + * Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the `endpoint_id` parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint. * * @param request - The request {@link DeleteEndpointRequest} */ @@ -576,9 +535,7 @@ export class API extends ParentAPI { }) /** - * Create a new Instance endpoint. Create a new endpoint for a MongoDB® - * Database Instance. You can add `public_network` or `private_network` - * specifications to the body of the request. + * Create a new Instance endpoint. Create a new endpoint for a MongoDB® Database Instance. You can add `public_network` or `private_network` specifications to the body of the request. * * @param request - The request {@link CreateEndpointRequest} * @returns A Promise of Endpoint diff --git a/packages/clients/src/api/mongodb/v1alpha1/types.gen.ts b/packages/clients/src/api/mongodb/v1alpha1/types.gen.ts index f9f698cc9..93c68dd4a 100644 --- a/packages/clients/src/api/mongodb/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/mongodb/v1alpha1/types.gen.ts @@ -57,29 +57,43 @@ export type UserRoleRole = export type VolumeType = 'unknown_type' | 'sbs_5k' | 'sbs_15k' -/** Private Network details. */ +/** + * Private Network details. + */ export interface EndpointPrivateNetworkDetails { - /** UUID of the Private Network. */ + /** + * UUID of the Private Network. + */ privateNetworkId: string } export interface EndpointPublicDetails {} export interface EndpointSpecPrivateNetworkDetails { - /** UUID of the Private Network. */ + /** + * UUID of the Private Network. + */ privateNetworkId: string } export interface EndpointSpecPublicDetails {} export interface Endpoint { - /** UUID of the endpoint. */ + /** + * UUID of the endpoint. + */ id: string - /** List of IPv4 addresses of the endpoint. */ + /** + * List of IPv4 addresses of the endpoint. + */ ips: string[] - /** List of DNS records of the endpoint. */ + /** + * List of DNS records of the endpoint. + */ dnsRecords: string[] - /** TCP port of the endpoint. */ + /** + * TCP port of the endpoint. + */ port: number /** * Private Network endpoint details. @@ -96,29 +110,47 @@ export interface Endpoint { } export interface InstanceSetting { - /** Name of the settings. */ + /** + * Name of the settings. + */ name: string - /** Value of the settings. */ + /** + * Value of the settings. + */ value: string } export interface Volume { - /** Type of volume where data is stored. */ + /** + * Type of volume where data is stored. + */ type: VolumeType - /** Volume size. */ + /** + * Volume size. + */ size: number } export interface NodeTypeVolumeType { - /** Volume Type. */ + /** + * Volume Type. + */ type: VolumeType - /** The description of the volume. */ + /** + * The description of the volume. + */ description: string - /** Mimimum size required for the volume. */ + /** + * Mimimum size required for the volume. + */ minSize: number - /** Maximum size required for the volume. */ + /** + * Maximum size required for the volume. + */ maxSize: number - /** Minimum increment level for a Block Storage volume size. */ + /** + * Minimum increment level for a Block Storage volume size. + */ chunkSize: number } @@ -128,396 +160,587 @@ export interface SnapshotVolumeType { export interface UserRole { role: UserRoleRole - /** One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. */ + /** + * + * One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. + */ database?: string - /** One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. */ + /** + * + * One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. + */ anyDatabase?: boolean } export interface Setting { - /** Setting name from the database engine. */ + /** + * Setting name from the database engine. + */ name: string - /** Value set when not specified. */ + /** + * Value set when not specified. + */ defaultValue: string - /** Setting can be applied without restarting. */ + /** + * Setting can be applied without restarting. + */ hotConfigurable: boolean - /** Setting description. */ + /** + * Setting description. + */ description: string - /** Setting type. */ + /** + * Setting type. + */ propertyType: SettingPropertyType - /** Setting base unit. */ + /** + * Setting base unit. + */ unit?: string - /** Validation regex for string type settings. */ + /** + * Validation regex for string type settings. + */ stringConstraint?: string - /** Minimum value for int types. */ + /** + * Minimum value for int types. + */ intMin?: number - /** Maximum value for int types. */ + /** + * Maximum value for int types. + */ intMax?: number - /** Minimum value for float types. */ + /** + * Minimum value for float types. + */ floatMin?: number - /** Maximum value for float types. */ + /** + * Maximum value for float types. + */ floatMax?: number } export interface EndpointSpec { - /** One-of ('details'): at most one of 'public', 'privateNetwork' could be set. */ + /** + * + * One-of ('details'): at most one of 'public', 'privateNetwork' could be set. + */ public?: EndpointSpecPublicDetails - /** One-of ('details'): at most one of 'public', 'privateNetwork' could be set. */ + /** + * + * One-of ('details'): at most one of 'public', 'privateNetwork' could be set. + */ privateNetwork?: EndpointSpecPrivateNetworkDetails } export interface CreateInstanceRequestVolumeDetails { - /** Volume size. */ + /** + * Volume size. + */ volumeSize: number - /** Type of volume where data is stored. */ + /** + * Type of volume where data is stored. + */ volumeType: VolumeType } export interface Instance { - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ id: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name: string - /** Project ID the Database Instance belongs to. */ + /** + * Project ID the Database Instance belongs to. + */ projectId: string - /** Status of the Database Instance. */ + /** + * Status of the Database Instance. + */ status: InstanceStatus - /** MongoDB® engine version of the Database Instance. */ + /** + * MongoDB® engine version of the Database Instance. + */ version: string - /** List of tags applied to the Database Instance. */ + /** + * List of tags applied to the Database Instance. + */ tags: string[] - /** Advanced settings of the Database Instance. */ + /** + * Advanced settings of the Database Instance. + */ settings: InstanceSetting[] - /** Number of node in the Database Instance. */ + /** + * Number of node in the Database Instance. + */ nodeNumber: number - /** Node type of the Database Instance. */ + /** + * Node type of the Database Instance. + */ nodeType: string - /** Volumes of the Database Instance. */ + /** + * Volumes of the Database Instance. + */ volume?: Volume - /** List of Database Instance endpoints. */ + /** + * List of Database Instance endpoints. + */ endpoints: Endpoint[] - /** Creation date (must follow the ISO 8601 format). */ + /** + * Creation date (must follow the ISO 8601 format). + */ createdAt?: Date - /** Region the Database Instance is in. */ + /** + * Region the Database Instance is in. + */ region: ScwRegion } export interface NodeType { - /** Node type name identifier. */ + /** + * Node type name identifier. + */ name: string - /** Current stock status for the node type. */ + /** + * Current stock status for the node type. + */ stockStatus: NodeTypeStock - /** Current specs of the offer. */ + /** + * Current specs of the offer. + */ description: string - /** Number of virtual CPUs. */ + /** + * Number of virtual CPUs. + */ vcpus: number - /** Quantity of RAM. */ + /** + * Quantity of RAM. + */ memory: number - /** Available storage options for the node type. */ + /** + * Available storage options for the node type. + */ availableVolumeTypes: NodeTypeVolumeType[] - /** The node type is currently disabled. */ + /** + * The node type is currently disabled. + */ disabled: boolean - /** The node type is currently in beta. */ + /** + * The node type is currently in beta. + */ beta: boolean - /** Instance range associated with the node type offer. */ + /** + * Instance range associated with the node type offer. + */ instanceRange: string } export interface Snapshot { - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ id: string - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** Status of the snapshot. */ + /** + * Status of the snapshot. + */ status: SnapshotStatus - /** Size of the snapshot. */ + /** + * Size of the snapshot. + */ size: number - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date - /** Creation date (must follow the ISO 8601 format). */ + /** + * Creation date (must follow the ISO 8601 format). + */ createdAt?: Date - /** Updated date (must follow the ISO 8601 format). */ + /** + * Updated date (must follow the ISO 8601 format). + */ updatedAt?: Date - /** Name of the Database Instance of the snapshot. */ + /** + * Name of the Database Instance of the snapshot. + */ instanceName: string - /** Source node type. */ + /** + * Source node type. + */ nodeType: string - /** Type of volume where data is stored - sbs_5k or sbs_15k. */ + /** + * Type of volume where data is stored - sbs_5k or sbs_15k. + */ volumeType?: SnapshotVolumeType - /** Region of the snapshot. */ + /** + * Region of the snapshot. + */ region: ScwRegion } export interface User { /** - * Name of the user (Length must be between 1 and 63 characters. First - * character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$- - * characters are accepted). + * Name of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$- characters are accepted). */ name: string /** - * List of roles assigned to the user, along with the corresponding database - * where each role is granted. + * List of roles assigned to the user, along with the corresponding database where each role is granted. */ roles: UserRole[] } export interface Version { - /** MongoDB® engine version. */ + /** + * MongoDB® engine version. + */ version: string - /** Date of End of Life. */ + /** + * Date of End of Life. + */ endOfLifeAt?: Date - /** Instance settings available to be updated. */ + /** + * Instance settings available to be updated. + */ availableSettings: Setting[] } export interface RestoreSnapshotRequestVolumeDetails { - /** Type of volume where data is stored. */ + /** + * Type of volume where data is stored. + */ volumeType: VolumeType } export type CreateEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** EndpointSpec used to expose your Database Instance. */ + /** + * EndpointSpec used to expose your Database Instance. + */ endpoint: EndpointSpec } export type CreateInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** The Project ID on which the Database Instance will be created. */ + /** + * The Project ID on which the Database Instance will be created. + */ projectId?: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name?: string - /** Version of the MongoDB® engine. */ + /** + * Version of the MongoDB® engine. + */ version: string - /** Tags to apply to the Database Instance. */ + /** + * Tags to apply to the Database Instance. + */ tags?: string[] - /** Number of node to use for the Database Instance. */ + /** + * Number of node to use for the Database Instance. + */ nodeNumber: number - /** Type of node to use for the Database Instance. */ + /** + * Type of node to use for the Database Instance. + */ nodeType: string - /** Username created when the Database Instance is created. */ + /** + * Username created when the Database Instance is created. + */ userName: string - /** Password of the initial user. */ + /** + * Password of the initial user. + */ password: string - /** Instance volume information. */ + /** + * Instance volume information. + */ volume?: CreateInstanceRequestVolumeDetails - /** One or multiple EndpointSpec used to expose your Database Instance. */ + /** + * One or multiple EndpointSpec used to expose your Database Instance. + */ endpoints?: EndpointSpec[] } export type CreateSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to snapshot. */ + /** + * UUID of the Database Instance to snapshot. + */ instanceId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** Expiration date of the snapshot (must follow the ISO 8601 format). */ + /** + * Expiration date of the snapshot (must follow the ISO 8601 format). + */ expiresAt?: Date } export type CreateUserRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance the user belongs to. */ + /** + * UUID of the Database Instance the user belongs to. + */ instanceId: string - /** Name of the database user. */ + /** + * Name of the database user. + */ name: string - /** Password of the database user. */ + /** + * Password of the database user. + */ password: string } export type DeleteEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Endpoint to delete. */ + /** + * UUID of the Endpoint to delete. + */ endpointId: string } export type DeleteInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to delete. */ + /** + * UUID of the Database Instance to delete. + */ instanceId: string } export type DeleteSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string } export type DeleteUserRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance the user belongs to. */ + /** + * UUID of the Database Instance the user belongs to. + */ instanceId: string - /** Name of the database user. */ + /** + * Name of the database user. + */ name: string } export type GetInstanceCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string } export type GetInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string } export type GetSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string } export type ListInstancesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** List Database Instances that have a given tag. */ + /** + * List Database Instances that have a given tag. + */ tags?: string[] - /** Lists Database Instances that match a name pattern. */ + /** + * Lists Database Instances that match a name pattern. + */ name?: string - /** Criteria to use when ordering Database Instance listings. */ + /** + * Criteria to use when ordering Database Instance listings. + */ orderBy?: ListInstancesRequestOrderBy - /** Organization ID of the Database Instance. */ + /** + * Organization ID of the Database Instance. + */ organizationId?: string - /** Project ID. */ + /** + * Project ID. + */ projectId?: string page?: number pageSize?: number } export interface ListInstancesResponse { - /** List of all Database Instances available in an Organization or Project. */ + /** + * List of all Database Instances available in an Organization or Project. + */ instances: Instance[] - /** Total count of Database Instances available in an Organization or Project. */ + /** + * Total count of Database Instances available in an Organization or Project. + */ totalCount: number } export type ListNodeTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Defines whether or not to include disabled types. */ + /** + * Defines whether or not to include disabled types. + */ includeDisabledTypes?: boolean page?: number pageSize?: number } export interface ListNodeTypesResponse { - /** Types of the node. */ + /** + * Types of the node. + */ nodeTypes: NodeType[] - /** Total count of node-types available. */ + /** + * Total count of node-types available. + */ totalCount: number } export type ListSnapshotsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Instance ID the snapshots belongs to. */ + /** + * Instance ID the snapshots belongs to. + */ instanceId?: string - /** Lists database snapshots that match a name pattern. */ + /** + * Lists database snapshots that match a name pattern. + */ name?: string - /** Criteria to use when ordering snapshot listings. */ + /** + * Criteria to use when ordering snapshot listings. + */ orderBy?: ListSnapshotsRequestOrderBy - /** Organization ID the snapshots belongs to. */ + /** + * Organization ID the snapshots belongs to. + */ organizationId?: string - /** Project ID to list the snapshots of. */ + /** + * Project ID to list the snapshots of. + */ projectId?: string page?: number pageSize?: number } export interface ListSnapshotsResponse { - /** List of all database snapshots available in an Organization or Project. */ + /** + * List of all database snapshots available in an Organization or Project. + */ snapshots: Snapshot[] - /** Total count of database snapshots available in a Organization or Project. */ + /** + * Total count of database snapshots available in a Organization or Project. + */ totalCount: number } export type ListUsersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of the user. */ + /** + * Name of the user. + */ name?: string - /** Criteria to use when requesting user listing. */ + /** + * Criteria to use when requesting user listing. + */ orderBy?: ListUsersRequestOrderBy page?: number pageSize?: number } export interface ListUsersResponse { - /** List of users in a Database Instance. */ + /** + * List of users in a Database Instance. + */ users: User[] - /** Total count of users present on a Database Instance. */ + /** + * Total count of users present on a Database Instance. + */ totalCount: number } export type ListVersionsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion version?: string @@ -526,96 +749,127 @@ export type ListVersionsRequest = { } export interface ListVersionsResponse { - /** Available MongoDB® engine version. */ + /** + * Available MongoDB® engine version. + */ versions: Version[] - /** Total count of MongoDB® engine version available. */ + /** + * Total count of MongoDB® engine version available. + */ totalCount: number } export type RestoreSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string - /** Name of the new Database Instance. */ + /** + * Name of the new Database Instance. + */ instanceName: string - /** Node type to use for the new Database Instance. */ + /** + * Node type to use for the new Database Instance. + */ nodeType: string - /** Number of nodes to use for the new Database Instance. */ + /** + * Number of nodes to use for the new Database Instance. + */ nodeNumber: number - /** Instance volume information. */ + /** + * Instance volume information. + */ volume: RestoreSnapshotRequestVolumeDetails } export type SetUserRoleRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance the user belongs to. */ + /** + * UUID of the Database Instance the user belongs to. + */ instanceId: string - /** Name of the database user. */ + /** + * Name of the database user. + */ userName: string /** - * List of roles assigned to the user, along with the corresponding database - * where each role is granted. + * List of roles assigned to the user, along with the corresponding database where each role is granted. */ roles?: UserRole[] } export type UpdateInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to update. */ + /** + * UUID of the Database Instance to update. + */ instanceId: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name?: string - /** Tags of a Database Instance. */ + /** + * Tags of a Database Instance. + */ tags?: string[] } export type UpdateSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Snapshot. */ + /** + * UUID of the Snapshot. + */ snapshotId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** Expiration date of the snapshot (must follow the ISO 8601 format). */ + /** + * Expiration date of the snapshot (must follow the ISO 8601 format). + */ expiresAt?: Date } export type UpdateUserRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance the user belongs to. */ + /** + * UUID of the Database Instance the user belongs to. + */ instanceId: string - /** Name of the database user. */ + /** + * Name of the database user. + */ name: string - /** Password of the database user. */ + /** + * Password of the database user. + */ password?: string } export type UpgradeInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to upgrade. */ + /** + * UUID of the Database Instance you want to upgrade. + */ instanceId: string /** * Increase your Block Storage volume size. diff --git a/packages/clients/src/api/qaas/v1alpha1/api.gen.ts b/packages/clients/src/api/qaas/v1alpha1/api.gen.ts index 593226e19..6369d52e3 100644 --- a/packages/clients/src/api/qaas/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/qaas/v1alpha1/api.gen.ts @@ -85,13 +85,12 @@ const jsonContentHeaders = { /** * Quantum as a Service API. - * - * This API allows you to manage Scaleway Quantum as a Service. + +This API allows you to manage Scaleway Quantum as a Service. */ export class API extends ParentAPI { /** - * Get job information. Retrieve information about the provided **job ID**, - * such as status, payload, and result. + * Get job information. Retrieve information about the provided **job ID**, such as status, payload, and result. * * @param request - The request {@link GetJobRequest} * @returns A Promise of Job @@ -154,8 +153,7 @@ export class API extends ParentAPI { ) /** - * List all jobs within a project or session. Retrieve information about all - * jobs within a given project or session. + * List all jobs within a project or session. Retrieve information about all jobs within a given project or session. * * @param request - The request {@link ListJobsRequest} * @returns A Promise of ListJobsResponse @@ -181,8 +179,7 @@ export class API extends ParentAPI { ) /** - * List all results of a job. Retrieve all intermediate and final results of a - * job. + * List all results of a job. Retrieve all intermediate and final results of a job. * * @param request - The request {@link ListJobResultsRequest} * @returns A Promise of ListJobResultsResponse @@ -210,8 +207,7 @@ export class API extends ParentAPI { ) /** - * Update job information. Update job information about the provided **job - * ID**. + * Update job information. Update job information about the provided **job ID**. * * @param request - The request {@link UpdateJobRequest} * @returns A Promise of Job @@ -273,8 +269,7 @@ export class API extends ParentAPI { ) /** - * Get platform information. Retrieve information about the provided - * **platform ID**, such as provider name, technology, and type. + * Get platform information. Retrieve information about the provided **platform ID**, such as provider name, technology, and type. * * @param request - The request {@link GetPlatformRequest} * @returns A Promise of Platform @@ -322,8 +317,7 @@ export class API extends ParentAPI { enrichForPagination('platforms', this.pageOfListPlatforms, request) /** - * Get session infrormation. Retrieve information about the provided **session - * ID**, such as name, status, and number of executed jobs. + * Get session infrormation. Retrieve information about the provided **session ID**, such as name, status, and number of executed jobs. * * @param request - The request {@link GetSessionRequest} * @returns A Promise of Session @@ -413,8 +407,7 @@ export class API extends ParentAPI { ) /** - * Update session information. Update session information of the provided - * **session ID**. + * Update session information. Update session information of the provided **session ID**. * * @param request - The request {@link UpdateSessionRequest} * @returns A Promise of Session @@ -433,8 +426,7 @@ export class API extends ParentAPI { ) /** - * Terminate an existing session. Terminate a session by its unique ID and - * cancel all its attached jobs. + * Terminate an existing session. Terminate a session by its unique ID and cancel all its attached jobs. * * @param request - The request {@link TerminateSessionRequest} * @returns A Promise of Session @@ -451,8 +443,7 @@ export class API extends ParentAPI { ) /** - * Delete an existing session. Delete a session by its unique ID and delete - * all its attached jobs. + * Delete an existing session. Delete a session by its unique ID and delete all its attached jobs. * * @param request - The request {@link DeleteSessionRequest} */ @@ -485,8 +476,7 @@ export class API extends ParentAPI { enrichForPagination('acls', this.pageOfListSessionACLs, request) /** - * Create a process. Create a new process for the specified application on a - * specified platform. + * Create a process. Create a new process for the specified application on a specified platform. * * @param request - The request {@link CreateProcessRequest} * @returns A Promise of Process @@ -505,8 +495,7 @@ export class API extends ParentAPI { ) /** - * Get process infrormation. Retrieve information about the provided **process - * ID**, such as name, status and progress. + * Get process infrormation. Retrieve information about the provided **process ID**, such as name, status and progress. * * @param request - The request {@link GetProcessRequest} * @returns A Promise of Process @@ -577,8 +566,7 @@ export class API extends ParentAPI { enrichForPagination('processes', this.pageOfListProcesses, request) /** - * Update process information. Update process information of the provided - * **process ID**. + * Update process information. Update process information of the provided **process ID**. * * @param request - The request {@link UpdateProcessRequest} * @returns A Promise of Process @@ -597,8 +585,7 @@ export class API extends ParentAPI { ) /** - * Cancel a running process. Cancel a process by its unique ID. Intermediate - * results are still available. + * Cancel a running process. Cancel a process by its unique ID. Intermediate results are still available. * * @param request - The request {@link CancelProcessRequest} * @returns A Promise of Process @@ -615,8 +602,7 @@ export class API extends ParentAPI { ) /** - * Delete an existing process. Delete a process by its unique ID and delete - * all its data. + * Delete an existing process. Delete a process by its unique ID and delete all its data. * * @param request - The request {@link DeleteProcessRequest} */ @@ -646,8 +632,7 @@ export class API extends ParentAPI { ) /** - * List all results of a process. Retrieve all intermediate and final result - * of a process. + * List all results of a process. Retrieve all intermediate and final result of a process. * * @param request - The request {@link ListProcessResultsRequest} * @returns A Promise of ListProcessResultsResponse @@ -660,8 +645,7 @@ export class API extends ParentAPI { ) /** - * Get application information. Retrieve information about the provided - * **applcation ID**, such as name, type and compatible platforms. + * Get application information. Retrieve information about the provided **applcation ID**, such as name, type and compatible platforms. * * @param request - The request {@link GetApplicationRequest} * @returns A Promise of Application @@ -697,8 +681,7 @@ export class API extends ParentAPI { ) /** - * List all available applications. Retrieve information about all - * applications. + * List all available applications. Retrieve information about all applications. * * @param request - The request {@link ListApplicationsRequest} * @returns A Promise of ListApplicationsResponse diff --git a/packages/clients/src/api/qaas/v1alpha1/types.gen.ts b/packages/clients/src/api/qaas/v1alpha1/types.gen.ts index fac065a54..f0f1c7629 100644 --- a/packages/clients/src/api/qaas/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/qaas/v1alpha1/types.gen.ts @@ -113,17 +113,29 @@ export type SessionStatus = | 'stopping' export interface PlatformHardware { - /** Product name of the hardware. */ + /** + * Product name of the hardware. + */ name: string - /** Number of vCPUs available. */ + /** + * Number of vCPUs available. + */ vcpus: number - /** Number of GPUs available (0 if no GPU). */ + /** + * Number of GPUs available (0 if no GPU). + */ gpus: number - /** Network topology of GPUs (PCIe, NVLink...). */ + /** + * Network topology of GPUs (PCIe, NVLink...). + */ gpusNetwork: string - /** Amount of RAM available in byte. */ + /** + * Amount of RAM available in byte. + */ ram: number - /** Amount of VRAM available in byte (0 if no GPU). */ + /** + * Amount of VRAM available in byte (0 if no GPU). + */ vram: number } @@ -131,311 +143,529 @@ export interface JobCircuit { /** * Circuit generated by Perceval that should be executed. * - * One-of ('circuitSerialization'): at most one of 'percevalCircuit', - * 'qiskitCircuit' could be set. + * One-of ('circuitSerialization'): at most one of 'percevalCircuit', 'qiskitCircuit' could be set. */ percevalCircuit?: string /** * Circuit generated by Qiskit that should be executed. * - * One-of ('circuitSerialization'): at most one of 'percevalCircuit', - * 'qiskitCircuit' could be set. + * One-of ('circuitSerialization'): at most one of 'percevalCircuit', 'qiskitCircuit' could be set. */ qiskitCircuit?: string } export interface Application { - /** Unique ID of the application. */ + /** + * Unique ID of the application. + */ id: string - /** Name of the application. */ + /** + * Name of the application. + */ name: string - /** Type of the application. */ + /** + * Type of the application. + */ type: ApplicationType - /** List of compatible platform (by IDs) able to run this application. */ + /** + * List of compatible platform (by IDs) able to run this application. + */ compatiblePlatformIds: string[] - /** JSON format describing the expected input. */ + /** + * JSON format describing the expected input. + */ inputTemplate: string } export interface JobResult { - /** ID of the parent job. */ + /** + * ID of the parent job. + */ jobId: string - /** Result in JSON format. */ + /** + * Result in JSON format. + */ result?: string - /** URL to download a large result (optional). */ + /** + * URL to download a large result (optional). + */ url?: string - /** Creation time of the result. */ + /** + * Creation time of the result. + */ createdAt?: Date } export interface Job { - /** Unique ID of the job. */ + /** + * Unique ID of the job. + */ id: string - /** Job name. */ + /** + * Job name. + */ name: string - /** Tags of the job. */ + /** + * Tags of the job. + */ tags?: string[] - /** Session ID in which the job is executed. */ + /** + * Session ID in which the job is executed. + */ sessionId: string - /** Time at which the job was created. */ + /** + * Time at which the job was created. + */ createdAt?: Date - /** Time at which the job was started. */ + /** + * Time at which the job was started. + */ startedAt?: Date - /** Time at which the job was updated. */ + /** + * Time at which the job was updated. + */ updatedAt?: Date - /** Job status. */ + /** + * Job status. + */ status: JobStatus - /** Last progress message, if the job has started. */ + /** + * Last progress message, if the job has started. + */ progressMessage?: string - /** Duration of the job, if the job is finished. */ + /** + * Duration of the job, if the job is finished. + */ jobDuration?: string - /** Result of the job, if the job is finished. */ + /** + * Result of the job, if the job is finished. + */ resultDistribution?: string } export interface Platform { - /** Unique ID of the platform. */ + /** + * Unique ID of the platform. + */ id: string - /** Verison of the platform. */ + /** + * Verison of the platform. + */ version: string - /** Name of the platform. */ + /** + * Name of the platform. + */ name: string - /** Provider name of the platform. */ + /** + * Provider name of the platform. + */ providerName: string - /** Name of the running backend over the platform (ascella, qsim, aer...). */ + /** + * Name of the running backend over the platform (ascella, qsim, aer...). + */ backendName: string - /** Type of the platform. */ + /** + * Type of the platform. + */ type: PlatformType - /** Technology used by the platform. */ + /** + * Technology used by the platform. + */ technology: PlatformTechnology - /** Estimated maximum number of qubits supported by the platform. */ + /** + * Estimated maximum number of qubits supported by the platform. + */ maxQubitCount: number - /** Availability of the platform. */ + /** + * Availability of the platform. + */ availability: PlatformAvailability - /** Metadata provided by the platform. */ + /** + * Metadata provided by the platform. + */ metadata: string - /** Price to be payed per hour (excluding free tiers). */ + /** + * Price to be payed per hour (excluding free tiers). + */ pricePerHour?: Money - /** Specifications of the underlying hardware. */ + /** + * Specifications of the underlying hardware. + */ hardware?: PlatformHardware } export interface ProcessResult { - /** ID of the parent process. */ + /** + * ID of the parent process. + */ processId: string - /** Result in JSON format. */ + /** + * Result in JSON format. + */ result: string - /** Creation time of the result. */ + /** + * Creation time of the result. + */ createdAt?: Date } export interface Process { - /** Unique ID of the process. */ + /** + * Unique ID of the process. + */ id: string - /** Name of the process. */ + /** + * Name of the process. + */ name: string - /** Application ID for which the process has been created. */ + /** + * Application ID for which the process has been created. + */ applicationId?: string - /** Platform ID for which the process has been created. */ + /** + * Platform ID for which the process has been created. + */ platformId?: string - /** List of sessions generated by the process. */ + /** + * List of sessions generated by the process. + */ attachedSessionIds: string[] - /** Tme at which the process was created. */ + /** + * Tme at which the process was created. + */ createdAt?: Date - /** Time at which the process started. */ + /** + * Time at which the process started. + */ startedAt?: Date - /** Time at which the process was updated. */ + /** + * Time at which the process was updated. + */ updatedAt?: Date - /** Time at which the process was finished. */ + /** + * Time at which the process was finished. + */ finishedAt?: Date - /** Status of the process. */ + /** + * Status of the process. + */ status: ProcessStatus - /** Project ID in which the process has been created. */ + /** + * Project ID in which the process has been created. + */ projectId: string - /** Tags of the process. */ + /** + * Tags of the process. + */ tags: string[] - /** Progress of the process, from 0 to 1. */ + /** + * Progress of the process, from 0 to 1. + */ progress?: number - /** Any progress of the process. */ + /** + * Any progress of the process. + */ progressMessage?: string - /** Input payload of the process as JSON string. */ + /** + * Input payload of the process as JSON string. + */ input?: string } export interface Session { - /** Unique ID of the session. */ + /** + * Unique ID of the session. + */ id: string - /** Name of the session. */ + /** + * Name of the session. + */ name: string - /** Platform ID for which the session has been created. */ + /** + * Platform ID for which the session has been created. + */ platformId: string - /** The time at which the session was created. */ + /** + * The time at which the session was created. + */ createdAt?: Date - /** The time at which the session started. */ + /** + * The time at which the session started. + */ startedAt?: Date - /** The time at which the session was updated. */ + /** + * The time at which the session was updated. + */ updatedAt?: Date - /** The time at which the session was terminated. */ + /** + * The time at which the session was terminated. + */ terminatedAt?: Date - /** Maximum idle time before the session ends. */ + /** + * Maximum idle time before the session ends. + */ maxIdleDuration?: string - /** Maximum duration before the session ends. */ + /** + * Maximum duration before the session ends. + */ maxDuration?: string - /** Number of waiting jobs linked to the session. */ + /** + * Number of waiting jobs linked to the session. + */ waitingJobCount: number - /** Number of finished jobs linked to the session. */ + /** + * Number of finished jobs linked to the session. + */ finishedJobCount: number - /** Status of the session. */ + /** + * Status of the session. + */ status: SessionStatus - /** Project ID in which the session has been created. */ + /** + * Project ID in which the session has been created. + */ projectId: string - /** Tags of the session. */ + /** + * Tags of the session. + */ tags?: string[] - /** Deduplication ID of the session. */ + /** + * Deduplication ID of the session. + */ deduplicationId: string - /** Resource type that creates the session. */ + /** + * Resource type that creates the session. + */ originType: SessionOriginType - /** Unique ID of the session's origin resource (if exists). */ + /** + * Unique ID of the session's origin resource (if exists). + */ originId?: string - /** Any progress of the session. */ + /** + * Any progress of the session. + */ progressMessage?: string } export type CancelJobRequest = { - /** Unique ID of the job. */ + /** + * Unique ID of the job. + */ jobId: string } export type CancelProcessRequest = { - /** Unique ID of the process. */ + /** + * Unique ID of the process. + */ processId: string } export type CreateJobRequest = { - /** Name of the job. */ + /** + * Name of the job. + */ name: string - /** Tags of the job. */ + /** + * Tags of the job. + */ tags?: string[] - /** Session in which the job is executed. */ + /** + * Session in which the job is executed. + */ sessionId: string - /** Quantum circuit that should be executed. */ + /** + * Quantum circuit that should be executed. + */ circuit: JobCircuit - /** Maximum duration of the job. */ + /** + * Maximum duration of the job. + */ maxDuration?: string } export type CreateProcessRequest = { - /** ID of the project in which the process was created. */ + /** + * ID of the project in which the process was created. + */ projectId?: string - /** ID of the platform for which the process was created. */ + /** + * ID of the platform for which the process was created. + */ platformId?: string - /** ID of the application for which the process was created. */ + /** + * ID of the application for which the process was created. + */ applicationId?: string - /** Name of the process. */ + /** + * Name of the process. + */ name: string - /** Process parameters in JSON format. */ + /** + * Process parameters in JSON format. + */ input?: string - /** Tags of the process. */ + /** + * Tags of the process. + */ tags?: string[] } export type CreateSessionRequest = { - /** ID of the Project in which the session was created. */ + /** + * ID of the Project in which the session was created. + */ projectId?: string - /** ID of the Platform for which the session was created. */ + /** + * ID of the Platform for which the session was created. + */ platformId: string - /** Name of the session. */ + /** + * Name of the session. + */ name?: string - /** Maximum idle duration before the session ends. */ + /** + * Maximum idle duration before the session ends. + */ maxIdleDuration?: string - /** Maximum duration before the session ends. */ + /** + * Maximum duration before the session ends. + */ maxDuration?: string - /** Tags of the session. */ + /** + * Tags of the session. + */ tags?: string[] - /** Deduplication ID of the session. */ + /** + * Deduplication ID of the session. + */ deduplicationId?: string } export type DeleteJobRequest = { - /** Unique ID of the job. */ + /** + * Unique ID of the job. + */ jobId: string } export type DeleteProcessRequest = { - /** Unique ID of the process. */ + /** + * Unique ID of the process. + */ processId: string } export type DeleteSessionRequest = { - /** Unique ID of the session. */ + /** + * Unique ID of the session. + */ sessionId: string } export type GetApplicationRequest = { - /** Unique ID of the application. */ + /** + * Unique ID of the application. + */ applicationId: string } export type GetJobCircuitRequest = { - /** Unique ID of the job. */ + /** + * Unique ID of the job. + */ jobId: string } export type GetJobRequest = { - /** Unique ID of the job you want to get. */ + /** + * Unique ID of the job you want to get. + */ jobId: string } export type GetPlatformRequest = { - /** Unique ID of the platform. */ + /** + * Unique ID of the platform. + */ platformId: string } export type GetProcessRequest = { - /** Unique ID of the process. */ + /** + * Unique ID of the process. + */ processId: string } export type GetSessionRequest = { - /** Unique ID of the session. */ + /** + * Unique ID of the session. + */ sessionId: string } export type ListApplicationsRequest = { - /** List applications with this name. */ + /** + * List applications with this name. + */ name?: string - /** List applications with this type. */ + /** + * List applications with this type. + */ applicationType?: ApplicationType - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of applications a to return per page. */ + /** + * Maximum number of applications a to return per page. + */ pageSize?: number - /** Sort order of the returned applications. */ + /** + * Sort order of the returned applications. + */ orderBy?: ListApplicationsRequestOrderBy } export interface ListApplicationsResponse { - /** Total number of applications. */ + /** + * Total number of applications. + */ totalCount: number - /** List of applications. */ + /** + * List of applications. + */ applications: Application[] } export type ListJobResultsRequest = { - /** ID of the job. */ + /** + * ID of the job. + */ jobId: string - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of results to return per page. */ + /** + * Maximum number of results to return per page. + */ pageSize?: number - /** Sort order of the returned results. */ + /** + * Sort order of the returned results. + */ orderBy?: ListJobResultsRequestOrderBy } export interface ListJobResultsResponse { - /** Total number of results. */ + /** + * Total number of results. + */ totalCount: number - /** List of results. */ + /** + * List of results. + */ jobResults: JobResult[] } @@ -443,97 +673,155 @@ export type ListJobsRequest = { /** * List jobs with this session ID. * - * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be - * set. + * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be set. */ sessionId?: string /** * List jobs with this project ID. * - * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be - * set. + * One-of ('resourceId'): at most one of 'sessionId', 'projectId' could be set. */ projectId?: string - /** List jobs with these tags. */ + /** + * List jobs with these tags. + */ tags?: string[] - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of jobs to return per page. */ + /** + * Maximum number of jobs to return per page. + */ pageSize?: number - /** Sort order of the returned jobs. */ + /** + * Sort order of the returned jobs. + */ orderBy?: ListJobsRequestOrderBy } export interface ListJobsResponse { - /** Total number of jobs. */ + /** + * Total number of jobs. + */ totalCount: number - /** List of jobs. */ + /** + * List of jobs. + */ jobs: Job[] } export type ListPlatformsRequest = { - /** List platforms with this provider name. */ + /** + * List platforms with this provider name. + */ providerName?: string - /** List platforms with this backend name. */ + /** + * List platforms with this backend name. + */ backendName?: string - /** List platforms with this name. */ + /** + * List platforms with this name. + */ name?: string - /** List platforms with this type. */ + /** + * List platforms with this type. + */ platformType?: PlatformType - /** List platforms with this technology. */ + /** + * List platforms with this technology. + */ platformTechnology?: PlatformTechnology - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of platforms to return per page. */ + /** + * Maximum number of platforms to return per page. + */ pageSize?: number - /** Sort order of the returned platforms. */ + /** + * Sort order of the returned platforms. + */ orderBy?: ListPlatformsRequestOrderBy } export interface ListPlatformsResponse { - /** Total number of platforms. */ + /** + * Total number of platforms. + */ totalCount: number - /** List of platforms. */ + /** + * List of platforms. + */ platforms: Platform[] } export type ListProcessResultsRequest = { - /** ID of the process. */ + /** + * ID of the process. + */ processId: string - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of results to return per page. */ + /** + * Maximum number of results to return per page. + */ pageSize?: number - /** Sort order of the returned results. */ + /** + * Sort order of the returned results. + */ orderBy?: ListProcessResultsRequestOrderBy } export interface ListProcessResultsResponse { - /** Total number of results. */ + /** + * Total number of results. + */ totalCount: number - /** List of results. */ + /** + * List of results. + */ processResults: ProcessResult[] } export type ListProcessesRequest = { - /** List processes that have been created for this application. */ + /** + * List processes that have been created for this application. + */ applicationId?: string - /** List processes with these tags. */ + /** + * List processes with these tags. + */ tags?: string[] - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of processes to return per page. */ + /** + * Maximum number of processes to return per page. + */ pageSize?: number - /** Sort order of the returned processes. */ + /** + * Sort order of the returned processes. + */ orderBy?: ListProcessesRequestOrderBy - /** List processes belonging to this project ID. */ + /** + * List processes belonging to this project ID. + */ projectId?: string } export interface ListProcessesResponse { - /** Total number of processes. */ + /** + * Total number of processes. + */ totalCount: number - /** List of processes. */ + /** + * List of processes. + */ processes: Process[] } @@ -550,59 +838,99 @@ export interface ListSessionACLsResponse { } export type ListSessionsRequest = { - /** List sessions that have been created for this platform. */ + /** + * List sessions that have been created for this platform. + */ platformId?: string - /** List sessions with these tags. */ + /** + * List sessions with these tags. + */ tags?: string[] - /** Page number. */ + /** + * Page number. + */ page?: number - /** Maximum number of sessions to return per page. */ + /** + * Maximum number of sessions to return per page. + */ pageSize?: number - /** Sort order of the returned sessions. */ + /** + * Sort order of the returned sessions. + */ orderBy?: ListSessionsRequestOrderBy - /** List sessions belonging to this project ID. */ + /** + * List sessions belonging to this project ID. + */ projectId?: string } export interface ListSessionsResponse { - /** Total number of sessions. */ + /** + * Total number of sessions. + */ totalCount: number - /** List of sessions. */ + /** + * List of sessions. + */ sessions: Session[] } export type TerminateSessionRequest = { - /** Unique ID of the session. */ + /** + * Unique ID of the session. + */ sessionId: string } export type UpdateJobRequest = { - /** Unique ID of the job. */ + /** + * Unique ID of the job. + */ jobId: string - /** Name of the job. */ + /** + * Name of the job. + */ name?: string - /** Tags of the job. */ + /** + * Tags of the job. + */ tags?: string[] } export type UpdateProcessRequest = { - /** Unique ID of the process. */ + /** + * Unique ID of the process. + */ processId: string - /** Name of the process. */ + /** + * Name of the process. + */ name?: string - /** Tags of the process. */ + /** + * Tags of the process. + */ tags?: string[] } export type UpdateSessionRequest = { - /** Unique ID of the session. */ + /** + * Unique ID of the session. + */ sessionId: string - /** Name of the session. */ + /** + * Name of the session. + */ name?: string - /** Maximum idle duration before the session ends. */ + /** + * Maximum idle duration before the session ends. + */ maxIdleDuration?: string - /** Maximum time before the session ends. */ + /** + * Maximum time before the session ends. + */ maxDuration?: string - /** Tags of the session. */ + /** + * Tags of the session. + */ tags?: string[] } diff --git a/packages/clients/src/api/rdb/v1/api.gen.ts b/packages/clients/src/api/rdb/v1/api.gen.ts index e0bc2882e..faad2ffeb 100644 --- a/packages/clients/src/api/rdb/v1/api.gen.ts +++ b/packages/clients/src/api/rdb/v1/api.gen.ts @@ -168,9 +168,8 @@ const jsonContentHeaders = { /** * Managed Database for PostgreSQL and MySQL API. - * - * This API allows you to manage your Managed Databases for PostgreSQL and - * MySQL. + +This API allows you to manage your Managed Databases for PostgreSQL and MySQL. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -201,8 +200,7 @@ export class API extends ParentAPI { ) /** - * List available database engines. List the PostgreSQL and MySQL database - * engines available at Scaleway. + * List available database engines. List the PostgreSQL and MySQL database engines available at Scaleway. * * @param request - The request {@link ListDatabaseEnginesRequest} * @returns A Promise of ListDatabaseEnginesResponse @@ -228,9 +226,7 @@ export class API extends ParentAPI { ) /** - * List available node types. List all available node types. By default, the - * node types returned in the list are ordered by creation date in ascending - * order, though this can be modified via the `order_by` field. + * List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListNodeTypesRequest} * @returns A Promise of ListNodeTypesResponse @@ -262,10 +258,7 @@ export class API extends ParentAPI { ) /** - * List database backups. List all backups in a specified region, for a given - * Scaleway Organization or Scaleway Project. By default, the backups listed - * are ordered by creation date in ascending order. This can be modified via - * the `order_by` field. + * List database backups. List all backups in a specified region, for a given Scaleway Organization or Scaleway Project. By default, the backups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. * * @param request - The request {@link ListDatabaseBackupsRequest} * @returns A Promise of ListDatabaseBackupsResponse @@ -278,8 +271,7 @@ export class API extends ParentAPI { ) /** - * Create a database backup. Create a new backup. You must set the - * `instance_id`, `database_name`, `name` and `expires_at` parameters. + * Create a database backup. Create a new backup. You must set the `instance_id`, `database_name`, `name` and `expires_at` parameters. * * @param request - The request {@link CreateDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -298,9 +290,7 @@ export class API extends ParentAPI { ) /** - * Get a database backup. Retrieve information about a given backup, specified - * by its database backup ID and region. Full details about the backup, like - * size, URL and expiration date, are returned in the response. + * Get a database backup. Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response. * * @param request - The request {@link GetDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -337,8 +327,7 @@ export class API extends ParentAPI { ) /** - * Update a database backup. Update the parameters of a backup, including name - * and expiration date. + * Update a database backup. Update the parameters of a backup, including name and expiration date. * * @param request - The request {@link UpdateDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -357,8 +346,7 @@ export class API extends ParentAPI { ) /** - * Delete a database backup. Delete a backup, specified by its database backup - * ID and region. Deleting a backup is permanent, and cannot be undone. + * Delete a database backup. Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone. * * @param request - The request {@link DeleteDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -373,10 +361,7 @@ export class API extends ParentAPI { ) /** - * Restore a database backup. Launch the process of restoring database backup. - * You must specify the `instance_id` of the Database Instance of destination, - * where the backup will be restored. Note that large database backups can - * take up to several hours to restore. + * Restore a database backup. Launch the process of restoring database backup. You must specify the `instance_id` of the Database Instance of destination, where the backup will be restored. Note that large database backups can take up to several hours to restore. * * @param request - The request {@link RestoreDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -395,9 +380,7 @@ export class API extends ParentAPI { ) /** - * Export a database backup. Export a backup, specified by the - * `database_backup_id` and the `region` parameters. The download URL is - * returned in the response. + * Export a database backup. Export a backup, specified by the `database_backup_id` and the `region` parameters. The download URL is returned in the response. * * @param request - The request {@link ExportDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -414,10 +397,7 @@ export class API extends ParentAPI { ) /** - * Upgrade a Database Instance. Upgrade your current Database Instance - * specifications like node type, high availability, volume, or the database - * engine version. Note that upon upgrade the `enable_ha` parameter can only - * be set to `true`. + * Upgrade a Database Instance. Upgrade your current Database Instance specifications like node type, high availability, volume, or the database engine version. Note that upon upgrade the `enable_ha` parameter can only be set to `true`. * * @param request - The request {@link UpgradeInstanceRequest} * @returns A Promise of Instance @@ -459,14 +439,7 @@ export class API extends ParentAPI { ) /** - * List Database Instances. List all Database Instances in the specified - * region, for a given Scaleway Organization or Scaleway Project. By default, - * the Database Instances returned in the list are ordered by creation date in - * ascending order, though this can be modified via the order_by field. You - * can define additional parameters for your query, such as `tags` and `name`. - * For the `name` parameter, the value you include will be checked against the - * whole name string to see if it includes the string you put in the - * parameter. + * List Database Instances. List all Database Instances in the specified region, for a given Scaleway Organization or Scaleway Project. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags` and `name`. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. * * @param request - The request {@link ListInstancesRequest} * @returns A Promise of ListInstancesResponse @@ -475,10 +448,7 @@ export class API extends ParentAPI { enrichForPagination('instances', this.pageOfListInstances, request) /** - * Get a Database Instance. Retrieve information about a given Database - * Instance, specified by the `region` and `instance_id` parameters. Its full - * details, including name, status, IP address and port, are returned in the - * response object. + * Get a Database Instance. Retrieve information about a given Database Instance, specified by the `region` and `instance_id` parameters. Its full details, including name, status, IP address and port, are returned in the response object. * * @param request - The request {@link GetInstanceRequest} * @returns A Promise of Instance @@ -515,9 +485,7 @@ export class API extends ParentAPI { ) /** - * Create a Database Instance. Create a new Database Instance. You must set - * the `engine`, `user_name`, `password` and `node_type` parameters. - * Optionally, you can specify the volume type and size. + * Create a Database Instance. Create a new Database Instance. You must set the `engine`, `user_name`, `password` and `node_type` parameters. Optionally, you can specify the volume type and size. * * @param request - The request {@link CreateInstanceRequest} * @returns A Promise of Instance @@ -536,8 +504,7 @@ export class API extends ParentAPI { ) /** - * Update a Database Instance. Update the parameters of a Database Instance, - * including name, tags and backup schedule details. + * Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details. * * @param request - The request {@link UpdateInstanceRequest} * @returns A Promise of Instance @@ -556,10 +523,7 @@ export class API extends ParentAPI { ) /** - * Delete a Database Instance. Delete a given Database Instance, specified by - * the `region` and `instance_id` parameters. Deleting a Database Instance is - * permanent, and cannot be undone. Note that upon deletion all your data will - * be lost. + * Delete a Database Instance. Delete a given Database Instance, specified by the `region` and `instance_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. * * @param request - The request {@link DeleteInstanceRequest} * @returns A Promise of Instance @@ -574,11 +538,7 @@ export class API extends ParentAPI { ) /** - * Clone a Database Instance. Clone a given Database Instance, specified by - * the `region` and `instance_id` parameters. The clone feature allows you to - * create a new Database Instance from an existing one. The clone includes all - * existing databases, users and permissions. You can create a clone on a - * Database Instance bigger than your current one. + * Clone a Database Instance. Clone a given Database Instance, specified by the `region` and `instance_id` parameters. The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users and permissions. You can create a clone on a Database Instance bigger than your current one. * * @param request - The request {@link CloneInstanceRequest} * @returns A Promise of Instance @@ -597,9 +557,7 @@ export class API extends ParentAPI { ) /** - * Restart Database Instance. Restart a given Database Instance, specified by - * the `region` and `instance_id` parameters. The status of the Database - * Instance returned in the response. + * Restart Database Instance. Restart a given Database Instance, specified by the `region` and `instance_id` parameters. The status of the Database Instance returned in the response. * * @param request - The request {@link RestartInstanceRequest} * @returns A Promise of Instance @@ -616,9 +574,7 @@ export class API extends ParentAPI { ) /** - * Get the TLS certificate of a Database Instance. Retrieve information about - * the TLS certificate of a given Database Instance. Details like name and - * content are returned in the response. + * Get the TLS certificate of a Database Instance. Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response. * * @param request - The request {@link GetInstanceCertificateRequest} * @returns A Promise of Blob @@ -632,11 +588,7 @@ export class API extends ParentAPI { }) /** - * Renew the TLS certificate of a Database Instance. Renew a TLS for a - * Database Instance. Renewing a certificate means that you will not be able - * to connect to your Database Instance using the previous certificate. You - * will also need to download and update the new certificate for all database - * clients. + * Renew the TLS certificate of a Database Instance. Renew a TLS for a Database Instance. Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients. * * @param request - The request {@link RenewInstanceCertificateRequest} */ @@ -651,9 +603,7 @@ export class API extends ParentAPI { }) /** - * Get Database Instance metrics. Retrieve the time series metrics of a given - * Database Instance. You can define the period from which to retrieve metrics - * by specifying the `start_date` and `end_date`. + * Get Database Instance metrics. Retrieve the time series metrics of a given Database Instance. You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`. * * @param request - The request {@link GetInstanceMetricsRequest} * @returns A Promise of InstanceMetrics @@ -673,9 +623,7 @@ export class API extends ParentAPI { ) /** - * Create a Read Replica. Create a new Read Replica of a Database Instance. - * You must specify the `region` and the `instance_id`. You can only create a - * maximum of 3 Read Replicas per Database Instance. + * Create a Read Replica. Create a new Read Replica of a Database Instance. You must specify the `region` and the `instance_id`. You can only create a maximum of 3 Read Replicas per Database Instance. * * @param request - The request {@link CreateReadReplicaRequest} * @returns A Promise of ReadReplica @@ -694,9 +642,7 @@ export class API extends ParentAPI { ) /** - * Get a Read Replica. Retrieve information about a Database Instance Read - * Replica. Full details about the Read Replica, like `endpoints`, `status` - * and `region` are returned in the response. + * Get a Read Replica. Retrieve information about a Database Instance Read Replica. Full details about the Read Replica, like `endpoints`, `status` and `region` are returned in the response. * * @param request - The request {@link GetReadReplicaRequest} * @returns A Promise of ReadReplica @@ -733,9 +679,7 @@ export class API extends ParentAPI { ) /** - * Delete a Read Replica. Delete a Read Replica of a Database Instance. You - * must specify the `region` and `read_replica_id` parameters of the Read - * Replica you want to delete. + * Delete a Read Replica. Delete a Read Replica of a Database Instance. You must specify the `region` and `read_replica_id` parameters of the Read Replica you want to delete. * * @param request - The request {@link DeleteReadReplicaRequest} * @returns A Promise of ReadReplica @@ -750,11 +694,8 @@ export class API extends ParentAPI { ) /** - * Resync a Read Replica. When you resync a Read Replica, first it is reset, - * then its data is resynchronized from the primary node. Your Read Replica - * remains unavailable during the resync process. The duration of this process - * is proportional to the size of your Database Instance. The configured - * endpoints do not change. + * Resync a Read Replica. When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance. +The configured endpoints do not change. * * @param request - The request {@link ResetReadReplicaRequest} * @returns A Promise of ReadReplica @@ -771,8 +712,7 @@ export class API extends ParentAPI { ) /** - * Promote a Read Replica. Promote a Read Replica to Database Instance - * automatically. + * Promote a Read Replica. Promote a Read Replica to Database Instance automatically. * * @param request - The request {@link PromoteReadReplicaRequest} * @returns A Promise of Instance @@ -789,9 +729,7 @@ export class API extends ParentAPI { ) /** - * Create an endpoint for a Read Replica. Create a new endpoint for a Read - * Replica. Read Replicas can have at most one direct access and one Private - * Network endpoint. + * Create an endpoint for a Read Replica. Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint. * * @param request - The request {@link CreateReadReplicaEndpointRequest} * @returns A Promise of ReadReplica @@ -815,12 +753,7 @@ export class API extends ParentAPI { ) /** - * Prepare logs of a Database Instance. Prepare your Database Instance logs. - * You can define the `start_date` and `end_date` parameters for your query. - * The download URL is returned in the response. Logs are recorded from 00h00 - * to 23h59 and then aggregated in a `.log` file once a day. Therefore, even - * if you specify a timeframe from which you want to get the logs, you will - * receive logs from the full 24 hours. + * Prepare logs of a Database Instance. Prepare your Database Instance logs. You can define the `start_date` and `end_date` parameters for your query. The download URL is returned in the response. Logs are recorded from 00h00 to 23h59 and then aggregated in a `.log` file once a day. Therefore, even if you specify a timeframe from which you want to get the logs, you will receive logs from the full 24 hours. * * @param request - The request {@link PrepareInstanceLogsRequest} * @returns A Promise of PrepareInstanceLogsResponse @@ -839,10 +772,7 @@ export class API extends ParentAPI { ) /** - * List available logs of a Database Instance. List the available logs of a - * Database Instance. By default, the logs returned in the list are ordered by - * creation date in ascending order, though this can be modified via the - * order_by field. + * List available logs of a Database Instance. List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. * * @param request - The request {@link ListInstanceLogsRequest} * @returns A Promise of ListInstanceLogsResponse @@ -858,10 +788,7 @@ export class API extends ParentAPI { ) /** - * Get given logs of a Database Instance. Retrieve information about the logs - * of a Database Instance. Specify the `instance_log_id` and `region` in your - * request to get information such as `download_url`, `status`, `expires_at` - * and `created_at` about your logs in the response. + * Get given logs of a Database Instance. Retrieve information about the logs of a Database Instance. Specify the `instance_log_id` and `region` in your request to get information such as `download_url`, `status`, `expires_at` and `created_at` about your logs in the response. * * @param request - The request {@link GetInstanceLogRequest} * @returns A Promise of InstanceLog @@ -898,9 +825,7 @@ export class API extends ParentAPI { ) /** - * Purge remote Database Instance logs. Purge a given remote log from a - * Database Instance. You can specify the `log_name` of the log you wish to - * clean from your Database Instance. + * Purge remote Database Instance logs. Purge a given remote log from a Database Instance. You can specify the `log_name` of the log you wish to clean from your Database Instance. * * @param request - The request {@link PurgeInstanceLogsRequest} */ @@ -915,9 +840,7 @@ export class API extends ParentAPI { }) /** - * List remote Database Instance logs details. List remote log details. By - * default, the details returned in the list are ordered by creation date in - * ascending order, though this can be modified via the order_by field. + * List remote Database Instance logs details. List remote log details. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. * * @param request - The request {@link ListInstanceLogsDetailsRequest} * @returns A Promise of ListInstanceLogsDetailsResponse @@ -934,9 +857,7 @@ export class API extends ParentAPI { ) /** - * Add Database Instance advanced settings. Add an advanced setting to a - * Database Instance. You must set the `name` and the `value` of each - * setting. + * Add Database Instance advanced settings. Add an advanced setting to a Database Instance. You must set the `name` and the `value` of each setting. * * @param request - The request {@link AddInstanceSettingsRequest} * @returns A Promise of AddInstanceSettingsResponse @@ -955,9 +876,7 @@ export class API extends ParentAPI { ) /** - * Delete Database Instance advanced settings. Delete an advanced setting in a - * Database Instance. You must specify the names of the settings you want to - * delete in the request. + * Delete Database Instance advanced settings. Delete an advanced setting in a Database Instance. You must specify the names of the settings you want to delete in the request. * * @param request - The request {@link DeleteInstanceSettingsRequest} * @returns A Promise of DeleteInstanceSettingsResponse @@ -976,9 +895,7 @@ export class API extends ParentAPI { ) /** - * Set Database Instance advanced settings. Update an advanced setting for a - * Database Instance. Settings added upon database engine initalization can - * only be defined once, and cannot, therefore, be updated. + * Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated. * * @param request - The request {@link SetInstanceSettingsRequest} * @returns A Promise of SetInstanceSettingsResponse @@ -1015,10 +932,7 @@ export class API extends ParentAPI { ) /** - * List ACL rules of a Database Instance. List the ACL rules for a given - * Database Instance. The response is an array of ACL objects, each one - * representing an ACL that denies, allows or redirects traffic based on - * certain conditions. + * List ACL rules of a Database Instance. List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions. * * @param request - The request {@link ListInstanceACLRulesRequest} * @returns A Promise of ListInstanceACLRulesResponse @@ -1027,8 +941,7 @@ export class API extends ParentAPI { enrichForPagination('rules', this.pageOfListInstanceACLRules, request) /** - * Add an ACL rule to a Database Instance. Add an additional ACL rule to a - * Database Instance. + * Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance. * * @param request - The request {@link AddInstanceACLRulesRequest} * @returns A Promise of AddInstanceACLRulesResponse @@ -1047,8 +960,7 @@ export class API extends ParentAPI { ) /** - * Set ACL rules for a Database Instance. Replace all the ACL rules of a - * Database Instance. + * Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance. * * @param request - The request {@link SetInstanceACLRulesRequest} * @returns A Promise of SetInstanceACLRulesResponse @@ -1067,8 +979,7 @@ export class API extends ParentAPI { ) /** - * Delete ACL rules of a Database Instance. Delete one or more ACL rules of a - * Database Instance. + * Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance. * * @param request - The request {@link DeleteInstanceACLRulesRequest} * @returns A Promise of DeleteInstanceACLRulesResponse @@ -1105,10 +1016,7 @@ export class API extends ParentAPI { ) /** - * List users of a Database Instance. List all users of a given Database - * Instance. By default, the users returned in the list are ordered by - * creation date in ascending order, though this can be modified via the - * order_by field. + * List users of a Database Instance. List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. * * @param request - The request {@link ListUsersRequest} * @returns A Promise of ListUsersResponse @@ -1117,9 +1025,7 @@ export class API extends ParentAPI { enrichForPagination('users', this.pageOfListUsers, request) /** - * Create a user for a Database Instance. Create a new user for a Database - * Instance. You must define the `name`, `password` and `is_admin` - * parameters. + * Create a user for a Database Instance. Create a new user for a Database Instance. You must define the `name`, `password` and `is_admin` parameters. * * @param request - The request {@link CreateUserRequest} * @returns A Promise of User @@ -1138,9 +1044,7 @@ export class API extends ParentAPI { ) /** - * Update a user on a Database Instance. Update the parameters of a user on a - * Database Instance. You can update the `password` and `is_admin` parameters, - * but you cannot change the name of the user. + * Update a user on a Database Instance. Update the parameters of a user on a Database Instance. You can update the `password` and `is_admin` parameters, but you cannot change the name of the user. * * @param request - The request {@link UpdateUserRequest} * @returns A Promise of User @@ -1159,9 +1063,7 @@ export class API extends ParentAPI { ) /** - * Delete a user on a Database Instance. Delete a given user on a Database - * Instance. You must specify, in the endpoint, the `region`, `instance_id` - * and `name` parameters of the user you want to delete. + * Delete a user on a Database Instance. Delete a given user on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the user you want to delete. * * @param request - The request {@link DeleteUserRequest} */ @@ -1192,11 +1094,7 @@ export class API extends ParentAPI { ) /** - * List databases in a Database Instance. List all databases of a given - * Database Instance. By default, the databases returned in the list are - * ordered by creation date in ascending order, though this can be modified - * via the order_by field. You can define additional parameters for your - * query, such as `name`, `managed` and `owner`. + * List databases in a Database Instance. List all databases of a given Database Instance. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `name`, `managed` and `owner`. * * @param request - The request {@link ListDatabasesRequest} * @returns A Promise of ListDatabasesResponse @@ -1205,8 +1103,7 @@ export class API extends ParentAPI { enrichForPagination('databases', this.pageOfListDatabases, request) /** - * Create a database in a Database Instance. Create a new database. You must - * define the `name` parameter in the request. + * Create a database in a Database Instance. Create a new database. You must define the `name` parameter in the request. * * @param request - The request {@link CreateDatabaseRequest} * @returns A Promise of Database @@ -1225,9 +1122,7 @@ export class API extends ParentAPI { ) /** - * Delete a database in a Database Instance. Delete a given database on a - * Database Instance. You must specify, in the endpoint, the `region`, - * `instance_id` and `name` parameters of the database you want to delete. + * Delete a database in a Database Instance. Delete a given database on a Database Instance. You must specify, in the endpoint, the `region`, `instance_id` and `name` parameters of the database you want to delete. * * @param request - The request {@link DeleteDatabaseRequest} */ @@ -1257,11 +1152,7 @@ export class API extends ParentAPI { ) /** - * List user privileges for a database. List privileges of a user on a - * database. By default, the details returned in the list are ordered by - * creation date in ascending order, though this can be modified via the - * order_by field. You can define additional parameters for your query, such - * as `database_name` and `user_name`. + * List user privileges for a database. List privileges of a user on a database. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `database_name` and `user_name`. * * @param request - The request {@link ListPrivilegesRequest} * @returns A Promise of ListPrivilegesResponse @@ -1270,9 +1161,7 @@ export class API extends ParentAPI { enrichForPagination('privileges', this.pageOfListPrivileges, request) /** - * Set user privileges for a database. Set the privileges of a user on a - * database. You must define `database_name`, `user_name` and `permission` in - * the request body. + * Set user privileges for a database. Set the privileges of a user on a database. You must define `database_name`, `user_name` and `permission` in the request body. * * @param request - The request {@link SetPrivilegeRequest} * @returns A Promise of Privilege @@ -1314,11 +1203,7 @@ export class API extends ParentAPI { ) /** - * List snapshots. List snapshots. You can include the `instance_id` or - * `project_id` in your query to get the list of snapshots for specific - * Database Instances and/or Projects. By default, the details returned in the - * list are ordered by creation date in ascending order, though this can be - * modified via the `order_by` field. + * List snapshots. List snapshots. You can include the `instance_id` or `project_id` in your query to get the list of snapshots for specific Database Instances and/or Projects. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListSnapshotsRequest} * @returns A Promise of ListSnapshotsResponse @@ -1327,9 +1212,7 @@ export class API extends ParentAPI { enrichForPagination('snapshots', this.pageOfListSnapshots, request) /** - * Get a Database Instance snapshot. Retrieve information about a given - * snapshot, specified by its `snapshot_id` and `region`. Full details about - * the snapshot, like size and expiration date, are returned in the response. + * Get a Database Instance snapshot. Retrieve information about a given snapshot, specified by its `snapshot_id` and `region`. Full details about the snapshot, like size and expiration date, are returned in the response. * * @param request - The request {@link GetSnapshotRequest} * @returns A Promise of Snapshot @@ -1366,8 +1249,7 @@ export class API extends ParentAPI { ) /** - * Create a Database Instance snapshot. Create a new snapshot of a Database - * Instance. You must define the `name` parameter in the request. + * Create a Database Instance snapshot. Create a new snapshot of a Database Instance. You must define the `name` parameter in the request. * * @param request - The request {@link CreateSnapshotRequest} * @returns A Promise of Snapshot @@ -1386,9 +1268,7 @@ export class API extends ParentAPI { ) /** - * Update a Database Instance snapshot. Update the parameters of a snapshot of - * a Database Instance. You can update the `name` and `expires_at` - * parameters. + * Update a Database Instance snapshot. Update the parameters of a snapshot of a Database Instance. You can update the `name` and `expires_at` parameters. * * @param request - The request {@link UpdateSnapshotRequest} * @returns A Promise of Snapshot @@ -1407,9 +1287,7 @@ export class API extends ParentAPI { ) /** - * Delete a Database Instance snapshot. Delete a given snapshot of a Database - * Instance. You must specify, in the endpoint, the `region` and `snapshot_id` - * parameters of the snapshot you want to delete. + * Delete a Database Instance snapshot. Delete a given snapshot of a Database Instance. You must specify, in the endpoint, the `region` and `snapshot_id` parameters of the snapshot you want to delete. * * @param request - The request {@link DeleteSnapshotRequest} * @returns A Promise of Snapshot @@ -1424,14 +1302,7 @@ export class API extends ParentAPI { ) /** - * Create a new Database Instance from a snapshot. Restore a snapshot. When - * you restore a snapshot, a new Instance is created and billed to your - * account. Note that is possible to select a larger node type for your new - * Database Instance. However, the Block volume size will be the same as the - * size of the restored snapshot. All Instance settings will be restored if - * you chose a node type with the same or more memory size than the initial - * Instance. Settings will be reset to the default if your node type has less - * memory. + * Create a new Database Instance from a snapshot. Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory. * * @param request - The request {@link CreateInstanceFromSnapshotRequest} * @returns A Promise of Instance @@ -1455,9 +1326,7 @@ export class API extends ParentAPI { ) /** - * Create a new Database Instance endpoint. Create a new endpoint for a - * Database Instance. You can add `load_balancer` and `private_network` - * specifications to the body of the request. + * Create a new Database Instance endpoint. Create a new endpoint for a Database Instance. You can add `load_balancer` and `private_network` specifications to the body of the request. * * @param request - The request {@link CreateEndpointRequest} * @returns A Promise of Endpoint @@ -1476,10 +1345,7 @@ export class API extends ParentAPI { ) /** - * Delete a Database Instance endpoint. Delete the endpoint of a Database - * Instance. You must specify the `region` and `endpoint_id` parameters of the - * endpoint you want to delete. Note that might need to update any environment - * configurations that point to the deleted endpoint. + * Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint. * * @param request - The request {@link DeleteEndpointRequest} */ @@ -1490,10 +1356,7 @@ export class API extends ParentAPI { }) /** - * Get a Database Instance endpoint. Retrieve information about a Database - * Instance endpoint. Full details about the endpoint, like `ip`, `port`, - * `private_network` and `load_balancer` specifications are returned in the - * response. + * Get a Database Instance endpoint. Retrieve information about a Database Instance endpoint. Full details about the endpoint, like `ip`, `port`, `private_network` and `load_balancer` specifications are returned in the response. * * @param request - The request {@link GetEndpointRequest} * @returns A Promise of Endpoint @@ -1527,11 +1390,7 @@ export class API extends ParentAPI { ) /** - * Apply Database Instance maintenance. Apply maintenance tasks to your - * Database Instance. This will trigger pending maintenance tasks to start in - * your Database Instance and can generate service interruption. Maintenance - * tasks can be applied between `starts_at` and `stops_at` times, and are run - * directly by Scaleway at `forced_at` timestamp. + * Apply Database Instance maintenance. Apply maintenance tasks to your Database Instance. This will trigger pending maintenance tasks to start in your Database Instance and can generate service interruption. Maintenance tasks can be applied between `starts_at` and `stops_at` times, and are run directly by Scaleway at `forced_at` timestamp. * * @param request - The request {@link ApplyInstanceMaintenanceRequest} * @returns A Promise of Maintenance diff --git a/packages/clients/src/api/rdb/v1/types.gen.ts b/packages/clients/src/api/rdb/v1/types.gen.ts index 394ea5f7d..4cdf98bc6 100644 --- a/packages/clients/src/api/rdb/v1/types.gen.ts +++ b/packages/clients/src/api/rdb/v1/types.gen.ts @@ -139,13 +139,21 @@ export interface EndpointDirectAccessDetails {} export interface EndpointLoadBalancerDetails {} export interface EndpointPrivateNetworkDetails { - /** UUID of the private network. */ + /** + * UUID of the private network. + */ privateNetworkId: string - /** CIDR notation of the endpoint IPv4 address. */ + /** + * CIDR notation of the endpoint IPv4 address. + */ serviceIp: string - /** Private network zone. */ + /** + * Private network zone. + */ zone: ScwZone - /** How endpoint ips are provisioned. */ + /** + * How endpoint ips are provisioned. + */ provisioningMode: EndpointPrivateNetworkDetailsProvisioningMode } @@ -154,32 +162,56 @@ export interface EndpointSpecPrivateNetworkIpamConfig {} export interface ReadReplicaEndpointSpecPrivateNetworkIpamConfig {} export interface EngineSetting { - /** Setting name from the database engine. */ + /** + * Setting name from the database engine. + */ name: string - /** Value set when not specified. */ + /** + * Value set when not specified. + */ defaultValue: string - /** Setting can be applied without restarting. */ + /** + * Setting can be applied without restarting. + */ hotConfigurable: boolean - /** Setting description. */ + /** + * Setting description. + */ description: string - /** Setting type. */ + /** + * Setting type. + */ propertyType: EngineSettingPropertyType - /** Setting base unit. */ + /** + * Setting base unit. + */ unit?: string - /** Validation regex for string type settings. */ + /** + * Validation regex for string type settings. + */ stringConstraint?: string - /** Minimum value for int types. */ + /** + * Minimum value for int types. + */ intMin?: number - /** Maximum value for int types. */ + /** + * Maximum value for int types. + */ intMax?: number - /** Minimum value for float types. */ + /** + * Minimum value for float types. + */ floatMin?: number - /** Maximum value for float types. */ + /** + * Maximum value for float types. + */ floatMax?: number } export interface Endpoint { - /** UUID of the endpoint. */ + /** + * UUID of the endpoint. + */ id: string /** * IPv4 address of the endpoint. @@ -187,33 +219,30 @@ export interface Endpoint { * One-of ('address'): at most one of 'ip', 'hostname' could be set. */ ip?: string - /** TCP port of the endpoint. */ + /** + * TCP port of the endpoint. + */ port: number - /** Name of the endpoint. */ + /** + * Name of the endpoint. + */ name?: string /** - * Private Network details. One maximum per Database Instance or Read Replica - * (a Database Instance and its Read Replica can have different Private - * Networks). Cannot be updated (has to be deleted and recreated). + * Private Network details. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated). * - * One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', - * 'directAccess' could be set. + * One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set. */ privateNetwork?: EndpointPrivateNetworkDetails /** - * Load balancer details. Public endpoint for Database Instance which is - * systematically present. One per Database Instance. + * Load balancer details. Public endpoint for Database Instance which is systematically present. One per Database Instance. * - * One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', - * 'directAccess' could be set. + * One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set. */ loadBalancer?: EndpointLoadBalancerDetails /** - * Direct access details. Public endpoint reserved for Read Replicas. One per - * Read Replica. + * Direct access details. Public endpoint reserved for Read Replicas. One per Read Replica. * - * One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', - * 'directAccess' could be set. + * One-of ('details'): at most one of 'privateNetwork', 'loadBalancer', 'directAccess' could be set. */ directAccess?: EndpointDirectAccessDetails /** @@ -227,20 +256,18 @@ export interface Endpoint { export interface EndpointSpecLoadBalancer {} export interface EndpointSpecPrivateNetwork { - /** UUID of the Private Network to be connected to the Database Instance. */ + /** + * UUID of the Private Network to be connected to the Database Instance. + */ privateNetworkId: string /** - * Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway - * documentation to learn more about IP and subnet limitations. + * Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. * * One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set. */ serviceIp?: string /** - * Automated configuration of your Private Network endpoint with Scaleway IPAM - * service. One at the most per Database Instance or Read Replica (a Database - * Instance and its Read Replica can have different Private Networks). Cannot - * be updated (has to be deleted and recreated). + * Automated configuration of your Private Network endpoint with Scaleway IPAM service. One at the most per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated). * * One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set. */ @@ -250,20 +277,18 @@ export interface EndpointSpecPrivateNetwork { export interface ReadReplicaEndpointSpecDirectAccess {} export interface ReadReplicaEndpointSpecPrivateNetwork { - /** UUID of the Private Network to be connected to the Read Replica. */ + /** + * UUID of the Private Network to be connected to the Read Replica. + */ privateNetworkId: string /** - * Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway - * documentation to learn more about IP and subnet limitations. + * Endpoint IPv4 address with a CIDR notation. Refer to the official Scaleway documentation to learn more about IP and subnet limitations. * * One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set. */ serviceIp?: string /** - * Automated configuration of your Private Network endpoint with Scaleway IPAM - * service. One at the most per Database Instance or Read Replica (a Database - * Instance and its Read Replica can have different private networks). Cannot - * be updated (has to be deleted and recreated). + * Automated configuration of your Private Network endpoint with Scaleway IPAM service. One at the most per Database Instance or Read Replica (a Database Instance and its Read Replica can have different private networks). Cannot be updated (has to be deleted and recreated). * * One-of ('config'): at most one of 'serviceIp', 'ipamConfig' could be set. */ @@ -271,30 +296,52 @@ export interface ReadReplicaEndpointSpecPrivateNetwork { } export interface EngineVersion { - /** Database engine version. */ + /** + * Database engine version. + */ version: string - /** Database engine name. */ + /** + * Database engine name. + */ name: string - /** End of life date. */ + /** + * End of life date. + */ endOfLife?: Date - /** Engine settings available to be set. */ + /** + * Engine settings available to be set. + */ availableSettings: EngineSetting[] - /** Disabled versions cannot be created. */ + /** + * Disabled versions cannot be created. + */ disabled: boolean - /** Beta status of engine version. */ + /** + * Beta status of engine version. + */ beta: boolean - /** Engine settings available to be set at database initialization. */ + /** + * Engine settings available to be set at database initialization. + */ availableInitSettings: EngineSetting[] } export interface BackupSchedule { - /** Frequency of the backup schedule (in hours). */ + /** + * Frequency of the backup schedule (in hours). + */ frequency: number - /** Default retention period of backups (in days). */ + /** + * Default retention period of backups (in days). + */ retention: number - /** Defines whether the backup schedule feature is disabled. */ + /** + * Defines whether the backup schedule feature is disabled. + */ disabled: boolean - /** Next run of the backup schedule (accurate to 10 minutes). */ + /** + * Next run of the backup schedule (accurate to 10 minutes). + */ nextRunAt?: Date } @@ -308,42 +355,67 @@ export interface InstanceSetting { } export interface LogsPolicy { - /** Max age (in days) of remote logs to keep on the Database Instance. */ + /** + * Max age (in days) of remote logs to keep on the Database Instance. + */ maxAgeRetention?: number - /** Max disk size of remote logs to keep on the Database Instance. */ + /** + * Max disk size of remote logs to keep on the Database Instance. + */ totalDiskRetention?: number } export interface Maintenance { - /** Start date of the maintenance window. */ + /** + * Start date of the maintenance window. + */ startsAt?: Date - /** End date of the maintenance window. */ + /** + * End date of the maintenance window. + */ stopsAt?: Date - /** Closed maintenance date. */ + /** + * Closed maintenance date. + */ closedAt?: Date - /** Maintenance information message. */ + /** + * Maintenance information message. + */ reason: string - /** Status of the maintenance. */ + /** + * Status of the maintenance. + */ status: MaintenanceStatus - /** Time when Scaleway-side maintenance will be applied. */ + /** + * Time when Scaleway-side maintenance will be applied. + */ forcedAt?: Date } export interface ReadReplica { - /** UUID of the Read Replica. */ + /** + * UUID of the Read Replica. + */ id: string - /** Display Read Replica connection information. */ + /** + * Display Read Replica connection information. + */ endpoints: Endpoint[] - /** Read replica status. */ + /** + * Read replica status. + */ status: ReadReplicaStatus - /** Region the Read Replica is in. */ + /** + * Region the Read Replica is in. + */ region: ScwRegion /** - * Whether the replica is in the same availability zone as the main instance - * nodes or not. + * Whether the replica is in the same availability zone as the main instance nodes or not. */ sameZone: boolean - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string } @@ -361,24 +433,40 @@ export interface Volume { } export interface NodeTypeVolumeConstraintSizes { - /** [deprecated] Mimimum size required for the Volume. */ + /** + * [deprecated] Mimimum size required for the Volume. + */ minSize: number - /** [deprecated] Maximum size required for the Volume. */ + /** + * [deprecated] Maximum size required for the Volume. + */ maxSize: number } export interface NodeTypeVolumeType { - /** Volume Type. */ + /** + * Volume Type. + */ type: VolumeType - /** The description of the Volume. */ + /** + * The description of the Volume. + */ description: string - /** Mimimum size required for the Volume. */ + /** + * Mimimum size required for the Volume. + */ minSize: number - /** Maximum size required for the Volume. */ + /** + * Maximum size required for the Volume. + */ maxSize: number - /** Minimum increment level for a Block Storage volume size. */ + /** + * Minimum increment level for a Block Storage volume size. + */ chunkSize: number - /** The storage class of the volume. */ + /** + * The storage class of the volume. + */ class: StorageClass } @@ -394,7 +482,9 @@ export interface ACLRuleRequest { export interface ACLRule { ip: string - /** @deprecated */ + /** + * @deprecated + */ port?: number protocol: ACLRuleProtocol direction: ACLRuleDirection @@ -404,94 +494,128 @@ export interface ACLRule { export interface EndpointSpec { /** - * Load balancer endpoint specifications. Public endpoint for Database - * Instance which is systematically present. One per RDB instance. + * Load balancer endpoint specifications. Public endpoint for Database Instance which is systematically present. One per RDB instance. * - * One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be - * set. + * One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be set. */ loadBalancer?: EndpointSpecLoadBalancer /** - * Private Network endpoint specifications. One maximum per Database Instance - * or Read Replica (a Database Instance and its Read Replica can have - * different Private Networks). Cannot be updated (has to be deleted and - * recreated). + * Private Network endpoint specifications. One maximum per Database Instance or Read Replica (a Database Instance and its Read Replica can have different Private Networks). Cannot be updated (has to be deleted and recreated). * - * One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be - * set. + * One-of ('spec'): at most one of 'loadBalancer', 'privateNetwork' could be set. */ privateNetwork?: EndpointSpecPrivateNetwork } export interface ReadReplicaEndpointSpec { /** - * Direct access endpoint specifications. Public endpoint reserved for Read - * Replicas. One per Read Replica. + * Direct access endpoint specifications. Public endpoint reserved for Read Replicas. One per Read Replica. * - * One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be - * set. + * One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be set. */ directAccess?: ReadReplicaEndpointSpecDirectAccess /** - * Private Network endpoint specifications. One at the most per Read Replica. - * Cannot be updated (has to be deleted and recreated). + * Private Network endpoint specifications. One at the most per Read Replica. Cannot be updated (has to be deleted and recreated). * - * One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be - * set. + * One-of ('spec'): at most one of 'directAccess', 'privateNetwork' could be set. */ privateNetwork?: ReadReplicaEndpointSpecPrivateNetwork } export interface DatabaseBackup { - /** UUID of the database backup. */ + /** + * UUID of the database backup. + */ id: string - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of backed up database. */ + /** + * Name of backed up database. + */ databaseName: string - /** Name of the backup. */ + /** + * Name of the backup. + */ name: string - /** Status of the backup. */ + /** + * Status of the backup. + */ status: DatabaseBackupStatus - /** Size of the database backup. */ + /** + * Size of the database backup. + */ size?: number - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date - /** Creation date (must follow the ISO 8601 format). */ + /** + * Creation date (must follow the ISO 8601 format). + */ createdAt?: Date - /** Updated date (must follow the ISO 8601 format). */ + /** + * Updated date (must follow the ISO 8601 format). + */ updatedAt?: Date - /** Name of the Database Instance of the backup. */ + /** + * Name of the Database Instance of the backup. + */ instanceName: string - /** URL you can download the backup from. */ + /** + * URL you can download the backup from. + */ downloadUrl?: string - /** Expiration date of the download link. */ + /** + * Expiration date of the download link. + */ downloadUrlExpiresAt?: Date - /** Region of the database backup. */ + /** + * Region of the database backup. + */ region: ScwRegion - /** Store logical backups in the same region as the source Database Instance. */ + /** + * Store logical backups in the same region as the source Database Instance. + */ sameRegion: boolean } export interface DatabaseEngine { - /** Engine name. */ + /** + * Engine name. + */ name: string - /** Engine logo URL. */ + /** + * Engine logo URL. + */ logoUrl: string - /** Available versions. */ + /** + * Available versions. + */ versions: EngineVersion[] - /** Region of this Database Instance. */ + /** + * Region of this Database Instance. + */ region: ScwRegion } export interface Database { - /** Name of the database. */ + /** + * Name of the database. + */ name: string - /** Name of the database owner. */ + /** + * Name of the database owner. + */ owner: string - /** Defines whether the database is managed or not. */ + /** + * Defines whether the database is managed or not. + */ managed: boolean - /** Size of the database. */ + /** + * Size of the database. + */ size: number } @@ -501,1152 +625,1509 @@ export interface ListInstanceLogsDetailsResponseInstanceLogDetail { } export interface InstanceLog { - /** Presigned Object Storage URL to download your log file. */ + /** + * Presigned Object Storage URL to download your log file. + */ downloadUrl?: string - /** UUID of the Database Instance log. */ + /** + * UUID of the Database Instance log. + */ id: string - /** Status of the logs in a Database Instance. */ + /** + * Status of the logs in a Database Instance. + */ status: InstanceLogStatus - /** Name of the underlying node. */ + /** + * Name of the underlying node. + */ nodeName: string - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date - /** Creation date (must follow the ISO 8601 format). */ + /** + * Creation date (must follow the ISO 8601 format). + */ createdAt?: Date - /** Region the Database Instance is in. */ + /** + * Region the Database Instance is in. + */ region: ScwRegion } export interface Instance { - /** Creation date (must follow the ISO 8601 format). */ + /** + * Creation date (must follow the ISO 8601 format). + */ createdAt?: Date - /** Volumes of the Database Instance. */ + /** + * Volumes of the Database Instance. + */ volume?: Volume - /** Region the Database Instance is in. */ + /** + * Region the Database Instance is in. + */ region: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ id: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name: string - /** Organization ID the Database Instance belongs to. */ + /** + * Organization ID the Database Instance belongs to. + */ organizationId: string - /** Project ID the Database Instance belongs to. */ + /** + * Project ID the Database Instance belongs to. + */ projectId: string - /** Status of the Database Instance. */ + /** + * Status of the Database Instance. + */ status: InstanceStatus - /** Database engine of the database (PostgreSQL, MySQL, ...). */ + /** + * Database engine of the database (PostgreSQL, MySQL, ...). + */ engine: string - /** Available database engine versions for upgrade. */ + /** + * Available database engine versions for upgrade. + */ upgradableVersion: UpgradableVersion[] - /** @deprecated Endpoint of the Database Instance. */ + /** + * @deprecated Endpoint of the Database Instance. + */ endpoint?: Endpoint - /** List of tags applied to the Database Instance. */ + /** + * List of tags applied to the Database Instance. + */ tags: string[] - /** Advanced settings of the Database Instance. */ + /** + * Advanced settings of the Database Instance. + */ settings: InstanceSetting[] - /** Backup schedule of the Database Instance. */ + /** + * Backup schedule of the Database Instance. + */ backupSchedule?: BackupSchedule - /** Defines whether or not High-Availability is enabled. */ + /** + * Defines whether or not High-Availability is enabled. + */ isHaCluster: boolean - /** Read Replicas of the Database Instance. */ + /** + * Read Replicas of the Database Instance. + */ readReplicas: ReadReplica[] - /** Node type of the Database Instance. */ + /** + * Node type of the Database Instance. + */ nodeType: string - /** List of engine settings to be set at database initialization. */ + /** + * List of engine settings to be set at database initialization. + */ initSettings: InstanceSetting[] - /** List of Database Instance endpoints. */ + /** + * List of Database Instance endpoints. + */ endpoints: Endpoint[] - /** Logs policy of the Database Instance. */ + /** + * Logs policy of the Database Instance. + */ logsPolicy?: LogsPolicy - /** Store logical backups in the same region as the Database Instance. */ + /** + * Store logical backups in the same region as the Database Instance. + */ backupSameRegion: boolean - /** List of Database Instance maintenance events. */ + /** + * List of Database Instance maintenance events. + */ maintenances: Maintenance[] - /** Encryption at rest settings for your Database Instance. */ + /** + * Encryption at rest settings for your Database Instance. + */ encryption?: EncryptionAtRest } export interface NodeType { - /** Node Type name identifier. */ + /** + * Node Type name identifier. + */ name: string - /** Current stock status for the Node Type. */ + /** + * Current stock status for the Node Type. + */ stockStatus: NodeTypeStock - /** Current specs of the offer. */ + /** + * Current specs of the offer. + */ description: string - /** Number of virtual CPUs. */ + /** + * Number of virtual CPUs. + */ vcpus: number - /** Quantity of RAM. */ + /** + * Quantity of RAM. + */ memory: number - /** @deprecated {undefined} Deprecated Node Type volume constraints. */ + /** + * @deprecated [deprecated] Node Type volume constraints. + */ volumeConstraint?: NodeTypeVolumeConstraintSizes - /** @deprecated The Node Type is compliant with Block Storage. */ + /** + * @deprecated The Node Type is compliant with Block Storage. + */ isBssdCompatible?: boolean - /** The Node Type is currently disabled. */ + /** + * The Node Type is currently disabled. + */ disabled: boolean - /** The Node Type is currently in beta. */ + /** + * The Node Type is currently in beta. + */ beta: boolean - /** Available storage options for the Node Type. */ + /** + * Available storage options for the Node Type. + */ availableVolumeTypes: NodeTypeVolumeType[] - /** The Node Type can be used only with high availability option. */ + /** + * The Node Type can be used only with high availability option. + */ isHaRequired: boolean - /** Generation associated with the NodeType offer. */ + /** + * Generation associated with the NodeType offer. + */ generation: NodeTypeGeneration - /** Instance range associated with the NodeType offer. */ + /** + * Instance range associated with the NodeType offer. + */ instanceRange: string - /** Region the Node Type is in. */ + /** + * Region the Node Type is in. + */ region: ScwRegion } export interface Privilege { - /** Permission (Read, Read/Write, All, Custom). */ + /** + * Permission (Read, Read/Write, All, Custom). + */ permission: Permission - /** Name of the database. */ + /** + * Name of the database. + */ databaseName: string - /** Name of the user. */ + /** + * Name of the user. + */ userName: string } export interface Snapshot { - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ id: string - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name: string - /** Status of the snapshot. */ + /** + * Status of the snapshot. + */ status: SnapshotStatus - /** Size of the snapshot. */ + /** + * Size of the snapshot. + */ size?: number - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date - /** Creation date (must follow the ISO 8601 format). */ + /** + * Creation date (must follow the ISO 8601 format). + */ createdAt?: Date - /** Updated date (must follow the ISO 8601 format). */ + /** + * Updated date (must follow the ISO 8601 format). + */ updatedAt?: Date - /** Name of the Database Instance of the snapshot. */ + /** + * Name of the Database Instance of the snapshot. + */ instanceName: string - /** Source node type. */ + /** + * Source node type. + */ nodeType: string - /** Type of volume where data is stored (lssd, bssd or sbs). */ + /** + * Type of volume where data is stored (lssd, bssd or sbs). + */ volumeType?: SnapshotVolumeType - /** Region of this snapshot. */ + /** + * Region of this snapshot. + */ region: ScwRegion } export interface User { /** - * Name of the user (Length must be between 1 and 63 characters for PostgreSQL - * and between 1 and 32 characters for MySQL. First character must be an - * alphabet character (a-zA-Z). Your username cannot start with '_rdb' or in - * PostgreSQL, 'pg_'. Only a-zA-Z0-9_$- characters are accepted). + * Name of the user (Length must be between 1 and 63 characters for PostgreSQL and between 1 and 32 characters for MySQL. First character must be an alphabet character (a-zA-Z). Your username cannot start with '_rdb' or in PostgreSQL, 'pg_'. Only a-zA-Z0-9_$- characters are accepted). */ name: string /** - * Defines whether or not a user got administrative privileges on the Database - * Instance. + * Defines whether or not a user got administrative privileges on the Database Instance. */ isAdmin: boolean } export interface UpgradeInstanceRequestMajorUpgradeWorkflow { /** - * This will create a new Database Instance with same specifications as the - * current one and perform a Database Engine upgrade. + * This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade. */ upgradableVersionId: string /** - * At the end of the migration procedure this option let you migrate all your - * database endpoint to the upgraded instance. + * At the end of the migration procedure this option let you migrate all your database endpoint to the upgraded instance. */ withEndpoints: boolean } export type AddInstanceACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to add ACL rules to. */ + /** + * UUID of the Database Instance you want to add ACL rules to. + */ instanceId: string - /** ACL rules to add to the Database Instance. */ + /** + * ACL rules to add to the Database Instance. + */ rules: ACLRuleRequest[] } export interface AddInstanceACLRulesResponse { - /** ACL Rules enabled for the Database Instance. */ + /** + * ACL Rules enabled for the Database Instance. + */ rules: ACLRule[] } export type AddInstanceSettingsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to add settings to. */ + /** + * UUID of the Database Instance you want to add settings to. + */ instanceId: string - /** Settings to add to the Database Instance. */ + /** + * Settings to add to the Database Instance. + */ settings: InstanceSetting[] } export interface AddInstanceSettingsResponse { - /** Settings available on the Database Instance. */ + /** + * Settings available on the Database Instance. + */ settings: InstanceSetting[] } export type ApplyInstanceMaintenanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to apply maintenance. */ + /** + * UUID of the Database Instance you want to apply maintenance. + */ instanceId: string } export type CloneInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to clone. */ + /** + * UUID of the Database Instance you want to clone. + */ instanceId: string - /** Name of the Database Instance clone. */ + /** + * Name of the Database Instance clone. + */ name: string - /** Node type of the clone. */ + /** + * Node type of the clone. + */ nodeType?: string } export type CreateDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of the database you want to back up. */ + /** + * Name of the database you want to back up. + */ databaseName: string - /** Name of the backup. */ + /** + * Name of the backup. + */ name?: string - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date } export type CreateDatabaseRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance where to create the database. */ + /** + * UUID of the Database Instance where to create the database. + */ instanceId: string - /** Name of the database. */ + /** + * Name of the database. + */ name: string } export type CreateEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you to which you want to add an endpoint. */ + /** + * UUID of the Database Instance you to which you want to add an endpoint. + */ instanceId: string - /** Specification of the endpoint you want to create. */ + /** + * Specification of the endpoint you want to create. + */ endpointSpec?: EndpointSpec } export type CreateInstanceFromSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Block snapshot of the Database Instance. */ + /** + * Block snapshot of the Database Instance. + */ snapshotId: string - /** Name of the Database Instance created with the snapshot. */ + /** + * Name of the Database Instance created with the snapshot. + */ instanceName: string /** - * Defines whether or not High-Availability is enabled on the new Database - * Instance. + * Defines whether or not High-Availability is enabled on the new Database Instance. */ isHaCluster?: boolean - /** The node type used to restore the snapshot. */ + /** + * The node type used to restore the snapshot. + */ nodeType?: string } export type CreateInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** * @deprecated Please use project_id instead. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * The Project ID on which the Database Instance will be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name?: string - /** Database engine of the Database Instance (PostgreSQL, MySQL, ...). */ + /** + * Database engine of the Database Instance (PostgreSQL, MySQL, ...). + */ engine: string - /** Username created when the Database Instance is created. */ + /** + * Username created when the Database Instance is created. + */ userName: string /** - * Password of the user. Password must be between 8 and 128 characters, - * contain at least one digit, one uppercase, one lowercase and one special - * character. + * Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character. */ password: string - /** Type of node to use for the Database Instance. */ + /** + * Type of node to use for the Database Instance. + */ nodeType: string - /** Defines whether or not High-Availability is enabled. */ + /** + * Defines whether or not High-Availability is enabled. + */ isHaCluster: boolean - /** Defines whether or not backups are disabled. */ + /** + * Defines whether or not backups are disabled. + */ disableBackup: boolean - /** Tags to apply to the Database Instance. */ + /** + * Tags to apply to the Database Instance. + */ tags?: string[] - /** List of engine settings to be set upon Database Instance initialization. */ + /** + * List of engine settings to be set upon Database Instance initialization. + */ initSettings?: InstanceSetting[] - /** Type of volume where data is stored (lssd, bssd, ...). */ + /** + * Type of volume where data is stored (lssd, bssd, ...). + */ volumeType?: VolumeType - /** Volume size when volume_type is not lssd. */ + /** + * Volume size when volume_type is not lssd. + */ volumeSize: number /** - * One or multiple EndpointSpec used to expose your Database Instance. A - * load_balancer public endpoint is systematically created. + * One or multiple EndpointSpec used to expose your Database Instance. A load_balancer public endpoint is systematically created. */ initEndpoints?: EndpointSpec[] /** - * Defines whether to or not to store logical backups in the same region as - * the Database Instance. + * Defines whether to or not to store logical backups in the same region as the Database Instance. */ backupSameRegion: boolean - /** Encryption at rest settings for your Database Instance. */ + /** + * Encryption at rest settings for your Database Instance. + */ encryption?: EncryptionAtRest } export type CreateReadReplicaEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Read Replica. */ + /** + * UUID of the Read Replica. + */ readReplicaId: string - /** Specification of the endpoint you want to create. */ + /** + * Specification of the endpoint you want to create. + */ endpointSpec: ReadReplicaEndpointSpec[] } export type CreateReadReplicaRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to create a Read Replica from. */ + /** + * UUID of the Database Instance you want to create a Read Replica from. + */ instanceId: string - /** Specification of the endpoint you want to create. */ + /** + * Specification of the endpoint you want to create. + */ endpointSpec?: ReadReplicaEndpointSpec[] /** - * Defines whether to create the replica in the same availability zone as the - * main instance nodes or not. + * Defines whether to create the replica in the same availability zone as the main instance nodes or not. */ sameZone?: boolean } export type CreateSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date } export type CreateUserRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance in which you want to create a user. */ + /** + * UUID of the Database Instance in which you want to create a user. + */ instanceId: string - /** Name of the user you want to create. */ + /** + * Name of the user you want to create. + */ name: string /** - * Password of the user you want to create. Password must be between 8 and 128 - * characters, contain at least one digit, one uppercase, one lowercase and - * one special character. + * Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character. */ password: string - /** Defines whether the user will have administrative privileges. */ + /** + * Defines whether the user will have administrative privileges. + */ isAdmin: boolean } export type DeleteDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the database backup to delete. */ + /** + * UUID of the database backup to delete. + */ databaseBackupId: string } export type DeleteDatabaseRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance where to delete the database. */ + /** + * UUID of the Database Instance where to delete the database. + */ instanceId: string - /** Name of the database to delete. */ + /** + * Name of the database to delete. + */ name: string } export type DeleteEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** This endpoint can also be used to delete a Read Replica endpoint. */ + /** + * This endpoint can also be used to delete a Read Replica endpoint. + */ endpointId: string } export type DeleteInstanceACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to delete an ACL rule from. */ + /** + * UUID of the Database Instance you want to delete an ACL rule from. + */ instanceId: string - /** IP addresses defined in the ACL rules of the Database Instance. */ + /** + * IP addresses defined in the ACL rules of the Database Instance. + */ aclRuleIps: string[] } export interface DeleteInstanceACLRulesResponse { - /** IP addresses defined in the ACL rules of the Database Instance. */ + /** + * IP addresses defined in the ACL rules of the Database Instance. + */ rules: ACLRule[] } export type DeleteInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to delete. */ + /** + * UUID of the Database Instance to delete. + */ instanceId: string } export type DeleteInstanceSettingsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to delete settings from. */ + /** + * UUID of the Database Instance to delete settings from. + */ instanceId: string - /** Settings names to delete. */ + /** + * Settings names to delete. + */ settingNames: string[] } export interface DeleteInstanceSettingsResponse { - /** Settings names to delete from the Database Instance. */ + /** + * Settings names to delete from the Database Instance. + */ settings: InstanceSetting[] } export type DeleteReadReplicaRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Read Replica. */ + /** + * UUID of the Read Replica. + */ readReplicaId: string } export type DeleteSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the snapshot to delete. */ + /** + * UUID of the snapshot to delete. + */ snapshotId: string } export type DeleteUserRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to delete the user from. */ + /** + * UUID of the Database Instance to delete the user from. + */ instanceId: string - /** Name of the user. */ + /** + * Name of the user. + */ name: string } export type ExportDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the database backup you want to export. */ + /** + * UUID of the database backup you want to export. + */ databaseBackupId: string } export type GetDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the database backup. */ + /** + * UUID of the database backup. + */ databaseBackupId: string } export type GetEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the endpoint you want to get. */ + /** + * UUID of the endpoint you want to get. + */ endpointId: string } export type GetInstanceCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string } export type GetInstanceLogRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the instance_log you want. */ + /** + * UUID of the instance_log you want. + */ instanceLogId: string } export type GetInstanceMetricsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Start date to gather metrics from. */ + /** + * Start date to gather metrics from. + */ startDate?: Date - /** End date to gather metrics from. */ + /** + * End date to gather metrics from. + */ endDate?: Date - /** Name of the metric to gather. */ + /** + * Name of the metric to gather. + */ metricName?: string } export type GetInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string } export type GetReadReplicaRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Read Replica. */ + /** + * UUID of the Read Replica. + */ readReplicaId: string } export type GetSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the snapshot. */ + /** + * UUID of the snapshot. + */ snapshotId: string } export interface InstanceMetrics { - /** Time series of metrics of a Database Instance. */ + /** + * Time series of metrics of a Database Instance. + */ timeseries: TimeSeries[] } export type ListDatabaseBackupsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the database backups. */ + /** + * Name of the database backups. + */ name?: string - /** Criteria to use when ordering database backups listing. */ + /** + * Criteria to use when ordering database backups listing. + */ orderBy?: ListDatabaseBackupsRequestOrderBy - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId?: string - /** Organization ID of the Organization the database backups belong to. */ + /** + * Organization ID of the Organization the database backups belong to. + */ organizationId?: string - /** Project ID of the Project the database backups belong to. */ + /** + * Project ID of the Project the database backups belong to. + */ projectId?: string page?: number pageSize?: number } export interface ListDatabaseBackupsResponse { - /** List of database backups. */ + /** + * List of database backups. + */ databaseBackups: DatabaseBackup[] - /** Total count of database backups available. */ + /** + * Total count of database backups available. + */ totalCount: number } export type ListDatabaseEnginesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the database engine. */ + /** + * Name of the database engine. + */ name?: string - /** Version of the database engine. */ + /** + * Version of the database engine. + */ version?: string page?: number pageSize?: number } export interface ListDatabaseEnginesResponse { - /** List of the available database engines. */ + /** + * List of the available database engines. + */ engines: DatabaseEngine[] - /** Total count of database engines available. */ + /** + * Total count of database engines available. + */ totalCount: number } export type ListDatabasesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to list the databases of. */ + /** + * UUID of the Database Instance to list the databases of. + */ instanceId: string - /** Name of the database. */ + /** + * Name of the database. + */ name?: string - /** Defines whether or not the database is managed. */ + /** + * Defines whether or not the database is managed. + */ managed?: boolean - /** User that owns this database. */ + /** + * User that owns this database. + */ owner?: string - /** Criteria to use when ordering database listing. */ + /** + * Criteria to use when ordering database listing. + */ orderBy?: ListDatabasesRequestOrderBy page?: number pageSize?: number } export interface ListDatabasesResponse { - /** List of the databases. */ + /** + * List of the databases. + */ databases: Database[] - /** Total count of databases present on a Database Instance. */ + /** + * Total count of databases present on a Database Instance. + */ totalCount: number } export type ListInstanceACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string page?: number pageSize?: number } export interface ListInstanceACLRulesResponse { - /** List of ACL rules present on a Database Instance. */ + /** + * List of ACL rules present on a Database Instance. + */ rules: ACLRule[] - /** Total count of ACL rules present on a Database Instance. */ + /** + * Total count of ACL rules present on a Database Instance. + */ totalCount: number } export type ListInstanceLogsDetailsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want logs of. */ + /** + * UUID of the Database Instance you want logs of. + */ instanceId: string } export interface ListInstanceLogsDetailsResponse { - /** Remote Database Instance logs details. */ + /** + * Remote Database Instance logs details. + */ details: ListInstanceLogsDetailsResponseInstanceLogDetail[] } export type ListInstanceLogsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want logs of. */ + /** + * UUID of the Database Instance you want logs of. + */ instanceId: string - /** Criteria to use when ordering Database Instance logs listing. */ + /** + * Criteria to use when ordering Database Instance logs listing. + */ orderBy?: ListInstanceLogsRequestOrderBy } export interface ListInstanceLogsResponse { - /** Available logs in a Database Instance. */ + /** + * Available logs in a Database Instance. + */ instanceLogs: InstanceLog[] } export type ListInstancesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** List Database Instances that have a given tag. */ + /** + * List Database Instances that have a given tag. + */ tags?: string[] - /** Lists Database Instances that match a name pattern. */ + /** + * Lists Database Instances that match a name pattern. + */ name?: string - /** Criteria to use when ordering Database Instance listings. */ + /** + * Criteria to use when ordering Database Instance listings. + */ orderBy?: ListInstancesRequestOrderBy - /** Please use project_id instead. */ + /** + * Please use project_id instead. + */ organizationId?: string - /** Project ID to list the Database Instance of. */ + /** + * Project ID to list the Database Instance of. + */ projectId?: string page?: number pageSize?: number } export interface ListInstancesResponse { - /** List of all Database Instances available in an Organization or Project. */ + /** + * List of all Database Instances available in an Organization or Project. + */ instances: Instance[] - /** Total count of Database Instances available in a Organization or Project. */ + /** + * Total count of Database Instances available in a Organization or Project. + */ totalCount: number } export type ListNodeTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Defines whether or not to include disabled types. */ + /** + * Defines whether or not to include disabled types. + */ includeDisabledTypes: boolean page?: number pageSize?: number } export interface ListNodeTypesResponse { - /** Types of the node. */ + /** + * Types of the node. + */ nodeTypes: NodeType[] - /** Total count of node-types available. */ + /** + * Total count of node-types available. + */ totalCount: number } export type ListPrivilegesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Criteria to use when ordering privileges listing. */ + /** + * Criteria to use when ordering privileges listing. + */ orderBy?: ListPrivilegesRequestOrderBy page?: number pageSize?: number - /** Name of the database. */ + /** + * Name of the database. + */ databaseName?: string - /** Name of the user. */ + /** + * Name of the user. + */ userName?: string } export interface ListPrivilegesResponse { - /** Privileges of a user in a database in a Database Instance. */ + /** + * Privileges of a user in a database in a Database Instance. + */ privileges: Privilege[] - /** Total count of privileges present on a database. */ + /** + * Total count of privileges present on a database. + */ totalCount: number } export type ListSnapshotsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** Criteria to use when ordering snapshot listing. */ + /** + * Criteria to use when ordering snapshot listing. + */ orderBy?: ListSnapshotsRequestOrderBy - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId?: string - /** Organization ID the snapshots belongs to. */ + /** + * Organization ID the snapshots belongs to. + */ organizationId?: string - /** Project ID the snapshots belongs to. */ + /** + * Project ID the snapshots belongs to. + */ projectId?: string page?: number pageSize?: number } export interface ListSnapshotsResponse { - /** List of snapshots. */ + /** + * List of snapshots. + */ snapshots: Snapshot[] - /** Total count of snapshots available. */ + /** + * Total count of snapshots available. + */ totalCount: number } export type ListUsersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of the user. */ + /** + * Name of the user. + */ name?: string - /** Criteria to use when requesting user listing. */ + /** + * Criteria to use when requesting user listing. + */ orderBy?: ListUsersRequestOrderBy page?: number pageSize?: number } export interface ListUsersResponse { - /** List of users in a Database Instance. */ + /** + * List of users in a Database Instance. + */ users: User[] - /** Total count of users present on a Database Instance. */ + /** + * Total count of users present on a Database Instance. + */ totalCount: number } export type MigrateEndpointRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the endpoint you want to migrate. */ + /** + * UUID of the endpoint you want to migrate. + */ endpointId: string - /** UUID of the instance you want to attach the endpoint to. */ + /** + * UUID of the instance you want to attach the endpoint to. + */ instanceId: string } export type PrepareInstanceLogsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want logs of. */ + /** + * UUID of the Database Instance you want logs of. + */ instanceId: string - /** Start datetime of your log. (RFC 3339 format). */ + /** + * Start datetime of your log. (RFC 3339 format). + */ startDate?: Date - /** End datetime of your log. (RFC 3339 format). */ + /** + * End datetime of your log. (RFC 3339 format). + */ endDate?: Date } export interface PrepareInstanceLogsResponse { - /** Instance logs for a Database Instance between a start and an end date. */ + /** + * Instance logs for a Database Instance between a start and an end date. + */ instanceLogs: InstanceLog[] } export type PromoteReadReplicaRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Read Replica. */ + /** + * UUID of the Read Replica. + */ readReplicaId: string } export type PurgeInstanceLogsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want logs of. */ + /** + * UUID of the Database Instance you want logs of. + */ instanceId: string - /** Given log name to purge. */ + /** + * Given log name to purge. + */ logName?: string } export type RenewInstanceCertificateRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want logs of. */ + /** + * UUID of the Database Instance you want logs of. + */ instanceId: string } export type ResetReadReplicaRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Read Replica. */ + /** + * UUID of the Read Replica. + */ readReplicaId: string } export type RestartInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to restart. */ + /** + * UUID of the Database Instance you want to restart. + */ instanceId: string } export type RestoreDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Backup of a logical database. */ + /** + * Backup of a logical database. + */ databaseBackupId: string /** - * Defines the destination database to restore into a specified database (the - * default destination is set to the origin database of the backup). + * Defines the destination database to restore into a specified database (the default destination is set to the origin database of the backup). */ databaseName?: string - /** Defines the Database Instance where the backup has to be restored. */ + /** + * Defines the Database Instance where the backup has to be restored. + */ instanceId: string } export type SetInstanceACLRulesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance where the ACL rules must be set. */ + /** + * UUID of the Database Instance where the ACL rules must be set. + */ instanceId: string - /** ACL rules to define for the Database Instance. */ + /** + * ACL rules to define for the Database Instance. + */ rules: ACLRuleRequest[] } export interface SetInstanceACLRulesResponse { - /** ACLs rules configured for a Database Instance. */ + /** + * ACLs rules configured for a Database Instance. + */ rules: ACLRule[] } export type SetInstanceSettingsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance where the settings must be set. */ + /** + * UUID of the Database Instance where the settings must be set. + */ instanceId: string - /** Settings to define for the Database Instance. */ + /** + * Settings to define for the Database Instance. + */ settings: InstanceSetting[] } export interface SetInstanceSettingsResponse { - /** Settings configured for a Database Instance. */ + /** + * Settings configured for a Database Instance. + */ settings: InstanceSetting[] } export type SetPrivilegeRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ instanceId: string - /** Name of the database. */ + /** + * Name of the database. + */ databaseName: string - /** Name of the user. */ + /** + * Name of the user. + */ userName: string - /** Permission to set (Read, Read/Write, All, Custom). */ + /** + * Permission to set (Read, Read/Write, All, Custom). + */ permission?: Permission } export type UpdateDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the database backup to update. */ + /** + * UUID of the database backup to update. + */ databaseBackupId: string - /** Name of the Database Backup. */ + /** + * Name of the Database Backup. + */ name?: string - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date } export type UpdateInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance to update. */ + /** + * UUID of the Database Instance to update. + */ instanceId: string - /** In hours. */ + /** + * In hours. + */ backupScheduleFrequency?: number - /** In days. */ + /** + * In days. + */ backupScheduleRetention?: number - /** Defines whether or not the backup schedule is disabled. */ + /** + * Defines whether or not the backup schedule is disabled. + */ isBackupScheduleDisabled?: boolean - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name?: string - /** Tags of a Database Instance. */ + /** + * Tags of a Database Instance. + */ tags?: string[] - /** Logs policy of the Database Instance. */ + /** + * Logs policy of the Database Instance. + */ logsPolicy?: LogsPolicy - /** Store logical backups in the same region as the Database Instance. */ + /** + * Store logical backups in the same region as the Database Instance. + */ backupSameRegion?: boolean - /** Defines the start time of the autobackup. */ + /** + * Defines the start time of the autobackup. + */ backupScheduleStartHour?: number } export type UpdateSnapshotRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the snapshot to update. */ + /** + * UUID of the snapshot to update. + */ snapshotId: string - /** Name of the snapshot. */ + /** + * Name of the snapshot. + */ name?: string - /** Expiration date (must follow the ISO 8601 format). */ + /** + * Expiration date (must follow the ISO 8601 format). + */ expiresAt?: Date } export type UpdateUserRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance the user belongs to. */ + /** + * UUID of the Database Instance the user belongs to. + */ instanceId: string - /** Name of the database user. */ + /** + * Name of the database user. + */ name: string /** - * Password of the database user. Password must be between 8 and 128 - * characters, contain at least one digit, one uppercase, one lowercase and - * one special character. + * Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character. */ password?: string - /** Defines whether or not this user got administrative privileges. */ + /** + * Defines whether or not this user got administrative privileges. + */ isAdmin?: boolean } export type UpgradeInstanceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Database Instance you want to upgrade. */ + /** + * UUID of the Database Instance you want to upgrade. + */ instanceId: string /** * Node type of the Database Instance you want to upgrade to. * - * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', - * 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', - * 'enableEncryption' could be set. + * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set. */ nodeType?: string /** - * Defines whether or not high availability should be enabled on the Database - * Instance. + * Defines whether or not high availability should be enabled on the Database Instance. * - * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', - * 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', - * 'enableEncryption' could be set. + * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set. */ enableHa?: boolean /** * Increase your block storage volume size. * - * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', - * 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', - * 'enableEncryption' could be set. + * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set. */ volumeSize?: number /** * Change your Database Instance storage type. * - * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', - * 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', - * 'enableEncryption' could be set. + * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set. */ volumeType?: VolumeType /** - * This will create a new Database Instance with same specifications as the - * current one and perform a Database Engine upgrade. + * This will create a new Database Instance with same specifications as the current one and perform a Database Engine upgrade. * - * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', - * 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', - * 'enableEncryption' could be set. + * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set. */ upgradableVersionId?: string /** - * Upgrade your database engine to a new major version including instance - * endpoints. + * Upgrade your database engine to a new major version including instance endpoints. * - * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', - * 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', - * 'enableEncryption' could be set. + * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set. */ majorUpgradeWorkflow?: UpgradeInstanceRequestMajorUpgradeWorkflow /** - * Defines whether or not encryption should be enabled on the Database - * Instance. + * Defines whether or not encryption should be enabled on the Database Instance. * - * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', - * 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', - * 'enableEncryption' could be set. + * One-of ('upgradeTarget'): at most one of 'nodeType', 'enableHa', 'volumeSize', 'volumeType', 'upgradableVersionId', 'majorUpgradeWorkflow', 'enableEncryption' could be set. */ enableEncryption?: boolean } diff --git a/packages/clients/src/api/redis/v1/api.gen.ts b/packages/clients/src/api/redis/v1/api.gen.ts index 769778a4b..2d9c26f03 100644 --- a/packages/clients/src/api/redis/v1/api.gen.ts +++ b/packages/clients/src/api/redis/v1/api.gen.ts @@ -77,8 +77,8 @@ const jsonContentHeaders = { /** * Managed Database for Redis™ API. - * - * This API allows you to manage your Managed Databases for Redis™. + +This API allows you to manage your Managed Databases for Redis™. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -92,10 +92,7 @@ export class API extends ParentAPI { ] /** - * Create a Redis™ Database Instance. Create a new Redis™ Database Instance - * (Redis™ cluster). You must set the `zone`, `project_id`, `version`, - * `node_type`, `user_name` and `password` parameters. Optionally you can - * define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`. + * Create a Redis™ Database Instance. Create a new Redis™ Database Instance (Redis™ cluster). You must set the `zone`, `project_id`, `version`, `node_type`, `user_name` and `password` parameters. Optionally you can define `acl_rules`, `endpoints`, `tls_enabled` and `cluster_settings`. * * @param request - The request {@link CreateClusterRequest} * @returns A Promise of Cluster @@ -114,9 +111,7 @@ export class API extends ParentAPI { ) /** - * Update a Redis™ Database Instance. Update the parameters of a Redis™ - * Database Instance (Redis™ cluster), including `name`, `tags`, `user_name` - * and `password`. + * Update a Redis™ Database Instance. Update the parameters of a Redis™ Database Instance (Redis™ cluster), including `name`, `tags`, `user_name` and `password`. * * @param request - The request {@link UpdateClusterRequest} * @returns A Promise of Cluster @@ -135,11 +130,7 @@ export class API extends ParentAPI { ) /** - * Get a Redis™ Database Instance. Retrieve information about a Redis™ - * Database Instance (Redis™ cluster). Specify the `cluster_id` and `region` - * in your request to get information such as `id`, `status`, `version`, - * `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints` - * about your cluster in the response. + * Get a Redis™ Database Instance. Retrieve information about a Redis™ Database Instance (Redis™ cluster). Specify the `cluster_id` and `region` in your request to get information such as `id`, `status`, `version`, `tls_enabled`, `cluster_settings`, `upgradable_versions` and `endpoints` about your cluster in the response. * * @param request - The request {@link GetClusterRequest} * @returns A Promise of Cluster @@ -200,12 +191,7 @@ export class API extends ParentAPI { ) /** - * List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ - * cluster) in the specified zone. By default, the Database Instances returned - * in the list are ordered by creation date in ascending order, though this - * can be modified via the order_by field. You can define additional - * parameters for your query, such as `tags`, `name`, `organization_id` and - * `version`. + * List Redis™ Database Instances. List all Redis™ Database Instances (Redis™ cluster) in the specified zone. By default, the Database Instances returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as `tags`, `name`, `organization_id` and `version`. * * @param request - The request {@link ListClustersRequest} * @returns A Promise of ListClustersResponse @@ -214,13 +200,7 @@ export class API extends ParentAPI { enrichForPagination('clusters', this.pageOfListClusters, request) /** - * Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, - * either by upgrading to a bigger node type (vertical scaling) or by adding - * more nodes to your Database Instance to increase your number of endpoints - * and distribute cache (horizontal scaling, available for clusters only). - * Note that scaling horizontally your Redis™ Database Instance will not renew - * its TLS certificate. In order to refresh the TLS certificate, you must use - * the Renew TLS certificate endpoint. + * Scale up a Redis™ Database Instance. Upgrade your Redis™ Database Instance, either by upgrading to a bigger node type (vertical scaling) or by adding more nodes to your Database Instance to increase your number of endpoints and distribute cache (horizontal scaling, available for clusters only). Note that scaling horizontally your Redis™ Database Instance will not renew its TLS certificate. In order to refresh the TLS certificate, you must use the Renew TLS certificate endpoint. * * @param request - The request {@link MigrateClusterRequest} * @returns A Promise of Cluster @@ -239,10 +219,7 @@ export class API extends ParentAPI { ) /** - * Delete a Redis™ Database Instance. Delete a Redis™ Database Instance - * (Redis™ cluster), specified by the `region` and `cluster_id` parameters. - * Deleting a Database Instance is permanent, and cannot be undone. Note that - * upon deletion all your data will be lost. + * Delete a Redis™ Database Instance. Delete a Redis™ Database Instance (Redis™ cluster), specified by the `region` and `cluster_id` parameters. Deleting a Database Instance is permanent, and cannot be undone. Note that upon deletion all your data will be lost. * * @param request - The request {@link DeleteClusterRequest} * @returns A Promise of Cluster @@ -257,9 +234,7 @@ export class API extends ParentAPI { ) /** - * Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ - * Database Instance (Redis™ cluster). You can define the period from which to - * retrieve metrics by specifying the `start_date` and `end_date`. + * Get metrics of a Redis™ Database Instance. Retrieve the metrics of a Redis™ Database Instance (Redis™ cluster). You can define the period from which to retrieve metrics by specifying the `start_date` and `end_date`. * * @param request - The request {@link GetClusterMetricsRequest} * @returns A Promise of ClusterMetricsResponse @@ -296,9 +271,7 @@ export class API extends ParentAPI { ) /** - * List available node types. List all available node types. By default, the - * node types returned in the list are ordered by creation date in ascending - * order, though this can be modified via the `order_by` field. + * List available node types. List all available node types. By default, the node types returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListNodeTypesRequest} * @returns A Promise of ListNodeTypesResponse @@ -329,9 +302,7 @@ export class API extends ParentAPI { ) /** - * List available Redis™ versions. List the Redis™ database engine versions - * available. You can define additional parameters for your query, such as - * `include_disabled`, `include_beta`, `include_deprecated` and `version`. + * List available Redis™ versions. List the Redis™ database engine versions available. You can define additional parameters for your query, such as `include_disabled`, `include_beta`, `include_deprecated` and `version`. * * @param request - The request {@link ListClusterVersionsRequest} * @returns A Promise of ListClusterVersionsResponse @@ -340,9 +311,7 @@ export class API extends ParentAPI { enrichForPagination('versions', this.pageOfListClusterVersions, request) /** - * Get the TLS certificate of a cluster. Retrieve information about the TLS - * certificate of a Redis™ Database Instance (Redis™ cluster). Details like - * name and content are returned in the response. + * Get the TLS certificate of a cluster. Retrieve information about the TLS certificate of a Redis™ Database Instance (Redis™ cluster). Details like name and content are returned in the response. * * @param request - The request {@link GetClusterCertificateRequest} * @returns A Promise of Blob @@ -356,11 +325,7 @@ export class API extends ParentAPI { }) /** - * Renew the TLS certificate of a cluster. Renew a TLS certificate for a - * Redis™ Database Instance (Redis™ cluster). Renewing a certificate means - * that you will not be able to connect to your Database Instance using the - * previous certificate. You will also need to download and update the new - * certificate for all database clients. + * Renew the TLS certificate of a cluster. Renew a TLS certificate for a Redis™ Database Instance (Redis™ cluster). Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients. * * @param request - The request {@link RenewClusterCertificateRequest} * @returns A Promise of Cluster @@ -379,9 +344,7 @@ export class API extends ParentAPI { ) /** - * Add advanced settings. Add an advanced setting to a Redis™ Database - * Instance (Redis™ cluster). You must set the `name` and the `value` of each - * setting. + * Add advanced settings. Add an advanced setting to a Redis™ Database Instance (Redis™ cluster). You must set the `name` and the `value` of each setting. * * @param request - The request {@link AddClusterSettingsRequest} * @returns A Promise of ClusterSettingsResponse @@ -400,9 +363,7 @@ export class API extends ParentAPI { ) /** - * Delete advanced setting. Delete an advanced setting in a Redis™ Database - * Instance (Redis™ cluster). You must specify the names of the settings you - * want to delete in the request body. + * Delete advanced setting. Delete an advanced setting in a Redis™ Database Instance (Redis™ cluster). You must specify the names of the settings you want to delete in the request body. * * @param request - The request {@link DeleteClusterSettingRequest} * @returns A Promise of Cluster @@ -417,9 +378,7 @@ export class API extends ParentAPI { ) /** - * Set advanced settings. Update an advanced setting for a Redis™ Database - * Instance (Redis™ cluster). Settings added upon database engine - * initalization can only be defined once, and cannot, therefore, be updated. + * Set advanced settings. Update an advanced setting for a Redis™ Database Instance (Redis™ cluster). Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated. * * @param request - The request {@link SetClusterSettingsRequest} * @returns A Promise of ClusterSettingsResponse @@ -438,8 +397,7 @@ export class API extends ParentAPI { ) /** - * Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database - * Instance (Redis™ cluster). + * Set ACL rules for a cluster. Replace all the ACL rules of a Redis™ Database Instance (Redis™ cluster). * * @param request - The request {@link SetAclRulesRequest} * @returns A Promise of SetAclRulesResponse @@ -458,8 +416,7 @@ export class API extends ParentAPI { ) /** - * Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ - * Database Instance (Redis™ cluster). + * Add ACL rules for a cluster. Add an additional ACL rule to a Redis™ Database Instance (Redis™ cluster). * * @param request - The request {@link AddAclRulesRequest} * @returns A Promise of AddAclRulesResponse @@ -478,9 +435,7 @@ export class API extends ParentAPI { ) /** - * Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database - * Instance (Redis™ cluster). You must specify the `acl_id` of the rule you - * want to delete in your request. + * Delete an ACL rule for a cluster. Delete an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule you want to delete in your request. * * @param request - The request {@link DeleteAclRuleRequest} * @returns A Promise of Cluster @@ -495,9 +450,7 @@ export class API extends ParentAPI { ) /** - * Get an ACL rule. Retrieve information about an ACL rule of a Redis™ - * Database Instance (Redis™ cluster). You must specify the `acl_id` of the - * rule in your request. + * Get an ACL rule. Retrieve information about an ACL rule of a Redis™ Database Instance (Redis™ cluster). You must specify the `acl_id` of the rule in your request. * * @param request - The request {@link GetAclRuleRequest} * @returns A Promise of ACLRule @@ -512,9 +465,7 @@ export class API extends ParentAPI { ) /** - * Set endpoints for a cluster. Update an endpoint for a Redis™ Database - * Instance (Redis™ cluster). You must specify the `cluster_id` and the - * `endpoints` parameters in your request. + * Set endpoints for a cluster. Update an endpoint for a Redis™ Database Instance (Redis™ cluster). You must specify the `cluster_id` and the `endpoints` parameters in your request. * * @param request - The request {@link SetEndpointsRequest} * @returns A Promise of SetEndpointsResponse @@ -533,9 +484,7 @@ export class API extends ParentAPI { ) /** - * Add endpoints for a cluster. Add a new endpoint for a Redis™ Database - * Instance (Redis™ cluster). You can add `private_network` or - * `public_network` specifications to the body of the request. + * Add endpoints for a cluster. Add a new endpoint for a Redis™ Database Instance (Redis™ cluster). You can add `private_network` or `public_network` specifications to the body of the request. * * @param request - The request {@link AddEndpointsRequest} * @returns A Promise of AddEndpointsResponse @@ -554,10 +503,7 @@ export class API extends ParentAPI { ) /** - * Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database - * Instance (Redis™ cluster). You must specify the `region` and `endpoint_id` - * parameters of the endpoint you want to delete. Note that might need to - * update any environment configurations that point to the deleted endpoint. + * Delete an endpoint for a cluster. Delete the endpoint of a Redis™ Database Instance (Redis™ cluster). You must specify the `region` and `endpoint_id` parameters of the endpoint you want to delete. Note that might need to update any environment configurations that point to the deleted endpoint. * * @param request - The request {@link DeleteEndpointRequest} * @returns A Promise of Cluster @@ -572,10 +518,7 @@ export class API extends ParentAPI { ) /** - * Get an endpoint. Retrieve information about a Redis™ Database Instance - * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, - * `port`, `private_network` and `public_network` specifications are returned - * in the response. + * Get an endpoint. Retrieve information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response. * * @param request - The request {@link GetEndpointRequest} * @returns A Promise of Endpoint @@ -590,10 +533,7 @@ export class API extends ParentAPI { ) /** - * Update an endpoint. Update information about a Redis™ Database Instance - * (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, - * `port`, `private_network` and `public_network` specifications are returned - * in the response. + * Update an endpoint. Update information about a Redis™ Database Instance (Redis™ cluster) endpoint. Full details about the endpoint, like `ips`, `port`, `private_network` and `public_network` specifications are returned in the response. * * @param request - The request {@link UpdateEndpointRequest} * @returns A Promise of Endpoint diff --git a/packages/clients/src/api/redis/v1/types.gen.ts b/packages/clients/src/api/redis/v1/types.gen.ts index b0472d868..acc3fd64e 100644 --- a/packages/clients/src/api/redis/v1/types.gen.ts +++ b/packages/clients/src/api/redis/v1/types.gen.ts @@ -37,29 +37,37 @@ export type PrivateNetworkProvisioningMode = 'static' | 'ipam' export interface EndpointSpecPrivateNetworkSpecIpamConfig {} export interface PrivateNetwork { - /** UUID of the Private Network. */ + /** + * UUID of the Private Network. + */ id: string - /** List of IPv4 CIDR notation addresses of the endpoint. */ + /** + * List of IPv4 CIDR notation addresses of the endpoint. + */ serviceIps: string[] - /** Zone of the Private Network. */ + /** + * Zone of the Private Network. + */ zone: ScwZone - /** How your endpoint ips are provisioned. */ + /** + * How your endpoint ips are provisioned. + */ provisioningMode: PrivateNetworkProvisioningMode } export interface PublicNetwork {} export interface EndpointSpecPrivateNetworkSpec { - /** UUID of the Private Network to connect to the Database Instance. */ + /** + * UUID of the Private Network to connect to the Database Instance. + */ id: string /** - * Endpoint IPv4 address with a CIDR notation. You must provide at least one - * IPv4 per node. + * Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. */ serviceIps: string[] /** - * Automated configuration of your Private Network endpoint with Scaleway IPAM - * service. + * Automated configuration of your Private Network endpoint with Scaleway IPAM service. */ ipamConfig?: EndpointSpecPrivateNetworkSpecIpamConfig } @@ -67,67 +75,101 @@ export interface EndpointSpecPrivateNetworkSpec { export interface EndpointSpecPublicNetworkSpec {} export interface AvailableClusterSetting { - /** Name of the setting. */ + /** + * Name of the setting. + */ name: string - /** Default value of the setting. */ + /** + * Default value of the setting. + */ defaultValue?: string - /** Type of setting. */ + /** + * Type of setting. + */ type: AvailableClusterSettingPropertyType - /** Description of the setting. */ + /** + * Description of the setting. + */ description: string - /** Optional maximum value of the setting. */ + /** + * Optional maximum value of the setting. + */ maxValue?: number - /** Optional minimum value of the setting. */ + /** + * Optional minimum value of the setting. + */ minValue?: number - /** Optional validation rule of the setting. */ + /** + * Optional validation rule of the setting. + */ regex?: string - /** Defines whether or not the setting is deprecated. */ + /** + * Defines whether or not the setting is deprecated. + */ deprecated: boolean } export interface ACLRule { - /** ID of the rule. */ + /** + * ID of the rule. + */ id: string - /** IPv4 network address of the rule. */ + /** + * IPv4 network address of the rule. + */ ipCidr?: string - /** Description of the rule. */ + /** + * Description of the rule. + */ description?: string } export interface ClusterSetting { - /** Value of the setting. */ + /** + * Value of the setting. + */ value: string - /** Name of the setting. */ + /** + * Name of the setting. + */ name: string } export interface Endpoint { - /** TCP port of the endpoint. */ + /** + * TCP port of the endpoint. + */ port: number /** * Private Network details. * - * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could - * be set. + * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could be set. */ privateNetwork?: PrivateNetwork /** * Public network details. * - * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could - * be set. + * One-of ('details'): at most one of 'privateNetwork', 'publicNetwork' could be set. */ publicNetwork?: PublicNetwork - /** List of IPv4 addresses of the endpoint. */ + /** + * List of IPv4 addresses of the endpoint. + */ ips: string[] - /** UUID of the endpoint. */ + /** + * UUID of the endpoint. + */ id: string } export interface ACLRuleSpec { - /** IPv4 network address of the rule. */ + /** + * IPv4 network address of the rule. + */ ipCidr: string - /** Description of the rule. */ + /** + * Description of the rule. + */ description: string } @@ -135,411 +177,646 @@ export interface EndpointSpec { /** * Private Network specification details. * - * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' - * could be set. + * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set. */ privateNetwork?: EndpointSpecPrivateNetworkSpec /** * Public network specification details. * - * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' - * could be set. + * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set. */ publicNetwork?: EndpointSpecPublicNetworkSpec } export interface ClusterVersion { - /** Redis™ engine version. */ + /** + * Redis™ engine version. + */ version: string - /** Date of End of Life. */ + /** + * Date of End of Life. + */ endOfLifeAt?: Date - /** Cluster settings available to be updated. */ + /** + * Cluster settings available to be updated. + */ availableSettings: AvailableClusterSetting[] - /** Redis™ logo url. */ + /** + * Redis™ logo url. + */ logoUrl: string - /** Zone of the Redis™ Database Instance. */ + /** + * Zone of the Redis™ Database Instance. + */ zone: ScwZone } export interface Cluster { - /** UUID of the Database Instance. */ + /** + * UUID of the Database Instance. + */ id: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name: string - /** Project ID the Database Instance belongs to. */ + /** + * Project ID the Database Instance belongs to. + */ projectId: string - /** Status of the Database Instance. */ + /** + * Status of the Database Instance. + */ status: ClusterStatus - /** Redis™ engine version of the Database Instance. */ + /** + * Redis™ engine version of the Database Instance. + */ version: string - /** List of Database Instance endpoints. */ + /** + * List of Database Instance endpoints. + */ endpoints: Endpoint[] - /** List of tags applied to the Database Instance. */ + /** + * List of tags applied to the Database Instance. + */ tags: string[] - /** Node type of the Database Instance. */ + /** + * Node type of the Database Instance. + */ nodeType: string - /** Creation date (Format ISO 8601). */ + /** + * Creation date (Format ISO 8601). + */ createdAt?: Date - /** Update date (Format ISO 8601). */ + /** + * Update date (Format ISO 8601). + */ updatedAt?: Date - /** Defines whether or not TLS is enabled. */ + /** + * Defines whether or not TLS is enabled. + */ tlsEnabled: boolean - /** List of Database Instance settings. */ + /** + * List of Database Instance settings. + */ clusterSettings: ClusterSetting[] - /** List of ACL rules. */ + /** + * List of ACL rules. + */ aclRules: ACLRule[] - /** Number of nodes of the Database Instance cluster. */ + /** + * Number of nodes of the Database Instance cluster. + */ clusterSize: number - /** Zone of the Database Instance. */ + /** + * Zone of the Database Instance. + */ zone: ScwZone - /** Name of the user associated to the cluster. */ + /** + * Name of the user associated to the cluster. + */ userName: string - /** List of engine versions the Database Instance can upgrade to. */ + /** + * List of engine versions the Database Instance can upgrade to. + */ upgradableVersions: string[] } export interface NodeType { - /** Node type name. */ + /** + * Node type name. + */ name: string - /** Current stock status of the node type. */ + /** + * Current stock status of the node type. + */ stockStatus: NodeTypeStock - /** Current specifications of the offer. */ + /** + * Current specifications of the offer. + */ description: string - /** Number of virtual CPUs. */ + /** + * Number of virtual CPUs. + */ vcpus: number - /** Quantity of RAM. */ + /** + * Quantity of RAM. + */ memory: number - /** Defines whether node type is currently disabled or not. */ + /** + * Defines whether node type is currently disabled or not. + */ disabled: boolean - /** Defines whether node type is currently in beta. */ + /** + * Defines whether node type is currently in beta. + */ beta: boolean - /** Zone of the node type. */ + /** + * Zone of the node type. + */ zone: ScwZone } export type AddAclRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance you want to add ACL rules to. */ + /** + * UUID of the Database Instance you want to add ACL rules to. + */ clusterId: string - /** ACLs rules to add to the cluster. */ + /** + * ACLs rules to add to the cluster. + */ aclRules: ACLRuleSpec[] } export interface AddAclRulesResponse { - /** ACL Rules enabled for the Database Instance. */ + /** + * ACL Rules enabled for the Database Instance. + */ aclRules: ACLRule[] - /** Total count of ACL rules of the Database Instance. */ + /** + * Total count of ACL rules of the Database Instance. + */ totalCount: number } export type AddClusterSettingsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance you want to add settings to. */ + /** + * UUID of the Database Instance you want to add settings to. + */ clusterId: string - /** Settings to add to the cluster. */ + /** + * Settings to add to the cluster. + */ settings: ClusterSetting[] } export type AddEndpointsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance you want to add endpoints to. */ + /** + * UUID of the Database Instance you want to add endpoints to. + */ clusterId: string - /** Endpoints to add to the Database Instance. */ + /** + * Endpoints to add to the Database Instance. + */ endpoints: EndpointSpec[] } export interface AddEndpointsResponse { - /** Endpoints defined on the Database Instance. */ + /** + * Endpoints defined on the Database Instance. + */ endpoints: Endpoint[] - /** Total count of endpoints of the Database Instance. */ + /** + * Total count of endpoints of the Database Instance. + */ totalCount: number } export interface ClusterMetricsResponse { - /** Time series of metrics of a given cluster. */ + /** + * Time series of metrics of a given cluster. + */ timeseries: TimeSeries[] } export interface ClusterSettingsResponse { - /** Settings configured for a given Database Instance. */ + /** + * Settings configured for a given Database Instance. + */ settings: ClusterSetting[] } export type CreateClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Project ID in which to create the Database Instance. */ + /** + * Project ID in which to create the Database Instance. + */ projectId?: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name?: string - /** Redis™ engine version of the Database Instance. */ + /** + * Redis™ engine version of the Database Instance. + */ version: string - /** Tags to apply to the Database Instance. */ + /** + * Tags to apply to the Database Instance. + */ tags?: string[] - /** Type of node to use for the Database Instance. */ + /** + * Type of node to use for the Database Instance. + */ nodeType: string - /** Name of the user created upon Database Instance creation. */ + /** + * Name of the user created upon Database Instance creation. + */ userName: string - /** Password of the user. */ + /** + * Password of the user. + */ password: string - /** Number of nodes in the Redis™ cluster. */ + /** + * Number of nodes in the Redis™ cluster. + */ clusterSize?: number - /** List of ACLRuleSpec used to secure your publicly exposed cluster. */ + /** + * List of ACLRuleSpec used to secure your publicly exposed cluster. + */ aclRules?: ACLRuleSpec[] /** - * Zero or multiple EndpointSpec used to expose your cluster publicly and - * inside private networks. If no EndpoindSpec is given the cluster will be - * publicly exposed by default. + * Zero or multiple EndpointSpec used to expose your cluster publicly and inside private networks. If no EndpoindSpec is given the cluster will be publicly exposed by default. */ endpoints?: EndpointSpec[] - /** Defines whether or not TLS is enabled. */ + /** + * Defines whether or not TLS is enabled. + */ tlsEnabled: boolean - /** List of advanced settings to be set upon Database Instance initialization. */ + /** + * List of advanced settings to be set upon Database Instance initialization. + */ clusterSettings?: ClusterSetting[] } export type DeleteAclRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the ACL rule you want to delete. */ + /** + * UUID of the ACL rule you want to delete. + */ aclId: string } export type DeleteClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance to delete. */ + /** + * UUID of the Database Instance to delete. + */ clusterId: string } export type DeleteClusterSettingRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance where the settings must be set. */ + /** + * UUID of the Database Instance where the settings must be set. + */ clusterId: string - /** Setting name to delete. */ + /** + * Setting name to delete. + */ settingName: string } export type DeleteEndpointRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the endpoint you want to delete. */ + /** + * UUID of the endpoint you want to delete. + */ endpointId: string } export type GetAclRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the ACL rule you want to get. */ + /** + * UUID of the ACL rule you want to get. + */ aclId: string } export type GetClusterCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the cluster. */ + /** + * UUID of the cluster. + */ clusterId: string } export type GetClusterMetricsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the cluster. */ + /** + * UUID of the cluster. + */ clusterId: string - /** Start date. */ + /** + * Start date. + */ startAt?: Date - /** End date. */ + /** + * End date. + */ endAt?: Date - /** Name of the metric to gather. */ + /** + * Name of the metric to gather. + */ metricName?: string } export type GetClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the cluster. */ + /** + * UUID of the cluster. + */ clusterId: string } export type GetEndpointRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the endpoint you want to get. */ + /** + * UUID of the endpoint you want to get. + */ endpointId: string } export type ListClusterVersionsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Defines whether or not to include disabled Redis™ engine versions. */ + /** + * Defines whether or not to include disabled Redis™ engine versions. + */ includeDisabled: boolean - /** Defines whether or not to include beta Redis™ engine versions. */ + /** + * Defines whether or not to include beta Redis™ engine versions. + */ includeBeta: boolean - /** Defines whether or not to include deprecated Redis™ engine versions. */ + /** + * Defines whether or not to include deprecated Redis™ engine versions. + */ includeDeprecated: boolean - /** List Redis™ engine versions that match a given name pattern. */ + /** + * List Redis™ engine versions that match a given name pattern. + */ version?: string page?: number pageSize?: number } export interface ListClusterVersionsResponse { - /** List of available Redis™ engine versions. */ + /** + * List of available Redis™ engine versions. + */ versions: ClusterVersion[] - /** Total count of available Redis™ engine versions. */ + /** + * Total count of available Redis™ engine versions. + */ totalCount: number } export type ListClustersRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Filter by Database Instance tags. */ + /** + * Filter by Database Instance tags. + */ tags?: string[] - /** Filter by Database Instance names. */ + /** + * Filter by Database Instance names. + */ name?: string - /** Criteria to use when ordering the list. */ + /** + * Criteria to use when ordering the list. + */ orderBy?: ListClustersRequestOrderBy - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Filter by Redis™ engine version. */ + /** + * Filter by Redis™ engine version. + */ version?: string page?: number pageSize?: number } export interface ListClustersResponse { - /** List all Database Instances. */ + /** + * List all Database Instances. + */ clusters: Cluster[] - /** Total count of Database Instances. */ + /** + * Total count of Database Instances. + */ totalCount: number } export type ListNodeTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** Defines whether or not to include disabled types. */ + /** + * Defines whether or not to include disabled types. + */ includeDisabledTypes: boolean page?: number pageSize?: number } export interface ListNodeTypesResponse { - /** Types of node. */ + /** + * Types of node. + */ nodeTypes: NodeType[] - /** Total count of node types available. */ + /** + * Total count of node types available. + */ totalCount: number } export type MigrateClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance to update. */ + /** + * UUID of the Database Instance to update. + */ clusterId: string /** * Redis™ engine version of the Database Instance. * - * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' - * could be set. + * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' could be set. */ version?: string /** * Type of node to use for the Database Instance. * - * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' - * could be set. + * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' could be set. */ nodeType?: string /** * Number of nodes for the Database Instance. * - * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' - * could be set. + * One-of ('action'): at most one of 'version', 'nodeType', 'clusterSize' could be set. */ clusterSize?: number } export type RenewClusterCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the cluster. */ + /** + * UUID of the cluster. + */ clusterId: string } export type SetAclRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance where the ACL rules have to be set. */ + /** + * UUID of the Database Instance where the ACL rules have to be set. + */ clusterId: string - /** ACLs rules to define for the cluster. */ + /** + * ACLs rules to define for the cluster. + */ aclRules: ACLRuleSpec[] } export interface SetAclRulesResponse { - /** ACL Rules enabled for the Database Instance. */ + /** + * ACL Rules enabled for the Database Instance. + */ aclRules: ACLRule[] } export type SetClusterSettingsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance where the settings must be set. */ + /** + * UUID of the Database Instance where the settings must be set. + */ clusterId: string - /** Settings to define for the Database Instance. */ + /** + * Settings to define for the Database Instance. + */ settings: ClusterSetting[] } export type SetEndpointsRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance where the endpoints have to be set. */ + /** + * UUID of the Database Instance where the endpoints have to be set. + */ clusterId: string - /** Endpoints to define for the Database Instance. */ + /** + * Endpoints to define for the Database Instance. + */ endpoints: EndpointSpec[] } export interface SetEndpointsResponse { - /** Endpoints defined on the Database Instance. */ + /** + * Endpoints defined on the Database Instance. + */ endpoints: Endpoint[] } export type UpdateClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the Database Instance to update. */ + /** + * UUID of the Database Instance to update. + */ clusterId: string - /** Name of the Database Instance. */ + /** + * Name of the Database Instance. + */ name?: string - /** Database Instance tags. */ + /** + * Database Instance tags. + */ tags?: string[] - /** Name of the Database Instance user. */ + /** + * Name of the Database Instance user. + */ userName?: string - /** Password of the Database Instance user. */ + /** + * Password of the Database Instance user. + */ password?: string } export type UpdateEndpointRequest = { - /** Zone to target. If none is passed will use default zone from the config. */ + /** + * Zone to target. If none is passed will use default zone from the config. + */ zone?: ScwZone - /** UUID of the endpoint you want to get. */ + /** + * UUID of the endpoint you want to get. + */ endpointId: string /** * Private Network details. * - * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' - * could be set. + * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set. */ privateNetwork?: EndpointSpecPrivateNetworkSpec /** * Public network details. * - * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' - * could be set. + * One-of ('endpointType'): at most one of 'privateNetwork', 'publicNetwork' could be set. */ publicNetwork?: EndpointSpecPublicNetworkSpec } diff --git a/packages/clients/src/api/registry/v1/api.gen.ts b/packages/clients/src/api/registry/v1/api.gen.ts index 0d01310b1..f70fc185a 100644 --- a/packages/clients/src/api/registry/v1/api.gen.ts +++ b/packages/clients/src/api/registry/v1/api.gen.ts @@ -51,8 +51,8 @@ const jsonContentHeaders = { /** * Container Registry API. - * - * This API allows you to manage your Container Registry resources. + +This API allows you to manage your Container Registry resources. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -85,11 +85,7 @@ export class API extends ParentAPI { ) /** - * List namespaces. List all namespaces in a specified region. By default, the - * namespaces listed are ordered by creation date in ascending order. This can - * be modified via the order_by field. You can also define additional - * parameters for your query, such as the `instance_id` and `project_id` - * parameters. + * List namespaces. List all namespaces in a specified region. By default, the namespaces listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `instance_id` and `project_id` parameters. * * @param request - The request {@link ListNamespacesRequest} * @returns A Promise of ListNamespacesResponse @@ -98,10 +94,7 @@ export class API extends ParentAPI { enrichForPagination('namespaces', this.pageOfListNamespaces, request) /** - * Get a namespace. Retrieve information about a given namespace, specified by - * its `namespace_id` and region. Full details about the namespace, such as - * `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and - * `image_count` are returned in the response. + * Get a namespace. Retrieve information about a given namespace, specified by its `namespace_id` and region. Full details about the namespace, such as `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and `image_count` are returned in the response. * * @param request - The request {@link GetNamespaceRequest} * @returns A Promise of Namespace @@ -138,10 +131,7 @@ export class API extends ParentAPI { ) /** - * Create a namespace. Create a new Container Registry namespace. You must - * specify the namespace name and region in which you want it to be created. - * Optionally, you can specify the `project_id` and `is_public` in the request - * payload. + * Create a namespace. Create a new Container Registry namespace. You must specify the namespace name and region in which you want it to be created. Optionally, you can specify the `project_id` and `is_public` in the request payload. * * @param request - The request {@link CreateNamespaceRequest} * @returns A Promise of Namespace @@ -160,9 +150,7 @@ export class API extends ParentAPI { ) /** - * Update a namespace. Update the parameters of a given namespace, specified - * by its `namespace_id` and `region`. You can update the `description` and - * `is_public` parameters. + * Update a namespace. Update the parameters of a given namespace, specified by its `namespace_id` and `region`. You can update the `description` and `is_public` parameters. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -181,9 +169,7 @@ export class API extends ParentAPI { ) /** - * Delete a namespace. Delete a given namespace. You must specify, in the - * endpoint, the `region` and `namespace_id` parameters of the namespace you - * want to delete. + * Delete a namespace. Delete a given namespace. You must specify, in the endpoint, the `region` and `namespace_id` parameters of the namespace you want to delete. * * @param request - The request {@link DeleteNamespaceRequest} * @returns A Promise of Namespace @@ -219,10 +205,7 @@ export class API extends ParentAPI { ) /** - * List images. List all images in a specified region. By default, the images - * listed are ordered by creation date in ascending order. This can be - * modified via the order_by field. You can also define additional parameters - * for your query, such as the `namespace_id` and `project_id` parameters. + * List images. List all images in a specified region. By default, the images listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `namespace_id` and `project_id` parameters. * * @param request - The request {@link ListImagesRequest} * @returns A Promise of ListImagesResponse @@ -231,10 +214,7 @@ export class API extends ParentAPI { enrichForPagination('images', this.pageOfListImages, request) /** - * Get an image. Retrieve information about a given container image, specified - * by its `image_id` and region. Full details about the image, such as `name`, - * `namespace_id`, `status`, `visibility`, and `size` are returned in the - * response. + * Get an image. Retrieve information about a given container image, specified by its `image_id` and region. Full details about the image, such as `name`, `namespace_id`, `status`, `visibility`, and `size` are returned in the response. * * @param request - The request {@link GetImageRequest} * @returns A Promise of Image @@ -271,8 +251,7 @@ export class API extends ParentAPI { ) /** - * Update an image. Update the parameters of a given image, specified by its - * `image_id` and `region`. You can update the `visibility` parameter. + * Update an image. Update the parameters of a given image, specified by its `image_id` and `region`. You can update the `visibility` parameter. * * @param request - The request {@link UpdateImageRequest} * @returns A Promise of Image @@ -291,8 +270,7 @@ export class API extends ParentAPI { ) /** - * Delete an image. Delete a given image. You must specify, in the endpoint, - * the `region` and `image_id` parameters of the image you want to delete. + * Delete an image. Delete a given image. You must specify, in the endpoint, the `region` and `image_id` parameters of the image you want to delete. * * @param request - The request {@link DeleteImageRequest} * @returns A Promise of Image @@ -325,10 +303,7 @@ export class API extends ParentAPI { ) /** - * List tags. List all tags for a given image, specified by region. By - * default, the tags listed are ordered by creation date in ascending order. - * This can be modified via the order_by field. You can also define additional - * parameters for your query, such as the `name`. + * List tags. List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`. * * @param request - The request {@link ListTagsRequest} * @returns A Promise of ListTagsResponse @@ -337,9 +312,7 @@ export class API extends ParentAPI { enrichForPagination('tags', this.pageOfListTags, request) /** - * Get a tag. Retrieve information about a given image tag, specified by its - * `tag_id` and region. Full details about the tag, such as `name`, - * `image_id`, `status`, and `digest` are returned in the response. + * Get a tag. Retrieve information about a given image tag, specified by its `tag_id` and region. Full details about the tag, such as `name`, `image_id`, `status`, and `digest` are returned in the response. * * @param request - The request {@link GetTagRequest} * @returns A Promise of Tag @@ -376,8 +349,7 @@ export class API extends ParentAPI { ) /** - * Delete a tag. Delete a given image tag. You must specify, in the endpoint, - * the `region` and `tag_id` parameters of the tag you want to delete. + * Delete a tag. Delete a given image tag. You must specify, in the endpoint, the `region` and `tag_id` parameters of the tag you want to delete. * * @param request - The request {@link DeleteTagRequest} * @returns A Promise of Tag diff --git a/packages/clients/src/api/registry/v1/types.gen.ts b/packages/clients/src/api/registry/v1/types.gen.ts index e61274170..40cc3956b 100644 --- a/packages/clients/src/api/registry/v1/types.gen.ts +++ b/packages/clients/src/api/registry/v1/types.gen.ts @@ -40,311 +40,395 @@ export type NamespaceStatus = export type TagStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked' export interface Image { - /** UUID of the image. */ + /** + * UUID of the image. + */ id: string - /** Name of the image, it must be unique within the namespace. */ + /** + * Name of the image, it must be unique within the namespace. + */ name: string - /** UUID of the namespace the image belongs to. */ + /** + * UUID of the namespace the image belongs to. + */ namespaceId: string - /** Status of the image. */ + /** + * Status of the image. + */ status: ImageStatus - /** Details of the image status. */ + /** + * Details of the image status. + */ statusMessage?: string /** - * Set to `public` to allow the image to be pulled without authentication. - * Else, set to `private`. Set to `inherit` to keep the same visibility - * configuration as the namespace. + * Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace. */ visibility: ImageVisibility /** - * Image size in bytes, calculated from the size of image layers. One layer - * used in two tags of the same image is counted once but one layer used in - * two images is counted twice. + * Image size in bytes, calculated from the size of image layers. One layer used in two tags of the same image is counted once but one layer used in two images is counted twice. */ size: number - /** Date and time of image creation. */ + /** + * Date and time of image creation. + */ createdAt?: Date - /** Date and time of last update. */ + /** + * Date and time of last update. + */ updatedAt?: Date - /** List of docker tags of the image. */ + /** + * List of docker tags of the image. + */ tags: string[] } export interface Namespace { - /** UUID of the namespace. */ + /** + * UUID of the namespace. + */ id: string - /** Name of the namespace, unique in a region accross all organizations. */ + /** + * Name of the namespace, unique in a region accross all organizations. + */ name: string - /** Description of the namespace. */ + /** + * Description of the namespace. + */ description: string - /** Owner of the namespace. */ + /** + * Owner of the namespace. + */ organizationId: string - /** Project of the namespace. */ + /** + * Project of the namespace. + */ projectId: string - /** Namespace status. */ + /** + * Namespace status. + */ status: NamespaceStatus - /** Namespace status details. */ + /** + * Namespace status details. + */ statusMessage: string - /** Endpoint reachable by docker. */ + /** + * Endpoint reachable by docker. + */ endpoint: string - /** Defines whether or not namespace is public. */ + /** + * Defines whether or not namespace is public. + */ isPublic: boolean /** - * Total size of the namespace, calculated as the sum of the size of all - * images in the namespace. + * Total size of the namespace, calculated as the sum of the size of all images in the namespace. */ size: number - /** Date and time of creation. */ + /** + * Date and time of creation. + */ createdAt?: Date - /** Date and time of last update. */ + /** + * Date and time of last update. + */ updatedAt?: Date - /** Number of images in the namespace. */ + /** + * Number of images in the namespace. + */ imageCount: number - /** Region the namespace belongs to. */ + /** + * Region the namespace belongs to. + */ region: ScwRegion } export interface Tag { - /** UUID of the tag. */ + /** + * UUID of the tag. + */ id: string - /** Tag name, unique to an image. */ + /** + * Tag name, unique to an image. + */ name: string - /** Image ID the of the image the tag belongs to. */ + /** + * Image ID the of the image the tag belongs to. + */ imageId: string - /** Tag status. */ + /** + * Tag status. + */ status: TagStatus /** - * Hash of the tag content. Several tags of a same image may have the same - * digest. + * Hash of the tag content. Several tags of a same image may have the same digest. */ digest: string - /** Date and time of creation. */ + /** + * Date and time of creation. + */ createdAt?: Date - /** Date and time of last update. */ + /** + * Date and time of last update. + */ updatedAt?: Date } export type CreateNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Name of the namespace. */ + /** + * Name of the namespace. + */ name?: string - /** Description of the namespace. */ + /** + * Description of the namespace. + */ description: string /** * @deprecated Namespace owner (deprecated). * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string /** * Project ID on which the namespace will be created. * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string - /** Defines whether or not namespace is public. */ + /** + * Defines whether or not namespace is public. + */ isPublic: boolean } export type DeleteImageRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the image. */ + /** + * UUID of the image. + */ imageId: string } export type DeleteNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the namespace. */ + /** + * UUID of the namespace. + */ namespaceId: string } export type DeleteTagRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the tag. */ + /** + * UUID of the tag. + */ tagId: string /** - * @deprecated If two tags share the same digest the deletion will fail unless - * this parameter is set to true (deprecated). + * @deprecated If two tags share the same digest the deletion will fail unless this parameter is set to true (deprecated). */ force?: boolean } export type GetImageRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the image. */ + /** + * UUID of the image. + */ imageId: string } export type GetNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the namespace. */ + /** + * UUID of the namespace. + */ namespaceId: string } export type GetTagRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the tag. */ + /** + * UUID of the tag. + */ tagId: string } export type ListImagesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** A positive integer to choose the page to display. */ + /** + * A positive integer to choose the page to display. + */ page?: number /** - * A positive integer lower or equal to 100 to select the number of items to - * display. + * A positive integer lower or equal to 100 to select the number of items to display. */ pageSize?: number /** - * Criteria to use when ordering image listings. Possible values are - * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, - * `status_asc` and `status_desc`. The default value is `created_at_asc`. + * Criteria to use when ordering image listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`. */ orderBy?: ListImagesRequestOrderBy - /** Filter by the namespace ID. */ + /** + * Filter by the namespace ID. + */ namespaceId?: string - /** Filter by the image name (exact match). */ + /** + * Filter by the image name (exact match). + */ name?: string - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string } export interface ListImagesResponse { - /** Paginated list of images that match the selected filters. */ + /** + * Paginated list of images that match the selected filters. + */ images: Image[] - /** Total number of images that match the selected filters. */ + /** + * Total number of images that match the selected filters. + */ totalCount: number } export type ListNamespacesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** A positive integer to choose the page to display. */ + /** + * A positive integer to choose the page to display. + */ page?: number /** - * A positive integer lower or equal to 100 to select the number of items to - * display. + * A positive integer lower or equal to 100 to select the number of items to display. */ pageSize?: number /** - * Criteria to use when ordering namespace listings. Possible values are - * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, - * `status_asc` and `status_desc`. The default value is `created_at_asc`. + * Criteria to use when ordering namespace listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`. */ orderBy?: ListNamespacesRequestOrderBy - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Filter by the namespace name (exact match). */ + /** + * Filter by the namespace name (exact match). + */ name?: string } export interface ListNamespacesResponse { - /** Paginated list of namespaces that match the selected filters. */ + /** + * Paginated list of namespaces that match the selected filters. + */ namespaces: Namespace[] - /** Total number of namespaces that match the selected filters. */ + /** + * Total number of namespaces that match the selected filters. + */ totalCount: number } export type ListTagsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the image. */ + /** + * UUID of the image. + */ imageId: string - /** A positive integer to choose the page to display. */ + /** + * A positive integer to choose the page to display. + */ page?: number /** - * A positive integer lower or equal to 100 to select the number of items to - * display. + * A positive integer lower or equal to 100 to select the number of items to display. */ pageSize?: number /** - * Criteria to use when ordering tag listings. Possible values are - * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, - * `status_asc` and `status_desc`. The default value is `created_at_asc`. + * Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`. */ orderBy?: ListTagsRequestOrderBy - /** Filter by the tag name (exact match). */ + /** + * Filter by the tag name (exact match). + */ name?: string } export interface ListTagsResponse { - /** Paginated list of tags that match the selected filters. */ + /** + * Paginated list of tags that match the selected filters. + */ tags: Tag[] - /** Total number of tags that match the selected filters. */ + /** + * Total number of tags that match the selected filters. + */ totalCount: number } export type UpdateImageRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the image to update. */ + /** + * ID of the image to update. + */ imageId: string /** - * Set to `public` to allow the image to be pulled without authentication. - * Else, set to `private`. Set to `inherit` to keep the same visibility - * configuration as the namespace. + * Set to `public` to allow the image to be pulled without authentication. Else, set to `private`. Set to `inherit` to keep the same visibility configuration as the namespace. */ visibility?: ImageVisibility } export type UpdateNamespaceRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the namespace to update. */ + /** + * ID of the namespace to update. + */ namespaceId: string - /** Namespace description. */ + /** + * Namespace description. + */ description?: string - /** Defines whether or not the namespace is public. */ + /** + * Defines whether or not the namespace is public. + */ isPublic?: boolean } diff --git a/packages/clients/src/api/secret/v1beta1/api.gen.ts b/packages/clients/src/api/secret/v1beta1/api.gen.ts index 4b729e847..555dae0ed 100644 --- a/packages/clients/src/api/secret/v1beta1/api.gen.ts +++ b/packages/clients/src/api/secret/v1beta1/api.gen.ts @@ -61,10 +61,8 @@ const jsonContentHeaders = { /** * Secret Manager API. - * - * This API allows you to manage your Secret Manager services, for storing, - * accessing and sharing sensitive data such as passwords, API keys and - * certificates. + +This API allows you to manage your Secret Manager services, for storing, accessing and sharing sensitive data such as passwords, API keys and certificates. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -75,8 +73,7 @@ export class API extends ParentAPI { ] /** - * Create a secret. Create a secret in a given region specified by the - * `region` parameter. + * Create a secret. Create a secret in a given region specified by the `region` parameter. * * @param request - The request {@link CreateSecretRequest} * @returns A Promise of Secret @@ -95,8 +92,7 @@ export class API extends ParentAPI { ) /** - * Get metadata using the secret's ID. Retrieve the metadata of a secret - * specified by the `region` and `secret_id` parameters. + * Get metadata using the secret's ID. Retrieve the metadata of a secret specified by the `region` and `secret_id` parameters. * * @param request - The request {@link GetSecretRequest} * @returns A Promise of Secret @@ -111,9 +107,7 @@ export class API extends ParentAPI { ) /** - * Update metadata of a secret. Edit a secret's metadata such as name, tag(s), - * description and ephemeral policy. The secret to update is specified by the - * `secret_id` and `region` parameters. + * Update metadata of a secret. Edit a secret's metadata such as name, tag(s), description and ephemeral policy. The secret to update is specified by the `secret_id` and `region` parameters. * * @param request - The request {@link UpdateSecretRequest} * @returns A Promise of Secret @@ -132,8 +126,7 @@ export class API extends ParentAPI { ) /** - * Delete a secret. Delete a given secret specified by the `region` and - * `secret_id` parameters. + * Delete a secret. Delete a given secret specified by the `region` and `secret_id` parameters. * * @param request - The request {@link DeleteSecretRequest} */ @@ -169,9 +162,7 @@ export class API extends ParentAPI { ) /** - * List secrets. Retrieve the list of secrets created within an Organization - * and/or Project. You must specify either the `organization_id` or the - * `project_id` and the `region`. + * List secrets. Retrieve the list of secrets created within an Organization and/or Project. You must specify either the `organization_id` or the `project_id` and the `region`. * * @param request - The request {@link ListSecretsRequest} * @returns A Promise of ListSecretsResponse @@ -180,9 +171,7 @@ export class API extends ParentAPI { enrichForPagination('secrets', this.pageOfListSecrets, request) /** - * Browse secrets. Retrieve the list of secrets and folders for the given - * prefix. You must specify either the `organization_id` or the `project_id` - * and the `region`. + * Browse secrets. Retrieve the list of secrets and folders for the given prefix. You must specify either the `organization_id` or the `project_id` and the `region`. * * @param request - The request {@link BrowseSecretsRequest} * @returns A Promise of BrowseSecretsResponse @@ -209,9 +198,7 @@ export class API extends ParentAPI { ) /** - * Enable secret protection. Enable secret protection for a given secret - * specified by the `secret_id` parameter. Enabling secret protection means - * that your secret can be read and modified, but it cannot be deleted. + * Enable secret protection. Enable secret protection for a given secret specified by the `secret_id` parameter. Enabling secret protection means that your secret can be read and modified, but it cannot be deleted. * * @param request - The request {@link ProtectSecretRequest} * @returns A Promise of Secret @@ -228,9 +215,7 @@ export class API extends ParentAPI { ) /** - * Disable secret protection. Disable secret protection for a given secret - * specified by the `secret_id` parameter. Disabling secret protection means - * that your secret can be read, modified and deleted. + * Disable secret protection. Disable secret protection for a given secret specified by the `secret_id` parameter. Disabling secret protection means that your secret can be read, modified and deleted. * * @param request - The request {@link UnprotectSecretRequest} * @returns A Promise of Secret @@ -262,8 +247,7 @@ export class API extends ParentAPI { }) /** - * Create a version. Create a version of a given secret specified by the - * `region` and `secret_id` parameters. + * Create a version. Create a version of a given secret specified by the `region` and `secret_id` parameters. * * @param request - The request {@link CreateSecretVersionRequest} * @returns A Promise of SecretVersion @@ -282,9 +266,7 @@ export class API extends ParentAPI { ) /** - * Get metadata of a secret's version using the secret's ID. Retrieve the - * metadata of a secret's given version specified by the `region`, `secret_id` - * and `revision` parameters. + * Get metadata of a secret's version using the secret's ID. Retrieve the metadata of a secret's given version specified by the `region`, `secret_id` and `revision` parameters. * * @param request - The request {@link GetSecretVersionRequest} * @returns A Promise of SecretVersion @@ -299,8 +281,7 @@ export class API extends ParentAPI { ) /** - * Update metadata of a version. Edit the metadata of a secret's given - * version, specified by the `region`, `secret_id` and `revision` parameters. + * Update metadata of a version. Edit the metadata of a secret's given version, specified by the `region`, `secret_id` and `revision` parameters. * * @param request - The request {@link UpdateSecretVersionRequest} * @returns A Promise of SecretVersion @@ -319,8 +300,7 @@ export class API extends ParentAPI { ) /** - * Delete a version. Delete a secret's version and the sensitive data - * contained in it. Deleting a version is permanent and cannot be undone. + * Delete a version. Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone. * * @param request - The request {@link DeleteSecretVersionRequest} */ @@ -350,9 +330,7 @@ export class API extends ParentAPI { ) /** - * List versions of a secret using the secret's ID. Retrieve the list of a - * given secret's versions specified by the `secret_id` and `region` - * parameters. + * List versions of a secret using the secret's ID. Retrieve the list of a given secret's versions specified by the `secret_id` and `region` parameters. * * @param request - The request {@link ListSecretVersionsRequest} * @returns A Promise of ListSecretVersionsResponse @@ -361,9 +339,7 @@ export class API extends ParentAPI { enrichForPagination('versions', this.pageOfListSecretVersions, request) /** - * Access a secret's version using the secret's ID. Access sensitive data in a - * secret's version specified by the `region`, `secret_id` and `revision` - * parameters. + * Access a secret's version using the secret's ID. Access sensitive data in a secret's version specified by the `region`, `secret_id` and `revision` parameters. * * @param request - The request {@link AccessSecretVersionRequest} * @returns A Promise of AccessSecretVersionResponse @@ -378,9 +354,7 @@ export class API extends ParentAPI { ) /** - * Access a secret's version using the secret's name and path. Access - * sensitive data in a secret's version specified by the `region`, - * `secret_name`, `secret_path` and `revision` parameters. + * Access a secret's version using the secret's name and path. Access sensitive data in a secret's version specified by the `region`, `secret_name`, `secret_path` and `revision` parameters. * * @param request - The request {@link AccessSecretVersionByPathRequest} * @returns A Promise of AccessSecretVersionResponse @@ -405,8 +379,7 @@ export class API extends ParentAPI { ) /** - * Enable a version. Make a specific version accessible. You must specify the - * `region`, `secret_id` and `revision` parameters. + * Enable a version. Make a specific version accessible. You must specify the `region`, `secret_id` and `revision` parameters. * * @param request - The request {@link EnableSecretVersionRequest} * @returns A Promise of SecretVersion @@ -423,8 +396,7 @@ export class API extends ParentAPI { ) /** - * Disable a version. Make a specific version inaccessible. You must specify - * the `region`, `secret_id` and `revision` parameters. + * Disable a version. Make a specific version inaccessible. You must specify the `region`, `secret_id` and `revision` parameters. * * @param request - The request {@link DisableSecretVersionRequest} * @returns A Promise of SecretVersion @@ -501,8 +473,7 @@ export class API extends ParentAPI { enrichForPagination('types', this.pageOfListSecretTypes, request) /** - * Restore a version. Restore a secret's version specified by the `region`, - * `secret_id` and `revision` parameters. + * Restore a version. Restore a secret's version specified by the `region`, `secret_id` and `revision` parameters. * * @param request - The request {@link RestoreSecretVersionRequest} * @returns A Promise of SecretVersion @@ -519,8 +490,7 @@ export class API extends ParentAPI { ) /** - * Restore a secret. Restore a secret and all its versions scheduled for - * deletion specified by the `region` and `secret_id` parameters. + * Restore a secret. Restore a secret and all its versions scheduled for deletion specified by the `region` and `secret_id` parameters. * * @param request - The request {@link RestoreSecretRequest} * @returns A Promise of Secret diff --git a/packages/clients/src/api/secret/v1beta1/types.gen.ts b/packages/clients/src/api/secret/v1beta1/types.gen.ts index 15c3714ef..6053e6869 100644 --- a/packages/clients/src/api/secret/v1beta1/types.gen.ts +++ b/packages/clients/src/api/secret/v1beta1/types.gen.ts @@ -42,13 +42,16 @@ export type SecretVersionStatus = export interface EphemeralPolicy { /** - * Time frame, from one second and up to one year, during which the secret's - * versions are valid. + * Time frame, from one second and up to one year, during which the secret's versions are valid. */ timeToLive?: string - /** Returns `true` if the version expires after a single user access. */ + /** + * Returns `true` if the version expires after a single user access. + */ expiresOnceAccessed?: boolean - /** See the `EphemeralPolicy.Action` enum for a description of values. */ + /** + * See the `EphemeralPolicy.Action` enum for a description of values. + */ action: EphemeralPolicyAction } @@ -64,14 +67,17 @@ export interface BrowseSecretsResponseItemSecretDetails { } export interface EphemeralProperties { - /** (Optional.) If not specified, the version does not have an expiration date. */ + /** + * (Optional.) If not specified, the version does not have an expiration date. + */ expiresAt?: Date /** - * (Optional.) If not specified, the version can be accessed an unlimited - * amount of times. + * (Optional.) If not specified, the version can be accessed an unlimited amount of times. */ expiresOnceAccessed?: boolean - /** See `EphemeralPolicy.Action` enum for a description of values. */ + /** + * See `EphemeralPolicy.Action` enum for a description of values. + */ action: EphemeralPolicyAction } @@ -79,481 +85,601 @@ export interface BrowseSecretsResponseItem { name: string createdAt?: Date updatedAt?: Date - /** One-of ('details'): at most one of 'secret', 'folder' could be set. */ + /** + * + * One-of ('details'): at most one of 'secret', 'folder' could be set. + */ secret?: BrowseSecretsResponseItemSecretDetails - /** One-of ('details'): at most one of 'secret', 'folder' could be set. */ + /** + * + * One-of ('details'): at most one of 'secret', 'folder' could be set. + */ folder?: BrowseSecretsResponseItemFolderDetails } export interface SecretVersion { /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. */ revision: number - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * - `unknown_status`: the version is in an invalid state. `enabled`: the - * version is accessible. `disabled`: the version is not accessible but can - * be enabled. `scheduled_for_deletion`: the version is scheduled for - * deletion. It will be deleted in 7 days. `deleted`: the version is - * permanently deleted. It is not possible to recover it. + * * `unknown_status`: the version is in an invalid state. + * `enabled`: the version is accessible. + * `disabled`: the version is not accessible but can be enabled. + * `scheduled_for_deletion`: the version is scheduled for deletion. It will be deleted in 7 days. + * `deleted`: the version is permanently deleted. It is not possible to recover it. */ status: SecretVersionStatus - /** Date and time of the version's creation. */ + /** + * Date and time of the version's creation. + */ createdAt?: Date - /** Last update of the version. */ + /** + * Last update of the version. + */ updatedAt?: Date - /** Date and time of the version's deletion. */ + /** + * Date and time of the version's deletion. + */ deletedAt?: Date - /** Description of the version. */ + /** + * Description of the version. + */ description?: string - /** Returns `true` if the version is the latest. */ + /** + * Returns `true` if the version is the latest. + */ latest: boolean /** - * Returns the version's expiration date, whether it expires after being - * accessed once, and the action to perform (disable or delete) once the - * version expires. + * Returns the version's expiration date, whether it expires after being accessed once, and the action to perform (disable or delete) once the version expires. */ ephemeralProperties?: EphemeralProperties - /** Returns the time at which deletion was requested. */ + /** + * Returns the time at which deletion was requested. + */ deletionRequestedAt?: Date } export interface Secret { - /** ID of the secret. */ + /** + * ID of the secret. + */ id: string - /** ID of the Project containing the secret. */ + /** + * ID of the Project containing the secret. + */ projectId: string - /** Name of the secret. */ + /** + * Name of the secret. + */ name: string /** - * - `ready`: the secret can be read, modified and deleted. `locked`: no action - * can be performed on the secret. This status can only be applied and - * removed by Scaleway. + * * `ready`: the secret can be read, modified and deleted. + * `locked`: no action can be performed on the secret. This status can only be applied and removed by Scaleway. */ status: SecretStatus - /** Date and time of the secret's creation. */ + /** + * Date and time of the secret's creation. + */ createdAt?: Date - /** Last update of the secret. */ + /** + * Last update of the secret. + */ updatedAt?: Date - /** List of the secret's tags. */ + /** + * List of the secret's tags. + */ tags: string[] - /** Number of versions for this secret. */ + /** + * Number of versions for this secret. + */ versionCount: number - /** Updated description of the secret. */ + /** + * Updated description of the secret. + */ description?: string - /** Returns `true` for secrets that are managed by another product. */ + /** + * Returns `true` for secrets that are managed by another product. + */ managed: boolean - /** Returns `true` for protected secrets that cannot be deleted. */ + /** + * Returns `true` for protected secrets that cannot be deleted. + */ protected: boolean - /** See the `Secret.Type` enum for a description of values. */ + /** + * See the `Secret.Type` enum for a description of values. + */ type: SecretType - /** Location of the secret in the directory structure. */ + /** + * Location of the secret in the directory structure. + */ path: string /** - * (Optional.) Policy that defines whether/when a secret's versions expire. By - * default, the policy is applied to all the secret's versions. + * (Optional.) Policy that defines whether/when a secret's versions expire. By default, the policy is applied to all the secret's versions. */ ephemeralPolicy?: EphemeralPolicy - /** List of Scaleway resources that can access and manage the secret. */ + /** + * List of Scaleway resources that can access and manage the secret. + */ usedBy: Product[] - /** Returns the time at which deletion was requested. */ + /** + * Returns the time at which deletion was requested. + */ deletionRequestedAt?: Date - /** Region of the secret. */ + /** + * Region of the secret. + */ region: ScwRegion } export type AccessSecretVersionByPathRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. Value can be either: - * - * - An integer (the revision number) - * - "latest" (the latest revision) - * - "latest_enabled" (the latest enabled revision). + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either: +- an integer (the revision number) +- "latest" (the latest revision) +- "latest_enabled" (the latest enabled revision). */ revision: string - /** Secret's path. */ + /** + * Secret's path. + */ secretPath: string - /** Secret's name. */ + /** + * Secret's name. + */ secretName: string - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string } export type AccessSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. Value can be either: - * - * - A number (the revision number) - * - "latest" (the latest revision) - * - "latest_enabled" (the latest enabled revision). + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either: +- a number (the revision number) +- "latest" (the latest revision) +- "latest_enabled" (the latest enabled revision). */ revision: string } export interface AccessSecretVersionResponse { - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. */ revision: number - /** The base64-encoded secret payload of the version. */ + /** + * The base64-encoded secret payload of the version. + */ data: string /** - * This field is only available if a CRC32 was supplied during the creation of - * the version. + * This field is only available if a CRC32 was supplied during the creation of the version. */ dataCrc32?: number - /** See the `Secret.Type` enum for a description of values. */ + /** + * See the `Secret.Type` enum for a description of values. + */ type: SecretType } export type AddSecretOwnerRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string - /** See `Product` enum for description of values. */ + /** + * See `Product` enum for description of values. + */ product?: Product } export interface BasicCredentials { - /** The username or identifier associated with the credentials. */ + /** + * The username or identifier associated with the credentials. + */ username: string - /** The password associated with the credentials. */ + /** + * The password associated with the credentials. + */ password: string } export type BrowseSecretsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Filter by Project ID (optional). */ + /** + * Filter by Project ID (optional). + */ projectId?: string orderBy?: BrowseSecretsRequestOrderBy - /** Filter secrets and folders for a given prefix (default /). */ + /** + * Filter secrets and folders for a given prefix (default /). + */ prefix: string page?: number pageSize?: number - /** Filter secrets by tags. */ + /** + * Filter secrets by tags. + */ tags?: string[] - /** Filter by secret type (optional). */ + /** + * Filter by secret type (optional). + */ type?: SecretType } export interface BrowseSecretsResponse { - /** Repeated item of type secret or folder, sorted by the request parameter. */ + /** + * Repeated item of type secret or folder, sorted by the request parameter. + */ items: BrowseSecretsResponseItem[] - /** Current path for the given prefix. */ + /** + * Current path for the given prefix. + */ currentPath: string - /** Count of all secrets and folders matching the requested criteria. */ + /** + * Count of all secrets and folders matching the requested criteria. + */ totalCount: number } export type CreateSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project containing the secret. */ + /** + * ID of the Project containing the secret. + */ projectId?: string - /** Name of the secret. */ + /** + * Name of the secret. + */ name: string - /** List of the secret's tags. */ + /** + * List of the secret's tags. + */ tags?: string[] - /** Description of the secret. */ + /** + * Description of the secret. + */ description?: string /** - * (Optional.) See the `Secret.Type` enum for a description of values. If not - * specified, the type is `Opaque`. + * (Optional.) See the `Secret.Type` enum for a description of values. If not specified, the type is `Opaque`. */ type?: SecretType /** - * (Optional.) Location of the secret in the directory structure. If not - * specified, the path is `/`. + * (Optional.) Location of the secret in the directory structure. If not specified, the path is `/`. */ path?: string /** - * (Optional.) Policy that defines whether/when a secret's versions expire. By - * default, the policy is applied to all the secret's versions. + * (Optional.) Policy that defines whether/when a secret's versions expire. By default, the policy is applied to all the secret's versions. */ ephemeralPolicy?: EphemeralPolicy - /** A protected secret cannot be deleted. */ + /** + * A protected secret cannot be deleted. + */ protected: boolean } export type CreateSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string - /** The base64-encoded secret payload of the version. */ + /** + * The base64-encoded secret payload of the version. + */ data: string - /** Description of the version. */ + /** + * Description of the version. + */ description?: string /** - * (Optional.) If there is no previous version or if the previous version was - * already disabled, does nothing. + * (Optional.) If there is no previous version or if the previous version was already disabled, does nothing. */ disablePrevious?: boolean /** - * If specified, Secret Manager will verify the integrity of the data received - * against the given CRC32 checksum. An error is returned if the CRC32 does - * not match. If, however, the CRC32 matches, it will be stored and returned - * along with the SecretVersion on future access requests. + * If specified, Secret Manager will verify the integrity of the data received against the given CRC32 checksum. An error is returned if the CRC32 does not match. If, however, the CRC32 matches, it will be stored and returned along with the SecretVersion on future access requests. */ dataCrc32?: number } export interface DatabaseCredentials { - /** Supported database engines are: 'postgres', 'mysql', 'other'. */ + /** + * Supported database engines are: 'postgres', 'mysql', 'other'. + */ engine: string - /** The username used to authenticate to the database server. */ + /** + * The username used to authenticate to the database server. + */ username: string - /** The password used to authenticate to the database server. */ + /** + * The password used to authenticate to the database server. + */ password: string - /** The hostname or resolvable DNS name of the database server. */ + /** + * The hostname or resolvable DNS name of the database server. + */ host: string - /** The name of the database to connect to. */ + /** + * The name of the database to connect to. + */ dbname: string - /** The port must be an integer ranging from 0 to 65535. */ + /** + * The port must be an integer ranging from 0 to 65535. + */ port: string } export type DeleteSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string } export type DeleteSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. Value can be either: - * - * - A number (the revision number) - * - "latest" (the latest revision) - * - "latest_enabled" (the latest enabled revision). + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either: +- a number (the revision number) +- "latest" (the latest revision) +- "latest_enabled" (the latest enabled revision). */ revision: string } export type DisableSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. Value can be either: - * - * - A number (the revision number) - * - "latest" (the latest revision) - * - "latest_enabled" (the latest enabled revision). + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either: +- a number (the revision number) +- "latest" (the latest revision) +- "latest_enabled" (the latest enabled revision). */ revision: string } export type EnableSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. Value can be either: - * - * - A number (the revision number) - * - "latest" (the latest revision) - * - "latest_enabled" (the latest enabled revision). + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either: +- a number (the revision number) +- "latest" (the latest revision) +- "latest_enabled" (the latest enabled revision). */ revision: string } export type GetSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string } export type GetSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. Value can be either: - * - * - A number (the revision number) - * - "latest" (the latest revision) - * - "latest_enabled" (the latest enabled revision). + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either: +- a number (the revision number) +- "latest" (the latest revision) +- "latest_enabled" (the latest enabled revision). */ revision: string } export type ListSecretTypesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string page?: number pageSize?: number } export interface ListSecretTypesResponse { - /** List of secret types. */ + /** + * List of secret types. + */ types: SecretType[] - /** Count of all secret types matching the requested criteria. */ + /** + * Count of all secret types matching the requested criteria. + */ totalCount: number } export type ListSecretVersionsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string page?: number pageSize?: number - /** Filter results by status. */ + /** + * Filter results by status. + */ status?: SecretVersionStatus[] } export interface ListSecretVersionsResponse { - /** Single page of versions. */ + /** + * Single page of versions. + */ versions: SecretVersion[] - /** Number of versions. */ + /** + * Number of versions. + */ totalCount: number } export type ListSecretsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Filter by Organization ID (optional). */ + /** + * Filter by Organization ID (optional). + */ organizationId?: string - /** Filter by Project ID (optional). */ + /** + * Filter by Project ID (optional). + */ projectId?: string orderBy?: ListSecretsRequestOrderBy page?: number pageSize?: number - /** List of tags to filter on (optional). */ + /** + * List of tags to filter on (optional). + */ tags?: string[] - /** Filter by secret name (optional). */ + /** + * Filter by secret name (optional). + */ name?: string - /** Filter by exact path (optional). */ + /** + * Filter by exact path (optional). + */ path?: string - /** Filter by ephemeral / not ephemeral (optional). */ + /** + * Filter by ephemeral / not ephemeral (optional). + */ ephemeral?: boolean - /** Filter by secret type (optional). */ + /** + * Filter by secret type (optional). + */ type?: SecretType /** - * Filter by whether the secret was scheduled for deletion / not scheduled for - * deletion. By default, it will display only not scheduled for deletion - * secrets. + * Filter by whether the secret was scheduled for deletion / not scheduled for deletion. By default, it will display only not scheduled for deletion secrets. */ scheduledForDeletion: boolean } export interface ListSecretsResponse { - /** Single page of secrets matching the requested criteria. */ + /** + * Single page of secrets matching the requested criteria. + */ secrets: Secret[] - /** Count of all secrets matching the requested criteria. */ + /** + * Count of all secrets matching the requested criteria. + */ totalCount: number } export type ListTagsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project to target. */ + /** + * ID of the Project to target. + */ projectId?: string page?: number pageSize?: number } export interface ListTagsResponse { - /** List of tags. */ + /** + * List of tags. + */ tags: string[] - /** Count of all tags matching the requested criteria. */ + /** + * Count of all tags matching the requested criteria. + */ totalCount: number } export type ProtectSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret to enable secret protection for. */ + /** + * ID of the secret to enable secret protection for. + */ secretId: string } export type RestoreSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion secretId: string @@ -561,8 +687,7 @@ export type RestoreSecretRequest = { export type RestoreSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion secretId: string @@ -570,66 +695,76 @@ export type RestoreSecretVersionRequest = { } export interface SSHKey { - /** The private SSH key. */ + /** + * The private SSH key. + */ sshPrivateKey: string } export type UnprotectSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret to disable secret protection for. */ + /** + * ID of the secret to disable secret protection for. + */ secretId: string } export type UpdateSecretRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string - /** Secret's updated name (optional). */ + /** + * Secret's updated name (optional). + */ name?: string - /** Secret's updated list of tags (optional). */ + /** + * Secret's updated list of tags (optional). + */ tags?: string[] - /** Description of the secret. */ + /** + * Description of the secret. + */ description?: string /** - * (Optional.) Location of the folder in the directory structure. If not - * specified, the path is `/`. + * (Optional.) Location of the folder in the directory structure. If not specified, the path is `/`. */ path?: string - /** (Optional.) Policy that defines whether/when a secret's versions expire. */ + /** + * (Optional.) Policy that defines whether/when a secret's versions expire. + */ ephemeralPolicy?: EphemeralPolicy } export type UpdateSecretVersionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the secret. */ + /** + * ID of the secret. + */ secretId: string /** - * The first version of the secret is numbered 1, and all subsequent revisions - * augment by 1. Value can be either: - * - * - A number (the revision number) - * - "latest" (the latest revision) - * - "latest_enabled" (the latest enabled revision). + * The first version of the secret is numbered 1, and all subsequent revisions augment by 1. Value can be either: +- a number (the revision number) +- "latest" (the latest revision) +- "latest_enabled" (the latest enabled revision). */ revision: string - /** Description of the version. */ + /** + * Description of the version. + */ description?: string /** - * (Optional.) Properties that defines the version's expiration date, whether - * it expires after being accessed once, and the action to perform (disable or - * delete) once the version expires. + * (Optional.) Properties that defines the version's expiration date, whether it expires after being accessed once, and the action to perform (disable or delete) once the version expires. */ ephemeralProperties?: EphemeralProperties } diff --git a/packages/clients/src/api/serverless_sqldb/v1alpha1/api.gen.ts b/packages/clients/src/api/serverless_sqldb/v1alpha1/api.gen.ts index 0e909ae3c..dd87cfde6 100644 --- a/packages/clients/src/api/serverless_sqldb/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/serverless_sqldb/v1alpha1/api.gen.ts @@ -40,17 +40,15 @@ const jsonContentHeaders = { /** * Serverless SQL Databases API. - * - * This API allows you to manage your Serverless SQL Databases. + +This API allows you to manage your Serverless SQL Databases. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: ScwRegion[] = ['fr-par'] /** - * Create a new Serverless SQL Database. You must provide the following - * parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`. - * You can also provide `from_backup_id` to create a database from a backup. + * Create a new Serverless SQL Database. You must provide the following parameters: `organization_id`, `project_id`, `name`, `cpu_min`, `cpu_max`. You can also provide `from_backup_id` to create a database from a backup. * * @param request - The request {@link CreateDatabaseRequest} * @returns A Promise of Database @@ -69,8 +67,7 @@ export class API extends ParentAPI { ) /** - * Get a database information. Retrieve information about your Serverless SQL - * Database. You must provide the `database_id` parameter. + * Get a database information. Retrieve information about your Serverless SQL Database. You must provide the `database_id` parameter. * * @param request - The request {@link GetDatabaseRequest} * @returns A Promise of Database @@ -107,8 +104,7 @@ export class API extends ParentAPI { ) /** - * Delete a database. Deletes a database. You must provide the `database_id` - * parameter. All data stored in the database will be permanently deleted. + * Delete a database. Deletes a database. You must provide the `database_id` parameter. All data stored in the database will be permanently deleted. * * @param request - The request {@link DeleteDatabaseRequest} * @returns A Promise of Database @@ -145,12 +141,7 @@ export class API extends ParentAPI { ) /** - * List your Serverless SQL Databases. List all Serverless SQL Databases for a - * given Scaleway Organization or Scaleway Project. By default, the databases - * returned in the list are ordered by creation date in ascending order, - * though this can be modified via the order_by field. For the `name` - * parameter, the value you include will be checked against the whole name - * string to see if it includes the string you put in the parameter. + * List your Serverless SQL Databases. List all Serverless SQL Databases for a given Scaleway Organization or Scaleway Project. By default, the databases returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. For the `name` parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter. * * @param request - The request {@link ListDatabasesRequest} * @returns A Promise of ListDatabasesResponse @@ -159,8 +150,7 @@ export class API extends ParentAPI { enrichForPagination('databases', this.pageOfListDatabases, request) /** - * Update database information. Update CPU limits of your Serverless SQL - * Database. You must provide the `database_id` parameter. + * Update database information. Update CPU limits of your Serverless SQL Database. You must provide the `database_id` parameter. * * @param request - The request {@link UpdateDatabaseRequest} * @returns A Promise of Database @@ -179,8 +169,7 @@ export class API extends ParentAPI { ) /** - * Restore a database from a backup. Restore a database from a backup. You - * must provide the `backup_id` parameter. + * Restore a database from a backup. Restore a database from a backup. You must provide the `backup_id` parameter. * * @param request - The request {@link RestoreDatabaseFromBackupRequest} * @returns A Promise of Database @@ -204,9 +193,7 @@ export class API extends ParentAPI { ) /** - * Get a database backup information. Retrieve information about your - * Serverless SQL Database backup. You must provide the `backup_id` - * parameter. + * Get a database backup information. Retrieve information about your Serverless SQL Database backup. You must provide the `backup_id` parameter. * * @param request - The request {@link GetDatabaseBackupRequest} * @returns A Promise of DatabaseBackup @@ -240,10 +227,7 @@ export class API extends ParentAPI { ) /** - * List your Serverless SQL Database backups. List all Serverless SQL Database - * backups for a given Scaleway Project or Database. By default, the backups - * returned in the list are ordered by creation date in descending order, - * though this can be modified via the order_by field. + * List your Serverless SQL Database backups. List all Serverless SQL Database backups for a given Scaleway Project or Database. By default, the backups returned in the list are ordered by creation date in descending order, though this can be modified via the order_by field. * * @param request - The request {@link ListDatabaseBackupsRequest} * @returns A Promise of ListDatabaseBackupsResponse @@ -252,9 +236,7 @@ export class API extends ParentAPI { enrichForPagination('backups', this.pageOfListDatabaseBackups, request) /** - * Export a database backup. Export a database backup providing a download - * link once the export process is completed. You must provide the `backup_id` - * parameter. + * Export a database backup. Export a database backup providing a download link once the export process is completed. You must provide the `backup_id` parameter. * * @param request - The request {@link ExportDatabaseBackupRequest} * @returns A Promise of DatabaseBackup diff --git a/packages/clients/src/api/serverless_sqldb/v1alpha1/types.gen.ts b/packages/clients/src/api/serverless_sqldb/v1alpha1/types.gen.ts index ee8c67076..8b33e6927 100644 --- a/packages/clients/src/api/serverless_sqldb/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/serverless_sqldb/v1alpha1/types.gen.ts @@ -28,204 +28,296 @@ export type ListDatabasesRequestOrderBy = | 'name_desc' export interface DatabaseBackup { - /** UUID that uniquely identifies a Serverless SQL Database backup. */ + /** + * UUID that uniquely identifies a Serverless SQL Database backup. + */ id: string /** - * Status of the Serverless SQL Database backup. One of `unknown_status` | - * `error` | `ready` | `locked`. + * Status of the Serverless SQL Database backup. One of `unknown_status` | `error` | `ready` | `locked`. */ status: DatabaseBackupStatus - /** The ID of your Scaleway organization. */ + /** + * The ID of your Scaleway organization. + */ organizationId: string - /** UUID of the Scaleway project. */ + /** + * UUID of the Scaleway project. + */ projectId: string - /** UUID of the source Serverless SQL Database the backup is created from. */ + /** + * UUID of the source Serverless SQL Database the backup is created from. + */ databaseId: string - /** Creation date. */ + /** + * Creation date. + */ createdAt?: Date - /** Expiration date. */ + /** + * Expiration date. + */ expiresAt?: Date - /** Size (in bytes) of the database backup file. */ + /** + * Size (in bytes) of the database backup file. + */ size?: number - /** Size (in bytes) of the database when backup has been done. */ + /** + * Size (in bytes) of the database when backup has been done. + */ dbSize?: number - /** Download URL of the exported database backup. */ + /** + * Download URL of the exported database backup. + */ downloadUrl?: string - /** Expiration date of the download URL. */ + /** + * Expiration date of the download URL. + */ downloadUrlExpiresAt?: Date - /** Region of the database backup. */ + /** + * Region of the database backup. + */ region: ScwRegion } export interface Database { - /** UUID that uniquely identifies your Serverless SQL DB Database. */ + /** + * UUID that uniquely identifies your Serverless SQL DB Database. + */ id: string - /** Name of the database. */ + /** + * Name of the database. + */ name: string /** - * Status of the Serverless SQL Ddatabase. One of `unknown_status` | `ready` | - * `creating` | `deleting` | `error` | `restoring` | `locked`. + * Status of the Serverless SQL Ddatabase. One of `unknown_status` | `ready` | `creating` | `deleting` | `error` | `restoring` | `locked`. */ status: DatabaseStatus - /** Endpoint of the database. */ + /** + * Endpoint of the database. + */ endpoint: string - /** The ID of your Scaleway organization. */ + /** + * The ID of your Scaleway organization. + */ organizationId: string - /** Project ID the database belongs to. */ + /** + * Project ID the database belongs to. + */ projectId: string - /** Region of the database. */ + /** + * Region of the database. + */ region: ScwRegion - /** Creation date. */ + /** + * Creation date. + */ createdAt?: Date - /** The minimum number of CPU units for your Serverless SQL Database. */ + /** + * The minimum number of CPU units for your Serverless SQL Database. + */ cpuMin: number - /** The maximum number of CPU units for your Serverless SQL Database. */ + /** + * The maximum number of CPU units for your Serverless SQL Database. + */ cpuMax: number - /** The current number of CPU units allocated to your Serverless SQL Database. */ + /** + * The current number of CPU units allocated to your Serverless SQL Database. + */ cpuCurrent: number - /** Whether your Serverless SQL Database is running or not. */ + /** + * Whether your Serverless SQL Database is running or not. + */ started: boolean - /** The major version of the underlying database engine. */ + /** + * The major version of the underlying database engine. + */ engineMajorVersion: number } export type CreateDatabaseRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** The ID of your Scaleway project. */ + /** + * The ID of your Scaleway project. + */ projectId?: string - /** The name of the Serverless SQL Database to be created. */ + /** + * The name of the Serverless SQL Database to be created. + */ name: string - /** The minimum number of CPU units for your Serverless SQL Database. */ + /** + * The minimum number of CPU units for your Serverless SQL Database. + */ cpuMin: number - /** The maximum number of CPU units for your Serverless SQL Database. */ + /** + * The maximum number of CPU units for your Serverless SQL Database. + */ cpuMax: number - /** The ID of the backup to create the database from. */ + /** + * The ID of the backup to create the database from. + */ fromBackupId?: string } export type DeleteDatabaseRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Serverless SQL Database. */ + /** + * UUID of the Serverless SQL Database. + */ databaseId: string } export type ExportDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Serverless SQL Database backup. */ + /** + * UUID of the Serverless SQL Database backup. + */ backupId: string } export type GetDatabaseBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Serverless SQL Database backup. */ + /** + * UUID of the Serverless SQL Database backup. + */ backupId: string } export type GetDatabaseRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Serverless SQL DB database. */ + /** + * UUID of the Serverless SQL DB database. + */ databaseId: string } export type ListDatabaseBackupsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Filter by the UUID of the Scaleway organization. */ + /** + * Filter by the UUID of the Scaleway organization. + */ organizationId?: string - /** Filter by the UUID of the Scaleway project. */ + /** + * Filter by the UUID of the Scaleway project. + */ projectId?: string - /** Filter by the UUID of the Serverless SQL Database. */ + /** + * Filter by the UUID of the Serverless SQL Database. + */ databaseId: string - /** Page number. */ + /** + * Page number. + */ page?: number - /** Page size. */ + /** + * Page size. + */ pageSize?: number - /** Sorting criteria. One of `created_at_asc`, `created_at_desc`. */ + /** + * Sorting criteria. One of `created_at_asc`, `created_at_desc`. + */ orderBy?: ListDatabaseBackupsRequestOrderBy } export interface ListDatabaseBackupsResponse { - /** List of the backups. */ + /** + * List of the backups. + */ backups: DatabaseBackup[] - /** Length of the backups list. */ + /** + * Length of the backups list. + */ totalCount: number } export type ListDatabasesRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Filter by the UUID of the Scaleway organization. */ + /** + * Filter by the UUID of the Scaleway organization. + */ organizationId?: string - /** UUID of the Scaleway project. */ + /** + * UUID of the Scaleway project. + */ projectId?: string - /** Page number. */ + /** + * Page number. + */ page?: number - /** Page size. */ + /** + * Page size. + */ pageSize?: number - /** Filter by the name of the database. */ + /** + * Filter by the name of the database. + */ name?: string /** - * Sorting criteria. One of `created_at_asc`, `created_at_desc`, `name_asc`, - * `name_desc`. + * Sorting criteria. One of `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`. */ orderBy?: ListDatabasesRequestOrderBy } export interface ListDatabasesResponse { - /** List of the databases. */ + /** + * List of the databases. + */ databases: Database[] - /** Total count of Serverless SQL Databases. */ + /** + * Total count of Serverless SQL Databases. + */ totalCount: number } export type RestoreDatabaseFromBackupRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Serverless SQL Database. */ + /** + * UUID of the Serverless SQL Database. + */ databaseId: string - /** UUID of the Serverless SQL Database backup to restore. */ + /** + * UUID of the Serverless SQL Database backup to restore. + */ backupId: string } export type UpdateDatabaseRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** UUID of the Serverless SQL Database. */ + /** + * UUID of the Serverless SQL Database. + */ databaseId: string - /** The minimum number of CPU units for your Serverless SQL Database. */ + /** + * The minimum number of CPU units for your Serverless SQL Database. + */ cpuMin?: number - /** The maximum number of CPU units for your Serverless SQL Database. */ + /** + * The maximum number of CPU units for your Serverless SQL Database. + */ cpuMax?: number } diff --git a/packages/clients/src/api/tem/v1alpha1/api.gen.ts b/packages/clients/src/api/tem/v1alpha1/api.gen.ts index a88651b9b..5acc10114 100644 --- a/packages/clients/src/api/tem/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/tem/v1alpha1/api.gen.ts @@ -95,18 +95,15 @@ const jsonContentHeaders = { /** * Transactional Email API. - * - * This API allows you to manage your Transactional Email services. + +This API allows you to manage your Transactional Email services. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: ScwRegion[] = ['fr-par'] /** - * Send an email. You must specify the `region`, the sender and the - * recipient's information and the `project_id` to send an email from a - * checked domain. The subject of the email must contain at least 6 - * characters. + * Send an email. You must specify the `region`, the sender and the recipient's information and the `project_id` to send an email from a checked domain. The subject of the email must contain at least 6 characters. * * @param request - The request {@link CreateEmailRequest} * @returns A Promise of CreateEmailResponse @@ -125,8 +122,7 @@ export class API extends ParentAPI { ) /** - * Get an email. Retrieve information about a specific email using the - * `email_id` and `region` parameters. + * Get an email. Retrieve information about a specific email using the `email_id` and `region` parameters. * * @param request - The request {@link GetEmailRequest} * @returns A Promise of Email @@ -190,8 +186,7 @@ export class API extends ParentAPI { ) /** - * List emails. Retrieve the list of emails sent from a specific domain or for - * a specific Project or Organization. You must specify the `region`. + * List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the `region`. * * @param request - The request {@link ListEmailsRequest} * @returns A Promise of ListEmailsResponse @@ -222,9 +217,7 @@ export class API extends ParentAPI { ) /** - * Cancel an email. You can cancel the sending of an email if it has not been - * sent yet. You must specify the `region` and the `email_id` of the email you - * want to cancel. + * Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the `region` and the `email_id` of the email you want to cancel. * * @param request - The request {@link CancelEmailRequest} * @returns A Promise of Email @@ -241,8 +234,7 @@ export class API extends ParentAPI { ) /** - * Register a domain in a project. You must specify the `region`, `project_id` - * and `domain_name` to register a domain in a specific Project. + * Register a domain in a project. You must specify the `region`, `project_id` and `domain_name` to register a domain in a specific Project. * * @param request - The request {@link CreateDomainRequest} * @returns A Promise of Domain @@ -261,14 +253,7 @@ export class API extends ParentAPI { ) /** - * Get information about a domain. Retrieve information about a specific - * domain using the `region` and `domain_id` parameters. Monitor your domain's - * reputation and improve **average** and **bad** reputation statuses, using - * your domain's **Email activity** tab on the [Scaleway - * console](https://console.scaleway.com/transactional-email/domains) to get a - * more detailed report. Check out our [dedicated - * documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) - * to improve your domain's reputation. + * Get information about a domain. Retrieve information about a specific domain using the `region` and `domain_id` parameters. Monitor your domain's reputation and improve **average** and **bad** reputation statuses, using your domain's **Email activity** tab on the [Scaleway console](https://console.scaleway.com/transactional-email/domains) to get a more detailed report. Check out our [dedicated documentation](https://www.scaleway.com/en/docs/managed-services/transactional-email/reference-content/understanding-tem-reputation-score/) to improve your domain's reputation. * * @param request - The request {@link GetDomainRequest} * @returns A Promise of Domain @@ -323,8 +308,7 @@ export class API extends ParentAPI { ) /** - * List domains. Retrieve domains in a specific Project or in a specific - * Organization using the `region` parameter. + * List domains. Retrieve domains in a specific Project or in a specific Organization using the `region` parameter. * * @param request - The request {@link ListDomainsRequest} * @returns A Promise of ListDomainsResponse @@ -333,9 +317,7 @@ export class API extends ParentAPI { enrichForPagination('domains', this.pageOfListDomains, request) /** - * Delete a domain. You must specify the domain you want to delete by the - * `region` and `domain_id`. Deleting a domain is permanent and cannot be - * undone. + * Delete a domain. You must specify the domain you want to delete by the `region` and `domain_id`. Deleting a domain is permanent and cannot be undone. * * @param request - The request {@link RevokeDomainRequest} * @returns A Promise of Domain @@ -352,8 +334,7 @@ export class API extends ParentAPI { ) /** - * Domain DNS check. Perform an immediate DNS check of a domain using the - * `region` and `domain_id` parameters. + * Domain DNS check. Perform an immediate DNS check of a domain using the `region` and `domain_id` parameters. * * @param request - The request {@link CheckDomainRequest} * @returns A Promise of Domain @@ -370,9 +351,7 @@ export class API extends ParentAPI { ) /** - * Display SPF and DKIM records status and potential errors. Display SPF and - * DKIM records status and potential errors, including the found records to - * make debugging easier. + * Display SPF and DKIM records status and potential errors. Display SPF and DKIM records status and potential errors, including the found records to make debugging easier. * * @param request - The request {@link GetDomainLastStatusRequest} * @returns A Promise of DomainLastStatus @@ -406,8 +385,7 @@ export class API extends ParentAPI { ) /** - * Create a Webhook. Create a new Webhook triggered by a list of event types - * and pushed to a Scaleway SNS ARN. + * Create a Webhook. Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN. * * @param request - The request {@link CreateWebhookRequest} * @returns A Promise of Webhook @@ -448,8 +426,7 @@ export class API extends ParentAPI { ) /** - * List Webhooks. Retrieve Webhooks in a specific Project or in a specific - * Organization using the `region` parameter. + * List Webhooks. Retrieve Webhooks in a specific Project or in a specific Organization using the `region` parameter. * * @param request - The request {@link ListWebhooksRequest} * @returns A Promise of ListWebhooksResponse @@ -458,8 +435,7 @@ export class API extends ParentAPI { enrichForPagination('webhooks', this.pageOfListWebhooks, request) /** - * Get information about a Webhook. Retrieve information about a specific - * Webhook using the `webhook_id` and `region` parameters. + * Get information about a Webhook. Retrieve information about a specific Webhook using the `webhook_id` and `region` parameters. * * @param request - The request {@link GetWebhookRequest} * @returns A Promise of Webhook @@ -493,9 +469,7 @@ export class API extends ParentAPI { ) /** - * Delete a Webhook. You must specify the Webhook you want to delete by the - * `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be - * undone. + * Delete a Webhook. You must specify the Webhook you want to delete by the `region` and `webhook_id`. Deleting a Webhook is permanent and cannot be undone. * * @param request - The request {@link DeleteWebhookRequest} */ @@ -531,9 +505,7 @@ export class API extends ParentAPI { ) /** - * List Webhook triggered events. Retrieve the list of Webhook events - * triggered from a specific Webhook or for a specific Project or - * Organization. You must specify the `region`. + * List Webhook triggered events. Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the `region`. * * @param request - The request {@link ListWebhookEventsRequest} * @returns A Promise of ListWebhookEventsResponse @@ -542,8 +514,7 @@ export class API extends ParentAPI { enrichForPagination('webhookEvents', this.pageOfListWebhookEvents, request) /** - * List project settings. Retrieve the project settings including periodic - * reports. + * List project settings. Retrieve the project settings including periodic reports. * * @param request - The request {@link GetProjectSettingsRequest} * @returns A Promise of ProjectSettings @@ -558,8 +529,7 @@ export class API extends ParentAPI { ) /** - * Update project settings. Update the project settings including periodic - * reports. + * Update project settings. Update the project settings including periodic reports. * * @param request - The request {@link UpdateProjectSettingsRequest} * @returns A Promise of ProjectSettings @@ -610,8 +580,7 @@ export class API extends ParentAPI { enrichForPagination('blocklists', this.pageOfListBlocklists, request) /** - * Bulk create blocklists. Create multiple blocklists in a specific Project or - * Organization using the `region` parameter. + * Bulk create blocklists. Create multiple blocklists in a specific Project or Organization using the `region` parameter. * * @param request - The request {@link BulkCreateBlocklistsRequest} * @returns A Promise of BulkCreateBlocklistsResponse @@ -630,8 +599,7 @@ export class API extends ParentAPI { ) /** - * Delete a blocklist. You must specify the blocklist you want to delete by - * the `region` and `blocklist_id`. + * Delete a blocklist. You must specify the blocklist you want to delete by the `region` and `blocklist_id`. * * @param request - The request {@link DeleteBlocklistRequest} */ @@ -642,9 +610,7 @@ export class API extends ParentAPI { }) /** - * Get information about subscribed offers. Retrieve information about the - * offers you are subscribed to using the `project_id` and `region` - * parameters. + * Get information about subscribed offers. Retrieve information about the offers you are subscribed to using the `project_id` and `region` parameters. * * @param request - The request {@link ListOfferSubscriptionsRequest} * @returns A Promise of ListOfferSubscriptionsResponse @@ -686,8 +652,7 @@ export class API extends ParentAPI { ) /** - * List the available offers.. Retrieve the list of the available and - * free-of-charge offers you can subscribe to. + * List the available offers.. Retrieve the list of the available and free-of-charge offers you can subscribe to. * * @param request - The request {@link ListOffersRequest} * @returns A Promise of ListOffersResponse @@ -722,8 +687,7 @@ export class API extends ParentAPI { ) /** - * Get information about a sending pool.. Retrieve information about a sending - * pool, including its creation status and configuration parameters. + * Get information about a sending pool.. Retrieve information about a sending pool, including its creation status and configuration parameters. * * @param request - The request {@link ListPoolsRequest} * @returns A Promise of ListPoolsResponse diff --git a/packages/clients/src/api/tem/v1alpha1/types.gen.ts b/packages/clients/src/api/tem/v1alpha1/types.gen.ts index e9b929a59..55922dca3 100644 --- a/packages/clients/src/api/tem/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/tem/v1alpha1/types.gen.ts @@ -115,48 +115,62 @@ export type WebhookEventType = | 'blocklist_created' export interface DomainRecordsDMARC { - /** Name of the DMARC TXT record. */ + /** + * Name of the DMARC TXT record. + */ name: string - /** Value of the DMARC TXT record. */ + /** + * Value of the DMARC TXT record. + */ value: string } export interface EmailTry { - /** Rank number of this attempt to send the email. */ + /** + * Rank number of this attempt to send the email. + */ rank: number - /** Date of the attempt to send the email. */ + /** + * Date of the attempt to send the email. + */ triedAt?: Date /** - * The SMTP status code received after the attempt. 0 if the attempt did not - * reach an SMTP server. + * The SMTP status code received after the attempt. 0 if the attempt did not reach an SMTP server. */ code: number /** - * The SMTP message received. If the attempt did not reach an SMTP server, the - * message returned explains what happened. + * The SMTP message received. If the attempt did not reach an SMTP server, the message returned explains what happened. */ message: string } export interface DomainRecords { - /** DMARC TXT record specification. */ + /** + * DMARC TXT record specification. + */ dmarc?: DomainRecordsDMARC } export interface DomainReputation { - /** Status of your domain's reputation. */ + /** + * Status of your domain's reputation. + */ status: DomainReputationStatus /** - * A range from 0 to 100 that determines your domain's reputation score. A - * score of `0` means a bad domain reputation and a score of `100` means an - * excellent domain reputation. + * A range from 0 to 100 that determines your domain's reputation score. A score of `0` means a bad domain reputation and a score of `100` means an excellent domain reputation. */ score: number - /** Time and date the score was calculated. */ + /** + * Time and date the score was calculated. + */ scoredAt?: Date - /** The previously-calculated domain's reputation score. */ + /** + * The previously-calculated domain's reputation score. + */ previousScore?: number - /** Time and date the previous reputation score was calculated. */ + /** + * Time and date the previous reputation score was calculated. + */ previousScoredAt?: Date } @@ -168,871 +182,1280 @@ export interface DomainStatistics { } export interface Blocklist { - /** ID of the blocklist. */ + /** + * ID of the blocklist. + */ id: string - /** Domain ID linked to the blocklist. */ + /** + * Domain ID linked to the blocklist. + */ domainId: string - /** Date and time of the blocklist creation. */ + /** + * Date and time of the blocklist creation. + */ createdAt?: Date - /** Date and time of the blocklist's last update. */ + /** + * Date and time of the blocklist's last update. + */ updatedAt?: Date - /** Date and time when the blocklist ends. Empty if the blocklist has no end. */ + /** + * Date and time when the blocklist ends. Empty if the blocklist has no end. + */ endsAt?: Date - /** Email blocked by the blocklist. */ + /** + * Email blocked by the blocklist. + */ email: string - /** Type of block for this email. */ + /** + * Type of block for this email. + */ type: BlocklistType - /** Reason to block this email. */ + /** + * Reason to block this email. + */ reason: string /** - * True if this blocklist was created manually. False for an automatic - * Transactional Email blocklist. + * True if this blocklist was created manually. False for an automatic Transactional Email blocklist. */ custom: boolean } export interface CreateEmailRequestAddress { - /** Email address. */ + /** + * Email address. + */ email: string - /** (Optional) Name displayed. */ + /** + * (Optional) Name displayed. + */ name?: string } export interface CreateEmailRequestAttachment { - /** Filename of the attachment. */ + /** + * Filename of the attachment. + */ name: string - /** MIME type of the attachment. */ + /** + * MIME type of the attachment. + */ type: string - /** Content of the attachment encoded in base64. */ + /** + * Content of the attachment encoded in base64. + */ content: string } export interface CreateEmailRequestHeader { - /** Email header key. */ + /** + * Email header key. + */ key: string - /** Email header value. */ + /** + * Email header value. + */ value: string } export interface Email { - /** Technical ID of the email. */ + /** + * Technical ID of the email. + */ id: string - /** Message ID of the email. */ + /** + * Message ID of the email. + */ messageId: string - /** ID of the Project to which the email belongs. */ + /** + * ID of the Project to which the email belongs. + */ projectId: string - /** Email address of the sender. */ + /** + * Email address of the sender. + */ mailFrom: string - /** @deprecated Deprecated. Email address of the recipient. */ + /** + * @deprecated Deprecated. Email address of the recipient. + */ rcptTo?: string - /** Email address of the recipient. */ + /** + * Email address of the recipient. + */ mailRcpt: string - /** Type of recipient. */ + /** + * Type of recipient. + */ rcptType: EmailRcptType - /** Subject of the email. */ + /** + * Subject of the email. + */ subject: string - /** Creation date of the email object. */ + /** + * Creation date of the email object. + */ createdAt?: Date - /** Last update of the email object. */ + /** + * Last update of the email object. + */ updatedAt?: Date - /** Status of the email. */ + /** + * Status of the email. + */ status: EmailStatus - /** Additional status information. */ + /** + * Additional status information. + */ statusDetails?: string - /** Number of attempts to send the email. */ + /** + * Number of attempts to send the email. + */ tryCount: number - /** Information about the last three attempts to send the email. */ + /** + * Information about the last three attempts to send the email. + */ lastTries: EmailTry[] /** - * Flags categorize emails. They allow you to obtain more information about - * recurring errors, for example. + * Flags categorize emails. They allow you to obtain more information about recurring errors, for example. */ flags: EmailFlag[] } export interface DomainLastStatusAutoconfigState { - /** Enable or disable the auto-configuration of domain DNS records. */ + /** + * Enable or disable the auto-configuration of domain DNS records. + */ enabled: boolean - /** Whether the domain can be auto-configured or not. */ + /** + * Whether the domain can be auto-configured or not. + */ autoconfigurable: boolean - /** The reason that the domain cannot be auto-configurable. */ + /** + * The reason that the domain cannot be auto-configurable. + */ reason?: DomainLastStatusAutoconfigStateReason } export interface DomainLastStatusDkimRecord { - /** Status of the DKIM record's configuration. */ + /** + * Status of the DKIM record's configuration. + */ status: DomainLastStatusRecordStatus - /** Time and date the DKIM record was last valid. */ + /** + * Time and date the DKIM record was last valid. + */ lastValidAt?: Date - /** An error text displays in case the record is not valid. */ + /** + * An error text displays in case the record is not valid. + */ error?: string } export interface DomainLastStatusDmarcRecord { - /** Status of the DMARC record's configuration. */ + /** + * Status of the DMARC record's configuration. + */ status: DomainLastStatusRecordStatus - /** Time and date the DMARC record was last valid. */ + /** + * Time and date the DMARC record was last valid. + */ lastValidAt?: Date - /** An error text displays in case the record is not valid. */ + /** + * An error text displays in case the record is not valid. + */ error?: string } export interface DomainLastStatusSpfRecord { - /** Status of the SPF record's configuration. */ + /** + * Status of the SPF record's configuration. + */ status: DomainLastStatusRecordStatus - /** Time and date the SPF record was last valid. */ + /** + * Time and date the SPF record was last valid. + */ lastValidAt?: Date - /** An error text displays in case the record is not valid. */ + /** + * An error text displays in case the record is not valid. + */ error?: string } export interface Domain { - /** ID of the domain. */ + /** + * ID of the domain. + */ id: string - /** ID of the domain's Organization. */ + /** + * ID of the domain's Organization. + */ organizationId: string - /** ID of the domain's Project. */ + /** + * ID of the domain's Project. + */ projectId: string - /** Domain name (example.com). */ + /** + * Domain name (example.com). + */ name: string - /** Status of the domain. */ + /** + * Status of the domain. + */ status: DomainStatus - /** Date and time of domain creation. */ + /** + * Date and time of domain creation. + */ createdAt?: Date - /** Date and time of the next scheduled check. */ + /** + * Date and time of the next scheduled check. + */ nextCheckAt?: Date - /** Date and time the domain was last valid. */ + /** + * Date and time the domain was last valid. + */ lastValidAt?: Date - /** Date and time of the domain's deletion. */ + /** + * Date and time of the domain's deletion. + */ revokedAt?: Date - /** @deprecated Deprecated. Error message returned if the last check failed. */ + /** + * @deprecated Deprecated. Error message returned if the last check failed. + */ lastError?: string - /** Snippet of the SPF record to register in the DNS zone. */ + /** + * Snippet of the SPF record to register in the DNS zone. + */ spfConfig: string - /** DKIM public key to record in the DNS zone. */ + /** + * DKIM public key to record in the DNS zone. + */ dkimConfig: string - /** Domain's statistics. */ + /** + * Domain's statistics. + */ statistics?: DomainStatistics /** - * The domain's reputation is available when your domain is checked and has - * sent enough emails. + * The domain's reputation is available when your domain is checked and has sent enough emails. */ reputation?: DomainReputation - /** List of records to configure to validate a domain. */ + /** + * List of records to configure to validate a domain. + */ records?: DomainRecords - /** Status of auto-configuration for the domain's DNS zone. */ + /** + * Status of auto-configuration for the domain's DNS zone. + */ autoconfig: boolean /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region: ScwRegion } export interface OfferSubscription { - /** ID of the offer-subscription Organization. */ + /** + * ID of the offer-subscription Organization. + */ organizationId: string - /** ID of the offer-subscription Project. */ + /** + * ID of the offer-subscription Project. + */ projectId: string - /** Name of the offer associated with the Project. */ + /** + * Name of the offer associated with the Project. + */ offerName: OfferName - /** Date and time of the subscription. */ + /** + * Date and time of the subscription. + */ subscribedAt?: Date - /** Date and time of the end of the offer-subscription commitment. */ + /** + * Date and time of the end of the offer-subscription commitment. + */ cancellationAvailableAt?: Date - /** Service Level Agreement percentage of the offer-subscription. */ + /** + * Service Level Agreement percentage of the offer-subscription. + */ sla: number /** - * Max number of domains that can be associated with the offer-subscription - * for a particular Project. + * Max number of domains that can be associated with the offer-subscription for a particular Project. */ maxDomains: number /** - * Max number of dedicated IPs that can be associated with the - * offer-subscription for a particular Project. + * Max number of dedicated IPs that can be associated with the offer-subscription for a particular Project. */ maxDedicatedIps: number /** - * Max number of webhooks that can be associated with the offer-subscription - * for a particular Project. + * Max number of webhooks that can be associated with the offer-subscription for a particular Project. */ maxWebhooksPerDomain: number /** - * Max number of custom blocklists that can be associated with the - * offer-subscription for a particular Project. + * Max number of custom blocklists that can be associated with the offer-subscription for a particular Project. */ maxCustomBlocklistsPerDomain: number - /** Number of emails included in the offer-subscription per month. */ + /** + * Number of emails included in the offer-subscription per month. + */ includedMonthlyEmails: number } export interface Offer { - /** Name of the offer. */ + /** + * Name of the offer. + */ name: OfferName - /** Date and time of the offer creation. */ + /** + * Date and time of the offer creation. + */ createdAt?: Date - /** Period of commitment. */ + /** + * Period of commitment. + */ commitmentPeriod?: string - /** Service Level Agreement percentage of the offer. */ + /** + * Service Level Agreement percentage of the offer. + */ sla: number - /** Max number of checked domains that can be associated with the offer. */ + /** + * Max number of checked domains that can be associated with the offer. + */ maxDomains: number - /** Max number of dedicated IPs that can be associated with the offer. */ + /** + * Max number of dedicated IPs that can be associated with the offer. + */ maxDedicatedIps: number - /** Number of emails included in the offer per month. */ + /** + * Number of emails included in the offer per month. + */ includedMonthlyEmails: number - /** Max number of webhooks that can be associated with the offer. */ + /** + * Max number of webhooks that can be associated with the offer. + */ maxWebhooksPerDomain: number /** - * Max number of active custom blocklists that can be associated with the - * offer. + * Max number of active custom blocklists that can be associated with the offer. */ maxCustomBlocklistsPerDomain: number } export interface Pool { - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId: string - /** Status of the pool. */ + /** + * Status of the pool. + */ status: PoolStatus - /** Details of the pool. */ + /** + * Details of the pool. + */ details?: string - /** Zone of the pool. */ + /** + * Zone of the pool. + */ zone?: ScwZone - /** IPs of the pool. */ + /** + * IPs of the pool. + */ ips: string[] - /** Reverse hostname of all IPs of the pool. */ + /** + * Reverse hostname of all IPs of the pool. + */ reverse?: string } export interface WebhookEvent { - /** ID of the Webhook Event. */ + /** + * ID of the Webhook Event. + */ id: string - /** ID of the Webhook that triggers the Event. */ + /** + * ID of the Webhook that triggers the Event. + */ webhookId: string - /** ID of the Webhook Event Organization. */ + /** + * ID of the Webhook Event Organization. + */ organizationId: string - /** ID of the Webhook Event Project. */ + /** + * ID of the Webhook Event Project. + */ projectId: string - /** ID of the webhook event domain. */ + /** + * ID of the webhook event domain. + */ domainId: string - /** Type of the Webhook Event. */ + /** + * Type of the Webhook Event. + */ type: WebhookEventType - /** Status of the Webhook Event. */ + /** + * Status of the Webhook Event. + */ status: WebhookEventStatus - /** Data sent to the Webhook destination. */ + /** + * Data sent to the Webhook destination. + */ data: string - /** Date and time of the Webhook Event creation. */ + /** + * Date and time of the Webhook Event creation. + */ createdAt?: Date - /** Date and time of last Webhook Event updates. */ + /** + * Date and time of last Webhook Event updates. + */ updatedAt?: Date - /** Optional Email ID if the event is triggered by an Email resource. */ + /** + * Optional Email ID if the event is triggered by an Email resource. + */ emailId?: string } export interface Webhook { - /** ID of the Webhook. */ + /** + * ID of the Webhook. + */ id: string - /** ID of the Domain to watch for triggering events. */ + /** + * ID of the Domain to watch for triggering events. + */ domainId: string - /** ID of the Webhook Organization. */ + /** + * ID of the Webhook Organization. + */ organizationId: string - /** ID of the Webhook Project. */ + /** + * ID of the Webhook Project. + */ projectId: string - /** Name of the Webhook. */ + /** + * Name of the Webhook. + */ name: string - /** List of event types that will trigger a Webhook Event. */ + /** + * List of event types that will trigger a Webhook Event. + */ eventTypes: WebhookEventType[] - /** Scaleway SNS ARN topic to push the events to. */ + /** + * Scaleway SNS ARN topic to push the events to. + */ snsArn: string - /** Date and time of the Webhook creation. */ + /** + * Date and time of the Webhook creation. + */ createdAt?: Date - /** Date and time of last Webhook updates. */ + /** + * Date and time of last Webhook updates. + */ updatedAt?: Date } export interface ProjectSettingsPeriodicReport { - /** Enable or disable periodic report notifications. */ + /** + * Enable or disable periodic report notifications. + */ enabled: boolean - /** At which frequency you receive periodic report notifications. */ + /** + * At which frequency you receive periodic report notifications. + */ frequency: ProjectSettingsPeriodicReportFrequency - /** At which hour you receive periodic report notifications. */ + /** + * At which hour you receive periodic report notifications. + */ sendingHour: number /** - * On which day you receive periodic report notifications (1-7 weekly, 1-28 - * monthly). + * On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly). */ sendingDay: number } export interface UpdateProjectSettingsRequestUpdatePeriodicReport { - /** (Optional) Enable or disable periodic report notifications. */ + /** + * (Optional) Enable or disable periodic report notifications. + */ enabled?: boolean - /** (Optional) Frequency at which you receive periodic report notifications. */ + /** + * (Optional) Frequency at which you receive periodic report notifications. + */ frequency?: ProjectSettingsPeriodicReportFrequency - /** (Optional) Hour at which you receive periodic report notifications. */ + /** + * (Optional) Hour at which you receive periodic report notifications. + */ sendingHour?: number /** - * (Optional) On which day you receive periodic report notifications (1-7 - * weekly, 1-28 monthly). + * (Optional) On which day you receive periodic report notifications (1-7 weekly, 1-28 monthly). */ sendingDay?: number } export type BulkCreateBlocklistsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Domain ID linked to the blocklist. */ + /** + * Domain ID linked to the blocklist. + */ domainId: string - /** Email blocked by the blocklist. */ + /** + * Email blocked by the blocklist. + */ emails?: string[] - /** Type of blocklist. */ + /** + * Type of blocklist. + */ type?: BlocklistType - /** Reason to block the email. */ + /** + * Reason to block the email. + */ reason?: string } export interface BulkCreateBlocklistsResponse { - /** List of blocklist created. */ + /** + * List of blocklist created. + */ blocklists: Blocklist[] } export type CancelEmailRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the email to cancel. */ + /** + * ID of the email to cancel. + */ emailId: string } export type CheckDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the domain to check. */ + /** + * ID of the domain to check. + */ domainId: string } export type CreateDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the project to which the domain belongs. */ + /** + * ID of the project to which the domain belongs. + */ projectId?: string - /** Fully qualified domain dame. */ + /** + * Fully qualified domain dame. + */ domainName: string - /** @deprecated Deprecated. Accept Scaleway's Terms of Service. */ + /** + * @deprecated Deprecated. Accept Scaleway's Terms of Service. + */ acceptTos?: boolean - /** Activate auto-configuration of the domain's DNS zone. */ + /** + * Activate auto-configuration of the domain's DNS zone. + */ autoconfig: boolean } export type CreateEmailRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Sender information. Must be from a checked domain declared in the Project. */ + /** + * Sender information. Must be from a checked domain declared in the Project. + */ from: CreateEmailRequestAddress - /** An array of the primary recipient's information. */ + /** + * An array of the primary recipient's information. + */ to?: CreateEmailRequestAddress[] - /** An array of the carbon copy recipient's information. */ + /** + * An array of the carbon copy recipient's information. + */ cc?: CreateEmailRequestAddress[] - /** An array of the blind carbon copy recipient's information. */ + /** + * An array of the blind carbon copy recipient's information. + */ bcc?: CreateEmailRequestAddress[] - /** Subject of the email. */ + /** + * Subject of the email. + */ subject: string - /** Text content. */ + /** + * Text content. + */ text: string - /** HTML content. */ + /** + * HTML content. + */ html: string - /** ID of the Project in which to create the email. */ + /** + * ID of the Project in which to create the email. + */ projectId?: string - /** Array of attachments. */ + /** + * Array of attachments. + */ attachments?: CreateEmailRequestAttachment[] - /** Maximum date to deliver the email. */ + /** + * Maximum date to deliver the email. + */ sendBefore?: Date - /** Array of additional headers as key-value. */ + /** + * Array of additional headers as key-value. + */ additionalHeaders?: CreateEmailRequestHeader[] } export interface CreateEmailResponse { - /** Single page of emails matching the requested criteria. */ + /** + * Single page of emails matching the requested criteria. + */ emails: Email[] } export type CreateWebhookRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Domain to watch for triggering events. */ + /** + * ID of the Domain to watch for triggering events. + */ domainId: string - /** ID of the project to which the Webhook belongs. */ + /** + * ID of the project to which the Webhook belongs. + */ projectId?: string - /** Name of the Webhook. */ + /** + * Name of the Webhook. + */ name: string - /** List of event types that will trigger an event. */ + /** + * List of event types that will trigger an event. + */ eventTypes?: WebhookEventType[] - /** Scaleway SNS ARN topic to push the events to. */ + /** + * Scaleway SNS ARN topic to push the events to. + */ snsArn: string } export type DeleteBlocklistRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the blocklist to delete. */ + /** + * ID of the blocklist to delete. + */ blocklistId: string } export type DeleteWebhookRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Webhook to delete. */ + /** + * ID of the Webhook to delete. + */ webhookId: string } export interface DomainLastStatus { - /** The ID of the domain. */ + /** + * The ID of the domain. + */ domainId: string - /** The domain name (example.com). */ + /** + * The domain name (example.com). + */ domainName: string - /** The SPF record verification data. */ + /** + * The SPF record verification data. + */ spfRecord?: DomainLastStatusSpfRecord - /** The DKIM record verification data. */ + /** + * The DKIM record verification data. + */ dkimRecord?: DomainLastStatusDkimRecord - /** The DMARC record verification data. */ + /** + * The DMARC record verification data. + */ dmarcRecord?: DomainLastStatusDmarcRecord - /** The verification state of domain auto-configuration. */ + /** + * The verification state of domain auto-configuration. + */ autoconfigState?: DomainLastStatusAutoconfigState } export type GetDomainLastStatusRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the domain to delete. */ + /** + * ID of the domain to delete. + */ domainId: string } export type GetDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the domain. */ + /** + * ID of the domain. + */ domainId: string } export type GetEmailRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the email to retrieve. */ + /** + * ID of the email to retrieve. + */ emailId: string } export type GetProjectConsumptionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the project. */ + /** + * ID of the project. + */ projectId?: string } export type GetProjectSettingsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the project. */ + /** + * ID of the project. + */ projectId?: string } export type GetStatisticsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** (Optional) Number of emails for this Project. */ + /** + * (Optional) Number of emails for this Project. + */ projectId?: string /** - * (Optional) Number of emails sent from this domain (must be coherent with - * the `project_id` and the `organization_id`). + * (Optional) Number of emails sent from this domain (must be coherent with the `project_id` and the `organization_id`). */ domainId?: string - /** (Optional) Number of emails created after this date. */ + /** + * (Optional) Number of emails created after this date. + */ since?: Date - /** (Optional) Number of emails created before this date. */ + /** + * (Optional) Number of emails created before this date. + */ until?: Date - /** (Optional) Number of emails sent with this sender's email address. */ + /** + * (Optional) Number of emails sent with this sender's email address. + */ mailFrom?: string } export type GetWebhookRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Webhook to check. */ + /** + * ID of the Webhook to check. + */ webhookId: string } export type ListBlocklistsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** (Optional) List blocklist corresponding to specific criteria. */ + /** + * (Optional) List blocklist corresponding to specific criteria. + */ orderBy?: ListBlocklistsRequestOrderBy - /** (Optional) Requested page number. Value must be greater or equal to 1. */ + /** + * (Optional) Requested page number. Value must be greater or equal to 1. + */ page?: number - /** (Optional) Requested page size. Value must be between 1 and 100. */ + /** + * (Optional) Requested page size. Value must be between 1 and 100. + */ pageSize?: number - /** (Optional) Filter by a domain ID. */ + /** + * (Optional) Filter by a domain ID. + */ domainId: string - /** (Optional) Filter by an email address. */ + /** + * (Optional) Filter by an email address. + */ email?: string - /** (Optional) Filter by a blocklist type. */ + /** + * (Optional) Filter by a blocklist type. + */ type?: BlocklistType /** - * (Optional) Filter by custom blocklist (true) or automatic Transactional - * Email blocklist (false). + * (Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false). */ custom?: boolean } export interface ListBlocklistsResponse { - /** Number of blocklists matching the requested criteria. */ + /** + * Number of blocklists matching the requested criteria. + */ totalCount: number - /** Single page of blocklists matching the requested criteria. */ + /** + * Single page of blocklists matching the requested criteria. + */ blocklists: Blocklist[] } export type ListDomainsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Requested page number. Value must be greater or equal to 1. */ + /** + * Requested page number. Value must be greater or equal to 1. + */ page?: number - /** Requested page size. Value must be between 1 and 1000. */ + /** + * Requested page size. Value must be between 1 and 1000. + */ pageSize?: number - /** (Optional) ID of the Project in which to list the domains. */ + /** + * (Optional) ID of the Project in which to list the domains. + */ projectId?: string - /** (Optional) List domains under specific statuses. */ + /** + * (Optional) List domains under specific statuses. + */ status?: DomainStatus[] - /** (Optional) ID of the Organization in which to list the domains. */ + /** + * (Optional) ID of the Organization in which to list the domains. + */ organizationId?: string - /** (Optional) Names of the domains to list. */ + /** + * (Optional) Names of the domains to list. + */ name?: string } export interface ListDomainsResponse { - /** Number of domains that match the request (without pagination). */ + /** + * Number of domains that match the request (without pagination). + */ totalCount: number - /** Single page of domains matching the requested criteria. */ + /** + * Single page of domains matching the requested criteria. + */ domains: Domain[] } export type ListEmailsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion page?: number pageSize?: number - /** (Optional) ID of the Project in which to list the emails. */ + /** + * (Optional) ID of the Project in which to list the emails. + */ projectId?: string - /** (Optional) ID of the domain for which to list the emails. */ + /** + * (Optional) ID of the domain for which to list the emails. + */ domainId?: string - /** (Optional) ID of the message for which to list the emails. */ + /** + * (Optional) ID of the message for which to list the emails. + */ messageId?: string - /** (Optional) List emails created after this date. */ + /** + * (Optional) List emails created after this date. + */ since?: Date - /** (Optional) List emails created before this date. */ + /** + * (Optional) List emails created before this date. + */ until?: Date - /** (Optional) List emails sent with this sender's email address. */ + /** + * (Optional) List emails sent with this sender's email address. + */ mailFrom?: string - /** @deprecated Deprecated. List emails sent to this recipient's email address. */ + /** + * @deprecated Deprecated. List emails sent to this recipient's email address. + */ mailTo?: string - /** (Optional) List emails sent to this recipient's email address. */ + /** + * (Optional) List emails sent to this recipient's email address. + */ mailRcpt?: string - /** (Optional) List emails with any of these statuses. */ + /** + * (Optional) List emails with any of these statuses. + */ statuses?: EmailStatus[] - /** (Optional) List emails with this subject. */ + /** + * (Optional) List emails with this subject. + */ subject?: string - /** (Optional) List emails by searching to all fields. */ + /** + * (Optional) List emails by searching to all fields. + */ search?: string - /** (Optional) List emails corresponding to specific criteria. */ + /** + * (Optional) List emails corresponding to specific criteria. + */ orderBy?: ListEmailsRequestOrderBy - /** (Optional) List emails containing only specific flags. */ + /** + * (Optional) List emails containing only specific flags. + */ flags?: EmailFlag[] } export interface ListEmailsResponse { - /** Number of emails matching the requested criteria. */ + /** + * Number of emails matching the requested criteria. + */ totalCount: number - /** Single page of emails matching the requested criteria. */ + /** + * Single page of emails matching the requested criteria. + */ emails: Email[] } export type ListOfferSubscriptionsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } export interface ListOfferSubscriptionsResponse { - /** Number of offer-subscriptions matching the requested criteria. */ + /** + * Number of offer-subscriptions matching the requested criteria. + */ totalCount: number - /** Single page of offer-subscriptions matching the requested criteria. */ + /** + * Single page of offer-subscriptions matching the requested criteria. + */ offerSubscriptions: OfferSubscription[] } export type ListOffersRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion } export interface ListOffersResponse { - /** Number of offers matching the requested criteria. */ + /** + * Number of offers matching the requested criteria. + */ totalCount: number - /** Single page of offers matching the requested criteria. */ + /** + * Single page of offers matching the requested criteria. + */ offers: Offer[] } export type ListPoolsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Requested page number. Value must be greater or equal to 1. */ + /** + * Requested page number. Value must be greater or equal to 1. + */ page?: number - /** Requested page size. Value must be between 1 and 1000. */ + /** + * Requested page size. Value must be between 1 and 1000. + */ pageSize?: number - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string } export interface ListPoolsResponse { - /** Number of pools matching the requested criteria. */ + /** + * Number of pools matching the requested criteria. + */ totalCount: number - /** Single page of pools matching the requested criteria. */ + /** + * Single page of pools matching the requested criteria. + */ pools: Pool[] } export type ListWebhookEventsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Webhook linked to the events. */ + /** + * ID of the Webhook linked to the events. + */ webhookId: string - /** (Optional) List Webhook events corresponding to specific criteria. */ + /** + * (Optional) List Webhook events corresponding to specific criteria. + */ orderBy?: ListWebhookEventsRequestOrderBy - /** Requested page number. Value must be greater or equal to 1. */ + /** + * Requested page number. Value must be greater or equal to 1. + */ page?: number - /** Requested page size. Value must be between 1 and 100. */ + /** + * Requested page size. Value must be between 1 and 100. + */ pageSize?: number - /** ID of the email linked to the events. */ + /** + * ID of the email linked to the events. + */ emailId?: string - /** List of event types linked to the events. */ + /** + * List of event types linked to the events. + */ eventTypes?: WebhookEventType[] - /** List of event statuses. */ + /** + * List of event statuses. + */ statuses?: WebhookEventStatus[] - /** ID of the webhook Project. */ + /** + * ID of the webhook Project. + */ projectId?: string - /** ID of the webhook Organization. */ + /** + * ID of the webhook Organization. + */ organizationId?: string - /** ID of the domain to watch for triggering events. */ + /** + * ID of the domain to watch for triggering events. + */ domainId?: string } export interface ListWebhookEventsResponse { - /** Number of Webhook events matching the requested criteria. */ + /** + * Number of Webhook events matching the requested criteria. + */ totalCount: number - /** Single page of Webhook events matching the requested criteria. */ + /** + * Single page of Webhook events matching the requested criteria. + */ webhookEvents: WebhookEvent[] } export type ListWebhooksRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** (Optional) List Webhooks corresponding to specific criteria. */ + /** + * (Optional) List Webhooks corresponding to specific criteria. + */ orderBy?: ListWebhooksRequestOrderBy - /** (Optional) Requested page number. Value must be greater or equal to 1. */ + /** + * (Optional) Requested page number. Value must be greater or equal to 1. + */ page?: number - /** (Optional) Requested page size. Value must be between 1 and 100. */ + /** + * (Optional) Requested page size. Value must be between 1 and 100. + */ pageSize?: number - /** (Optional) ID of the Project for which to list the Webhooks. */ + /** + * (Optional) ID of the Project for which to list the Webhooks. + */ projectId?: string - /** (Optional) ID of the Organization for which to list the Webhooks. */ + /** + * (Optional) ID of the Organization for which to list the Webhooks. + */ organizationId?: string - /** (Optional) ID of the Domain for which to list the Webhooks. */ + /** + * (Optional) ID of the Domain for which to list the Webhooks. + */ domainId?: string } export interface ListWebhooksResponse { - /** Number of Webhooks matching the requested criteria. */ + /** + * Number of Webhooks matching the requested criteria. + */ totalCount: number - /** Single page of Webhooks matching the requested criteria. */ + /** + * Single page of Webhooks matching the requested criteria. + */ webhooks: Webhook[] } export interface ProjectConsumption { - /** ID of the project. */ + /** + * ID of the project. + */ projectId: string - /** Number of domains in the project. */ + /** + * Number of domains in the project. + */ domainsCount: number - /** Number of dedicated IP in the project. */ + /** + * Number of dedicated IP in the project. + */ dedicatedIpsCount: number - /** Number of emails sent during the current month in the project. */ + /** + * Number of emails sent during the current month in the project. + */ monthlyEmailsCount: number - /** Number of webhooks in the project. */ + /** + * Number of webhooks in the project. + */ webhooksCount: number - /** Number of custom blocklists in the project. */ + /** + * Number of custom blocklists in the project. + */ customBlocklistsCount: number } export interface ProjectSettings { - /** Information about your periodic report. */ + /** + * Information about your periodic report. + */ periodicReport?: ProjectSettingsPeriodicReport } export type RevokeDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the domain to delete. */ + /** + * ID of the domain to delete. + */ domainId: string } export interface Statistics { - /** Total number of emails matching the requested criteria. */ + /** + * Total number of emails matching the requested criteria. + */ totalCount: number /** - * Number of emails still in the `new` transient state. This means emails - * received from the API but not yet processed. + * Number of emails still in the `new` transient state. This means emails received from the API but not yet processed. */ newCount: number /** - * Number of emails still in the `sending` transient state. This means emails - * received from the API but not yet in their final status. + * Number of emails still in the `sending` transient state. This means emails received from the API but not yet in their final status. */ sendingCount: number /** - * Number of emails in the final `sent` state. This means emails that have - * been delivered to the target mail system. + * Number of emails in the final `sent` state. This means emails that have been delivered to the target mail system. */ sentCount: number /** - * Number of emails in the final `failed` state. This means emails that have - * been refused by the target mail system with a final error status. + * Number of emails in the final `failed` state. This means emails that have been refused by the target mail system with a final error status. */ failedCount: number /** - * Number of emails in the final `canceled` state. This means emails that have - * been canceled upon request. + * Number of emails in the final `canceled` state. This means emails that have been canceled upon request. */ canceledCount: number } export type UpdateDomainRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the domain to update. */ + /** + * ID of the domain to update. + */ domainId: string /** - * (Optional) If set to true, activate auto-configuration of the domain's DNS - * zone. + * (Optional) If set to true, activate auto-configuration of the domain's DNS zone. */ autoconfig?: boolean } export type UpdateOfferSubscriptionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Project. */ + /** + * ID of the Project. + */ projectId?: string - /** Name of the offer-subscription. */ + /** + * Name of the offer-subscription. + */ name?: OfferName } export type UpdateProjectSettingsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the project. */ + /** + * ID of the project. + */ projectId?: string - /** Periodic report update details - all fields are optional. */ + /** + * Periodic report update details - all fields are optional. + */ periodicReport?: UpdateProjectSettingsRequestUpdatePeriodicReport } export type UpdateWebhookRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** ID of the Webhook to update. */ + /** + * ID of the Webhook to update. + */ webhookId: string - /** Name of the Webhook to update. */ + /** + * Name of the Webhook to update. + */ name?: string - /** List of event types to update. */ + /** + * List of event types to update. + */ eventTypes?: WebhookEventType[] - /** Scaleway SNS ARN topic to update. */ + /** + * Scaleway SNS ARN topic to update. + */ snsArn?: string } diff --git a/packages/clients/src/api/test/v1/api.gen.ts b/packages/clients/src/api/test/v1/api.gen.ts index cd4d0e227..5b7116379 100644 --- a/packages/clients/src/api/test/v1/api.gen.ts +++ b/packages/clients/src/api/test/v1/api.gen.ts @@ -37,16 +37,14 @@ const jsonContentHeaders = { /** * Fake API. - * - * No Auth Service for end-to-end testing. + +No Auth Service for end-to-end testing. */ export class API extends ParentAPI { /** - * Register a user. Register a human and return a access-key and a secret-key - * that must be used in all other commands. - * - * Hint: you can use other test commands by setting the SCW_SECRET_KEY env - * variable. + * Register a user. Register a human and return a access-key and a secret-key that must be used in all other commands. + +Hint: you can use other test commands by setting the SCW_SECRET_KEY env variable. * * @param request - The request {@link RegisterRequest} * @returns A Promise of RegisterResponse @@ -181,8 +179,7 @@ export class API extends ParentAPI { ) /** - * Start a 1h running for the given human. Start a one hour running for the - * given human. + * Start a 1h running for the given human. Start a one hour running for the given human. * * @param request - The request {@link RunHumanRequest} * @returns A Promise of Human diff --git a/packages/clients/src/api/test/v1/types.gen.ts b/packages/clients/src/api/test/v1/types.gen.ts index 45577a67b..7d775ce14 100644 --- a/packages/clients/src/api/test/v1/types.gen.ts +++ b/packages/clients/src/api/test/v1/types.gen.ts @@ -52,25 +52,28 @@ export type CreateHumanRequest = { /** * @deprecated * - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ organizationId?: string name: string /** - * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' - * could be set. + * + * One-of ('projectIdentifier'): at most one of 'projectId', 'organizationId' could be set. */ projectId?: string } export type DeleteHumanRequest = { - /** UUID of the human you want to delete. */ + /** + * UUID of the human you want to delete. + */ humanId: string } export type GetHumanRequest = { - /** UUID of the human you want to get. */ + /** + * UUID of the human you want to get. + */ humanId: string } @@ -97,19 +100,27 @@ export interface RegisterResponse { } export type RunHumanRequest = { - /** UUID of the human you want to make run. */ + /** + * UUID of the human you want to make run. + */ humanId: string } export type SmokeHumanRequest = { - /** @deprecated UUID of the human you want to make smoking. */ + /** + * @deprecated UUID of the human you want to make smoking. + */ humanId: string } export type UpdateHumanRequest = { - /** UUID of the human you want to update. */ + /** + * UUID of the human you want to update. + */ humanId: string - /** Height of the human in meters. */ + /** + * Height of the human in meters. + */ height?: number shoeSize?: number altitudeInMeter?: number