From 6bdebea5dcb6c3ff24a2da6ced5788aa5d2fd643 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Wed, 2 Apr 2025 15:03:33 +0000 Subject: [PATCH] feat: update generated APIs --- .../clients/src/api/account/v3/api.gen.ts | 53 ++-- .../clients/src/api/account/v3/types.gen.ts | 272 ++++++++++++------ packages/clients/src/api/index.gen.ts | 2 + .../src/api/product_catalog/index.gen.ts | 6 + .../api/product_catalog/v2alpha1/index.gen.ts | 27 ++ 5 files changed, 239 insertions(+), 121 deletions(-) create mode 100644 packages/clients/src/api/product_catalog/index.gen.ts create mode 100644 packages/clients/src/api/product_catalog/v2alpha1/index.gen.ts 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/index.gen.ts b/packages/clients/src/api/index.gen.ts index 9ad0f77af..5e47484ee 100644 --- a/packages/clients/src/api/index.gen.ts +++ b/packages/clients/src/api/index.gen.ts @@ -32,6 +32,7 @@ import * as LlmInference from './llm_inference/index.gen' import * as Marketplace from './marketplace/index.gen' import * as Mnq from './mnq/index.gen' import * as Mongodb from './mongodb/index.gen' +import * as ProductCatalog from './product_catalog/index.gen' import * as Qaas from './qaas/index.gen' import * as Rdb from './rdb/index.gen' import * as Redis from './redis/index.gen' @@ -75,6 +76,7 @@ export { Marketplace, Mnq, Mongodb, + ProductCatalog, Qaas, Rdb, Redis, diff --git a/packages/clients/src/api/product_catalog/index.gen.ts b/packages/clients/src/api/product_catalog/index.gen.ts new file mode 100644 index 000000000..36dc2b2b7 --- /dev/null +++ b/packages/clients/src/api/product_catalog/index.gen.ts @@ -0,0 +1,6 @@ +/** + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE + */ + +export * as v2alpha1 from './v2alpha1/index.gen' diff --git a/packages/clients/src/api/product_catalog/v2alpha1/index.gen.ts b/packages/clients/src/api/product_catalog/v2alpha1/index.gen.ts new file mode 100644 index 000000000..b94d747c0 --- /dev/null +++ b/packages/clients/src/api/product_catalog/v2alpha1/index.gen.ts @@ -0,0 +1,27 @@ +// This file was automatically generated. DO NOT EDIT. +// If you have any remark or suggestion do not hesitate to open an issue. +export { PublicCatalogAPI } from './api.gen' +export type { + ListPublicCatalogProductsResponse, + PublicCatalogApiListPublicCatalogProductsRequest, + PublicCatalogProduct, + PublicCatalogProductLocality, + PublicCatalogProductPrice, + PublicCatalogProductPriceUnitOfMeasure, + PublicCatalogProductPriceUnitOfMeasureCountableUnit, + PublicCatalogProductProperties, + PublicCatalogProductPropertiesAppleSilicon, + PublicCatalogProductPropertiesDedibox, + PublicCatalogProductPropertiesElasticMetal, + PublicCatalogProductPropertiesHardware, + PublicCatalogProductPropertiesHardwareCPU, + PublicCatalogProductPropertiesHardwareCPUArch, + PublicCatalogProductPropertiesHardwareCPUPhysical, + PublicCatalogProductPropertiesHardwareCPUVirtual, + PublicCatalogProductPropertiesHardwareGPU, + PublicCatalogProductPropertiesHardwareNetwork, + PublicCatalogProductPropertiesHardwareRAM, + PublicCatalogProductPropertiesHardwareStorage, + PublicCatalogProductPropertiesInstance, +} from './types.gen' +export * as ValidationRules from './validation-rules.gen'