From 6c76f5a8e580e96423c3c4d2da3fe1aa81e8cc56 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Mon, 31 Mar 2025 09:25:35 +0000 Subject: [PATCH] feat: update generated APIs --- packages/clients/src/api/account/index.gen.ts | 4 +- .../clients/src/api/account/v3/index.gen.ts | 5 +- .../clients/src/api/applesilicon/index.gen.ts | 4 +- .../api/applesilicon/v1alpha1/index.gen.ts | 5 +- .../clients/src/api/audit_trail/index.gen.ts | 4 +- .../clients/src/api/baremetal/index.gen.ts | 4 +- .../clients/src/api/baremetal/v1/index.gen.ts | 5 +- packages/clients/src/api/billing/index.gen.ts | 4 +- packages/clients/src/api/block/index.gen.ts | 4 +- packages/clients/src/api/cockpit/index.gen.ts | 4 +- .../clients/src/api/cockpit/v1/index.gen.ts | 5 +- .../clients/src/api/container/index.gen.ts | 4 +- packages/clients/src/api/dedibox/index.gen.ts | 4 +- .../clients/src/api/document_db/index.gen.ts | 4 +- packages/clients/src/api/domain/index.gen.ts | 4 +- .../src/api/domain/v2beta1/index.gen.ts | 5 +- .../src/api/edge_services/index.gen.ts | 4 +- .../clients/src/api/flexibleip/index.gen.ts | 4 +- .../clients/src/api/function/index.gen.ts | 4 +- .../src/api/function/v1beta1/api.gen.ts | 46 +- .../src/api/function/v1beta1/types.gen.ts | 903 +++++++---- packages/clients/src/api/iam/index.gen.ts | 4 +- .../clients/src/api/iam/v1alpha1/api.gen.ts | 210 +-- .../clients/src/api/iam/v1alpha1/types.gen.ts | 1347 ++++++++++++----- packages/clients/src/api/index.gen.ts | 4 +- .../clients/src/api/inference/index.gen.ts | 4 +- .../clients/src/api/instance/index.gen.ts | 4 +- .../clients/src/api/interlink/index.gen.ts | 4 +- packages/clients/src/api/iot/index.gen.ts | 4 +- packages/clients/src/api/ipam/index.gen.ts | 4 +- packages/clients/src/api/ipfs/index.gen.ts | 4 +- packages/clients/src/api/jobs/index.gen.ts | 4 +- packages/clients/src/api/k8s/index.gen.ts | 4 +- .../clients/src/api/key_manager/index.gen.ts | 4 +- packages/clients/src/api/lb/index.gen.ts | 4 +- packages/clients/src/api/lb/v1/index.gen.ts | 5 +- .../src/api/llm_inference/index.gen.ts | 4 +- .../clients/src/api/marketplace/index.gen.ts | 4 +- packages/clients/src/api/mnq/index.gen.ts | 4 +- .../clients/src/api/mnq/v1beta1/index.gen.ts | 6 +- packages/clients/src/api/mongodb/index.gen.ts | 4 +- packages/clients/src/api/qaas/index.gen.ts | 4 +- packages/clients/src/api/rdb/index.gen.ts | 4 +- packages/clients/src/api/redis/index.gen.ts | 4 +- .../clients/src/api/registry/index.gen.ts | 4 +- packages/clients/src/api/secret/index.gen.ts | 4 +- .../src/api/serverless_sqldb/index.gen.ts | 4 +- packages/clients/src/api/tem/index.gen.ts | 4 +- packages/clients/src/api/test/index.gen.ts | 4 +- packages/clients/src/api/vpc/index.gen.ts | 4 +- packages/clients/src/api/vpc/v2/api.gen.ts | 48 +- packages/clients/src/api/vpc/v2/types.gen.ts | 519 ++++--- packages/clients/src/api/vpcgw/index.gen.ts | 4 +- packages/clients/src/api/vpcgw/v1/api.gen.ts | 175 +-- .../clients/src/api/vpcgw/v1/types.gen.ts | 1148 +++++++++----- packages/clients/src/api/vpcgw/v2/api.gen.ts | 119 +- .../clients/src/api/vpcgw/v2/types.gen.ts | 741 ++++++--- .../clients/src/api/webhosting/index.gen.ts | 4 +- .../clients/src/api/webhosting/v1/api.gen.ts | 107 +- .../src/api/webhosting/v1/types.gen.ts | 1049 ++++++++----- 60 files changed, 4246 insertions(+), 2366 deletions(-) diff --git a/packages/clients/src/api/account/index.gen.ts b/packages/clients/src/api/account/index.gen.ts index 1b3f55320..333d11779 100644 --- a/packages/clients/src/api/account/index.gen.ts +++ b/packages/clients/src/api/account/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v2 from './v2/index.gen' diff --git a/packages/clients/src/api/account/v3/index.gen.ts b/packages/clients/src/api/account/v3/index.gen.ts index 602eeae7d..dd72dadae 100644 --- a/packages/clients/src/api/account/v3/index.gen.ts +++ b/packages/clients/src/api/account/v3/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { ContractAPI, ProjectAPI } from './api.gen' +export { + ContractAPI, + ProjectAPI, +} from './api.gen' export type { CheckContractSignatureResponse, Contract, diff --git a/packages/clients/src/api/applesilicon/index.gen.ts b/packages/clients/src/api/applesilicon/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/applesilicon/index.gen.ts +++ b/packages/clients/src/api/applesilicon/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts b/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts index 2fef6a0c1..2234c5055 100644 --- a/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts +++ b/packages/clients/src/api/applesilicon/v1alpha1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, PrivateNetworkAPI } from './api.gen' +export { + API, + PrivateNetworkAPI, +} from './api.gen' export * from './content.gen' export type { Commitment, diff --git a/packages/clients/src/api/audit_trail/index.gen.ts b/packages/clients/src/api/audit_trail/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/audit_trail/index.gen.ts +++ b/packages/clients/src/api/audit_trail/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/baremetal/index.gen.ts b/packages/clients/src/api/baremetal/index.gen.ts index 81bee1055..66600f8ba 100644 --- a/packages/clients/src/api/baremetal/index.gen.ts +++ b/packages/clients/src/api/baremetal/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/baremetal/v1/index.gen.ts b/packages/clients/src/api/baremetal/v1/index.gen.ts index fff7d779f..025e18a7a 100644 --- a/packages/clients/src/api/baremetal/v1/index.gen.ts +++ b/packages/clients/src/api/baremetal/v1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, PrivateNetworkAPI } from './api.gen' +export { + API, + PrivateNetworkAPI, +} from './api.gen' export * from './content.gen' export type { AddOptionServerRequest, diff --git a/packages/clients/src/api/billing/index.gen.ts b/packages/clients/src/api/billing/index.gen.ts index 35a5f69ed..151c81ecc 100644 --- a/packages/clients/src/api/billing/index.gen.ts +++ b/packages/clients/src/api/billing/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * 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/block/index.gen.ts b/packages/clients/src/api/block/index.gen.ts index 3c605af8e..abe7c4339 100644 --- a/packages/clients/src/api/block/index.gen.ts +++ b/packages/clients/src/api/block/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/cockpit/index.gen.ts b/packages/clients/src/api/cockpit/index.gen.ts index 5fbe167b7..a7faa1b20 100644 --- a/packages/clients/src/api/cockpit/index.gen.ts +++ b/packages/clients/src/api/cockpit/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/cockpit/v1/index.gen.ts b/packages/clients/src/api/cockpit/v1/index.gen.ts index 36ef92f90..443477b24 100644 --- a/packages/clients/src/api/cockpit/v1/index.gen.ts +++ b/packages/clients/src/api/cockpit/v1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { GlobalAPI, RegionalAPI } from './api.gen' +export { + GlobalAPI, + RegionalAPI, +} from './api.gen' export type { Alert, AlertManager, diff --git a/packages/clients/src/api/container/index.gen.ts b/packages/clients/src/api/container/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/container/index.gen.ts +++ b/packages/clients/src/api/container/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/dedibox/index.gen.ts b/packages/clients/src/api/dedibox/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/dedibox/index.gen.ts +++ b/packages/clients/src/api/dedibox/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/document_db/index.gen.ts b/packages/clients/src/api/document_db/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/document_db/index.gen.ts +++ b/packages/clients/src/api/document_db/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/domain/index.gen.ts b/packages/clients/src/api/domain/index.gen.ts index b4fd0db98..20241ec7a 100644 --- a/packages/clients/src/api/domain/index.gen.ts +++ b/packages/clients/src/api/domain/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v2beta1 from './v2beta1/index.gen' diff --git a/packages/clients/src/api/domain/v2beta1/index.gen.ts b/packages/clients/src/api/domain/v2beta1/index.gen.ts index 10fdd848e..228732a9e 100644 --- a/packages/clients/src/api/domain/v2beta1/index.gen.ts +++ b/packages/clients/src/api/domain/v2beta1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, RegistrarAPI } from './api.gen' +export { + API, + RegistrarAPI, +} from './api.gen' export * from './content.gen' export type { AvailableDomain, diff --git a/packages/clients/src/api/edge_services/index.gen.ts b/packages/clients/src/api/edge_services/index.gen.ts index 72d281d6b..6a15a4900 100644 --- a/packages/clients/src/api/edge_services/index.gen.ts +++ b/packages/clients/src/api/edge_services/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/flexibleip/index.gen.ts b/packages/clients/src/api/flexibleip/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/flexibleip/index.gen.ts +++ b/packages/clients/src/api/flexibleip/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/function/index.gen.ts b/packages/clients/src/api/function/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/function/index.gen.ts +++ b/packages/clients/src/api/function/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/function/v1beta1/api.gen.ts b/packages/clients/src/api/function/v1beta1/api.gen.ts index b4123fb54..948df4f29 100644 --- a/packages/clients/src/api/function/v1beta1/api.gen.ts +++ b/packages/clients/src/api/function/v1beta1/api.gen.ts @@ -100,8 +100,8 @@ const jsonContentHeaders = { /** * Serverless Functions API. - * - * This API allows you to manage your Serverless Functions. + +This API allows you to manage your Serverless Functions. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -134,8 +134,7 @@ export class API extends ParentAPI { ) /** - * List all your namespaces. List all existing namespaces in the specified - * region. + * List all your namespaces. List all existing namespaces in the specified region. * * @param request - The request {@link ListNamespacesRequest} * @returns A Promise of ListNamespacesResponse @@ -181,8 +180,7 @@ export class API extends ParentAPI { ) /** - * Create a new namespace. Create a new namespace in a specified Organization - * or Project. + * Create a new namespace. Create a new namespace in a specified Organization or Project. * * @param request - The request {@link CreateNamespaceRequest} * @returns A Promise of Namespace @@ -201,8 +199,7 @@ export class API extends ParentAPI { ) /** - * Update an existing namespace. Update the namespace associated with the - * specified ID. + * Update an existing namespace. Update the namespace associated with the specified ID. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -221,8 +218,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 @@ -304,8 +300,7 @@ export class API extends ParentAPI { ) /** - * Create a new function. Create a new function in the specified region for a - * specified Organization or Project. + * Create a new function. Create a new function in the specified region for a specified Organization or Project. * * @param request - The request {@link CreateFunctionRequest} * @returns A Promise of Function @@ -324,8 +319,7 @@ export class API extends ParentAPI { ) /** - * Update an existing function. Update the function associated with the - * specified ID. + * Update an existing function. Update the function associated with the specified ID. * * @param request - The request {@link UpdateFunctionRequest} * @returns A Promise of Function @@ -393,8 +387,7 @@ export class API extends ParentAPI { ) /** - * Get an upload URL of a function. Get an upload URL of a function associated - * with the specified ID. + * Get an upload URL of a function. Get an upload URL of a function associated with the specified ID. * * @param request - The request {@link GetFunctionUploadURLRequest} * @returns A Promise of UploadURL @@ -410,8 +403,7 @@ export class API extends ParentAPI { ) /** - * Get a download URL of a function. Get a download URL for a function - * associated with the specified ID. + * Get a download URL of a function. Get a download URL for a function associated with the specified ID. * * @param request - The request {@link GetFunctionDownloadURLRequest} * @returns A Promise of DownloadURL @@ -490,8 +482,7 @@ export class API extends ParentAPI { ) /** - * Create a new cron. Create a new cronjob for a function with the specified - * ID. + * Create a new cron. Create a new cronjob for a function with the specified ID. * * @param request - The request {@link CreateCronRequest} * @returns A Promise of Cron @@ -562,8 +553,7 @@ export class API extends ParentAPI { ) /** - * List all domain name bindings. List all domain name bindings in a specified - * region. + * List all domain name bindings. List all domain name bindings in a specified region. * * @param request - The request {@link ListDomainsRequest} * @returns A Promise of ListDomainsResponse @@ -572,8 +562,7 @@ export class API extends ParentAPI { enrichForPagination('domains', this.pageOfListDomains, request) /** - * Get a domain name binding. Get a domain name binding for the function with - * the specified ID. + * Get a domain name binding. Get a domain name binding for the function with the specified ID. * * @param request - The request {@link GetDomainRequest} * @returns A Promise of Domain @@ -610,8 +599,7 @@ export class API extends ParentAPI { ) /** - * Create a domain name binding. Create a domain name binding for the function - * with the specified ID. + * Create a domain name binding. Create a domain name binding for the function with the specified ID. * * @param request - The request {@link CreateDomainRequest} * @returns A Promise of Domain @@ -630,8 +618,7 @@ export class API extends ParentAPI { ) /** - * Delete a domain name binding. Delete a domain name binding for the function - * with the specified ID. + * Delete a domain name binding. Delete a domain name binding for the function with the specified ID. * * @param request - The request {@link DeleteDomainRequest} * @returns A Promise of Domain @@ -831,8 +818,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/function/v1beta1/types.gen.ts b/packages/clients/src/api/function/v1beta1/types.gen.ts index 92cdc56c1..3c29b5f1e 100644 --- a/packages/clients/src/api/function/v1beta1/types.gen.ts +++ b/packages/clients/src/api/function/v1beta1/types.gen.ts @@ -144,31 +144,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 } @@ -186,22 +198,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 } @@ -213,32 +239,56 @@ export interface CreateTriggerRequestSqsClientConfig { } export interface Cron { - /** UUID of the cron. */ + /** + * UUID of the cron. + */ id: string - /** UUID of the function the cron applies to. */ + /** + * UUID of the function the cron applies to. + */ functionId: string - /** Schedule of the cron. */ + /** + * Schedule of the cron. + */ 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 - /** Hostname associated with the function. */ + /** + * Hostname associated with the function. + */ hostname: string - /** UUID of the function the domain is associated with. */ + /** + * UUID of the function the domain is associated with. + */ functionId: string - /** URL of the function. */ + /** + * URL of the function. + */ url: string - /** State of the doamin. */ + /** + * State of the doamin. + */ status: DomainStatus - /** Error message if the domain is in "error" state. */ + /** + * Error message if the domain is in "error" state. + */ errorMessage?: string } @@ -256,100 +306,178 @@ export interface Runtime { } export interface Function { - /** UUID of the function. */ + /** + * UUID of the function. + */ id: string - /** Name of the function. */ + /** + * Name of the function. + */ name: string - /** UUID of the namespace the function belongs to. */ + /** + * UUID of the namespace the function belongs to. + */ namespaceId: string - /** Status of the function. */ + /** + * Status of the function. + */ status: FunctionStatus - /** Environment variables of the function. */ + /** + * Environment variables of the function. + */ environmentVariables: Record - /** Minimum number of instances to scale the function to. */ + /** + * Minimum number of instances to scale the function to. + */ minScale: number - /** Maximum number of instances to scale the function to. */ + /** + * Maximum number of instances to scale the function to. + */ maxScale: number - /** Runtime of the function. */ + /** + * Runtime of the function. + */ runtime: FunctionRuntime - /** Memory limit of the function in MB. */ + /** + * Memory limit of the function in MB. + */ memoryLimit: number - /** CPU limit of the function. */ + /** + * CPU limit of the function. + */ cpuLimit: number - /** Request processing time limit for the function. */ + /** + * Request processing time limit for the function. + */ timeout?: string - /** Handler to use for the function. */ + /** + * Handler to use for the function. + */ handler: string - /** Error message if the function is in "error" state. */ + /** + * Error message if the function is in "error" state. + */ errorMessage?: string - /** Description of the current build step. */ + /** + * Description of the current build step. + */ buildMessage?: string - /** Privacy setting of the function. */ + /** + * Privacy setting of the function. + */ privacy: FunctionPrivacy - /** Description of the function. */ + /** + * Description of the function. + */ description?: string - /** Domain name associated with the function. */ + /** + * Domain name associated with the function. + */ domainName: string - /** Secret environment variables of the function. */ + /** + * Secret environment variables of the function. + */ secretEnvironmentVariables: SecretHashedValue[] - /** Region in which the function is deployed. */ + /** + * Region in which the function is deployed. + */ region: ScwRegion /** * 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: FunctionHttpOption runtimeMessage: string - /** Execution environment of the function. */ + /** + * Execution environment of the function. + */ sandbox: FunctionSandbox - /** Creation date of the function. */ + /** + * Creation date of the function. + */ createdAt?: Date - /** Last update date of the function. */ + /** + * Last update date of the function. + */ updatedAt?: Date - /** Last date when the function was successfully deployed and set to ready. */ + /** + * Last date when the function was successfully deployed and set to ready. + */ readyAt?: Date } 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 - /** Error message if the namespace is in "error" state. */ + /** + * Error message if the namespace is in "error" state. + */ errorMessage?: string - /** Registry endpoint of the namespace. */ + /** + * Registry endpoint of the namespace. + */ registryEndpoint: string - /** Description of the namespace. */ + /** + * Description of the namespace. + */ description?: string - /** Secret environment variables of the namespace. */ + /** + * Secret environment variables of the namespace. + */ secretEnvironmentVariables: SecretHashedValue[] - /** Region in which the namespace is located. */ + /** + * Region in which the namespace is located. + */ region: ScwRegion - /** [ALPHA] List of tags applied to the Serverless Function Namespace. */ + /** + * [ALPHA] List of tags applied to the Serverless Function 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 - /** String of the token. */ + /** + * String of the token. + */ token: string /** * UUID of the function the token is associated with. @@ -363,50 +491,69 @@ export interface Token { * One-of ('scope'): at most one of 'functionId', '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 - /** Date on which the token expires. */ + /** + * Date on which the token expires. + */ 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 function to trigger. */ + /** + * ID of the function to trigger. + */ functionId: 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 } @@ -418,96 +565,135 @@ export interface UpdateTriggerRequestSqsClientConfig { 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 function to use the cron with. */ + /** + * UUID of the function to use the cron with. + */ functionId: string - /** Schedule of the cron in UNIX cron format. */ + /** + * Schedule of the cron in UNIX cron format. + */ schedule: string - /** Arguments to use with the cron. */ + /** + * Arguments to use with the cron. + */ args?: Record - /** Name of the cron. */ + /** + * Name of the cron. + */ 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 - /** Hostame to create. */ + /** + * Hostame to create. + */ hostname: string - /** UUID of the function to associate the domain with. */ + /** + * UUID of the function to associate the domain with. + */ functionId: string } export type CreateFunctionRequest = { /** - * Region to target. If none is 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 function to create. */ + /** + * Name of the function to create. + */ name?: string - /** UUID of the namespace the function will be created in. */ + /** + * UUID of the namespace the function will be created in. + */ namespaceId: string - /** Environment variables of the function. */ + /** + * Environment variables of the function. + */ environmentVariables?: Record - /** Minumum number of instances to scale the function to. */ + /** + * Minumum number of instances to scale the function to. + */ minScale?: number - /** Maximum number of instances to scale the function to. */ + /** + * Maximum number of instances to scale the function to. + */ maxScale?: number - /** Runtime to use with the function. */ + /** + * Runtime to use with the function. + */ runtime?: FunctionRuntime - /** Memory limit of the function in MB. */ + /** + * Memory limit of the function in MB. + */ memoryLimit?: number - /** Request processing time limit for the function. */ + /** + * Request processing time limit for the function. + */ timeout?: string - /** Handler to use with the function. */ + /** + * Handler to use with the function. + */ handler?: string - /** Privacy setting of the function. */ + /** + * Privacy setting of the function. + */ privacy?: FunctionPrivacy - /** Description of the function. */ + /** + * Description of the function. + */ description?: string 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?: FunctionHttpOption - /** Execution environment of the function. */ + /** + * Execution environment of the function. + */ sandbox?: FunctionSandbox } 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?: string - /** Environment variables of the namespace. */ + /** + * Environment variables of the namespace. + */ 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. */ + /** + * Description of the namespace. + */ description?: string - /** Secret environment variables of the namespace. */ + /** + * Secret environment variables of the namespace. + */ secretEnvironmentVariables?: Secret[] - /** [ALPHA] Tags of the Serverless Function Namespace. */ + /** + * [ALPHA] Tags of the Serverless Function 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 /** @@ -522,114 +708,127 @@ export type CreateTokenRequest = { * One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */ namespaceId?: string - /** Description of the token. */ + /** + * Description of the token. + */ description?: string - /** Date on which the token expires. */ + /** + * Date on which the token expires. + */ 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 function to trigger. */ + /** + * ID of the function to trigger. + */ functionId: 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 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 DeleteFunctionRequest = { /** - * Region to target. If none is 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 function to delete. */ + /** + * UUID of the function to delete. + */ functionId: 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 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 DeployFunctionRequest = { /** - * Region to target. If none is 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 function to deploy. */ + /** + * UUID of the function to deploy. + */ functionId: string } @@ -640,217 +839,291 @@ export interface DownloadURL { 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 GetFunctionDownloadURLRequest = { /** - * Region to target. If none is 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 function to get the the download URL for. */ + /** + * UUID of the function to get the download URL for. + */ functionId: string } export type GetFunctionRequest = { /** - * Region to target. If none is 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 function. */ + /** + * UUID of the function. + */ functionId: string } export type GetFunctionUploadURLRequest = { /** - * Region to target. If none is 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 function to get the upload URL for. */ + /** + * UUID of the function to get the upload URL for. + */ functionId: string - /** Size of the archive to upload in bytes. */ + /** + * Size of the archive to upload in bytes. + */ contentLength: number } 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 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 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 function. */ + /** + * UUID of the function. + */ functionId: 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 function the domain is assoicated with. */ + /** + * UUID of the function the domain is assoicated with. + */ functionId: string } export interface ListDomainsResponse { - /** Array of domains. */ + /** + * Array of domains. + */ domains: Domain[] - /** Total number of domains. */ + /** + * Total number of domains. + */ totalCount: number } export type ListFunctionRuntimesRequest = { /** - * Region to target. If none is 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 ListFunctionRuntimesResponse { - /** Array of runtimes available. */ + /** + * Array of runtimes available. + */ runtimes: Runtime[] - /** Total number of runtimes. */ + /** + * Total number of runtimes. + */ totalCount: number } export type ListFunctionsRequest = { /** - * Region to target. If none is 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 functions per page. */ + /** + * Number of functions per page. + */ pageSize?: number - /** Order of the functions. */ + /** + * Order of the functions. + */ orderBy?: ListFunctionsRequestOrderBy - /** UUID of the namespace the function belongs to. */ + /** + * UUID of the namespace the function belongs to. + */ namespaceId: string - /** Name of the function. */ + /** + * Name of the function. + */ name?: string - /** UUID of the Organziation the function belongs to. */ + /** + * UUID of the Organziation the function belongs to. + */ organizationId?: string - /** UUID of the Project the function belongs to. */ + /** + * UUID of the Project the function belongs to. + */ projectId?: string } export interface ListFunctionsResponse { - /** Array of functions. */ + /** + * Array of functions. + */ functions: Function[] - /** Total number of functions. */ + /** + * Total number of functions. + */ 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 namespace. */ + /** + * Name of the namespace. + */ 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 { 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 - /** Sort order for the tokens. */ + /** + * Sort order for the tokens. + */ orderBy?: ListTokensRequestOrderBy - /** UUID of the function the token is assoicated with. */ + /** + * UUID of the function the token is assoicated with. + */ functionId?: string - /** UUID of the namespace the token is associated with. */ + /** + * UUID of the namespace the token is associated with. + */ namespaceId?: string } @@ -861,135 +1134,187 @@ 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 function the triggers belongs to. * - * One-of ('scope'): at most one of 'functionId', 'namespaceId', 'projectId' - * could be set. + * One-of ('scope'): at most one of 'functionId', 'namespaceId', 'projectId' could be set. */ functionId?: string /** * ID of the namespace the triggers belongs to. * - * One-of ('scope'): at most one of 'functionId', 'namespaceId', 'projectId' - * could be set. + * One-of ('scope'): at most one of 'functionId', 'namespaceId', 'projectId' could be set. */ namespaceId?: string /** * ID of the project the triggers belongs to. * - * One-of ('scope'): at most one of 'functionId', 'namespaceId', 'projectId' - * could be set. + * One-of ('scope'): at most one of 'functionId', '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 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 function to use the cron with. */ + /** + * UUID of the function to use the cron with. + */ functionId?: string - /** Schedule of the cron in UNIX cron format. */ + /** + * Schedule of the cron in UNIX cron format. + */ schedule?: string - /** Arguments to use with the cron. */ + /** + * Arguments to use with the cron. + */ args?: Record - /** Name of the cron. */ + /** + * Name of the cron. + */ name?: string } export type UpdateFunctionRequest = { /** - * Region to target. If none is 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 function to update. */ + /** + * UUID of the function to update. + */ functionId: string - /** Environment variables of the function to update. */ + /** + * Environment variables of the function to update. + */ environmentVariables?: Record - /** Minumum number of instances to scale the function to. */ + /** + * Minumum number of instances to scale the function to. + */ minScale?: number - /** Maximum number of instances to scale the function to. */ + /** + * Maximum number of instances to scale the function to. + */ maxScale?: number - /** Runtime to use with the function. */ + /** + * Runtime to use with the function. + */ runtime?: FunctionRuntime - /** Memory limit of the function in MB. */ + /** + * Memory limit of the function in MB. + */ memoryLimit?: number - /** Processing time limit for the function. */ + /** + * Processing time limit for the function. + */ timeout?: string - /** Redeploy failed function. */ + /** + * Redeploy failed function. + */ redeploy?: boolean - /** Handler to use with the function. */ + /** + * Handler to use with the function. + */ handler?: string - /** Privacy setting of the function. */ + /** + * Privacy setting of the function. + */ privacy?: FunctionPrivacy - /** Description of the function. */ + /** + * Description of the function. + */ description?: string - /** Secret environment variables of the function. */ + /** + * Secret environment variables of the function. + */ 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?: FunctionHttpOption - /** Execution environment of the function. */ + /** + * Execution environment of the function. + */ sandbox?: FunctionSandbox } 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 namespapce. */ + /** + * UUID of the namespapce. + */ namespaceId: string - /** Environment variables of the namespace. */ + /** + * Environment variables of the namespace. + */ environmentVariables?: Record - /** Description of the namespace. */ + /** + * Description of the namespace. + */ description?: string - /** Secret environment variables of the namespace. */ + /** + * Secret environment variables of the namespace. + */ secretEnvironmentVariables?: Secret[] - /** [ALPHA] Tags of the Serverless Function Namespace. */ + /** + * [ALPHA] Tags of the Serverless Function 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. @@ -1000,8 +1325,12 @@ export type UpdateTriggerRequest = { } export interface UploadURL { - /** Upload URL to upload the function to. */ + /** + * Upload URL to upload the function to. + */ url: string - /** HTTP headers. */ + /** + * HTTP headers. + */ headers: Record } diff --git a/packages/clients/src/api/iam/index.gen.ts b/packages/clients/src/api/iam/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/iam/index.gen.ts +++ b/packages/clients/src/api/iam/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/iam/v1alpha1/api.gen.ts b/packages/clients/src/api/iam/v1alpha1/api.gen.ts index ab64c718a..17a2795c6 100644 --- a/packages/clients/src/api/iam/v1alpha1/api.gen.ts +++ b/packages/clients/src/api/iam/v1alpha1/api.gen.ts @@ -151,9 +151,8 @@ const jsonContentHeaders = { /** * IAM API. - * - * This API allows you to manage Identity and Access Management (IAM) across - * your Scaleway Organizations, Projects and resources. + +This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources. */ export class API extends ParentAPI { protected pageOfListSSHKeys = (request: Readonly = {}) => @@ -178,10 +177,7 @@ export class API extends ParentAPI { ) /** - * List SSH keys. List SSH keys. By default, the SSH keys listed are ordered - * by creation date in ascending order. This can be modified via the - * `order_by` field. You can define additional parameters for your query such - * as `organization_id`, `name`, `project_id` and `disabled`. + * List SSH keys. List SSH keys. By default, the SSH keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `organization_id`, `name`, `project_id` and `disabled`. * * @param request - The request {@link ListSSHKeysRequest} * @returns A Promise of ListSSHKeysResponse @@ -190,8 +186,7 @@ export class API extends ParentAPI { enrichForPagination('sshKeys', this.pageOfListSSHKeys, request) /** - * Create an SSH key. Add a new SSH key to a Scaleway Project. You must - * specify the `name`, `public_key` and `project_id`. + * Create an SSH key. Add a new SSH key to a Scaleway Project. You must specify the `name`, `public_key` and `project_id`. * * @param request - The request {@link CreateSSHKeyRequest} * @returns A Promise of SSHKey @@ -210,9 +205,7 @@ export class API extends ParentAPI { ) /** - * Get an SSH key. Retrieve information about a given SSH key, specified by - * the `ssh_key_id` parameter. The SSH key's full details, including `id`, - * `name`, `public_key`, and `project_id` are returned in the response. + * Get an SSH key. Retrieve information about a given SSH key, specified by the `ssh_key_id` parameter. The SSH key's full details, including `id`, `name`, `public_key`, and `project_id` are returned in the response. * * @param request - The request {@link GetSSHKeyRequest} * @returns A Promise of SSHKey @@ -227,8 +220,7 @@ export class API extends ParentAPI { ) /** - * Update an SSH key. Update the parameters of an SSH key, including `name` - * and `disable`. + * Update an SSH key. Update the parameters of an SSH key, including `name` and `disable`. * * @param request - The request {@link UpdateSSHKeyRequest} * @returns A Promise of SSHKey @@ -247,9 +239,7 @@ export class API extends ParentAPI { ) /** - * Delete an SSH key. Delete a given SSH key, specified by the `ssh_key_id`. - * Deleting an SSH is permanent, and cannot be undone. Note that you might - * need to update any configurations that used the SSH key. + * Delete an SSH key. Delete a given SSH key, specified by the `ssh_key_id`. Deleting an SSH is permanent, and cannot be undone. Note that you might need to update any configurations that used the SSH key. * * @param request - The request {@link DeleteSSHKeyRequest} */ @@ -286,11 +276,7 @@ export class API extends ParentAPI { ) /** - * List users of an Organization. List the users of an Organization. By - * default, the users listed are ordered by creation date in ascending order. - * This can be modified via the `order_by` field. You must define the - * `organization_id` in the query path of your request. You can also define - * additional parameters for your query such as `user_ids`. + * List users of an Organization. List the users of an Organization. By default, the users listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `user_ids`. * * @param request - The request {@link ListUsersRequest} * @returns A Promise of ListUsersResponse @@ -299,9 +285,7 @@ export class API extends ParentAPI { enrichForPagination('users', this.pageOfListUsers, request) /** - * Get a given user. Retrieve information about a user, specified by the - * `user_id` parameter. The user's full details, including `id`, `email`, - * `organization_id`, `status` and `mfa` are returned in the response. + * Get a given user. Retrieve information about a user, specified by the `user_id` parameter. The user's full details, including `id`, `email`, `organization_id`, `status` and `mfa` are returned in the response. * * @param request - The request {@link GetUserRequest} * @returns A Promise of User @@ -335,11 +319,7 @@ export class API extends ParentAPI { ) /** - * Delete a guest user from an Organization. Remove a user from an - * Organization in which they are a guest. You must define the `user_id` in - * your request. Note that removing a user from an Organization automatically - * deletes their API keys, and any policies directly attached to them become - * orphaned. + * Delete a guest user from an Organization. Remove a user from an Organization in which they are a guest. You must define the `user_id` in your request. Note that removing a user from an Organization automatically deletes their API keys, and any policies directly attached to them become orphaned. * * @param request - The request {@link DeleteUserRequest} */ @@ -350,10 +330,7 @@ export class API extends ParentAPI { }) /** - * Create a new user. Create a new user. You must define the `organization_id` - * in your request. If you are adding a member, enter the member's details. If - * you are adding a guest, you must define the `email` and not add the member - * attribute. + * Create a new user. Create a new user. You must define the `organization_id` in your request. If you are adding a member, enter the member's details. If you are adding a guest, you must define the `email` and not add the member attribute. * * @param request - The request {@link CreateUserRequest} * @returns A Promise of User @@ -459,8 +436,7 @@ export class API extends ParentAPI { }) /** - * Lock a member. Lock a member. A locked member cannot log in or use API keys - * until the locked status is removed. + * Lock a member. Lock a member. A locked member cannot log in or use API keys until the locked status is removed. * * @param request - The request {@link LockUserRequest} * @returns A Promise of User @@ -547,12 +523,7 @@ export class API extends ParentAPI { ) /** - * List applications of an Organization. List the applications of an - * Organization. By default, the applications listed are ordered by creation - * date in ascending order. This can be modified via the `order_by` field. You - * must define the `organization_id` in the query path of your request. You - * can also define additional parameters for your query such as - * `application_ids`. + * List applications of an Organization. List the applications of an Organization. By default, the applications listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters for your query such as `application_ids`. * * @param request - The request {@link ListApplicationsRequest} * @returns A Promise of ListApplicationsResponse @@ -561,8 +532,7 @@ export class API extends ParentAPI { enrichForPagination('applications', this.pageOfListApplications, request) /** - * Create a new application. Create a new application. You must define the - * `name` parameter in the request. + * Create a new application. Create a new application. You must define the `name` parameter in the request. * * @param request - The request {@link CreateApplicationRequest} * @returns A Promise of Application @@ -581,10 +551,7 @@ export class API extends ParentAPI { ) /** - * Get a given application. Retrieve information about an application, - * specified by the `application_id` parameter. The application's full - * details, including `id`, `email`, `organization_id`, `status` and - * `two_factor_enabled` are returned in the response. + * Get a given application. Retrieve information about an application, specified by the `application_id` parameter. The application's full details, including `id`, `email`, `organization_id`, `status` and `two_factor_enabled` are returned in the response. * * @param request - The request {@link GetApplicationRequest} * @returns A Promise of Application @@ -599,8 +566,7 @@ export class API extends ParentAPI { ) /** - * Update an application. Update the parameters of an application, including - * `name` and `description`. + * Update an application. Update the parameters of an application, including `name` and `description`. * * @param request - The request {@link UpdateApplicationRequest} * @returns A Promise of Application @@ -619,10 +585,7 @@ export class API extends ParentAPI { ) /** - * Delete an application. Delete an application. Note that this action is - * irreversible and will automatically delete the application's API keys. - * Policies attached to users and applications via this group will no longer - * apply. + * Delete an application. Delete an application. Note that this action is irreversible and will automatically delete the application's API keys. Policies attached to users and applications via this group will no longer apply. * * @param request - The request {@link DeleteApplicationRequest} */ @@ -660,11 +623,7 @@ export class API extends ParentAPI { ) /** - * List groups. List groups. By default, the groups listed are ordered by - * creation date in ascending order. This can be modified via the `order_by` - * field. You can define additional parameters to filter your query. Use - * `user_ids` or `application_ids` to list all groups certain users or - * applications belong to. + * List groups. List groups. By default, the groups listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters to filter your query. Use `user_ids` or `application_ids` to list all groups certain users or applications belong to. * * @param request - The request {@link ListGroupsRequest} * @returns A Promise of ListGroupsResponse @@ -673,8 +632,7 @@ export class API extends ParentAPI { enrichForPagination('groups', this.pageOfListGroups, request) /** - * Create a group. Create a new group. You must define the `name` and - * `organization_id` parameters in the request. + * Create a group. Create a new group. You must define the `name` and `organization_id` parameters in the request. * * @param request - The request {@link CreateGroupRequest} * @returns A Promise of Group @@ -693,9 +651,7 @@ export class API extends ParentAPI { ) /** - * Get a group. Retrive information about a given group, specified by the - * `group_id` parameter. The group's full details, including `user_ids` and - * `application_ids` are returned in the response. + * Get a group. Retrive information about a given group, specified by the `group_id` parameter. The group's full details, including `user_ids` and `application_ids` are returned in the response. * * @param request - The request {@link GetGroupRequest} * @returns A Promise of Group @@ -710,8 +666,7 @@ export class API extends ParentAPI { ) /** - * Update a group. Update the parameters of group, including `name` and - * `description`. + * Update a group. Update the parameters of group, including `name` and `description`. * * @param request - The request {@link UpdateGroupRequest} * @returns A Promise of Group @@ -730,9 +685,7 @@ export class API extends ParentAPI { ) /** - * Overwrite users and applications of a group. Overwrite users and - * applications configuration in a group. Any information that you add using - * this command will overwrite the previous configuration. + * Overwrite users and applications of a group. Overwrite users and applications configuration in a group. Any information that you add using this command will overwrite the previous configuration. * * @param request - The request {@link SetGroupMembersRequest} * @returns A Promise of Group @@ -751,9 +704,7 @@ export class API extends ParentAPI { ) /** - * Add a user or an application to a group. Add a user or an application to a - * group. You can specify a `user_id` and and `application_id` in the body of - * your request. Note that you can only add one of each per request. + * Add a user or an application to a group. Add a user or an application to a group. You can specify a `user_id` and `application_id` in the body of your request. Note that you can only add one of each per request. * * @param request - The request {@link AddGroupMemberRequest} * @returns A Promise of Group @@ -772,12 +723,7 @@ export class API extends ParentAPI { ) /** - * Add multiple users and applications to a group. Add multiple users and - * applications to a group in a single call. You can specify an array of - * `user_id`s and `application_id`s. Note that any existing users and - * applications in the group will remain. To add new users/applications and - * delete pre-existing ones, use the [Overwrite users and applications of a - * group](#path-groups-overwrite-users-and-applications-of-a-group) method. + * Add multiple users and applications to a group. Add multiple users and applications to a group in a single call. You can specify an array of `user_id`s and `application_id`s. Note that any existing users and applications in the group will remain. To add new users/applications and delete pre-existing ones, use the [Overwrite users and applications of a group](#path-groups-overwrite-users-and-applications-of-a-group) method. * * @param request - The request {@link AddGroupMembersRequest} * @returns A Promise of Group @@ -796,13 +742,7 @@ export class API extends ParentAPI { ) /** - * Remove a user or an application from a group. Remove a user or an - * application from a group. You can specify a `user_id` and and - * `application_id` in the body of your request. Note that you can only remove - * one of each per request. Removing a user from a group means that any - * permissions given to them via the group (i.e. from an attached policy) will - * no longer apply. Be sure you want to remove these permissions from the user - * before proceeding. + * Remove a user or an application from a group. Remove a user or an application from a group. You can specify a `user_id` and `application_id` in the body of your request. Note that you can only remove one of each per request. Removing a user from a group means that any permissions given to them via the group (i.e. from an attached policy) will no longer apply. Be sure you want to remove these permissions from the user before proceeding. * * @param request - The request {@link RemoveGroupMemberRequest} * @returns A Promise of Group @@ -821,9 +761,7 @@ export class API extends ParentAPI { ) /** - * Delete a group. Delete a group. Note that this action is irreversible and - * could delete permissions for group members. Policies attached to users and - * applications via this group will no longer apply. + * Delete a group. Delete a group. Note that this action is irreversible and could delete permissions for group members. Policies attached to users and applications via this group will no longer apply. * * @param request - The request {@link DeleteGroupRequest} */ @@ -866,12 +804,7 @@ export class API extends ParentAPI { ) /** - * List policies of an Organization. List the policies of an Organization. By - * default, the policies listed are ordered by creation date in ascending - * order. This can be modified via the `order_by` field. You must define the - * `organization_id` in the query path of your request. You can also define - * additional parameters to filter your query, such as `user_ids`, - * `groups_ids`, `application_ids`, and `policy_name`. + * List policies of an Organization. List the policies of an Organization. By default, the policies listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. You can also define additional parameters to filter your query, such as `user_ids`, `groups_ids`, `application_ids`, and `policy_name`. * * @param request - The request {@link ListPoliciesRequest} * @returns A Promise of ListPoliciesResponse @@ -880,10 +813,7 @@ export class API extends ParentAPI { enrichForPagination('policies', this.pageOfListPolicies, request) /** - * Create a new policy. Create a new application. You must define the `name` - * parameter in the request. You can specify parameters such as `user_id`, - * `groups_id`, `application_id`, `no_principal`, `rules` and its child - * attributes. + * Create a new policy. Create a new application. You must define the `name` parameter in the request. You can specify parameters such as `user_id`, `groups_id`, `application_id`, `no_principal`, `rules` and its child attributes. * * @param request - The request {@link CreatePolicyRequest} * @returns A Promise of Policy @@ -902,10 +832,7 @@ export class API extends ParentAPI { ) /** - * Get an existing policy. Retrieve information about a policy, speficified by - * the `policy_id` parameter. The policy's full details, including `id`, - * `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` - * are returned in the response. + * Get an existing policy. Retrieve information about a policy, speficified by the `policy_id` parameter. The policy's full details, including `id`, `name`, `organization_id`, `nb_rules` and `nb_scopes`, `nb_permission_sets` are returned in the response. * * @param request - The request {@link GetPolicyRequest} * @returns A Promise of Policy @@ -920,9 +847,7 @@ export class API extends ParentAPI { ) /** - * Update an existing policy. Update the parameters of a policy, including - * `name`, `description`, `user_id`, `group_id`, `application_id` and - * `no_principal`. + * Update an existing policy. Update the parameters of a policy, including `name`, `description`, `user_id`, `group_id`, `application_id` and `no_principal`. * * @param request - The request {@link UpdatePolicyRequest} * @returns A Promise of Policy @@ -941,10 +866,7 @@ export class API extends ParentAPI { ) /** - * Delete a policy. Delete a policy. You must define specify the `policy_id` - * parameter in your request. Note that when deleting a policy, all - * permissions it gives to its principal (user, group or application) will be - * revoked. + * Delete a policy. Delete a policy. You must define specify the `policy_id` parameter in your request. Note that when deleting a policy, all permissions it gives to its principal (user, group or application) will be revoked. * * @param request - The request {@link DeletePolicyRequest} */ @@ -955,8 +877,7 @@ export class API extends ParentAPI { }) /** - * Clone a policy. Clone a policy. You must define specify the `policy_id` - * parameter in your request. + * Clone a policy. Clone a policy. You must define specify the `policy_id` parameter in your request. * * @param request - The request {@link ClonePolicyRequest} * @returns A Promise of Policy @@ -973,12 +894,7 @@ export class API extends ParentAPI { ) /** - * Set rules of a given policy. Overwrite the rules of a given policy. Any - * information that you add using this command will overwrite the previous - * configuration. If you include some of the rules you already had in your - * previous configuration in your new one, but you change their order, the new - * order of display will apply. While policy rules are ordered, they have no - * impact on the access logic of IAM because rules are allow-only. + * Set rules of a given policy. Overwrite the rules of a given policy. Any information that you add using this command will overwrite the previous configuration. If you include some of the rules you already had in your previous configuration in your new one, but you change their order, the new order of display will apply. While policy rules are ordered, they have no impact on the access logic of IAM because rules are allow-only. * * @param request - The request {@link SetRulesRequest} * @returns A Promise of SetRulesResponse @@ -1014,10 +930,7 @@ export class API extends ParentAPI { ) /** - * List rules of a given policy. List the rules of a given policy. By default, - * the rules listed are ordered by creation date in ascending order. This can - * be modified via the `order_by` field. You must define the `policy_id` in - * the query path of your request. + * List rules of a given policy. List the rules of a given policy. By default, the rules listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `policy_id` in the query path of your request. * * @param request - The request {@link ListRulesRequest} * @returns A Promise of ListRulesResponse @@ -1050,9 +963,7 @@ export class API extends ParentAPI { ) /** - * List permission sets. List permission sets available for given - * Organization. You must define the `organization_id` in the query path of - * your request. + * List permission sets. List permission sets available for given Organization. You must define the `organization_id` in the query path of your request. * * @param request - The request {@link ListPermissionSetsRequest} * @returns A Promise of ListPermissionSetsResponse @@ -1100,10 +1011,7 @@ export class API extends ParentAPI { ) /** - * List API keys. List API keys. By default, the API keys listed are ordered - * by creation date in ascending order. This can be modified via the - * `order_by` field. You can define additional parameters for your query such - * as `editable`, `expired`, `access_key` and `bearer_id`. + * List API keys. List API keys. By default, the API keys listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You can define additional parameters for your query such as `editable`, `expired`, `access_key` and `bearer_id`. * * @param request - The request {@link ListAPIKeysRequest} * @returns A Promise of ListAPIKeysResponse @@ -1112,12 +1020,7 @@ export class API extends ParentAPI { enrichForPagination('apiKeys', this.pageOfListAPIKeys, request) /** - * Create an API key. Create an API key. You must specify the `application_id` - * or the `user_id` and the description. You can also specify the - * `default_project_id`, which is the Project ID of your preferred Project, to - * use with Object Storage. The `access_key` and `secret_key` values are - * returned in the response. Note that the secret key is only shown once. Make - * sure that you copy and store both keys somewhere safe. + * Create an API key. Create an API key. You must specify the `application_id` or the `user_id` and the description. You can also specify the `default_project_id`, which is the Project ID of your preferred Project, to use with Object Storage. The `access_key` and `secret_key` values are returned in the response. Note that the secret key is only shown once. Make sure that you copy and store both keys somewhere safe. * * @param request - The request {@link CreateAPIKeyRequest} * @returns A Promise of APIKey @@ -1136,12 +1039,7 @@ export class API extends ParentAPI { ) /** - * Get an API key. Retrive information about an API key, specified by the - * `access_key` parameter. The API key's details, including either the - * `user_id` or `application_id` of its bearer are returned in the response. - * Note that the string value for the `secret_key` is nullable, and therefore - * is not displayed in the response. The `secret_key` value is only displayed - * upon API key creation. + * Get an API key. Retrive information about an API key, specified by the `access_key` parameter. The API key's details, including either the `user_id` or `application_id` of its bearer are returned in the response. Note that the string value for the `secret_key` is nullable, and therefore is not displayed in the response. The `secret_key` value is only displayed upon API key creation. * * @param request - The request {@link GetAPIKeyRequest} * @returns A Promise of APIKey @@ -1156,8 +1054,7 @@ export class API extends ParentAPI { ) /** - * Update an API key. Update the parameters of an API key, including - * `default_project_id` and `description`. + * Update an API key. Update the parameters of an API key, including `default_project_id` and `description`. * * @param request - The request {@link UpdateAPIKeyRequest} * @returns A Promise of APIKey @@ -1176,9 +1073,7 @@ export class API extends ParentAPI { ) /** - * Delete an API key. Delete an API key. Note that this action is irreversible - * and cannot be undone. Make sure you update any configurations using the API - * keys you delete. + * Delete an API key. Delete an API key. Note that this action is irreversible and cannot be undone. Make sure you update any configurations using the API keys you delete. * * @param request - The request {@link DeleteAPIKeyRequest} */ @@ -1212,11 +1107,7 @@ export class API extends ParentAPI { ) /** - * List all quotas in the Organization. List all product and features quota - * for an Organization, with their associated limits. By default, the quota - * listed are ordered by creation date in ascending order. This can be - * modified via the `order_by` field. You must define the `organization_id` in - * the query path of your request. + * List all quotas in the Organization. List all product and features quota for an Organization, with their associated limits. By default, the quota listed are ordered by creation date in ascending order. This can be modified via the `order_by` field. You must define the `organization_id` in the query path of your request. * * @param request - The request {@link ListQuotaRequest} * @returns A Promise of ListQuotaResponse @@ -1225,9 +1116,7 @@ export class API extends ParentAPI { enrichForPagination('quota', this.pageOfListQuota, request) /** - * Get a quota in the Organization. Retrieve information about a resource - * quota, specified by the `quotum_name` parameter. The quota's `limit`, or - * whether it is unlimited, is returned in the response. + * Get a quota in the Organization. Retrieve information about a resource quota, specified by the `quotum_name` parameter. The quota's `limit`, or whether it is unlimited, is returned in the response. * * @param request - The request {@link GetQuotumRequest} * @returns A Promise of Quotum @@ -1346,8 +1235,7 @@ export class API extends ParentAPI { ) /** - * List logs. List logs available for given Organization. You must define the - * `organization_id` in the query path of your request. + * List logs. List logs available for given Organization. You must define the `organization_id` in the query path of your request. * * @param request - The request {@link ListLogsRequest} * @returns A Promise of ListLogsResponse @@ -1356,10 +1244,7 @@ export class API extends ParentAPI { enrichForPagination('logs', this.pageOfListLogs, request) /** - * Get a log. Retrieve information about a log, specified by the `log_id` - * parameter. The log's full details, including `id`, `ip`, `user_agent`, - * `action`, `bearer_id`, `resource_type` and `resource_id` are returned in - * the response. + * Get a log. Retrieve information about a log, specified by the `log_id` parameter. The log's full details, including `id`, `ip`, `user_agent`, `action`, `bearer_id`, `resource_type` and `resource_id` are returned in the response. * * @param request - The request {@link GetLogRequest} * @returns A Promise of Log @@ -1374,9 +1259,7 @@ export class API extends ParentAPI { ) /** - * Get security settings of an Organization. Retrieve information about the - * security settings of an Organization, specified by the `organization_id` - * parameter. + * Get security settings of an Organization. Retrieve information about the security settings of an Organization, specified by the `organization_id` parameter. * * @param request - The request {@link GetOrganizationSecuritySettingsRequest} * @returns A Promise of OrganizationSecuritySettings @@ -1395,8 +1278,7 @@ export class API extends ParentAPI { /** * Update the security settings of an Organization. * - * @param request - The request - * {@link UpdateOrganizationSecuritySettingsRequest} + * @param request - The request {@link UpdateOrganizationSecuritySettingsRequest} * @returns A Promise of OrganizationSecuritySettings */ updateOrganizationSecuritySettings = ( diff --git a/packages/clients/src/api/iam/v1alpha1/types.gen.ts b/packages/clients/src/api/iam/v1alpha1/types.gen.ts index 02e0307b4..99e6c28a1 100644 --- a/packages/clients/src/api/iam/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/iam/v1alpha1/types.gen.ts @@ -115,22 +115,19 @@ export interface QuotumLimit { /** * Whether or not the limit is applied globally. * - * One-of ('locality'): at most one of 'global', 'region', 'zone' could be - * set. + * One-of ('locality'): at most one of 'global', 'region', 'zone' could be set. */ global?: boolean /** * The region on which the limit is applied. * - * One-of ('locality'): at most one of 'global', 'region', 'zone' could be - * set. + * One-of ('locality'): at most one of 'global', 'region', 'zone' could be set. */ region?: ScwRegion /** * The zone on which the limit is applied. * - * One-of ('locality'): at most one of 'global', 'region', 'zone' could be - * set. + * One-of ('locality'): at most one of 'global', 'region', 'zone' could be set. */ zone?: ScwZone /** @@ -148,80 +145,121 @@ export interface QuotumLimit { } export interface JWT { - /** JWT ID. */ + /** + * JWT ID. + */ jti: string - /** ID of the user who issued the JWT. */ + /** + * ID of the user who issued the JWT. + */ issuerId: string - /** ID of the user targeted by the JWT. */ + /** + * ID of the user targeted by the JWT. + */ audienceId: string - /** Creation date of the JWT. */ + /** + * Creation date of the JWT. + */ createdAt?: Date - /** Last update date of the JWT. */ + /** + * Last update date of the JWT. + */ updatedAt?: Date - /** Expiration date of the JWT. */ + /** + * Expiration date of the JWT. + */ expiresAt?: Date - /** IP address used during the creation of the JWT. */ + /** + * IP address used during the creation of the JWT. + */ ip: string - /** User-agent used during the creation of the JWT. */ + /** + * User-agent used during the creation of the JWT. + */ userAgent: string } export interface RuleSpecs { - /** Names of permission sets bound to the rule. */ + /** + * Names of permission sets bound to the rule. + */ permissionSetNames?: string[] - /** Condition expression to evaluate. */ + /** + * Condition expression to evaluate. + */ condition: string /** * List of Project IDs the rule is scoped to. * - * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be - * set. + * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be set. */ projectIds?: string[] /** * ID of Organization the rule is scoped to. * - * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be - * set. + * One-of ('scope'): at most one of 'projectIds', 'organizationId' could be set. */ organizationId?: string } export interface CreateUserRequestMember { - /** Email of the user to create. */ + /** + * Email of the user to create. + */ email: string - /** Whether or not to send an email containing the member's password. */ + /** + * Whether or not to send an email containing the member's password. + */ sendPasswordEmail: boolean /** - * Whether or not to send a welcome email that includes onboarding - * information. + * Whether or not to send a welcome email that includes onboarding information. */ sendWelcomeEmail: boolean - /** The member's username. */ + /** + * The member's username. + */ username: string - /** The member's password. */ + /** + * The member's password. + */ password: string - /** The member's first name. */ + /** + * The member's first name. + */ firstName: string - /** The member's last name. */ + /** + * The member's last name. + */ lastName: string - /** The member's phone number. */ + /** + * The member's phone number. + */ phoneNumber: string - /** The member's locale. */ + /** + * The member's locale. + */ locale: string } export interface Connection { - /** Information about the connected organization. */ + /** + * Information about the connected organization. + */ organization?: ConnectionConnectedOrganization - /** Information about the connected user. */ + /** + * Information about the connected user. + */ user?: ConnectionConnectedUser } export interface APIKey { - /** Access key of the API key. */ + /** + * Access key of the API key. + */ accessKey: string - /** Secret key of the API Key. */ + /** + * Secret key of the API Key. + */ secretKey?: string /** * ID of application that bears the API key. @@ -235,304 +273,496 @@ export interface APIKey { * One-of ('bearer'): at most one of 'applicationId', 'userId' could be set. */ userId?: string - /** Description of API key. */ + /** + * Description of API key. + */ description: string - /** Date and time of API key creation. */ + /** + * Date and time of API key creation. + */ createdAt?: Date - /** Date and time of last API key update. */ + /** + * Date and time of last API key update. + */ updatedAt?: Date - /** Date and time of API key expiration. */ + /** + * Date and time of API key expiration. + */ expiresAt?: Date - /** Default Project ID specified for this API key. */ + /** + * Default Project ID specified for this API key. + */ defaultProjectId: string - /** Defines whether or not the API key is editable. */ + /** + * Defines whether or not the API key is editable. + */ editable: boolean - /** Defines whether or not the API key is deletable. */ + /** + * Defines whether or not the API key is deletable. + */ deletable: boolean - /** Defines whether or not the API key is managed. */ + /** + * Defines whether or not the API key is managed. + */ managed: boolean - /** IP address of the device that created the API key. */ + /** + * IP address of the device that created the API key. + */ creationIp: string } export interface Application { - /** ID of the application. */ + /** + * ID of the application. + */ id: string - /** Name of the application. */ + /** + * Name of the application. + */ name: string - /** Description of the application. */ + /** + * Description of the application. + */ description: string - /** Date and time application was created. */ + /** + * Date and time application was created. + */ createdAt?: Date - /** Date and time of last application update. */ + /** + * Date and time of last application update. + */ updatedAt?: Date - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId: string - /** Defines whether or not the application is editable. */ + /** + * Defines whether or not the application is editable. + */ editable: boolean - /** Defines whether or not the application is deletable. */ + /** + * Defines whether or not the application is deletable. + */ deletable: boolean - /** Defines whether or not the application is managed. */ + /** + * Defines whether or not the application is managed. + */ managed: boolean - /** Number of API keys attributed to the application. */ + /** + * Number of API keys attributed to the application. + */ nbApiKeys: number - /** Tags associated with the user. */ + /** + * Tags associated with the user. + */ tags: string[] } export interface GracePeriod { - /** Type of grace period. */ + /** + * Type of grace period. + */ type: GracePeriodType - /** Date and time the grace period was created. */ + /** + * Date and time the grace period was created. + */ createdAt?: Date - /** Date and time the grace period expires. */ + /** + * Date and time the grace period expires. + */ expiresAt?: Date } export interface Group { - /** ID of the group. */ + /** + * ID of the group. + */ id: string - /** Date and time of group creation. */ + /** + * Date and time of group creation. + */ createdAt?: Date - /** Date and time of last group update. */ + /** + * Date and time of last group update. + */ updatedAt?: Date - /** ID of Organization linked to the group. */ + /** + * ID of Organization linked to the group. + */ organizationId: string - /** Name of the group. */ + /** + * Name of the group. + */ name: string - /** Description of the group. */ + /** + * Description of the group. + */ description: string - /** IDs of users attached to this group. */ + /** + * IDs of users attached to this group. + */ userIds: string[] - /** IDs of applications attached to this group. */ + /** + * IDs of applications attached to this group. + */ applicationIds: string[] - /** Tags associated to the group. */ + /** + * Tags associated to the group. + */ tags: string[] - /** Defines whether or not the group is editable. */ + /** + * Defines whether or not the group is editable. + */ editable: boolean - /** Defines whether or not the group is deletable. */ + /** + * Defines whether or not the group is deletable. + */ deletable: boolean - /** Defines whether or not the group is managed. */ + /** + * Defines whether or not the group is managed. + */ managed: boolean } export interface Log { - /** Log ID. */ + /** + * Log ID. + */ id: string - /** Creation date of the log. */ + /** + * Creation date of the log. + */ createdAt?: Date - /** IP address of the HTTP request linked to the log. */ + /** + * IP address of the HTTP request linked to the log. + */ ip: string - /** User-Agent of the HTTP request linked to the log. */ + /** + * User-Agent of the HTTP request linked to the log. + */ userAgent: string - /** Action linked to the log. */ + /** + * Action linked to the log. + */ action: LogAction - /** ID of the principal at the origin of the log. */ + /** + * ID of the principal at the origin of the log. + */ bearerId: string - /** ID of Organization linked to the log. */ + /** + * ID of Organization linked to the log. + */ organizationId: string - /** Type of the resource linked to the log. */ + /** + * Type of the resource linked to the log. + */ resourceType: LogResourceType - /** ID of the resource linked to the log. */ + /** + * ID of the resource linked to the log. + */ resourceId: string } export interface PermissionSet { - /** Id of the permission set. */ + /** + * Id of the permission set. + */ id: string - /** Name of the permission set. */ + /** + * Name of the permission set. + */ name: string - /** Scope of the permission set. */ + /** + * Scope of the permission set. + */ scopeType: PermissionSetScopeType - /** Description of the permission set. */ + /** + * Description of the permission set. + */ description: string - /** Categories of the permission set. */ + /** + * Categories of the permission set. + */ categories?: string[] } export interface Policy { - /** Id of the policy. */ + /** + * Id of the policy. + */ id: string - /** Name of the policy. */ + /** + * Name of the policy. + */ name: string - /** Description of the policy. */ + /** + * Description of the policy. + */ description: string - /** Organization ID of the policy. */ + /** + * Organization ID of the policy. + */ organizationId: string - /** Date and time of policy creation. */ + /** + * Date and time of policy creation. + */ createdAt?: Date - /** Date and time of last policy update. */ + /** + * Date and time of last policy update. + */ updatedAt?: Date - /** Defines whether or not a policy is editable. */ + /** + * Defines whether or not a policy is editable. + */ editable: boolean - /** Defines whether or not a policy is deletable. */ + /** + * Defines whether or not a policy is deletable. + */ deletable: boolean - /** Defines whether or not a policy is managed. */ + /** + * Defines whether or not a policy is managed. + */ managed: boolean - /** Number of rules of the policy. */ + /** + * Number of rules of the policy. + */ nbRules: number - /** Number of policy scopes. */ + /** + * Number of policy scopes. + */ nbScopes: number - /** Number of permission sets of the policy. */ + /** + * Number of permission sets of the policy. + */ nbPermissionSets: number - /** Tags associated with the policy. */ + /** + * Tags associated with the policy. + */ tags: string[] /** * ID of the user attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ userId?: string /** * ID of the group attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ groupId?: string /** * ID of the application attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ applicationId?: string /** * Defines whether or not a policy is attributed to a principal. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ noPrincipal?: boolean } export interface Quotum { - /** Name of the quota. */ + /** + * Name of the quota. + */ name: string /** * @deprecated Maximum limit of the quota. * - * One-of ('value'): at most one of 'limit', 'unlimited' could be set. + * One-of ('value'): at most one of 'limit', 'unlimited' could be set. */ limit?: number /** * @deprecated Defines whether or not the quota is unlimited. * - * One-of ('value'): at most one of 'limit', 'unlimited' could be set. + * One-of ('value'): at most one of 'limit', 'unlimited' could be set. */ unlimited?: boolean - /** A human-readable name for the quota. */ + /** + * A human-readable name for the quota. + */ prettyName: string - /** The unit in which the quota is expressed. */ + /** + * The unit in which the quota is expressed. + */ unit: string - /** Details about the quota. */ + /** + * Details about the quota. + */ description: string /** - * Whether this quotum is applied on at the zone level, region level, or - * globally. + * Whether this quotum is applied on at the zone level, region level, or globally. */ localityType: LocalityType - /** Limits per locality. */ + /** + * Limits per locality. + */ limits: QuotumLimit[] } export interface Rule { - /** Id of rule. */ + /** + * Id of rule. + */ id: string - /** Names of permission sets bound to the rule. */ + /** + * Names of permission sets bound to the rule. + */ permissionSetNames?: string[] - /** Permission_set_names have the same scope_type. */ + /** + * Permission_set_names have the same scope_type. + */ permissionSetsScopeType: PermissionSetScopeType - /** Condition expression to evaluate. */ + /** + * Condition expression to evaluate. + */ condition: string /** * List of Project IDs the rule is scoped to. * - * One-of ('scope'): at most one of 'projectIds', 'organizationId', - * 'accountRootUserId' could be set. + * One-of ('scope'): at most one of 'projectIds', 'organizationId', 'accountRootUserId' could be set. */ projectIds?: string[] /** * ID of Organization the rule is scoped to. * - * One-of ('scope'): at most one of 'projectIds', 'organizationId', - * 'accountRootUserId' could be set. + * One-of ('scope'): at most one of 'projectIds', 'organizationId', 'accountRootUserId' could be set. */ organizationId?: string /** * ID of account root user the rule is scoped to. * - * One-of ('scope'): at most one of 'projectIds', 'organizationId', - * 'accountRootUserId' could be set. + * One-of ('scope'): at most one of 'projectIds', 'organizationId', 'accountRootUserId' could be set. */ accountRootUserId?: string } export interface SSHKey { - /** ID of SSH key. */ + /** + * ID of SSH key. + */ id: string - /** Name of SSH key. */ + /** + * Name of SSH key. + */ name: string - /** Public key of SSH key. */ + /** + * Public key of SSH key. + */ publicKey: string - /** Fingerprint of the SSH key. */ + /** + * Fingerprint of the SSH key. + */ fingerprint: string - /** Creation date of SSH key. */ + /** + * Creation date of SSH key. + */ createdAt?: Date - /** Last update date of SSH key. */ + /** + * Last update date of SSH key. + */ updatedAt?: Date - /** ID of Organization linked to the SSH key. */ + /** + * ID of Organization linked to the SSH key. + */ organizationId: string - /** ID of Project linked to the SSH key. */ + /** + * ID of Project linked to the SSH key. + */ projectId: string - /** SSH key status. */ + /** + * SSH key status. + */ disabled: boolean } export interface User { - /** ID of user. */ + /** + * ID of user. + */ id: string - /** Email of user. */ + /** + * Email of user. + */ email: string - /** User identifier unique to the Organization. */ + /** + * User identifier unique to the Organization. + */ username: string - /** First name of the user. */ + /** + * First name of the user. + */ firstName: string - /** Last name of the user. */ + /** + * Last name of the user. + */ lastName: string - /** Phone number of the user. */ + /** + * Phone number of the user. + */ phoneNumber: string - /** Locale of the user. */ + /** + * Locale of the user. + */ locale: string - /** Date user was created. */ + /** + * Date user was created. + */ createdAt?: Date - /** Date of last user update. */ + /** + * Date of last user update. + */ updatedAt?: Date - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId: string - /** Deletion status of user. Owners cannot be deleted. */ + /** + * Deletion status of user. Owners cannot be deleted. + */ deletable: boolean - /** Date of the last login. */ + /** + * Date of the last login. + */ lastLoginAt?: Date - /** Type of user. */ + /** + * Type of user. + */ type: UserType - /** @deprecated Deprecated, use "mfa" instead. */ + /** + * @deprecated Deprecated, use "mfa" instead. + */ twoFactorEnabled?: boolean - /** Status of user invitation. */ + /** + * Status of user invitation. + */ status: UserStatus - /** Defines whether MFA is enabled. */ + /** + * Defines whether MFA is enabled. + */ mfa: boolean - /** ID of the account root user associated with the user. */ + /** + * ID of the account root user associated with the user. + */ accountRootUserId: string - /** Tags associated with the user. */ + /** + * Tags associated with the user. + */ tags: string[] - /** Defines whether the user is locked. */ + /** + * Defines whether the user is locked. + */ locked: boolean } export type AddGroupMemberRequest = { - /** ID of the group. */ + /** + * ID of the group. + */ groupId: string /** * ID of the user to add. @@ -549,11 +779,17 @@ export type AddGroupMemberRequest = { } export type AddGroupMembersRequest = { - /** ID of the group. */ + /** + * ID of the group. + */ groupId: string - /** IDs of the users to add. */ + /** + * IDs of the users to add. + */ userIds?: string[] - /** IDs of the applications to add. */ + /** + * IDs of the applications to add. + */ applicationIds?: string[] } @@ -574,106 +810,142 @@ export type CreateAPIKeyRequest = { * One-of ('bearer'): at most one of 'applicationId', 'userId' could be set. */ userId?: string - /** Expiration date of the API key. */ + /** + * Expiration date of the API key. + */ expiresAt?: Date - /** Default Project ID to use with Object Storage. */ + /** + * Default Project ID to use with Object Storage. + */ defaultProjectId?: string - /** Description of the API key (max length is 200 characters). */ + /** + * Description of the API key (max length is 200 characters). + */ description: string } export type CreateApplicationRequest = { - /** Name of the application to create (max length is 64 characters). */ + /** + * Name of the application to create (max length is 64 characters). + */ name?: string - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId?: string - /** Description of the application (max length is 200 characters). */ + /** + * Description of the application (max length is 200 characters). + */ description: string - /** Tags associated with the application (maximum of 10 tags). */ + /** + * Tags associated with the application (maximum of 10 tags). + */ tags?: string[] } export type CreateGroupRequest = { - /** ID of Organization linked to the group. */ + /** + * ID of Organization linked to the group. + */ organizationId?: string /** - * Name of the group to create (max length is 64 chars). MUST be unique inside - * an Organization. + * Name of the group to create (max length is 64 chars). MUST be unique inside an Organization. */ name?: string - /** Description of the group to create (max length is 200 chars). */ + /** + * Description of the group to create (max length is 200 chars). + */ description: string - /** Tags associated with the group (maximum of 10 tags). */ + /** + * Tags associated with the group (maximum of 10 tags). + */ tags?: string[] } export type CreateJWTRequest = { - /** ID of the user the JWT will be created for. */ + /** + * ID of the user the JWT will be created for. + */ userId: string - /** Referrer of the JWT. */ + /** + * Referrer of the JWT. + */ referrer: string } export type CreatePolicyRequest = { - /** Name of the policy to create (max length is 64 characters). */ + /** + * Name of the policy to create (max length is 64 characters). + */ name?: string - /** Description of the policy to create (max length is 200 characters). */ + /** + * Description of the policy to create (max length is 200 characters). + */ description: string - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId?: string - /** Rules of the policy to create. */ + /** + * Rules of the policy to create. + */ rules?: RuleSpecs[] - /** Tags associated with the policy (maximum of 10 tags). */ + /** + * Tags associated with the policy (maximum of 10 tags). + */ tags?: string[] /** * ID of user attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ userId?: string /** * ID of group attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ groupId?: string /** * ID of application attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ applicationId?: string /** * Defines whether or not a policy is attributed to a principal. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ noPrincipal?: boolean } export type CreateSSHKeyRequest = { - /** Name of the SSH key. Max length is 1000. */ + /** + * Name of the SSH key. Max length is 1000. + */ name?: string /** - * SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and - * ecdsa keys with NIST curves are supported. Max length is 65000. + * SSH public key. Currently only the ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa keys with NIST curves are supported. Max length is 65000. */ publicKey: string - /** Project the resource is attributed to. */ + /** + * Project the resource is attributed to. + */ projectId?: string } export type CreateUserMFAOTPRequest = { - /** User ID of the MFA OTP. */ + /** + * User ID of the MFA OTP. + */ userId: string } export type CreateUserRequest = { - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId?: string /** * Email of the user. @@ -681,7 +953,9 @@ export type CreateUserRequest = { * One-of ('type'): at most one of 'email', 'member' could be set. */ email?: string - /** Tags associated with the user. */ + /** + * Tags associated with the user. + */ tags?: string[] /** * Details of IAM member. @@ -692,27 +966,37 @@ export type CreateUserRequest = { } export type DeleteAPIKeyRequest = { - /** Access key to delete. */ + /** + * Access key to delete. + */ accessKey: string } export type DeleteApplicationRequest = { - /** ID of the application to delete. */ + /** + * ID of the application to delete. + */ applicationId: string } export type DeleteGroupRequest = { - /** ID of the group to delete. */ + /** + * ID of the group to delete. + */ groupId: string } export type DeleteJWTRequest = { - /** JWT ID of the JWT to delete. */ + /** + * JWT ID of the JWT to delete. + */ jti: string } export type DeletePolicyRequest = { - /** Id of policy to delete. */ + /** + * Id of policy to delete. + */ policyId: string } @@ -721,204 +1005,322 @@ export type DeleteSSHKeyRequest = { } export type DeleteUserMFAOTPRequest = { - /** User ID of the MFA OTP. */ + /** + * User ID of the MFA OTP. + */ userId: string } export type DeleteUserRequest = { - /** ID of the user to delete. */ + /** + * ID of the user to delete. + */ userId: string } export interface EncodedJWT { - /** The renewed JWT. */ + /** + * The renewed JWT. + */ jwt?: JWT - /** The encoded token of the renewed JWT. */ + /** + * The encoded token of the renewed JWT. + */ token: string - /** The encoded renew token. This token is necessary to renew the JWT. */ + /** + * The encoded renew token. This token is necessary to renew the JWT. + */ renewToken: string } export type GetAPIKeyRequest = { - /** Access key to search for. */ + /** + * Access key to search for. + */ accessKey: string } export type GetApplicationRequest = { - /** ID of the application to find. */ + /** + * ID of the application to find. + */ applicationId: string } export type GetGroupRequest = { - /** ID of the group. */ + /** + * ID of the group. + */ groupId: string } export type GetJWTRequest = { - /** JWT ID of the JWT to get. */ + /** + * JWT ID of the JWT to get. + */ jti: string } export type GetLogRequest = { - /** ID of the log. */ + /** + * ID of the log. + */ logId: string } export type GetOrganizationSecuritySettingsRequest = { - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId?: string } export type GetPolicyRequest = { - /** Id of policy to search. */ + /** + * Id of policy to search. + */ policyId: string } export type GetQuotumRequest = { - /** Name of the quota to get. */ + /** + * Name of the quota to get. + */ quotumName: string - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId?: string } export type GetSSHKeyRequest = { - /** ID of the SSH key. */ + /** + * ID of the SSH key. + */ sshKeyId: string } export type GetUserConnectionsRequest = { - /** ID of the user to list connections for. */ + /** + * ID of the user to list connections for. + */ userId: string } export interface GetUserConnectionsResponse { - /** List of connections. */ + /** + * List of connections. + */ connections: Connection[] } export type GetUserRequest = { - /** ID of the user to find. */ + /** + * ID of the user to find. + */ userId: string } export type ListAPIKeysRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListAPIKeysRequestOrderBy - /** Page number. Value must be greater or equal to 1. */ + /** + * Page number. Value must be greater or equal to 1. + */ page?: number - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** ID of Organization. */ + /** + * ID of Organization. + */ organizationId?: string /** * @deprecated ID of application that bears the API key. * - * One-of ('bearer'): at most one of 'applicationId', 'userId' could be set. + * One-of ('bearer'): at most one of 'applicationId', 'userId' could be set. */ applicationId?: string /** * @deprecated ID of user that bears the API key. * - * One-of ('bearer'): at most one of 'applicationId', 'userId' could be set. + * One-of ('bearer'): at most one of 'applicationId', 'userId' could be set. */ userId?: string - /** Defines whether to filter out editable API keys or not. */ + /** + * Defines whether to filter out editable API keys or not. + */ editable?: boolean - /** Defines whether to filter out expired API keys or not. */ + /** + * Defines whether to filter out expired API keys or not. + */ expired?: boolean - /** @deprecated Filter by access key (deprecated in favor of `access_keys`). */ + /** + * @deprecated Filter by access key (deprecated in favor of `access_keys`). + */ accessKey?: string - /** Filter by description. */ + /** + * Filter by description. + */ description?: string - /** Filter by bearer ID. */ + /** + * Filter by bearer ID. + */ bearerId?: string - /** Filter by type of bearer. */ + /** + * Filter by type of bearer. + */ bearerType?: BearerType - /** Filter by a list of access keys. */ + /** + * Filter by a list of access keys. + */ accessKeys?: string[] } export interface ListAPIKeysResponse { - /** List of API keys. */ + /** + * List of API keys. + */ apiKeys: APIKey[] - /** Total count of API Keys. */ + /** + * Total count of API Keys. + */ totalCount: number } export type ListApplicationsRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListApplicationsRequestOrderBy - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater than 1. */ + /** + * Page number. Value must be greater than 1. + */ page?: number - /** Name of the application to filter. */ + /** + * Name of the application to filter. + */ name?: string - /** ID of the Organization to filter. */ + /** + * ID of the Organization to filter. + */ organizationId?: string - /** Defines whether to filter out editable applications or not. */ + /** + * Defines whether to filter out editable applications or not. + */ editable?: boolean - /** Filter by list of IDs. */ + /** + * Filter by list of IDs. + */ applicationIds?: string[] - /** Filter by tags containing a given string. */ + /** + * Filter by tags containing a given string. + */ tag?: string } export interface ListApplicationsResponse { - /** List of applications. */ + /** + * List of applications. + */ applications: Application[] - /** Total count of applications. */ + /** + * Total count of applications. + */ totalCount: number } export type ListGracePeriodsRequest = { - /** ID of the user to list grace periods for. */ + /** + * ID of the user to list grace periods for. + */ userId?: string } export interface ListGracePeriodsResponse { - /** List of grace periods. */ + /** + * List of grace periods. + */ gracePeriods: GracePeriod[] } export type ListGroupsRequest = { - /** Sort order of groups. */ + /** + * Sort order of groups. + */ orderBy?: ListGroupsRequestOrderBy - /** Requested page number. Value must be greater or equal to 1. */ + /** + * Requested page number. Value must be greater or equal to 1. + */ page?: number - /** Number of items per page. Value must be between 1 and 100. */ + /** + * Number of items per page. Value must be between 1 and 100. + */ pageSize?: number - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Name of group to find. */ + /** + * Name of group to find. + */ name?: string - /** Filter by a list of application IDs. */ + /** + * Filter by a list of application IDs. + */ applicationIds?: string[] - /** Filter by a list of user IDs. */ + /** + * Filter by a list of user IDs. + */ userIds?: string[] - /** Filter by a list of group IDs. */ + /** + * Filter by a list of group IDs. + */ groupIds?: string[] - /** Filter by tags containing a given string. */ + /** + * Filter by tags containing a given string. + */ tag?: string } export interface ListGroupsResponse { - /** List of groups. */ + /** + * List of groups. + */ groups: Group[] - /** Total count of groups. */ + /** + * Total count of groups. + */ totalCount: number } export type ListJWTsRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListJWTsRequestOrderBy - /** ID of the user to search. */ + /** + * ID of the user to search. + */ audienceId?: string - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater to 1. */ + /** + * Page number. Value must be greater to 1. + */ page?: number - /** Filter out expired JWTs or not. */ + /** + * Filter out expired JWTs or not. + */ expired?: boolean } @@ -928,173 +1330,299 @@ export interface ListJWTsResponse { } export type ListLogsRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListLogsRequestOrderBy - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater to 1. */ + /** + * Page number. Value must be greater to 1. + */ page?: number - /** Defined whether or not to filter out logs created after this timestamp. */ + /** + * Defined whether or not to filter out logs created after this timestamp. + */ createdAfter?: Date - /** Defined whether or not to filter out logs created before this timestamp. */ + /** + * Defined whether or not to filter out logs created before this timestamp. + */ createdBefore?: Date - /** Defined whether or not to filter out by a specific action. */ + /** + * Defined whether or not to filter out by a specific action. + */ action?: LogAction - /** Defined whether or not to filter out by a specific type of resource. */ + /** + * Defined whether or not to filter out by a specific type of resource. + */ resourceType?: LogResourceType - /** Defined whether or not to filter out log by bearer ID or resource ID. */ + /** + * Defined whether or not to filter out log by bearer ID or resource ID. + */ search?: string } export interface ListLogsResponse { - /** List of logs. */ + /** + * List of logs. + */ logs: Log[] - /** Total count of logs. */ + /** + * Total count of logs. + */ totalCount: number } export type ListPermissionSetsRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListPermissionSetsRequestOrderBy - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater than 1. */ + /** + * Page number. Value must be greater than 1. + */ page?: number - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string } export interface ListPermissionSetsResponse { - /** List of permission sets. */ + /** + * List of permission sets. + */ permissionSets: PermissionSet[] - /** Total count of permission sets. */ + /** + * Total count of permission sets. + */ totalCount: number } export type ListPoliciesRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListPoliciesRequestOrderBy - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater than 1. */ + /** + * Page number. Value must be greater than 1. + */ page?: number - /** ID of the Organization to filter. */ + /** + * ID of the Organization to filter. + */ organizationId?: string - /** Defines whether or not filter out editable policies. */ + /** + * Defines whether or not filter out editable policies. + */ editable?: boolean - /** Defines whether or not to filter by list of user IDs. */ + /** + * Defines whether or not to filter by list of user IDs. + */ userIds?: string[] - /** Defines whether or not to filter by list of group IDs. */ + /** + * Defines whether or not to filter by list of group IDs. + */ groupIds?: string[] - /** Filter by a list of application IDs. */ + /** + * Filter by a list of application IDs. + */ applicationIds?: string[] - /** Defines whether or not the policy is attributed to a principal. */ + /** + * Defines whether or not the policy is attributed to a principal. + */ noPrincipal?: boolean - /** Name of the policy to fetch. */ + /** + * Name of the policy to fetch. + */ policyName?: string - /** Filter by tags containing a given string. */ + /** + * Filter by tags containing a given string. + */ tag?: string - /** Filter by a list of IDs. */ + /** + * Filter by a list of IDs. + */ policyIds?: string[] } export interface ListPoliciesResponse { - /** List of policies. */ + /** + * List of policies. + */ policies: Policy[] - /** Total count of policies. */ + /** + * Total count of policies. + */ totalCount: number } export type ListQuotaRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListQuotaRequestOrderBy - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater than 1. */ + /** + * Page number. Value must be greater than 1. + */ page?: number - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** List of quotum names to filter from. */ + /** + * List of quotum names to filter from. + */ quotumNames?: string[] } export interface ListQuotaResponse { - /** List of quota. */ + /** + * List of quota. + */ quota: Quotum[] - /** Total count of quota. */ + /** + * Total count of quota. + */ totalCount: number } export type ListRulesRequest = { - /** Id of policy to search. */ + /** + * Id of policy to search. + */ policyId: string - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater than 1. */ + /** + * Page number. Value must be greater than 1. + */ page?: number } export interface ListRulesResponse { - /** Rules of the policy. */ + /** + * Rules of the policy. + */ rules: Rule[] - /** Total count of rules. */ + /** + * Total count of rules. + */ totalCount: number } export type ListSSHKeysRequest = { - /** Sort order of the SSH keys. */ + /** + * Sort order of the SSH keys. + */ orderBy?: ListSSHKeysRequestOrderBy - /** Requested page number. Value must be greater or equal to 1. */ + /** + * Requested page number. Value must be greater or equal to 1. + */ page?: number - /** Number of items per page. Value must be between 1 and 100. */ + /** + * Number of items per page. Value must be between 1 and 100. + */ pageSize?: number - /** Filter by Organization ID. */ + /** + * Filter by Organization ID. + */ organizationId?: string - /** Name of group to find. */ + /** + * Name of group to find. + */ name?: string - /** Filter by Project ID. */ + /** + * Filter by Project ID. + */ projectId?: string - /** Defines whether to include disabled SSH keys or not. */ + /** + * Defines whether to include disabled SSH keys or not. + */ disabled?: boolean } export interface ListSSHKeysResponse { - /** List of SSH keys. */ + /** + * List of SSH keys. + */ sshKeys: SSHKey[] - /** Total count of SSH keys. */ + /** + * Total count of SSH keys. + */ totalCount: number } export type ListUsersRequest = { - /** Criteria for sorting results. */ + /** + * Criteria for sorting results. + */ orderBy?: ListUsersRequestOrderBy - /** Number of results per page. Value must be between 1 and 100. */ + /** + * Number of results per page. Value must be between 1 and 100. + */ pageSize?: number - /** Page number. Value must be greater or equal to 1. */ + /** + * Page number. Value must be greater or equal to 1. + */ page?: number - /** ID of the Organization to filter. */ + /** + * ID of the Organization to filter. + */ organizationId?: string - /** Filter by list of IDs. */ + /** + * Filter by list of IDs. + */ userIds?: string[] - /** Filter by MFA status. */ + /** + * Filter by MFA status. + */ mfa?: boolean - /** Filter by tags containing a given string. */ + /** + * Filter by tags containing a given string. + */ tag?: string - /** Filter by user type. */ + /** + * Filter by user type. + */ type?: UserType } export interface ListUsersResponse { - /** List of users. */ + /** + * List of users. + */ users: User[] - /** Total count of users. */ + /** + * Total count of users. + */ totalCount: number } export type LockUserRequest = { - /** ID of the user to lock. */ + /** + * ID of the user to lock. + */ userId: string } @@ -1103,16 +1631,24 @@ export interface MFAOTP { } export interface OrganizationSecuritySettings { - /** Defines whether password renewal is enforced during first login. */ + /** + * Defines whether password renewal is enforced during first login. + */ enforcePasswordRenewal: boolean - /** Duration of the grace period to renew password or enable MFA. */ + /** + * Duration of the grace period to renew password or enable MFA. + */ gracePeriodDuration?: string - /** Number of login attempts before the account is locked. */ + /** + * Number of login attempts before the account is locked. + */ loginAttemptsBeforeLocked: number } export type RemoveGroupMemberRequest = { - /** ID of the group. */ + /** + * ID of the group. + */ groupId: string /** * ID of the user to remove. @@ -1135,153 +1671,224 @@ export type SetGroupMembersRequest = { } export type SetRulesRequest = { - /** Id of policy to update. */ + /** + * Id of policy to update. + */ policyId: string - /** Rules of the policy to set. */ + /** + * Rules of the policy to set. + */ rules: RuleSpecs[] } export interface SetRulesResponse { - /** Rules of the policy. */ + /** + * Rules of the policy. + */ rules: Rule[] } export type UnlockUserRequest = { - /** ID of the user to unlock. */ + /** + * ID of the user to unlock. + */ userId: string } export type UpdateAPIKeyRequest = { - /** Access key to update. */ + /** + * Access key to update. + */ accessKey: string - /** New default Project ID to set. */ + /** + * New default Project ID to set. + */ defaultProjectId?: string - /** New description to update. */ + /** + * New description to update. + */ description?: string } export type UpdateApplicationRequest = { - /** ID of the application to update. */ + /** + * ID of the application to update. + */ applicationId: string - /** New name for the application (max length is 64 chars). */ + /** + * New name for the application (max length is 64 chars). + */ name?: string - /** New description for the application (max length is 200 chars). */ + /** + * New description for the application (max length is 200 chars). + */ description?: string - /** New tags for the application (maximum of 10 tags). */ + /** + * New tags for the application (maximum of 10 tags). + */ tags?: string[] } export type UpdateGroupRequest = { - /** ID of the group to update. */ + /** + * ID of the group to update. + */ groupId: string /** - * New name for the group (max length is 64 chars). MUST be unique inside an - * Organization. + * New name for the group (max length is 64 chars). MUST be unique inside an Organization. */ name?: string - /** New description for the group (max length is 200 chars). */ + /** + * New description for the group (max length is 200 chars). + */ description?: string - /** New tags for the group (maximum of 10 tags). */ + /** + * New tags for the group (maximum of 10 tags). + */ tags?: string[] } export type UpdateOrganizationSecuritySettingsRequest = { - /** ID of the Organization. */ + /** + * ID of the Organization. + */ organizationId?: string - /** Defines whether password renewal is enforced during first login. */ + /** + * Defines whether password renewal is enforced during first login. + */ enforcePasswordRenewal?: boolean - /** Duration of the grace period to renew password or enable MFA. */ + /** + * Duration of the grace period to renew password or enable MFA. + */ gracePeriodDuration?: string - /** Number of login attempts before the account is locked. */ + /** + * Number of login attempts before the account is locked. + */ loginAttemptsBeforeLocked?: number } export type UpdatePolicyRequest = { - /** Id of policy to update. */ + /** + * Id of policy to update. + */ policyId: string - /** New name for the policy (max length is 64 characters). */ + /** + * New name for the policy (max length is 64 characters). + */ name?: string - /** New description of policy (max length is 200 characters). */ + /** + * New description of policy (max length is 200 characters). + */ description?: string - /** New tags for the policy (maximum of 10 tags). */ + /** + * New tags for the policy (maximum of 10 tags). + */ tags?: string[] /** * New ID of user attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ userId?: string /** * New ID of group attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ groupId?: string /** * New ID of application attributed to the policy. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ applicationId?: string /** * Defines whether or not the policy is attributed to a principal. * - * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', - * 'noPrincipal' could be set. + * One-of ('principal'): at most one of 'userId', 'groupId', 'applicationId', 'noPrincipal' could be set. */ noPrincipal?: boolean } export type UpdateSSHKeyRequest = { sshKeyId: string - /** Name of the SSH key. Max length is 1000. */ + /** + * Name of the SSH key. Max length is 1000. + */ name?: string - /** Enable or disable the SSH key. */ + /** + * Enable or disable the SSH key. + */ disabled?: boolean } export type UpdateUserPasswordRequest = { - /** ID of the user to update. */ + /** + * ID of the user to update. + */ userId: string - /** The new password. */ + /** + * The new password. + */ password: string } export type UpdateUserRequest = { - /** ID of the user to update. */ + /** + * ID of the user to update. + */ userId: string - /** New tags for the user (maximum of 10 tags). */ + /** + * New tags for the user (maximum of 10 tags). + */ tags?: string[] - /** IAM member email. */ + /** + * IAM member email. + */ email?: string - /** IAM member first name. */ + /** + * IAM member first name. + */ firstName?: string - /** IAM member last name. */ + /** + * IAM member last name. + */ lastName?: string - /** IAM member phone number. */ + /** + * IAM member phone number. + */ phoneNumber?: string - /** IAM member locale. */ + /** + * IAM member locale. + */ locale?: string } export type UpdateUserUsernameRequest = { - /** ID of the user to update. */ + /** + * ID of the user to update. + */ userId: string - /** The new username. */ + /** + * The new username. + */ username: string } export type ValidateUserMFAOTPRequest = { - /** User ID of the MFA OTP. */ + /** + * User ID of the MFA OTP. + */ userId: string - /** A password generated using the OTP. */ + /** + * A password generated using the OTP. + */ oneTimePassword: string } export interface ValidateUserMFAOTPResponse { - /** List of recovery codes usable for this OTP method. */ + /** + * List of recovery codes usable for this OTP method. + */ recoveryCodes: string[] } diff --git a/packages/clients/src/api/index.gen.ts b/packages/clients/src/api/index.gen.ts index b4c0be94c..9ad0f77af 100644 --- a/packages/clients/src/api/index.gen.ts +++ b/packages/clients/src/api/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ import * as Account from './account/index.gen' diff --git a/packages/clients/src/api/inference/index.gen.ts b/packages/clients/src/api/inference/index.gen.ts index 5fbe167b7..a7faa1b20 100644 --- a/packages/clients/src/api/inference/index.gen.ts +++ b/packages/clients/src/api/inference/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/instance/index.gen.ts b/packages/clients/src/api/instance/index.gen.ts index 552427430..7b9ae965b 100644 --- a/packages/clients/src/api/instance/index.gen.ts +++ b/packages/clients/src/api/instance/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/interlink/index.gen.ts b/packages/clients/src/api/interlink/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/interlink/index.gen.ts +++ b/packages/clients/src/api/interlink/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/iot/index.gen.ts b/packages/clients/src/api/iot/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/iot/index.gen.ts +++ b/packages/clients/src/api/iot/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/ipam/index.gen.ts b/packages/clients/src/api/ipam/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/ipam/index.gen.ts +++ b/packages/clients/src/api/ipam/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/ipfs/index.gen.ts b/packages/clients/src/api/ipfs/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/ipfs/index.gen.ts +++ b/packages/clients/src/api/ipfs/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/jobs/index.gen.ts b/packages/clients/src/api/jobs/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/jobs/index.gen.ts +++ b/packages/clients/src/api/jobs/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/k8s/index.gen.ts b/packages/clients/src/api/k8s/index.gen.ts index 552427430..7b9ae965b 100644 --- a/packages/clients/src/api/k8s/index.gen.ts +++ b/packages/clients/src/api/k8s/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/key_manager/index.gen.ts b/packages/clients/src/api/key_manager/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/key_manager/index.gen.ts +++ b/packages/clients/src/api/key_manager/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/lb/index.gen.ts b/packages/clients/src/api/lb/index.gen.ts index 552427430..7b9ae965b 100644 --- a/packages/clients/src/api/lb/index.gen.ts +++ b/packages/clients/src/api/lb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index' diff --git a/packages/clients/src/api/lb/v1/index.gen.ts b/packages/clients/src/api/lb/v1/index.gen.ts index 4943a11e2..66e090491 100644 --- a/packages/clients/src/api/lb/v1/index.gen.ts +++ b/packages/clients/src/api/lb/v1/index.gen.ts @@ -1,6 +1,9 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { API, ZonedAPI } from './api.gen' +export { + API, + ZonedAPI, +} from './api.gen' export * from './content.gen' export type { Acl, diff --git a/packages/clients/src/api/llm_inference/index.gen.ts b/packages/clients/src/api/llm_inference/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/llm_inference/index.gen.ts +++ b/packages/clients/src/api/llm_inference/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/marketplace/index.gen.ts b/packages/clients/src/api/marketplace/index.gen.ts index 40f288ff0..21ef57b6c 100644 --- a/packages/clients/src/api/marketplace/index.gen.ts +++ b/packages/clients/src/api/marketplace/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v2 from './v2/index.gen' diff --git a/packages/clients/src/api/mnq/index.gen.ts b/packages/clients/src/api/mnq/index.gen.ts index 886270369..79692e383 100644 --- a/packages/clients/src/api/mnq/index.gen.ts +++ b/packages/clients/src/api/mnq/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1beta1 from './v1beta1/index.gen' diff --git a/packages/clients/src/api/mnq/v1beta1/index.gen.ts b/packages/clients/src/api/mnq/v1beta1/index.gen.ts index 0bc8b8f72..82440fa58 100644 --- a/packages/clients/src/api/mnq/v1beta1/index.gen.ts +++ b/packages/clients/src/api/mnq/v1beta1/index.gen.ts @@ -1,6 +1,10 @@ // This file was automatically generated. DO NOT EDIT. // If you have any remark or suggestion do not hesitate to open an issue. -export { NatsAPI, SnsAPI, SqsAPI } from './api.gen' +export { + NatsAPI, + SnsAPI, + SqsAPI, +} from './api.gen' export type { File, ListNatsAccountsRequestOrderBy, diff --git a/packages/clients/src/api/mongodb/index.gen.ts b/packages/clients/src/api/mongodb/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/mongodb/index.gen.ts +++ b/packages/clients/src/api/mongodb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/qaas/index.gen.ts b/packages/clients/src/api/qaas/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/qaas/index.gen.ts +++ b/packages/clients/src/api/qaas/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/rdb/index.gen.ts b/packages/clients/src/api/rdb/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/rdb/index.gen.ts +++ b/packages/clients/src/api/rdb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/redis/index.gen.ts b/packages/clients/src/api/redis/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/redis/index.gen.ts +++ b/packages/clients/src/api/redis/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/registry/index.gen.ts b/packages/clients/src/api/registry/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/registry/index.gen.ts +++ b/packages/clients/src/api/registry/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/secret/index.gen.ts b/packages/clients/src/api/secret/index.gen.ts index 72d281d6b..6a15a4900 100644 --- a/packages/clients/src/api/secret/index.gen.ts +++ b/packages/clients/src/api/secret/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/serverless_sqldb/index.gen.ts b/packages/clients/src/api/serverless_sqldb/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/serverless_sqldb/index.gen.ts +++ b/packages/clients/src/api/serverless_sqldb/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/tem/index.gen.ts b/packages/clients/src/api/tem/index.gen.ts index 6dec29b44..4e5e04061 100644 --- a/packages/clients/src/api/tem/index.gen.ts +++ b/packages/clients/src/api/tem/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1alpha1 from './v1alpha1/index.gen' diff --git a/packages/clients/src/api/test/index.gen.ts b/packages/clients/src/api/test/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/test/index.gen.ts +++ b/packages/clients/src/api/test/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/vpc/index.gen.ts b/packages/clients/src/api/vpc/index.gen.ts index bfc9cec79..2c3742e31 100644 --- a/packages/clients/src/api/vpc/index.gen.ts +++ b/packages/clients/src/api/vpc/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/vpc/v2/api.gen.ts b/packages/clients/src/api/vpc/v2/api.gen.ts index 3b97f182e..d272a29eb 100644 --- a/packages/clients/src/api/vpc/v2/api.gen.ts +++ b/packages/clients/src/api/vpc/v2/api.gen.ts @@ -68,9 +68,8 @@ const jsonContentHeaders = { /** * VPC API. - * - * This API allows you to manage your Virtual Private Clouds (VPCs) and Private - * Networks. + +This API allows you to manage your Virtual Private Clouds (VPCs) and Private Networks. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ @@ -203,10 +202,7 @@ export class API extends ParentAPI { ) /** - * List Private Networks. List existing Private Networks in the specified - * region. By default, the Private Networks returned in the list are ordered - * by creation date in ascending order, though this can be modified via the - * order_by field. + * List Private Networks. List existing Private Networks in the specified region. By default, the Private Networks 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 ListPrivateNetworksRequest} * @returns A Promise of ListPrivateNetworksResponse @@ -219,8 +215,7 @@ export class API extends ParentAPI { ) /** - * Create a Private Network. Create a new Private Network. Once created, you - * can attach Scaleway resources which are in the same region. + * Create a Private Network. Create a new Private Network. Once created, you can attach Scaleway resources which are in the same region. * * @param request - The request {@link CreatePrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -241,9 +236,7 @@ export class API extends ParentAPI { ) /** - * Get a Private Network. Retrieve information about an existing Private - * Network, specified by its Private Network ID. Its full details are returned - * in the response object. + * Get a Private Network. Retrieve information about an existing Private Network, specified by its Private Network ID. Its full details are returned in the response object. * * @param request - The request {@link GetPrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -258,8 +251,7 @@ export class API extends ParentAPI { ) /** - * Update Private Network. Update parameters (such as name or tags) of an - * existing Private Network, specified by its Private Network ID. + * Update Private Network. Update parameters (such as name or tags) of an existing Private Network, specified by its Private Network ID. * * @param request - The request {@link UpdatePrivateNetworkRequest} * @returns A Promise of PrivateNetwork @@ -278,8 +270,7 @@ export class API extends ParentAPI { ) /** - * Delete a Private Network. Delete an existing Private Network. Note that you - * must first detach all resources from the network, in order to delete it. + * Delete a Private Network. Delete an existing Private Network. Note that you must first detach all resources from the network, in order to delete it. * * @param request - The request {@link DeletePrivateNetworkRequest} */ @@ -290,9 +281,7 @@ export class API extends ParentAPI { }) /** - * Enable DHCP on a Private Network. Enable DHCP managed on an existing - * Private Network. Note that you will not be able to deactivate it - * afterwards. + * Enable DHCP on a Private Network. Enable DHCP managed on an existing Private Network. Note that you will not be able to deactivate it afterwards. * * @param request - The request {@link EnableDHCPRequest} * @returns A Promise of PrivateNetwork @@ -309,8 +298,7 @@ export class API extends ParentAPI { ) /** - * Enable routing on a VPC. Enable routing on an existing VPC. Note that you - * will not be able to deactivate it afterwards. + * Enable routing on a VPC. Enable routing on an existing VPC. Note that you will not be able to deactivate it afterwards. * * @param request - The request {@link EnableRoutingRequest} * @returns A Promise of VPC @@ -348,8 +336,7 @@ export class API extends ParentAPI { ) /** - * List subnets. List any Private Network's subnets. See ListPrivateNetworks - * to list a specific Private Network's subnets. + * List subnets. List any Private Network's subnets. See ListPrivateNetworks to list a specific Private Network's subnets. * * @param request - The request {@link ListSubnetsRequest} * @returns A Promise of ListSubnetsResponse @@ -358,8 +345,7 @@ export class API extends ParentAPI { enrichForPagination('subnets', this.pageOfListSubnets, request) /** - * Add subnets to a Private Network. Add new subnets to an existing Private - * Network. + * Add subnets to a Private Network. Add new subnets to an existing Private Network. * * @param request - The request {@link AddSubnetsRequest} * @returns A Promise of AddSubnetsResponse @@ -378,8 +364,7 @@ export class API extends ParentAPI { ) /** - * Delete subnets from a Private Network. Delete the specified subnets from a - * Private Network. + * Delete subnets from a Private Network. Delete the specified subnets from a Private Network. * * @param request - The request {@link DeleteSubnetsRequest} * @returns A Promise of DeleteSubnetsResponse @@ -417,8 +402,7 @@ export class API extends ParentAPI { ) /** - * Get a Route. Retrieve details of an existing Route, specified by its Route - * ID. + * Get a Route. Retrieve details of an existing Route, specified by its Route ID. * * @param request - The request {@link GetRouteRequest} * @returns A Promise of Route @@ -463,8 +447,7 @@ export class API extends ParentAPI { }) /** - * Get ACL Rules for VPC. Retrieve a list of ACL rules for a VPC, specified by - * its VPC ID. + * Get ACL Rules for VPC. Retrieve a list of ACL rules for a VPC, specified by its VPC ID. * * @param request - The request {@link GetAclRequest} * @returns A Promise of GetAclResponse @@ -480,8 +463,7 @@ export class API extends ParentAPI { ) /** - * Set VPC ACL rules. Set the list of ACL rules and the default routing policy - * for a VPC. + * Set VPC ACL rules. Set the list of ACL rules and the default routing policy for a VPC. * * @param request - The request {@link SetAclRequest} * @returns A Promise of SetAclResponse diff --git a/packages/clients/src/api/vpc/v2/types.gen.ts b/packages/clients/src/api/vpc/v2/types.gen.ts index a39782db8..10ea599e9 100644 --- a/packages/clients/src/api/vpc/v2/types.gen.ts +++ b/packages/clients/src/api/vpc/v2/types.gen.ts @@ -21,145 +21,228 @@ export type ListVPCsRequestOrderBy = | 'name_desc' export interface Subnet { - /** ID of the subnet. */ + /** + * ID of the subnet. + */ id: string - /** Subnet creation date. */ + /** + * Subnet creation date. + */ createdAt?: Date - /** Subnet last modification date. */ + /** + * Subnet last modification date. + */ updatedAt?: Date - /** Subnet CIDR. */ + /** + * Subnet CIDR. + */ subnet: string - /** Scaleway Project the subnet belongs to. */ + /** + * Scaleway Project the subnet belongs to. + */ projectId: string - /** Private Network the subnet belongs to. */ + /** + * Private Network the subnet belongs to. + */ privateNetworkId: string - /** VPC the subnet belongs to. */ + /** + * VPC the subnet belongs to. + */ vpcId: string } export interface PrivateNetwork { - /** Private Network ID. */ + /** + * Private Network ID. + */ id: string - /** Private Network name. */ + /** + * Private Network name. + */ name: string - /** Scaleway Organization the Private Network belongs to. */ + /** + * Scaleway Organization the Private Network belongs to. + */ organizationId: string - /** Scaleway Project the Private Network belongs to. */ + /** + * Scaleway Project the Private Network belongs to. + */ projectId: string - /** Region in which the Private Network is available. */ + /** + * Region in which the Private Network is available. + */ region: ScwRegion - /** Tags of the Private Network. */ + /** + * Tags of the Private Network. + */ tags: string[] - /** Date the Private Network was created. */ + /** + * Date the Private Network was created. + */ createdAt?: Date - /** Date the Private Network was last modified. */ + /** + * Date the Private Network was last modified. + */ updatedAt?: Date - /** Private Network subnets. */ + /** + * Private Network subnets. + */ subnets: Subnet[] - /** VPC the Private Network belongs to. */ + /** + * VPC the Private Network belongs to. + */ vpcId: string - /** Defines whether managed DHCP is enabled for this Private Network. */ + /** + * Defines whether managed DHCP is enabled for this Private Network. + */ dhcpEnabled: boolean } export interface Route { - /** Route ID. */ + /** + * Route ID. + */ id: string - /** Route description. */ + /** + * Route description. + */ description: string - /** Tags of the Route. */ + /** + * Tags of the Route. + */ tags: string[] - /** VPC the Route belongs to. */ + /** + * VPC the Route belongs to. + */ vpcId: string - /** Destination of the Route. */ + /** + * Destination of the Route. + */ destination: string - /** ID of the nexthop resource. */ + /** + * ID of the nexthop resource. + */ nexthopResourceId?: string - /** ID of the nexthop private network. */ + /** + * ID of the nexthop private network. + */ nexthopPrivateNetworkId?: string - /** Date the Route was created. */ + /** + * Date the Route was created. + */ createdAt?: Date - /** Date the Route was last modified. */ + /** + * Date the Route was last modified. + */ updatedAt?: Date - /** Defines whether the route can be modified or deleted by the user. */ + /** + * Defines whether the route can be modified or deleted by the user. + */ isReadOnly: boolean - /** Region of the Route. */ + /** + * Region of the Route. + */ region: ScwRegion } export interface AclRule { - /** Protocol to which this rule applies. */ + /** + * Protocol to which this rule applies. + */ protocol: AclRuleProtocol /** - * Source IP range to which this rule applies (CIDR notation with subnet - * mask). + * Source IP range to which this rule applies (CIDR notation with subnet mask). */ source: string /** - * Starting port of the source port range to which this rule applies - * (inclusive). + * Starting port of the source port range to which this rule applies (inclusive). */ srcPortLow: number /** - * Ending port of the source port range to which this rule applies - * (inclusive). + * Ending port of the source port range to which this rule applies (inclusive). */ srcPortHigh: number /** - * Destination IP range to which this rule applies (CIDR notation with subnet - * mask). + * Destination IP range to which this rule applies (CIDR notation with subnet mask). */ destination: string /** - * Starting port of the destination port range to which this rule applies - * (inclusive). + * Starting port of the destination port range to which this rule applies (inclusive). */ dstPortLow: number /** - * Ending port of the destination port range to which this rule applies - * (inclusive). + * Ending port of the destination port range to which this rule applies (inclusive). */ dstPortHigh: number - /** Policy to apply to the packet. */ + /** + * Policy to apply to the packet. + */ action: Action - /** Rule description. */ + /** + * Rule description. + */ description?: string } export interface VPC { - /** VPC ID. */ + /** + * VPC ID. + */ id: string - /** VPC name. */ + /** + * VPC name. + */ name: string - /** Scaleway Organization the VPC belongs to. */ + /** + * Scaleway Organization the VPC belongs to. + */ organizationId: string - /** Scaleway Project the VPC belongs to. */ + /** + * Scaleway Project the VPC belongs to. + */ projectId: string - /** Region of the VPC. */ + /** + * Region of the VPC. + */ region: ScwRegion - /** Tags for the VPC. */ + /** + * Tags for the VPC. + */ tags: string[] - /** Defines whether the VPC is the default one for its Project. */ + /** + * Defines whether the VPC is the default one for its Project. + */ isDefault: boolean - /** Date the VPC was created. */ + /** + * Date the VPC was created. + */ createdAt?: Date - /** Date the VPC was last modified. */ + /** + * Date the VPC was last modified. + */ updatedAt?: Date - /** Number of Private Networks within this VPC. */ + /** + * Number of Private Networks within this VPC. + */ privateNetworkCount: number - /** Defines whether the VPC routes traffic between its Private Networks. */ + /** + * Defines whether the VPC routes traffic between its Private Networks. + */ routingEnabled: boolean } export type AddSubnetsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string - /** Private Network subnets CIDR. */ + /** + * Private Network subnets CIDR. + */ subnets?: string[] } @@ -169,87 +252,119 @@ export interface AddSubnetsResponse { export type CreatePrivateNetworkRequest = { /** - * Region to target. If none is 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 for the Private Network. */ + /** + * Name for the Private Network. + */ name?: string - /** Scaleway Project in which to create the Private Network. */ + /** + * Scaleway Project in which to create the Private Network. + */ projectId?: string - /** Tags for the Private Network. */ + /** + * Tags for the Private Network. + */ tags?: string[] - /** Private Network subnets CIDR. */ + /** + * Private Network subnets CIDR. + */ subnets?: string[] - /** VPC in which to create the Private Network. */ + /** + * VPC in which to create the Private Network. + */ vpcId?: 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 description. */ + /** + * Route description. + */ description: string - /** Tags of the Route. */ + /** + * Tags of the Route. + */ tags?: string[] - /** VPC the Route belongs to. */ + /** + * VPC the Route belongs to. + */ vpcId: string - /** Destination of the Route. */ + /** + * Destination of the Route. + */ destination: string - /** ID of the nexthop resource. */ + /** + * ID of the nexthop resource. + */ nexthopResourceId?: string - /** ID of the nexthop private network. */ + /** + * ID of the nexthop private network. + */ nexthopPrivateNetworkId?: string } export type CreateVPCRequest = { /** - * Region to target. If none is 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 for the VPC. */ + /** + * Name for the VPC. + */ name?: string - /** Scaleway Project in which to create the VPC. */ + /** + * Scaleway Project in which to create the VPC. + */ projectId?: string - /** Tags for the VPC. */ + /** + * Tags for the VPC. + */ tags?: string[] - /** Enable routing between Private Networks in the VPC. */ + /** + * Enable routing between Private Networks in the VPC. + */ enableRouting: boolean } export type DeletePrivateNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: 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 DeleteSubnetsRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string - /** Private Network subnets CIDR. */ + /** + * Private Network subnets CIDR. + */ subnets?: string[] } @@ -259,45 +374,48 @@ export interface DeleteSubnetsResponse { export type DeleteVPCRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** VPC ID. */ + /** + * VPC ID. + */ vpcId: string } export type EnableDHCPRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string } export type EnableRoutingRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** VPC ID. */ + /** + * VPC ID. + */ vpcId: string } export type GetAclRequest = { /** - * Region to target. If none is 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 Network ACL's VPC. */ + /** + * ID of the Network ACL's VPC. + */ vpcId: string /** - * Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each - * Network ACL can have rules for only one IP type. + * Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each Network ACL can have rules for only one IP type. */ isIpv6: boolean } @@ -309,79 +427,80 @@ export interface GetAclResponse { export type GetPrivateNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: 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 GetVPCRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** VPC ID. */ + /** + * VPC ID. + */ vpcId: string } export type ListPrivateNetworksRequest = { /** - * Region to target. If none is 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 Private Networks. */ + /** + * Sort order of the returned Private Networks. + */ orderBy?: ListPrivateNetworksRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of Private Networks to return per page. */ + /** + * Maximum number of Private Networks to return per page. + */ pageSize?: number /** - * Name to filter for. Only Private Networks with names containing this string - * will be returned. + * Name to filter for. Only Private Networks with names containing this string will be returned. */ name?: string /** - * Tags to filter for. Only Private Networks with one or more matching tags - * will be returned. + * Tags to filter for. Only Private Networks with one or more matching tags will be returned. */ tags?: string[] /** - * Organization ID to filter for. Only Private Networks belonging to this - * Organization will be returned. + * Organization ID to filter for. Only Private Networks belonging to this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for. Only Private Networks belonging to this Project - * will be returned. + * Project ID to filter for. Only Private Networks belonging to this Project will be returned. */ projectId?: string /** - * Private Network IDs to filter for. Only Private Networks with one of these - * IDs will be returned. + * Private Network IDs to filter for. Only Private Networks with one of these IDs will be returned. */ privateNetworkIds?: string[] /** - * VPC ID to filter for. Only Private Networks belonging to this VPC will be - * returned. + * VPC ID to filter for. Only Private Networks belonging to this VPC will be returned. */ vpcId?: string /** - * DHCP status to filter for. When true, only Private Networks with managed - * DHCP enabled will be returned. + * DHCP status to filter for. When true, only Private Networks with managed DHCP enabled will be returned. */ dhcpEnabled?: boolean } @@ -393,32 +512,36 @@ export interface ListPrivateNetworksResponse { export type ListSubnetsRequest = { /** - * Region to target. If none is 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 subnets. */ + /** + * Sort order of the returned subnets. + */ orderBy?: ListSubnetsRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of Private Networks to return per page. */ + /** + * Maximum number of Private Networks to return per page. + */ pageSize?: number /** - * Organization ID to filter for. Only subnets belonging to this Organization - * will be returned. + * Organization ID to filter for. Only subnets belonging to this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for. Only subnets belonging to this Project will be - * returned. + * Project ID to filter for. Only subnets belonging to this Project will be returned. */ projectId?: string /** - * Subnet IDs to filter for. Only subnets matching the specified IDs will be - * returned. + * Subnet IDs to filter for. Only subnets matching the specified IDs will be returned. */ subnetIds?: string[] - /** VPC ID to filter for. Only subnets belonging to this VPC will be returned. */ + /** + * VPC ID to filter for. Only subnets belonging to this VPC will be returned. + */ vpcId?: string } @@ -429,44 +552,43 @@ export interface ListSubnetsResponse { export type ListVPCsRequest = { /** - * Region to target. If none is 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 VPCs. */ + /** + * Sort order of the returned VPCs. + */ orderBy?: ListVPCsRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Maximum number of VPCs to return per page. */ + /** + * Maximum number of VPCs to return per page. + */ pageSize?: number /** - * Name to filter for. Only VPCs with names containing this string will be - * returned. + * Name to filter for. Only VPCs with names containing this string will be returned. */ name?: string /** - * Tags to filter for. Only VPCs with one more more matching tags will be - * returned. + * Tags to filter for. Only VPCs with one or more matching tags will be returned. */ tags?: string[] /** - * Organization ID to filter for. Only VPCs belonging to this Organization - * will be returned. + * Organization ID to filter for. Only VPCs belonging to this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for. Only VPCs belonging to this Project will be - * returned. + * Project ID to filter for. Only VPCs belonging to this Project will be returned. */ projectId?: string /** - * Defines whether to filter only for VPCs which are the default one for their - * Project. + * Defines whether to filter only for VPCs which are the default one for their Project. */ isDefault?: boolean /** - * Defines whether to filter only for VPCs which route traffic between their - * Private Networks. + * Defines whether to filter only for VPCs which route traffic between their Private Networks. */ routingEnabled?: boolean } @@ -478,20 +600,24 @@ export interface ListVPCsResponse { export type SetAclRequest = { /** - * Region to target. If none is 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 Network ACL's VPC. */ + /** + * ID of the Network ACL's VPC. + */ vpcId: string - /** List of Network ACL rules. */ + /** + * List of Network ACL rules. + */ rules: AclRule[] /** - * Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each - * Network ACL can have rules for only one IP type. + * Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each Network ACL can have rules for only one IP type. */ isIpv6: boolean - /** Action to take for packets which do not match any rules. */ + /** + * Action to take for packets which do not match any rules. + */ defaultPolicy: Action } @@ -502,48 +628,69 @@ export interface SetAclResponse { export type UpdatePrivateNetworkRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Private Network ID. */ + /** + * Private Network ID. + */ privateNetworkId: string - /** Name for the Private Network. */ + /** + * Name for the Private Network. + */ name?: string - /** Tags for the Private Network. */ + /** + * Tags for the Private Network. + */ tags?: string[] } 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 description. */ + /** + * Route description. + */ description?: string - /** Tags of the Route. */ + /** + * Tags of the Route. + */ tags?: string[] - /** Destination of the Route. */ + /** + * Destination of the Route. + */ destination?: string - /** ID of the nexthop resource. */ + /** + * ID of the nexthop resource. + */ nexthopResourceId?: string - /** ID of the nexthop private network. */ + /** + * ID of the nexthop private network. + */ nexthopPrivateNetworkId?: string } export type UpdateVPCRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** VPC ID. */ + /** + * VPC ID. + */ vpcId: string - /** Name for the VPC. */ + /** + * Name for the VPC. + */ name?: string - /** Tags for the VPC. */ + /** + * Tags for the VPC. + */ tags?: string[] } diff --git a/packages/clients/src/api/vpcgw/index.gen.ts b/packages/clients/src/api/vpcgw/index.gen.ts index bfc9cec79..2c3742e31 100644 --- a/packages/clients/src/api/vpcgw/index.gen.ts +++ b/packages/clients/src/api/vpcgw/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/vpcgw/v1/api.gen.ts b/packages/clients/src/api/vpcgw/v1/api.gen.ts index 398c105b9..6d16ad3b5 100644 --- a/packages/clients/src/api/vpcgw/v1/api.gen.ts +++ b/packages/clients/src/api/vpcgw/v1/api.gen.ts @@ -105,8 +105,8 @@ const jsonContentHeaders = { /** * Public Gateways API. - * - * This API allows you to manage your Public Gateways. + +This API allows you to manage your Public Gateways. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -148,9 +148,7 @@ export class API extends ParentAPI { ) /** - * List Public Gateways. List Public Gateways in a given Scaleway Organization - * or Project. By default, results are displayed in ascending order of - * creation date. + * List Public Gateways. List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date. * * @param request - The request {@link ListGatewaysRequest} * @returns A Promise of ListGatewaysResponse @@ -159,9 +157,7 @@ export class API extends ParentAPI { enrichForPagination('gateways', this.pageOfListGateways, request) /** - * Get a Public Gateway. Get details of a Public Gateway, specified by its - * gateway ID. The response object contains full details of the gateway, - * including its **name**, **type**, **status** and more. + * Get a Public Gateway. Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its **name**, **type**, **status** and more. * * @param request - The request {@link GetGatewayRequest} * @returns A Promise of Gateway @@ -198,9 +194,7 @@ export class API extends ParentAPI { ) /** - * Create a Public Gateway. Create a new Public Gateway in the specified - * Scaleway Project, defining its **name**, **type** and other configuration - * details such as whether to enable SSH bastion. + * Create a Public Gateway. Create a new Public Gateway in the specified Scaleway Project, defining its **name**, **type** and other configuration details such as whether to enable SSH bastion. * * @param request - The request {@link CreateGatewayRequest} * @returns A Promise of Gateway @@ -219,9 +213,7 @@ export class API extends ParentAPI { ) /** - * Update a Public Gateway. Update the parameters of an existing Public - * Gateway, for example, its **name**, **tags**, **SSH bastion - * configuration**, and **DNS servers**. + * Update a Public Gateway. Update the parameters of an existing Public Gateway, for example, its **name**, **tags**, **SSH bastion configuration**, and **DNS servers**. * * @param request - The request {@link UpdateGatewayRequest} * @returns A Promise of Gateway @@ -240,8 +232,7 @@ export class API extends ParentAPI { ) /** - * Delete a Public Gateway. Delete an existing Public Gateway, specified by - * its gateway ID. This action is irreversible. + * Delete a Public Gateway. Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible. * * @param request - The request {@link DeleteGatewayRequest} */ @@ -253,11 +244,7 @@ export class API extends ParentAPI { }) /** - * Upgrade a Public Gateway to the latest version and/or to a different - * commercial offer type. Upgrade a given Public Gateway to the newest - * software version or to a different commercial offer type. This applies the - * latest bugfixes and features to your Public Gateway. Note that gateway - * service will be interrupted during the update. + * Upgrade a Public Gateway to the latest version and/or to a different commercial offer type. Upgrade a given Public Gateway to the newest software version or to a different commercial offer type. This applies the latest bugfixes and features to your Public Gateway. Note that gateway service will be interrupted during the update. * * @param request - The request {@link UpgradeGatewayRequest} * @returns A Promise of Gateway @@ -276,9 +263,7 @@ export class API extends ParentAPI { ) /** - * Upgrade a Public Gateway to IP mobility. Upgrade a Public Gateway to IP - * mobility (move from NAT IP to routed IP). This is idempotent: repeated - * calls after the first will return no error but have no effect. + * Upgrade a Public Gateway to IP mobility. Upgrade a Public Gateway to IP mobility (move from NAT IP to routed IP). This is idempotent: repeated calls after the first will return no error but have no effect. * * @param request - The request {@link EnableIPMobilityRequest} */ @@ -315,14 +300,7 @@ export class API extends ParentAPI { ) /** - * List Public Gateway connections to Private Networks. List the connections - * between Public Gateways and Private Networks (a connection = a - * GatewayNetwork). You can choose to filter by `gateway-id` to list all - * Private Networks attached to the specified Public Gateway, or by - * `private_network_id` to list all Public Gateways attached to the specified - * Private Network. Other query parameters are also available. The result is - * an array of GatewayNetwork objects, each giving details of the connection - * between a given Public Gateway and a given Private Network. + * List Public Gateway connections to Private Networks. List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by `gateway-id` to list all Private Networks attached to the specified Public Gateway, or by `private_network_id` to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network. * * @param request - The request {@link ListGatewayNetworksRequest} * @returns A Promise of ListGatewayNetworksResponse @@ -335,12 +313,7 @@ export class API extends ParentAPI { ) /** - * Get a Public Gateway connection to a Private Network. Get details of a - * given connection between a Public Gateway and a Private Network (this - * connection = a GatewayNetwork), specified by its `gateway_network_id`. The - * response object contains details of the connection including the IDs of the - * Public Gateway and Private Network, the dates the connection was - * created/updated and its configuration settings. + * Get a Public Gateway connection to a Private Network. Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its `gateway_network_id`. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings. * * @param request - The request {@link GetGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -377,10 +350,7 @@ export class API extends ParentAPI { ) /** - * Attach a Public Gateway to a Private Network. Attach a specific Public - * Gateway to a specific Private Network (create a GatewayNetwork). You can - * configure parameters for the connection including DHCP settings, whether to - * enable masquerade (dynamic NAT), and more. + * Attach a Public Gateway to a Private Network. Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including DHCP settings, whether to enable masquerade (dynamic NAT), and more. * * @param request - The request {@link CreateGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -399,11 +369,7 @@ export class API extends ParentAPI { ) /** - * Update a Public Gateway's connection to a Private Network. Update the - * configuration parameters of a connection between a given Public Gateway and - * Private Network (the connection = a GatewayNetwork). Updatable parameters - * include DHCP settings and whether to enable traffic masquerade (dynamic - * NAT). + * Update a Public Gateway's connection to a Private Network. Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include DHCP settings and whether to enable traffic masquerade (dynamic NAT). * * @param request - The request {@link UpdateGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -422,9 +388,7 @@ export class API extends ParentAPI { ) /** - * Detach a Public Gateway from a Private Network. Detach a given Public - * Gateway from a given Private Network, i.e. delete a GatewayNetwork - * specified by a gateway_network_id. + * Detach a Public Gateway from a Private Network. Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id. * * @param request - The request {@link DeleteGatewayNetworkRequest} */ @@ -457,14 +421,7 @@ export class API extends ParentAPI { ) /** - * List DHCP configurations. List DHCP configurations, optionally filtering by - * Organization, Project, Public Gateway IP address or more. The response is - * an array of DHCP configuration objects, each identified by a DHCP ID and - * containing configuration settings for the assignment of IP addresses to - * devices on a Private Network attached to a Public Gateway. Note that the - * response does not contain the IDs of any Private Network / Public Gateway - * the configuration is attached to. Use the `List Public Gateway connections - * to Private Networks` method for that purpose, filtering on DHCP ID. + * List DHCP configurations. List DHCP configurations, optionally filtering by Organization, Project, Public Gateway IP address or more. The response is an array of DHCP configuration objects, each identified by a DHCP ID and containing configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID. * * @param request - The request {@link ListDHCPsRequest} * @returns A Promise of ListDHCPsResponse @@ -473,13 +430,7 @@ export class API extends ParentAPI { enrichForPagination('dhcps', this.pageOfListDHCPs, request) /** - * Get a DHCP configuration. Get a DHCP configuration object, identified by - * its DHCP ID. The response object contains configuration settings for the - * assignment of IP addresses to devices on a Private Network attached to a - * Public Gateway. Note that the response does not contain the IDs of any - * Private Network / Public Gateway the configuration is attached to. Use the - * `List Public Gateway connections to Private Networks` method for that - * purpose, filtering on DHCP ID. + * Get a DHCP configuration. Get a DHCP configuration object, identified by its DHCP ID. The response object contains configuration settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. Note that the response does not contain the IDs of any Private Network / Public Gateway the configuration is attached to. Use the `List Public Gateway connections to Private Networks` method for that purpose, filtering on DHCP ID. * * @param request - The request {@link GetDHCPRequest} * @returns A Promise of DHCP @@ -494,13 +445,7 @@ export class API extends ParentAPI { ) /** - * Create a DHCP configuration. Create a new DHCP configuration object, - * containing settings for the assignment of IP addresses to devices on a - * Private Network attached to a Public Gateway. The response object includes - * the ID of the DHCP configuration object. You can use this ID as part of a - * call to `Create a Public Gateway connection to a Private Network` or - * `Update a Public Gateway connection to a Private Network` to directly apply - * this DHCP configuration. + * Create a DHCP configuration. Create a new DHCP configuration object, containing settings for the assignment of IP addresses to devices on a Private Network attached to a Public Gateway. The response object includes the ID of the DHCP configuration object. You can use this ID as part of a call to `Create a Public Gateway connection to a Private Network` or `Update a Public Gateway connection to a Private Network` to directly apply this DHCP configuration. * * @param request - The request {@link CreateDHCPRequest} * @returns A Promise of DHCP @@ -519,8 +464,7 @@ export class API extends ParentAPI { ) /** - * Update a DHCP configuration. Update a DHCP configuration object, identified - * by its DHCP ID. + * Update a DHCP configuration. Update a DHCP configuration object, identified by its DHCP ID. * * @param request - The request {@link UpdateDHCPRequest} * @returns A Promise of DHCP @@ -539,9 +483,7 @@ export class API extends ParentAPI { ) /** - * Delete a DHCP configuration. Delete a DHCP configuration object, identified - * by its DHCP ID. Note that you cannot delete a DHCP configuration object - * that is currently being used by a Gateway Network. + * Delete a DHCP configuration. Delete a DHCP configuration object, identified by its DHCP ID. Note that you cannot delete a DHCP configuration object that is currently being used by a Gateway Network. * * @param request - The request {@link DeleteDHCPRequest} */ @@ -576,9 +518,7 @@ export class API extends ParentAPI { ) /** - * List DHCP entries. List DHCP entries, whether dynamically assigned and/or - * statically reserved. DHCP entries can be filtered by the Gateway Network - * they are on, their MAC address, IP address, type or hostname. + * List DHCP entries. List DHCP entries, whether dynamically assigned and/or statically reserved. DHCP entries can be filtered by the Gateway Network they are on, their MAC address, IP address, type or hostname. * * @param request - The request {@link ListDHCPEntriesRequest} * @returns A Promise of ListDHCPEntriesResponse @@ -602,11 +542,7 @@ export class API extends ParentAPI { ) /** - * Create a DHCP entry. Create a static DHCP reservation, specifying the - * Gateway Network for the reservation, the MAC address of the target device - * and the IP address to assign this device. The response is a DHCP entry - * object, confirming the ID and configuration details of the static DHCP - * reservation. + * Create a DHCP entry. Create a static DHCP reservation, specifying the Gateway Network for the reservation, the MAC address of the target device and the IP address to assign this device. The response is a DHCP entry object, confirming the ID and configuration details of the static DHCP reservation. * * @param request - The request {@link CreateDHCPEntryRequest} * @returns A Promise of DHCPEntry @@ -625,11 +561,7 @@ export class API extends ParentAPI { ) /** - * Update a DHCP entry. Update the IP address for a DHCP entry, specified by - * its DHCP entry ID. You can update an existing DHCP entry of any type - * (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually - * updating the IP address the entry will necessarily be of type `reservation` - * after the update. + * Update a DHCP entry. Update the IP address for a DHCP entry, specified by its DHCP entry ID. You can update an existing DHCP entry of any type (`reservation` (static), `lease` (dynamic) or `unknown`), but in manually updating the IP address the entry will necessarily be of type `reservation` after the update. * * @param request - The request {@link UpdateDHCPEntryRequest} * @returns A Promise of DHCPEntry @@ -648,10 +580,7 @@ export class API extends ParentAPI { ) /** - * Set all DHCP reservations on a Gateway Network. Set the list of DHCP - * reservations attached to a Gateway Network. Reservations are identified by - * their MAC address, and will sync the current DHCP entry list to the given - * list, creating, updating or deleting DHCP entries accordingly. + * Set all DHCP reservations on a Gateway Network. Set the list of DHCP reservations attached to a Gateway Network. Reservations are identified by their MAC address, and will sync the current DHCP entry list to the given list, creating, updating or deleting DHCP entries accordingly. * * @param request - The request {@link SetDHCPEntriesRequest} * @returns A Promise of SetDHCPEntriesResponse @@ -670,9 +599,7 @@ export class API extends ParentAPI { ) /** - * Delete a DHCP entry. Delete a static DHCP reservation, identified by its - * DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`, - * these are deleted automatically when their time-to-live expires. + * Delete a DHCP entry. Delete a static DHCP reservation, identified by its DHCP entry ID. Note that you cannot delete DHCP entries of type `lease`, these are deleted automatically when their time-to-live expires. * * @param request - The request {@link DeleteDHCPEntryRequest} */ @@ -705,9 +632,7 @@ export class API extends ParentAPI { ) /** - * List PAT rules. List PAT rules. You can filter by gateway ID to list all - * PAT rules for a particular gateway, or filter for PAT rules targeting a - * specific IP address or using a specific protocol. + * List PAT rules. List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol. * * @param request - The request {@link ListPATRulesRequest} * @returns A Promise of ListPATRulesResponse @@ -716,10 +641,7 @@ export class API extends ParentAPI { enrichForPagination('patRules', this.pageOfListPATRules, request) /** - * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response - * object gives full details of the PAT rule, including the Public Gateway it - * belongs to and the configuration settings in terms of public / private - * ports, private IP and protocol. + * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response object gives full details of the PAT rule, including the Public Gateway it belongs to and the configuration settings in terms of public / private ports, private IP and protocol. * * @param request - The request {@link GetPATRuleRequest} * @returns A Promise of PATRule @@ -734,9 +656,7 @@ export class API extends ParentAPI { ) /** - * Create a PAT rule. Create a new PAT rule on a specified Public Gateway, - * defining the protocol to use, public port to listen on, and private port / - * IP address to map to. + * Create a PAT rule. Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to. * * @param request - The request {@link CreatePATRuleRequest} * @returns A Promise of PATRule @@ -755,9 +675,7 @@ export class API extends ParentAPI { ) /** - * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. - * Configuration settings including private/public port, private IP address - * and protocol can all be updated. + * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated. * * @param request - The request {@link UpdatePATRuleRequest} * @returns A Promise of PATRule @@ -776,10 +694,7 @@ export class API extends ParentAPI { ) /** - * Set all PAT rules. Set a definitive list of PAT rules attached to a Public - * Gateway. Each rule is identified by its public port and protocol. This will - * sync the current PAT rule list on the gateway with the new list, creating, - * updating or deleting PAT rules accordingly. + * Set all PAT rules. Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly. * * @param request - The request {@link SetPATRulesRequest} * @returns A Promise of SetPATRulesResponse @@ -798,8 +713,7 @@ export class API extends ParentAPI { ) /** - * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This - * action is irreversible. + * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This action is irreversible. * * @param request - The request {@link DeletePATRuleRequest} */ @@ -810,9 +724,7 @@ export class API extends ParentAPI { }) /** - * List Public Gateway types. List the different Public Gateway commercial - * offer types available at Scaleway. The response is an array of objects - * describing the name and technical details of each available gateway type. + * List Public Gateway types. List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type. * * @param request - The request {@link ListGatewayTypesRequest} * @returns A Promise of ListGatewayTypesResponse @@ -849,8 +761,7 @@ export class API extends ParentAPI { ) /** - * List IPs. List Public Gateway flexible IP addresses. A number of filter - * options are available for limiting results in the response. + * List IPs. List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response. * * @param request - The request {@link ListIPsRequest} * @returns A Promise of ListIPsResponse @@ -859,10 +770,7 @@ export class API extends ParentAPI { enrichForPagination('ips', this.pageOfListIPs, request) /** - * Get an IP. Get details of a Public Gateway flexible IP address, identified - * by its IP ID. The response object contains information including which (if - * any) Public Gateway using this IP address, the reverse and various other - * metadata. + * Get an IP. Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata. * * @param request - The request {@link GetIPRequest} * @returns A Promise of IP @@ -877,8 +785,7 @@ export class API extends ParentAPI { ) /** - * Reserve an IP. Create (reserve) a new flexible IP address that can be used - * for a Public Gateway in a specified Scaleway Project. + * Reserve an IP. Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project. * * @param request - The request {@link CreateIPRequest} * @returns A Promise of IP @@ -897,8 +804,7 @@ export class API extends ParentAPI { ) /** - * Update an IP. Update details of an existing flexible IP address, including - * its tags, reverse and the Public Gateway it is assigned to. + * Update an IP. Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to. * * @param request - The request {@link UpdateIPRequest} * @returns A Promise of IP @@ -917,8 +823,7 @@ export class API extends ParentAPI { ) /** - * Delete an IP. Delete a flexible IP address from your account. This action - * is irreversible. + * Delete an IP. Delete a flexible IP address from your account. This action is irreversible. * * @param request - The request {@link DeleteIPRequest} */ @@ -929,9 +834,7 @@ export class API extends ParentAPI { }) /** - * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public - * Gateway, specified by its gateway ID. This adds any new SSH keys in the - * gateway's Scaleway Project to the gateway itself. + * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself. * * @param request - The request {@link RefreshSSHKeysRequest} * @returns A Promise of Gateway @@ -948,9 +851,7 @@ export class API extends ParentAPI { ) /** - * Put a Public Gateway in IPAM mode. Put a Public Gateway in IPAM mode, so - * that it can be used with the Public Gateways API v2. This call is - * idempotent. + * Put a Public Gateway in IPAM mode. Put a Public Gateway in IPAM mode, so that it can be used with the Public Gateways API v2. This call is idempotent. * * @param request - The request {@link MigrateToV2Request} */ diff --git a/packages/clients/src/api/vpcgw/v1/types.gen.ts b/packages/clients/src/api/vpcgw/v1/types.gen.ts index 7aff5d8af..d22cd20e8 100644 --- a/packages/clients/src/api/vpcgw/v1/types.gen.ts +++ b/packages/clients/src/api/vpcgw/v1/types.gen.ts @@ -72,957 +72,1375 @@ export type ListPATRulesRequestOrderBy = export type PATRuleProtocol = 'unknown' | 'both' | 'tcp' | 'udp' export interface DHCP { - /** ID of the DHCP config. */ + /** + * ID of the DHCP config. + */ id: string - /** Owning Organization. */ + /** + * Owning Organization. + */ organizationId: string - /** Owning Project. */ + /** + * Owning Project. + */ projectId: string - /** Date the DHCP configuration was created. */ + /** + * Date the DHCP configuration was created. + */ createdAt?: Date - /** Configuration last modification date. */ + /** + * Configuration last modification date. + */ updatedAt?: Date - /** Subnet for the DHCP server. */ + /** + * Subnet for the DHCP server. + */ subnet: string /** - * IP address of the DHCP server. This will be the Public Gateway's address in - * the Private Network. It must be part of config's subnet. + * IP address of the DHCP server. This will be the Public Gateway's address in the Private Network. It must be part of config's subnet. */ address: string /** - * Low IP (inclusive) of the dynamic address pool. Must be in the config's - * subnet. + * Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet. */ poolLow: string /** - * High IP (inclusive) of the dynamic address pool. Must be in the config's - * subnet. + * High IP (inclusive) of the dynamic address pool. Must be in the config's subnet. */ poolHigh: string /** - * Defines whether to enable dynamic pooling of IPs. When false, only - * pre-existing DHCP reservations will be handed out. + * Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. */ enableDynamic: boolean - /** How long DHCP entries will be valid for. */ + /** + * How long DHCP entries will be valid for. + */ validLifetime?: string /** - * After how long a renew will be attempted. Must be 30s lower than - * `rebind_timer`. + * After how long a renew will be attempted. Must be 30s lower than `rebind_timer`. */ renewTimer?: string /** - * After how long a DHCP client will query for a new lease if previous renews - * fail. Must be 30s lower than `valid_lifetime`. + * After how long a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. */ rebindTimer?: string /** - * Defines whether the gateway should push a default route to DHCP clients, or - * only hand out IPs. + * Defines whether the gateway should push a default route to DHCP clients, or only hand out IPs. */ pushDefaultRoute: boolean /** - * Defines whether the gateway should push custom DNS servers to clients. This - * allows for instance hostname -> IP resolution. + * Defines whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. */ pushDnsServer: boolean /** - * Array of DNS server IP addresses used to override the DNS server list - * pushed to DHCP clients, instead of the gateway itself. + * Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself. */ dnsServersOverride: string[] - /** Array of search paths in addition to the pushed DNS configuration. */ + /** + * Array of search paths in addition to the pushed DNS configuration. + */ dnsSearch: string[] /** - * TLD given to hostnames in the Private Networks. If an Instance with - * hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will - * resolve. + * TLD given to hostnames in the Private Networks. If an Instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. */ dnsLocalName: string - /** Zone of this DHCP configuration. */ + /** + * Zone of this DHCP configuration. + */ zone: ScwZone } export interface IpamConfig { - /** Defines whether the default route is enabled on that Gateway Network. */ + /** + * Defines whether the default route is enabled on that Gateway Network. + */ pushDefaultRoute: boolean - /** IPAM-booked IP ID as the Gateway's IP in this Private Network. */ + /** + * IPAM-booked IP ID as the Gateway's IP in this Private Network. + */ ipamIpId: string } export interface GatewayNetwork { - /** ID of the Public Gateway-Private Network connection. */ + /** + * ID of the Public Gateway-Private Network connection. + */ id: string - /** Connection creation date. */ + /** + * Connection creation date. + */ createdAt?: Date - /** Connection last modification date. */ + /** + * Connection last modification date. + */ updatedAt?: Date - /** ID of the connected Public Gateway. */ + /** + * ID of the connected Public Gateway. + */ gatewayId: string - /** ID of the connected Private Network. */ + /** + * ID of the connected Private Network. + */ privateNetworkId: string /** - * MAC address of the gateway in the Private Network (if the gateway is up and - * running). + * MAC address of the gateway in the Private Network (if the gateway is up and running). */ macAddress?: string /** - * Defines whether the gateway masquerades traffic for this Private Network - * (Dynamic NAT). + * Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT). */ enableMasquerade: boolean - /** Current status of the Public Gateway's connection to the Private Network. */ + /** + * Current status of the Public Gateway's connection to the Private Network. + */ status: GatewayNetworkStatus - /** DHCP configuration for the connected Private Network. */ + /** + * DHCP configuration for the connected Private Network. + */ dhcp?: DHCP - /** Defines whether DHCP is enabled on the connected Private Network. */ + /** + * Defines whether DHCP is enabled on the connected Private Network. + */ enableDhcp: boolean - /** Address of the Gateway (in CIDR form) to use when DHCP is not used. */ + /** + * Address of the Gateway (in CIDR form) to use when DHCP is not used. + */ address?: string - /** IPAM IP configuration used. */ + /** + * IPAM IP configuration used. + */ ipamConfig?: IpamConfig - /** Zone of the GatewayNetwork connection. */ + /** + * Zone of the GatewayNetwork connection. + */ zone: ScwZone } export interface GatewayType { - /** Public Gateway type name. */ + /** + * Public Gateway type name. + */ name: string /** - * Bandwidth, in bps, of the Public Gateway. This is the public bandwidth to - * the outer Internet, and the internal bandwidth to each connected Private - * Networks. + * Bandwidth, in bps, of the Public Gateway. This is the public bandwidth to the outer Internet, and the internal bandwidth to each connected Private Networks. */ bandwidth: number - /** Zone the Public Gateway type is available in. */ + /** + * Zone the Public Gateway type is available in. + */ zone: ScwZone } export interface IP { - /** IP address ID. */ + /** + * IP address ID. + */ id: string - /** Owning Organization. */ + /** + * Owning Organization. + */ organizationId: string - /** Owning Project. */ + /** + * Owning Project. + */ projectId: string - /** IP address creation date. */ + /** + * IP address creation date. + */ createdAt?: Date - /** IP address last modification date. */ + /** + * IP address last modification date. + */ updatedAt?: Date - /** Tags associated with the IP address. */ + /** + * Tags associated with the IP address. + */ tags: string[] - /** The IP address itself. */ + /** + * The IP address itself. + */ address: string - /** Reverse domain name for the IP address. */ + /** + * Reverse domain name for the IP address. + */ reverse?: string - /** Public Gateway associated with the IP address. */ + /** + * Public Gateway associated with the IP address. + */ gatewayId?: string - /** Zone of the IP address. */ + /** + * Zone of the IP address. + */ zone: ScwZone } export type CreateDHCPRequest = { - /** 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 to create the DHCP configuration in. */ + /** + * Project to create the DHCP configuration in. + */ projectId?: string - /** Subnet for the DHCP server. */ + /** + * Subnet for the DHCP server. + */ subnet: string /** - * IP address of the DHCP server. This will be the gateway's address in the - * Private Network. Defaults to the first address of the subnet. + * IP address of the DHCP server. This will be the gateway's address in the Private Network. Defaults to the first address of the subnet. */ address?: string /** - * Low IP (inclusive) of the dynamic address pool. Must be in the config's - * subnet. Defaults to the second address of the subnet. + * Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the second address of the subnet. */ poolLow?: string /** - * High IP (inclusive) of the dynamic address pool. Must be in the config's - * subnet. Defaults to the last address of the subnet. + * High IP (inclusive) of the dynamic address pool. Must be in the config's subnet. Defaults to the last address of the subnet. */ poolHigh?: string /** - * Defines whether to enable dynamic pooling of IPs. When false, only - * pre-existing DHCP reservations will be handed out. Defaults to true. + * Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true. */ enableDynamic?: boolean - /** How long DHCP entries will be valid for. Defaults to 1h (3600s). */ + /** + * How long DHCP entries will be valid for. Defaults to 1h (3600s). + */ validLifetime?: string /** - * After how long a renew will be attempted. Must be 30s lower than - * `rebind_timer`. Defaults to 50m (3000s). + * After how long a renew will be attempted. Must be 30s lower than `rebind_timer`. Defaults to 50m (3000s). */ renewTimer?: string /** - * After how long a DHCP client will query for a new lease if previous renews - * fail. Must be 30s lower than `valid_lifetime`. Defaults to 51m (3060s). + * After how long a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. Defaults to 51m (3060s). */ rebindTimer?: string /** - * Defines whether the gateway should push a default route to DHCP clients or - * only hand out IPs. Defaults to true. + * Defines whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true. */ pushDefaultRoute?: boolean /** - * Defines whether the gateway should push custom DNS servers to clients. This - * allows for Instance hostname -> IP resolution. Defaults to true. + * Defines whether the gateway should push custom DNS servers to clients. This allows for Instance hostname -> IP resolution. Defaults to true. */ pushDnsServer?: boolean /** - * Array of DNS server IP addresses used to override the DNS server list - * pushed to DHCP clients, instead of the gateway itself. + * Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself. */ dnsServersOverride?: string[] - /** Array of search paths in addition to the pushed DNS configuration. */ + /** + * Array of search paths in addition to the pushed DNS configuration. + */ dnsSearch?: string[] /** - * TLD given to hostnames in the Private Network. Allowed characters are - * `a-z0-9-.`. Defaults to the slugified Private Network name if created along - * a GatewayNetwork, or else to `priv`. + * TLD given to hostnames in the Private Network. Allowed characters are `a-z0-9-.`. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to `priv`. */ dnsLocalName?: string } export interface CreateGatewayNetworkRequestIpamConfig { - /** Enabling the default route also enables masquerading. */ + /** + * Enabling the default route also enables masquerading. + */ pushDefaultRoute: boolean - /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */ + /** + * Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. + */ ipamIpId?: string } export interface DHCPEntry { - /** DHCP entry ID. */ + /** + * DHCP entry ID. + */ id: string - /** DHCP entry creation date. */ + /** + * DHCP entry creation date. + */ createdAt?: Date - /** DHCP entry last modification date. */ + /** + * DHCP entry last modification date. + */ updatedAt?: Date - /** Owning GatewayNetwork. */ + /** + * Owning GatewayNetwork. + */ gatewayNetworkId: string - /** MAC address of the client device. */ + /** + * MAC address of the client device. + */ macAddress: string - /** Assigned IP address. */ + /** + * Assigned IP address. + */ ipAddress: string - /** Hostname of the client device. */ + /** + * Hostname of the client device. + */ hostname: string - /** Entry type, either static (DHCP reservation) or dynamic (DHCP lease). */ + /** + * Entry type, either static (DHCP reservation) or dynamic (DHCP lease). + */ type: DHCPEntryType - /** Zone of this DHCP entry. */ + /** + * Zone of this DHCP entry. + */ zone: ScwZone } export interface Gateway { - /** ID of the gateway. */ + /** + * ID of the gateway. + */ id: string - /** Owning Organization. */ + /** + * Owning Organization. + */ organizationId: string - /** Owning Project. */ + /** + * Owning Project. + */ projectId: string - /** Gateway creation date. */ + /** + * Gateway creation date. + */ createdAt?: Date - /** Gateway last modification date. */ + /** + * Gateway last modification date. + */ updatedAt?: Date - /** Gateway type (commercial offer). */ + /** + * Gateway type (commercial offer). + */ type?: GatewayType - /** Current status of the gateway. */ + /** + * Current status of the gateway. + */ status: GatewayStatus - /** Name of the gateway. */ + /** + * Name of the gateway. + */ name: string - /** Tags associated with the gateway. */ + /** + * Tags associated with the gateway. + */ tags: string[] - /** Public IP address of the gateway. */ + /** + * Public IP address of the gateway. + */ ip?: IP /** - * GatewayNetwork objects attached to the gateway (each one represents a - * connection to a Private Network). + * GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network). */ gatewayNetworks: GatewayNetwork[] /** - * Array of DNS server IP addresses to override the gateway's default - * recursive DNS servers. + * Array of DNS server IP addresses to override the gateway's default recursive DNS servers. */ upstreamDnsServers: string[] - /** Version of the running gateway software. */ + /** + * Version of the running gateway software. + */ version?: string - /** Newly available gateway software version that can be updated to. */ + /** + * Newly available gateway software version that can be updated to. + */ canUpgradeTo?: string - /** Defines whether SSH bastion is enabled on the gateway. */ + /** + * Defines whether SSH bastion is enabled on the gateway. + */ bastionEnabled: boolean - /** Port of the SSH bastion. */ + /** + * Port of the SSH bastion. + */ bastionPort: number - /** Defines whether SMTP traffic is allowed to pass through the gateway. */ + /** + * Defines whether SMTP traffic is allowed to pass through the gateway. + */ smtpEnabled: boolean - /** Defines whether the gateway uses non-IPAM IP configurations. */ + /** + * Defines whether the gateway uses non-IPAM IP configurations. + */ isLegacy: boolean /** - * Defines whether the gateway uses routed IPs (IP mobility) instead of NAT - * IPs. + * Defines whether the gateway uses routed IPs (IP mobility) instead of NAT IPs. */ ipMobilityEnabled: boolean - /** Zone of the gateway. */ + /** + * Zone of the gateway. + */ zone: ScwZone } export interface PATRule { - /** PAT rule ID. */ + /** + * PAT rule ID. + */ id: string - /** Gateway the PAT rule applies to. */ + /** + * Gateway the PAT rule applies to. + */ gatewayId: string - /** PAT rule creation date. */ + /** + * PAT rule creation date. + */ createdAt?: Date - /** PAT rule last modification date. */ + /** + * PAT rule last modification date. + */ updatedAt?: Date - /** Public port to listen on. */ + /** + * Public port to listen on. + */ publicPort: number - /** Private IP address to forward data to. */ + /** + * Private IP address to forward data to. + */ privateIp: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort: number - /** Protocol the rule applies to. */ + /** + * Protocol the rule applies to. + */ protocol: PATRuleProtocol - /** Zone of the PAT rule. */ + /** + * Zone of the PAT rule. + */ zone: ScwZone } export interface SetDHCPEntriesRequestEntry { /** - * MAC address to give a static entry to. A matching entry will be upgraded to - * a reservation, and a matching reservation will be updated. + * MAC address to give a static entry to. A matching entry will be upgraded to a reservation, and a matching reservation will be updated. */ macAddress: string - /** IP address to give to the device. */ + /** + * IP address to give to the device. + */ ipAddress: string } export interface SetPATRulesRequestRule { /** - * Public port to listen on. Uniquely identifies the rule, and a matching rule - * will be updated with the new parameters. + * Public port to listen on. Uniquely identifies the rule, and a matching rule will be updated with the new parameters. */ publicPort: number - /** Private IP to forward data to. */ + /** + * Private IP to forward data to. + */ privateIp: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort: number - /** Protocol the rule should apply to. */ + /** + * Protocol the rule should apply to. + */ protocol: PATRuleProtocol } export interface UpdateGatewayNetworkRequestIpamConfig { - /** Enabling the default route also enables masquerading. */ + /** + * Enabling the default route also enables masquerading. + */ pushDefaultRoute?: boolean - /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */ + /** + * Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. + */ ipamIpId?: string } export type CreateDHCPEntryRequest = { - /** 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 - /** GatewayNetwork on which to create a DHCP reservation. */ + /** + * GatewayNetwork on which to create a DHCP reservation. + */ gatewayNetworkId: string - /** MAC address to give a static entry to. */ + /** + * MAC address to give a static entry to. + */ macAddress: string - /** IP address to give to the device. */ + /** + * IP address to give to the device. + */ ipAddress: string } export type CreateGatewayNetworkRequest = { - /** 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 - /** Public Gateway to connect. */ + /** + * Public Gateway to connect. + */ gatewayId: string - /** Private Network to connect. */ + /** + * Private Network to connect. + */ privateNetworkId: string - /** Note: this setting is ignored when passing `ipam_config`. */ + /** + * Note: this setting is ignored when passing `ipam_config`. + */ enableMasquerade: boolean /** - * Defaults to `true` if either `dhcp_id` or `dhcp` are present. If set to - * `true`, either `dhcp_id` or `dhcp` must be present. Note: this setting is - * ignored when passing `ipam_config`. + * Defaults to `true` if either `dhcp_id` or `dhcp` are present. If set to `true`, either `dhcp_id` or `dhcp` must be present. +Note: this setting is ignored when passing `ipam_config`. */ enableDhcp?: boolean /** * ID of an existing DHCP configuration object to use for this GatewayNetwork. * - * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', - * 'ipamConfig' could be set. + * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set. */ dhcpId?: string /** * New DHCP configuration object to use for this GatewayNetwork. * - * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', - * 'ipamConfig' could be set. + * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set. */ dhcp?: CreateDHCPRequest /** - * Static IP address in CIDR format to to use without DHCP. + * Static IP address in CIDR format to use without DHCP. * - * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', - * 'ipamConfig' could be set. + * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set. */ address?: string /** - * Note: all or none of the GatewayNetworks for a single gateway can use the - * IPAM. DHCP and IPAM configurations cannot be mixed. Some products may - * require that the Public Gateway uses the IPAM, to ensure correct - * functionality. + * Note: all or none of the GatewayNetworks for a single gateway can use the IPAM. DHCP and IPAM configurations cannot be mixed. Some products may require that the Public Gateway uses the IPAM, to ensure correct functionality. * - * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', - * 'ipamConfig' could be set. + * One-of ('ipConfig'): at most one of 'dhcpId', 'dhcp', 'address', 'ipamConfig' could be set. */ ipamConfig?: CreateGatewayNetworkRequestIpamConfig } export type CreateGatewayRequest = { - /** 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 Project to create the gateway in. */ + /** + * Scaleway Project to create the gateway in. + */ projectId?: string - /** Name for the gateway. */ + /** + * Name for the gateway. + */ name?: string - /** Tags for the gateway. */ + /** + * Tags for the gateway. + */ tags?: string[] - /** Gateway type (commercial offer type). */ + /** + * Gateway type (commercial offer type). + */ type: string /** - * Array of DNS server IP addresses to override the gateway's default - * recursive DNS servers. + * Array of DNS server IP addresses to override the gateway's default recursive DNS servers. */ upstreamDnsServers?: string[] - /** Existing IP address to attach to the gateway. */ + /** + * Existing IP address to attach to the gateway. + */ ipId?: string - /** Defines whether SMTP traffic should be allowed pass through the gateway. */ + /** + * Defines whether SMTP traffic should be allowed pass through the gateway. + */ enableSmtp: boolean - /** Defines whether SSH bastion should be enabled the gateway. */ + /** + * Defines whether SSH bastion should be enabled the gateway. + */ enableBastion: boolean - /** Port of the SSH bastion. */ + /** + * Port of the SSH bastion. + */ bastionPort?: number } 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 - /** Project to create the IP address in. */ + /** + * Project to create the IP address in. + */ projectId?: string - /** Tags to give to the IP address. */ + /** + * Tags to give to the IP address. + */ tags?: string[] } export type CreatePATRuleRequest = { - /** 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 Gateway on which to create the rule. */ + /** + * ID of the Gateway on which to create the rule. + */ gatewayId: string - /** Public port to listen on. */ + /** + * Public port to listen on. + */ publicPort: number - /** Private IP to forward data to. */ + /** + * Private IP to forward data to. + */ privateIp: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort: number - /** Protocol the rule should apply to. */ + /** + * Protocol the rule should apply to. + */ protocol?: PATRuleProtocol } export type DeleteDHCPEntryRequest = { - /** 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 DHCP entry to delete. */ + /** + * ID of the DHCP entry to delete. + */ dhcpEntryId: string } export type DeleteDHCPRequest = { - /** 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 - /** DHCP configuration ID to delete. */ + /** + * DHCP configuration ID to delete. + */ dhcpId: string } export type DeleteGatewayNetworkRequest = { - /** 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 GatewayNetwork to delete. */ + /** + * ID of the GatewayNetwork to delete. + */ gatewayNetworkId: string /** - * Defines whether to clean up attached DHCP configurations (if any, and if - * not attached to another Gateway Network). + * Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network). */ cleanupDhcp: boolean } export type DeleteGatewayRequest = { - /** 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 gateway to delete. */ + /** + * ID of the gateway to delete. + */ gatewayId: string /** - * Defines whether to clean up attached DHCP configurations (if any, and if - * not attached to another Gateway Network). + * Defines whether to clean up attached DHCP configurations (if any, and if not attached to another Gateway Network). */ cleanupDhcp: boolean } 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 of the IP address to delete. */ + /** + * ID of the IP address to delete. + */ ipId: string } export type DeletePATRuleRequest = { - /** 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 PAT rule to delete. */ + /** + * ID of the PAT rule to delete. + */ patRuleId: string } export type EnableIPMobilityRequest = { - /** 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 gateway to upgrade to IP mobility. */ + /** + * ID of the gateway to upgrade to IP mobility. + */ gatewayId: string } export type GetDHCPEntryRequest = { - /** 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 DHCP entry to fetch. */ + /** + * ID of the DHCP entry to fetch. + */ dhcpEntryId: string } export type GetDHCPRequest = { - /** 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 DHCP configuration to fetch. */ + /** + * ID of the DHCP configuration to fetch. + */ dhcpId: string } export type GetGatewayNetworkRequest = { - /** 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 GatewayNetwork to fetch. */ + /** + * ID of the GatewayNetwork to fetch. + */ gatewayNetworkId: string } export type GetGatewayRequest = { - /** 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 gateway to fetch. */ + /** + * ID of the gateway to fetch. + */ gatewayId: string } 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 - /** ID of the IP address to get. */ + /** + * ID of the IP address to get. + */ ipId: string } export type GetPATRuleRequest = { - /** 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 PAT rule to get. */ + /** + * ID of the PAT rule to get. + */ patRuleId: string } export type ListDHCPEntriesRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListDHCPEntriesRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** DHCP entries per page. */ + /** + * DHCP entries per page. + */ pageSize?: number - /** Filter for entries on this GatewayNetwork. */ + /** + * Filter for entries on this GatewayNetwork. + */ gatewayNetworkId?: string - /** Filter for entries with this MAC address. */ + /** + * Filter for entries with this MAC address. + */ macAddress?: string - /** Filter for entries with this IP address. */ + /** + * Filter for entries with this IP address. + */ ipAddress?: string - /** Filter for entries with this hostname substring. */ + /** + * Filter for entries with this hostname substring. + */ hostname?: string - /** Filter for entries of this type. */ + /** + * Filter for entries of this type. + */ type?: DHCPEntryType } export interface ListDHCPEntriesResponse { - /** DHCP entries in this page. */ + /** + * DHCP entries in this page. + */ dhcpEntries: DHCPEntry[] - /** Total count of DHCP entries matching the filter. */ + /** + * Total count of DHCP entries matching the filter. + */ totalCount: number } export type ListDHCPsRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListDHCPsRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** DHCP configurations per page. */ + /** + * DHCP configurations per page. + */ pageSize?: number - /** Include only DHCP configuration objects in this Organization. */ + /** + * Include only DHCP configuration objects in this Organization. + */ organizationId?: string - /** Include only DHCP configuration objects in this Project. */ + /** + * Include only DHCP configuration objects in this Project. + */ projectId?: string /** - * Filter for DHCP configuration objects with this DHCP server IP address (the - * gateway's address in the Private Network). + * Filter for DHCP configuration objects with this DHCP server IP address (the gateway's address in the Private Network). */ address?: string /** - * Filter for DHCP configuration objects with subnets containing this IP - * address. + * Filter for DHCP configuration objects with subnets containing this IP address. */ hasAddress?: string } export interface ListDHCPsResponse { - /** First page of DHCP configuration objects. */ + /** + * First page of DHCP configuration objects. + */ dhcps: DHCP[] - /** Total count of DHCP configuration objects matching the filter. */ + /** + * Total count of DHCP configuration objects matching the filter. + */ totalCount: number } export type ListGatewayNetworksRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListGatewayNetworksRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** GatewayNetworks per page. */ + /** + * GatewayNetworks per page. + */ pageSize?: number - /** Filter for GatewayNetworks connected to this gateway. */ + /** + * Filter for GatewayNetworks connected to this gateway. + */ gatewayId?: string - /** Filter for GatewayNetworks connected to this Private Network. */ + /** + * Filter for GatewayNetworks connected to this Private Network. + */ privateNetworkId?: string - /** Filter for GatewayNetworks with this `enable_masquerade` setting. */ + /** + * Filter for GatewayNetworks with this `enable_masquerade` setting. + */ enableMasquerade?: boolean - /** Filter for GatewayNetworks using this DHCP configuration. */ + /** + * Filter for GatewayNetworks using this DHCP configuration. + */ dhcpId?: string /** - * Filter for GatewayNetworks with this current status this status. Use - * `unknown` to include all statuses. + * Filter for GatewayNetworks with this current status this status. Use `unknown` to include all statuses. */ status?: GatewayNetworkStatus } export interface ListGatewayNetworksResponse { - /** GatewayNetworks on this page. */ + /** + * GatewayNetworks on this page. + */ gatewayNetworks: GatewayNetwork[] - /** Total GatewayNetworks count matching the filter. */ + /** + * Total GatewayNetworks count matching the filter. + */ totalCount: number } export type ListGatewayTypesRequest = { - /** 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 ListGatewayTypesResponse { - /** Available types of Public Gateway. */ + /** + * Available types of Public Gateway. + */ types: GatewayType[] } export type ListGatewaysRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListGatewaysRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Gateways per page. */ + /** + * Gateways per page. + */ pageSize?: number - /** Include only gateways in this Organization. */ + /** + * Include only gateways in this Organization. + */ organizationId?: string - /** Include only gateways in this Project. */ + /** + * Include only gateways in this Project. + */ projectId?: string - /** Filter for gateways which have this search term in their name. */ + /** + * Filter for gateways which have this search term in their name. + */ name?: string - /** Filter for gateways with these tags. */ + /** + * Filter for gateways with these tags. + */ tags?: string[] - /** Filter for gateways of this type. */ + /** + * Filter for gateways of this type. + */ type?: string /** - * Filter for gateways with this current status. Use `unknown` to include all - * statuses. + * Filter for gateways with this current status. Use `unknown` to include all statuses. */ status?: GatewayStatus - /** Filter for gateways attached to this Private nNetwork. */ + /** + * Filter for gateways attached to this Private nNetwork. + */ privateNetworkId?: string } export interface ListGatewaysResponse { - /** Gateways on this page. */ + /** + * Gateways on this page. + */ gateways: Gateway[] - /** Total count of gateways matching the filter. */ + /** + * Total count of gateways matching the filter. + */ totalCount: number } 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListIPsRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** IP addresses per page. */ + /** + * IP addresses per page. + */ pageSize?: number - /** Filter for IP addresses in this Organization. */ + /** + * Filter for IP addresses in this Organization. + */ organizationId?: string - /** Filter for IP addresses in this Project. */ + /** + * Filter for IP addresses in this Project. + */ projectId?: string - /** Filter for IP addresses with these tags. */ + /** + * Filter for IP addresses with these tags. + */ tags?: string[] - /** Filter for IP addresses that have a reverse containing this string. */ + /** + * Filter for IP addresses that have a reverse containing this string. + */ reverse?: string - /** Filter based on whether the IP is attached to a gateway or not. */ + /** + * Filter based on whether the IP is attached to a gateway or not. + */ isFree?: boolean } export interface ListIPsResponse { - /** IP addresses on this page. */ + /** + * IP addresses on this page. + */ ips: IP[] - /** Total count of IP addresses matching the filter. */ + /** + * Total count of IP addresses matching the filter. + */ totalCount: number } export type ListPATRulesRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListPATRulesRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** PAT rules per page. */ + /** + * PAT rules per page. + */ pageSize?: number - /** Filter for PAT rules on this Gateway. */ + /** + * Filter for PAT rules on this Gateway. + */ gatewayId?: string - /** Filter for PAT rules targeting this private ip. */ + /** + * Filter for PAT rules targeting this private ip. + */ privateIp?: string - /** Filter for PAT rules with this protocol. */ + /** + * Filter for PAT rules with this protocol. + */ protocol?: PATRuleProtocol } export interface ListPATRulesResponse { - /** Array of PAT rules matching the filter. */ + /** + * Array of PAT rules matching the filter. + */ patRules: PATRule[] - /** Total count of PAT rules matching the filter. */ + /** + * Total count of PAT rules matching the filter. + */ totalCount: number } export type MigrateToV2Request = { - /** 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 gateway to put into IPAM mode. */ + /** + * ID of the gateway to put into IPAM mode. + */ gatewayId: string } export type RefreshSSHKeysRequest = { - /** 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 gateway to refresh SSH keys on. */ + /** + * ID of the gateway to refresh SSH keys on. + */ gatewayId: string } export type SetDHCPEntriesRequest = { - /** 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 Gateway Network on which to set DHCP reservation list. */ + /** + * ID of the Gateway Network on which to set DHCP reservation list. + */ gatewayNetworkId: string - /** New list of DHCP reservations. */ + /** + * New list of DHCP reservations. + */ dhcpEntries?: SetDHCPEntriesRequestEntry[] } export interface SetDHCPEntriesResponse { - /** List of DHCP entries. */ + /** + * List of DHCP entries. + */ dhcpEntries: DHCPEntry[] } export type SetPATRulesRequest = { - /** 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 gateway on which to set the PAT rules. */ + /** + * ID of the gateway on which to set the PAT rules. + */ gatewayId: string - /** New list of PAT rules. */ + /** + * New list of PAT rules. + */ patRules: SetPATRulesRequestRule[] } export interface SetPATRulesResponse { - /** List of PAT rules. */ + /** + * List of PAT rules. + */ patRules: PATRule[] } export type UpdateDHCPEntryRequest = { - /** 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 DHCP entry to update. */ + /** + * ID of the DHCP entry to update. + */ dhcpEntryId: string - /** New IP address to give to the device. */ + /** + * New IP address to give to the device. + */ ipAddress?: string } export type UpdateDHCPRequest = { - /** 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 - /** DHCP configuration to update. */ + /** + * DHCP configuration to update. + */ dhcpId: string - /** Subnet for the DHCP server. */ + /** + * Subnet for the DHCP server. + */ subnet?: string /** - * IP address of the DHCP server. This will be the Public Gateway's address in - * the Private Network. It must be part of config's subnet. + * IP address of the DHCP server. This will be the Public Gateway's address in the Private Network. It must be part of config's subnet. */ address?: string /** - * Low IP (inclusive) of the dynamic address pool. Must be in the config's - * subnet. + * Low IP (inclusive) of the dynamic address pool. Must be in the config's subnet. */ poolLow?: string /** - * High IP (inclusive) of the dynamic address pool. Must be in the config's - * subnet. + * High IP (inclusive) of the dynamic address pool. Must be in the config's subnet. */ poolHigh?: string /** - * Defines whether to enable dynamic pooling of IPs. When false, only - * pre-existing DHCP reservations will be handed out. Defaults to true. + * Defines whether to enable dynamic pooling of IPs. When false, only pre-existing DHCP reservations will be handed out. Defaults to true. */ enableDynamic?: boolean - /** How long DHCP entries will be valid for. */ + /** + * How long DHCP entries will be valid for. + */ validLifetime?: string /** - * After how long a renew will be attempted. Must be 30s lower than - * `rebind_timer`. + * After how long a renew will be attempted. Must be 30s lower than `rebind_timer`. */ renewTimer?: string /** - * After how long a DHCP client will query for a new lease if previous renews - * fail. Must be 30s lower than `valid_lifetime`. + * After how long a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. */ rebindTimer?: string /** - * Defines whether the gateway should push a default route to DHCP clients, or - * only hand out IPs. + * Defines whether the gateway should push a default route to DHCP clients, or only hand out IPs. */ pushDefaultRoute?: boolean /** - * Defines whether the gateway should push custom DNS servers to clients. This - * allows for instance hostname -> IP resolution. + * Defines whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. */ pushDnsServer?: boolean /** - * Array of DNS server IP addresses used to override the DNS server list - * pushed to DHCP clients, instead of the gateway itself. + * Array of DNS server IP addresses used to override the DNS server list pushed to DHCP clients, instead of the gateway itself. */ dnsServersOverride?: string[] - /** Array of search paths in addition to the pushed DNS configuration. */ + /** + * Array of search paths in addition to the pushed DNS configuration. + */ dnsSearch?: string[] /** - * TLD given to hostnames in the Private Networks. If an instance with - * hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will - * resolve. Allowed characters are `a-z0-9-.`. + * TLD given to hostnames in the Private Networks. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. Allowed characters are `a-z0-9-.`. */ dnsLocalName?: string } export type UpdateGatewayNetworkRequest = { - /** 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 GatewayNetwork to update. */ + /** + * ID of the GatewayNetwork to update. + */ gatewayNetworkId: string - /** Note: this setting is ignored when passing `ipam_config`. */ + /** + * Note: this setting is ignored when passing `ipam_config`. + */ enableMasquerade?: boolean /** - * Defaults to `true` if `dhcp_id` is present. If set to `true`, `dhcp_id` - * must be present. Note: this setting is ignored when passing `ipam_config`. + * Defaults to `true` if `dhcp_id` is present. If set to `true`, `dhcp_id` must be present. +Note: this setting is ignored when passing `ipam_config`. */ enableDhcp?: boolean /** * ID of the new DHCP configuration object to use with this GatewayNetwork. * - * One-of ('ipConfig'): at most one of 'dhcpId', 'address', 'ipamConfig' could - * be set. + * One-of ('ipConfig'): at most one of 'dhcpId', 'address', 'ipamConfig' could be set. */ dhcpId?: string /** * New static IP address. * - * One-of ('ipConfig'): at most one of 'dhcpId', 'address', 'ipamConfig' could - * be set. + * One-of ('ipConfig'): at most one of 'dhcpId', 'address', 'ipamConfig' could be set. */ address?: string /** - * Note: all or none of the GatewayNetworks for a single gateway can use the - * IPAM. DHCP and IPAM configurations cannot be mixed. Some products may - * require that the Public Gateway uses the IPAM, to ensure correct - * functionality. + * Note: all or none of the GatewayNetworks for a single gateway can use the IPAM. DHCP and IPAM configurations cannot be mixed. Some products may require that the Public Gateway uses the IPAM, to ensure correct functionality. * - * One-of ('ipConfig'): at most one of 'dhcpId', 'address', 'ipamConfig' could - * be set. + * One-of ('ipConfig'): at most one of 'dhcpId', 'address', 'ipamConfig' could be set. */ ipamConfig?: UpdateGatewayNetworkRequestIpamConfig } export type UpdateGatewayRequest = { - /** 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 gateway to update. */ + /** + * ID of the gateway to update. + */ gatewayId: string - /** Name for the gateway. */ + /** + * Name for the gateway. + */ name?: string - /** Tags for the gateway. */ + /** + * Tags for the gateway. + */ tags?: string[] /** - * Array of DNS server IP addresses to override the gateway's default - * recursive DNS servers. + * Array of DNS server IP addresses to override the gateway's default recursive DNS servers. */ upstreamDnsServers?: string[] - /** Defines whether SSH bastion should be enabled the gateway. */ + /** + * Defines whether SSH bastion should be enabled the gateway. + */ enableBastion?: boolean - /** Port of the SSH bastion. */ + /** + * Port of the SSH bastion. + */ bastionPort?: number - /** Defines whether SMTP traffic should be allowed to pass through the gateway. */ + /** + * Defines whether SMTP traffic should be allowed to pass through the gateway. + */ enableSmtp?: boolean } 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 IP address to update. */ + /** + * ID of the IP address to update. + */ ipId: string - /** Tags to give to the IP address. */ + /** + * Tags to give to the IP address. + */ tags?: string[] - /** Reverse to set on the address. Empty string to unset. */ + /** + * Reverse to set on the address. Empty string to unset. + */ reverse?: string - /** Gateway to attach the IP address to. Empty string to detach. */ + /** + * Gateway to attach the IP address to. Empty string to detach. + */ gatewayId?: string } export type UpdatePATRuleRequest = { - /** 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 PAT rule to update. */ + /** + * ID of the PAT rule to update. + */ patRuleId: string - /** Public port to listen on. */ + /** + * Public port to listen on. + */ publicPort?: number - /** Private IP to forward data to. */ + /** + * Private IP to forward data to. + */ privateIp?: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort?: number - /** Protocol the rule should apply to. */ + /** + * Protocol the rule should apply to. + */ protocol?: PATRuleProtocol } export type UpgradeGatewayRequest = { - /** 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 gateway to upgrade. */ + /** + * ID of the gateway to upgrade. + */ gatewayId: string - /** Gateway type (commercial offer). */ + /** + * Gateway type (commercial offer). + */ type?: string } diff --git a/packages/clients/src/api/vpcgw/v2/api.gen.ts b/packages/clients/src/api/vpcgw/v2/api.gen.ts index 97650f2b5..1e33603fd 100644 --- a/packages/clients/src/api/vpcgw/v2/api.gen.ts +++ b/packages/clients/src/api/vpcgw/v2/api.gen.ts @@ -86,8 +86,8 @@ const jsonContentHeaders = { /** * Public Gateways API. - * - * This API allows you to manage your Public Gateways. + +This API allows you to manage your Public Gateways. */ export class API extends ParentAPI { /** Lists the available zones of the API. */ @@ -130,9 +130,7 @@ export class API extends ParentAPI { ) /** - * List Public Gateways. List Public Gateways in a given Scaleway Organization - * or Project. By default, results are displayed in ascending order of - * creation date. + * List Public Gateways. List Public Gateways in a given Scaleway Organization or Project. By default, results are displayed in ascending order of creation date. * * @param request - The request {@link ListGatewaysRequest} * @returns A Promise of ListGatewaysResponse @@ -141,9 +139,7 @@ export class API extends ParentAPI { enrichForPagination('gateways', this.pageOfListGateways, request) /** - * Get a Public Gateway. Get details of a Public Gateway, specified by its - * gateway ID. The response object contains full details of the gateway, - * including its **name**, **type**, **status** and more. + * Get a Public Gateway. Get details of a Public Gateway, specified by its gateway ID. The response object contains full details of the gateway, including its **name**, **type**, **status** and more. * * @param request - The request {@link GetGatewayRequest} * @returns A Promise of Gateway @@ -180,9 +176,7 @@ export class API extends ParentAPI { ) /** - * Create a Public Gateway. Create a new Public Gateway in the specified - * Scaleway Project, defining its **name**, **type** and other configuration - * details such as whether to enable SSH bastion. + * Create a Public Gateway. Create a new Public Gateway in the specified Scaleway Project, defining its **name**, **type** and other configuration details such as whether to enable SSH bastion. * * @param request - The request {@link CreateGatewayRequest} * @returns A Promise of Gateway @@ -201,9 +195,7 @@ export class API extends ParentAPI { ) /** - * Update a Public Gateway. Update the parameters of an existing Public - * Gateway, for example, its **name**, **tags**, **SSH bastion - * configuration**, and **DNS servers**. + * Update a Public Gateway. Update the parameters of an existing Public Gateway, for example, its **name**, **tags**, **SSH bastion configuration**, and **DNS servers**. * * @param request - The request {@link UpdateGatewayRequest} * @returns A Promise of Gateway @@ -222,8 +214,7 @@ export class API extends ParentAPI { ) /** - * Delete a Public Gateway. Delete an existing Public Gateway, specified by - * its gateway ID. This action is irreversible. + * Delete a Public Gateway. Delete an existing Public Gateway, specified by its gateway ID. This action is irreversible. * * @param request - The request {@link DeleteGatewayRequest} * @returns A Promise of Gateway @@ -239,11 +230,7 @@ export class API extends ParentAPI { ) /** - * Upgrade a Public Gateway to the latest version and/or to a different - * commercial offer type. Upgrade a given Public Gateway to the newest - * software version or to a different commercial offer type. This applies the - * latest bugfixes and features to your Public Gateway. Note that gateway - * service will be interrupted during the update. + * Upgrade a Public Gateway to the latest version and/or to a different commercial offer type. Upgrade a given Public Gateway to the newest software version or to a different commercial offer type. This applies the latest bugfixes and features to your Public Gateway. Note that gateway service will be interrupted during the update. * * @param request - The request {@link UpgradeGatewayRequest} * @returns A Promise of Gateway @@ -285,14 +272,7 @@ export class API extends ParentAPI { ) /** - * List Public Gateway connections to Private Networks. List the connections - * between Public Gateways and Private Networks (a connection = a - * GatewayNetwork). You can choose to filter by `gateway-id` to list all - * Private Networks attached to the specified Public Gateway, or by - * `private_network_id` to list all Public Gateways attached to the specified - * Private Network. Other query parameters are also available. The result is - * an array of GatewayNetwork objects, each giving details of the connection - * between a given Public Gateway and a given Private Network. + * List Public Gateway connections to Private Networks. List the connections between Public Gateways and Private Networks (a connection = a GatewayNetwork). You can choose to filter by `gateway-id` to list all Private Networks attached to the specified Public Gateway, or by `private_network_id` to list all Public Gateways attached to the specified Private Network. Other query parameters are also available. The result is an array of GatewayNetwork objects, each giving details of the connection between a given Public Gateway and a given Private Network. * * @param request - The request {@link ListGatewayNetworksRequest} * @returns A Promise of ListGatewayNetworksResponse @@ -305,12 +285,7 @@ export class API extends ParentAPI { ) /** - * Get a Public Gateway connection to a Private Network. Get details of a - * given connection between a Public Gateway and a Private Network (this - * connection = a GatewayNetwork), specified by its `gateway_network_id`. The - * response object contains details of the connection including the IDs of the - * Public Gateway and Private Network, the dates the connection was - * created/updated and its configuration settings. + * Get a Public Gateway connection to a Private Network. Get details of a given connection between a Public Gateway and a Private Network (this connection = a GatewayNetwork), specified by its `gateway_network_id`. The response object contains details of the connection including the IDs of the Public Gateway and Private Network, the dates the connection was created/updated and its configuration settings. * * @param request - The request {@link GetGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -347,10 +322,7 @@ export class API extends ParentAPI { ) /** - * Attach a Public Gateway to a Private Network. Attach a specific Public - * Gateway to a specific Private Network (create a GatewayNetwork). You can - * configure parameters for the connection including whether to enable - * masquerade (dynamic NAT), and more. + * Attach a Public Gateway to a Private Network. Attach a specific Public Gateway to a specific Private Network (create a GatewayNetwork). You can configure parameters for the connection including whether to enable masquerade (dynamic NAT), and more. * * @param request - The request {@link CreateGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -369,10 +341,7 @@ export class API extends ParentAPI { ) /** - * Update a Public Gateway's connection to a Private Network. Update the - * configuration parameters of a connection between a given Public Gateway and - * Private Network (the connection = a GatewayNetwork). Updatable parameters - * include whether to enable traffic masquerade (dynamic NAT). + * Update a Public Gateway's connection to a Private Network. Update the configuration parameters of a connection between a given Public Gateway and Private Network (the connection = a GatewayNetwork). Updatable parameters include whether to enable traffic masquerade (dynamic NAT). * * @param request - The request {@link UpdateGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -391,9 +360,7 @@ export class API extends ParentAPI { ) /** - * Detach a Public Gateway from a Private Network. Detach a given Public - * Gateway from a given Private Network, i.e. delete a GatewayNetwork - * specified by a gateway_network_id. + * Detach a Public Gateway from a Private Network. Detach a given Public Gateway from a given Private Network, i.e. delete a GatewayNetwork specified by a gateway_network_id. * * @param request - The request {@link DeleteGatewayNetworkRequest} * @returns A Promise of GatewayNetwork @@ -430,9 +397,7 @@ export class API extends ParentAPI { ) /** - * List PAT rules. List PAT rules. You can filter by gateway ID to list all - * PAT rules for a particular gateway, or filter for PAT rules targeting a - * specific IP address or using a specific protocol. + * List PAT rules. List PAT rules. You can filter by gateway ID to list all PAT rules for a particular gateway, or filter for PAT rules targeting a specific IP address or using a specific protocol. * * @param request - The request {@link ListPatRulesRequest} * @returns A Promise of ListPatRulesResponse @@ -441,10 +406,7 @@ export class API extends ParentAPI { enrichForPagination('patRules', this.pageOfListPatRules, request) /** - * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response - * object gives full details of the PAT rule, including the Public Gateway it - * belongs to and the configuration settings in terms of public / private - * ports, private IP and protocol. + * Get a PAT rule. Get a PAT rule, specified by its PAT rule ID. The response object gives full details of the PAT rule, including the Public Gateway it belongs to and the configuration settings in terms of public / private ports, private IP and protocol. * * @param request - The request {@link GetPatRuleRequest} * @returns A Promise of PatRule @@ -459,9 +421,7 @@ export class API extends ParentAPI { ) /** - * Create a PAT rule. Create a new PAT rule on a specified Public Gateway, - * defining the protocol to use, public port to listen on, and private port / - * IP address to map to. + * Create a PAT rule. Create a new PAT rule on a specified Public Gateway, defining the protocol to use, public port to listen on, and private port / IP address to map to. * * @param request - The request {@link CreatePatRuleRequest} * @returns A Promise of PatRule @@ -480,9 +440,7 @@ export class API extends ParentAPI { ) /** - * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. - * Configuration settings including private/public port, private IP address - * and protocol can all be updated. + * Update a PAT rule. Update a PAT rule, specified by its PAT rule ID. Configuration settings including private/public port, private IP address and protocol can all be updated. * * @param request - The request {@link UpdatePatRuleRequest} * @returns A Promise of PatRule @@ -501,10 +459,7 @@ export class API extends ParentAPI { ) /** - * Set all PAT rules. Set a definitive list of PAT rules attached to a Public - * Gateway. Each rule is identified by its public port and protocol. This will - * sync the current PAT rule list on the gateway with the new list, creating, - * updating or deleting PAT rules accordingly. + * Set all PAT rules. Set a definitive list of PAT rules attached to a Public Gateway. Each rule is identified by its public port and protocol. This will sync the current PAT rule list on the gateway with the new list, creating, updating or deleting PAT rules accordingly. * * @param request - The request {@link SetPatRulesRequest} * @returns A Promise of SetPatRulesResponse @@ -523,8 +478,7 @@ export class API extends ParentAPI { ) /** - * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This - * action is irreversible. + * Delete a PAT rule. Delete a PAT rule, identified by its PAT rule ID. This action is irreversible. * * @param request - The request {@link DeletePatRuleRequest} */ @@ -535,9 +489,7 @@ export class API extends ParentAPI { }) /** - * List Public Gateway types. List the different Public Gateway commercial - * offer types available at Scaleway. The response is an array of objects - * describing the name and technical details of each available gateway type. + * List Public Gateway types. List the different Public Gateway commercial offer types available at Scaleway. The response is an array of objects describing the name and technical details of each available gateway type. * * @param request - The request {@link ListGatewayTypesRequest} * @returns A Promise of ListGatewayTypesResponse @@ -574,8 +526,7 @@ export class API extends ParentAPI { ) /** - * List IPs. List Public Gateway flexible IP addresses. A number of filter - * options are available for limiting results in the response. + * List IPs. List Public Gateway flexible IP addresses. A number of filter options are available for limiting results in the response. * * @param request - The request {@link ListIPsRequest} * @returns A Promise of ListIPsResponse @@ -584,10 +535,7 @@ export class API extends ParentAPI { enrichForPagination('ips', this.pageOfListIPs, request) /** - * Get an IP. Get details of a Public Gateway flexible IP address, identified - * by its IP ID. The response object contains information including which (if - * any) Public Gateway using this IP address, the reverse and various other - * metadata. + * Get an IP. Get details of a Public Gateway flexible IP address, identified by its IP ID. The response object contains information including which (if any) Public Gateway using this IP address, the reverse and various other metadata. * * @param request - The request {@link GetIPRequest} * @returns A Promise of IP @@ -602,8 +550,7 @@ export class API extends ParentAPI { ) /** - * Reserve an IP. Create (reserve) a new flexible IP address that can be used - * for a Public Gateway in a specified Scaleway Project. + * Reserve an IP. Create (reserve) a new flexible IP address that can be used for a Public Gateway in a specified Scaleway Project. * * @param request - The request {@link CreateIPRequest} * @returns A Promise of IP @@ -622,8 +569,7 @@ export class API extends ParentAPI { ) /** - * Update an IP. Update details of an existing flexible IP address, including - * its tags, reverse and the Public Gateway it is assigned to. + * Update an IP. Update details of an existing flexible IP address, including its tags, reverse and the Public Gateway it is assigned to. * * @param request - The request {@link UpdateIPRequest} * @returns A Promise of IP @@ -642,8 +588,7 @@ export class API extends ParentAPI { ) /** - * Delete an IP. Delete a flexible IP address from your account. This action - * is irreversible. + * Delete an IP. Delete a flexible IP address from your account. This action is irreversible. * * @param request - The request {@link DeleteIPRequest} */ @@ -654,9 +599,7 @@ export class API extends ParentAPI { }) /** - * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public - * Gateway, specified by its gateway ID. This adds any new SSH keys in the - * gateway's Scaleway Project to the gateway itself. + * Refresh a Public Gateway's SSH keys. Refresh the SSH keys of a given Public Gateway, specified by its gateway ID. This adds any new SSH keys in the gateway's Scaleway Project to the gateway itself. * * @param request - The request {@link RefreshSSHKeysRequest} * @returns A Promise of Gateway @@ -673,8 +616,7 @@ export class API extends ParentAPI { ) /** - * Add allowed IP range to SSH bastion. Add an IP range (in CIDR notation) to - * be allowed to connect to the SSH bastion. + * Add allowed IP range to SSH bastion. Add an IP range (in CIDR notation) to be allowed to connect to the SSH bastion. * * @param request - The request {@link AddBastionAllowedIPsRequest} * @returns A Promise of AddBastionAllowedIPsResponse @@ -693,8 +635,7 @@ export class API extends ParentAPI { ) /** - * Set all IP ranges allowed for SSH bastion. Set a definitive list of IP - * ranges (in CIDR notation) allowed to connect to the SSH bastion. + * Set all IP ranges allowed for SSH bastion. Set a definitive list of IP ranges (in CIDR notation) allowed to connect to the SSH bastion. * * @param request - The request {@link SetBastionAllowedIPsRequest} * @returns A Promise of SetBastionAllowedIPsResponse @@ -713,9 +654,7 @@ export class API extends ParentAPI { ) /** - * Delete allowed IP range from SSH bastion. Delete an IP range (defined in - * CIDR notation) from SSH bastion, so that it is no longer allowed to - * connect. + * Delete allowed IP range from SSH bastion. Delete an IP range (defined in CIDR notation) from SSH bastion, so that it is no longer allowed to connect. * * @param request - The request {@link DeleteBastionAllowedIPsRequest} */ diff --git a/packages/clients/src/api/vpcgw/v2/types.gen.ts b/packages/clients/src/api/vpcgw/v2/types.gen.ts index f3b239a9a..4f604a89c 100644 --- a/packages/clients/src/api/vpcgw/v2/types.gen.ts +++ b/packages/clients/src/api/vpcgw/v2/types.gen.ts @@ -54,523 +54,872 @@ export type ListPatRulesRequestOrderBy = export type PatRuleProtocol = 'unknown_protocol' | 'both' | 'tcp' | 'udp' export interface GatewayNetwork { - /** ID of the Public Gateway-Private Network connection. */ + /** + * ID of the Public Gateway-Private Network connection. + */ id: string - /** Connection creation date. */ + /** + * Connection creation date. + */ createdAt?: Date - /** Connection last modification date. */ + /** + * Connection last modification date. + */ updatedAt?: Date - /** ID of the connected Public Gateway. */ + /** + * ID of the connected Public Gateway. + */ gatewayId: string - /** ID of the connected Private Network. */ + /** + * ID of the connected Private Network. + */ privateNetworkId: string /** - * MAC address of the gateway in the Private Network (if the gateway is up and - * running). + * MAC address of the gateway in the Private Network (if the gateway is up and running). */ macAddress?: string /** - * Defines whether the gateway masquerades traffic for this Private Network - * (Dynamic NAT). + * Defines whether the gateway masquerades traffic for this Private Network (Dynamic NAT). */ masqueradeEnabled: boolean - /** Current status of the Public Gateway's connection to the Private Network. */ + /** + * Current status of the Public Gateway's connection to the Private Network. + */ status: GatewayNetworkStatus - /** Enabling the default route also enables masquerading. */ + /** + * Enabling the default route also enables masquerading. + */ pushDefaultRoute: boolean - /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */ + /** + * Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. + */ ipamIpId: string - /** Zone of the GatewayNetwork connection. */ + /** + * Zone of the GatewayNetwork connection. + */ zone: ScwZone } export interface IP { - /** IP address ID. */ + /** + * IP address ID. + */ id: string - /** Owning Organization. */ + /** + * Owning Organization. + */ organizationId: string - /** Owning Project. */ + /** + * Owning Project. + */ projectId: string - /** IP address creation date. */ + /** + * IP address creation date. + */ createdAt?: Date - /** IP address last modification date. */ + /** + * IP address last modification date. + */ updatedAt?: Date - /** Tags associated with the IP address. */ + /** + * Tags associated with the IP address. + */ tags: string[] - /** The IP address itself. */ + /** + * The IP address itself. + */ address: string - /** Reverse domain name for the IP address. */ + /** + * Reverse domain name for the IP address. + */ reverse?: string - /** Public Gateway associated with the IP address. */ + /** + * Public Gateway associated with the IP address. + */ gatewayId?: string - /** Zone of the IP address. */ + /** + * Zone of the IP address. + */ zone: ScwZone } export interface GatewayType { - /** Public Gateway type name. */ + /** + * Public Gateway type name. + */ name: string /** - * Bandwidth, in bps, of the Public Gateway. This is the public bandwidth to - * the outer Internet, and the internal bandwidth to each connected Private - * Networks. + * Bandwidth, in bps, of the Public Gateway. This is the public bandwidth to the outer Internet, and the internal bandwidth to each connected Private Networks. */ bandwidth: number - /** Zone the Public Gateway type is available in. */ + /** + * Zone the Public Gateway type is available in. + */ zone: ScwZone } export interface Gateway { - /** ID of the gateway. */ + /** + * ID of the gateway. + */ id: string - /** Owning Organization. */ + /** + * Owning Organization. + */ organizationId: string - /** Owning Project. */ + /** + * Owning Project. + */ projectId: string - /** Gateway creation date. */ + /** + * Gateway creation date. + */ createdAt?: Date - /** Gateway last modification date. */ + /** + * Gateway last modification date. + */ updatedAt?: Date - /** Gateway type name (commercial offer). */ + /** + * Gateway type name (commercial offer). + */ type: string - /** Bandwidth available of the gateway. */ + /** + * Bandwidth available of the gateway. + */ bandwidth: number - /** Current status of the gateway. */ + /** + * Current status of the gateway. + */ status: GatewayStatus - /** Name of the gateway. */ + /** + * Name of the gateway. + */ name: string - /** Tags associated with the gateway. */ + /** + * Tags associated with the gateway. + */ tags: string[] - /** Public IPv4 address of the gateway. */ + /** + * Public IPv4 address of the gateway. + */ ipv4?: IP /** - * GatewayNetwork objects attached to the gateway (each one represents a - * connection to a Private Network). + * GatewayNetwork objects attached to the gateway (each one represents a connection to a Private Network). */ gatewayNetworks: GatewayNetwork[] - /** Version of the running gateway software. */ + /** + * Version of the running gateway software. + */ version?: string - /** Newly available gateway software version that can be updated to. */ + /** + * Newly available gateway software version that can be updated to. + */ canUpgradeTo?: string - /** Defines whether SSH bastion is enabled on the gateway. */ + /** + * Defines whether SSH bastion is enabled on the gateway. + */ bastionEnabled: boolean - /** Port of the SSH bastion. */ + /** + * Port of the SSH bastion. + */ bastionPort: number - /** Defines whether SMTP traffic is allowed to pass through the gateway. */ + /** + * Defines whether SMTP traffic is allowed to pass through the gateway. + */ smtpEnabled: boolean - /** Defines whether the gateway uses non-IPAM IP configurations. */ + /** + * Defines whether the gateway uses non-IPAM IP configurations. + */ isLegacy: boolean - /** Ranges of IP addresses allowed to connect to the gateway's SSH bastion. */ + /** + * Ranges of IP addresses allowed to connect to the gateway's SSH bastion. + */ bastionAllowedIps: string[] - /** Zone of the gateway. */ + /** + * Zone of the gateway. + */ zone: ScwZone } export interface PatRule { - /** PAT rule ID. */ + /** + * PAT rule ID. + */ id: string - /** Gateway the PAT rule applies to. */ + /** + * Gateway the PAT rule applies to. + */ gatewayId: string - /** PAT rule creation date. */ + /** + * PAT rule creation date. + */ createdAt?: Date - /** PAT rule last modification date. */ + /** + * PAT rule last modification date. + */ updatedAt?: Date - /** Public port to listen on. */ + /** + * Public port to listen on. + */ publicPort: number - /** Private IP address to forward data to. */ + /** + * Private IP address to forward data to. + */ privateIp: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort: number - /** Protocol the rule applies to. */ + /** + * Protocol the rule applies to. + */ protocol: PatRuleProtocol - /** Zone of the PAT rule. */ + /** + * Zone of the PAT rule. + */ zone: ScwZone } export interface SetPatRulesRequestRule { /** - * Public port to listen on. Uniquely identifies the rule, and a matching rule - * will be updated with the new parameters. + * Public port to listen on. Uniquely identifies the rule, and a matching rule will be updated with the new parameters. */ publicPort: number - /** Private IP to forward data to. */ + /** + * Private IP to forward data to. + */ privateIp: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort: number - /** Protocol the rule should apply to. */ + /** + * Protocol the rule should apply to. + */ protocol: PatRuleProtocol } export type AddBastionAllowedIPsRequest = { - /** 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 gateway to add the allowed IP range to. */ + /** + * ID of the gateway to add the allowed IP range to. + */ gatewayId: string - /** IP range allowed to connect to the SSH bastion. */ + /** + * IP range allowed to connect to the SSH bastion. + */ ipRange: string } export interface AddBastionAllowedIPsResponse { - /** Ranges of IP addresses allowed to connect to the gateway's SSH bastion. */ + /** + * Ranges of IP addresses allowed to connect to the gateway's SSH bastion. + */ ipRanges: string[] } export type CreateGatewayNetworkRequest = { - /** 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 - /** Public Gateway to connect. */ + /** + * Public Gateway to connect. + */ gatewayId: string - /** Private Network to connect. */ + /** + * Private Network to connect. + */ privateNetworkId: string - /** Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. */ + /** + * Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. + */ enableMasquerade: boolean - /** Enabling the default route also enables masquerading. */ + /** + * Enabling the default route also enables masquerading. + */ pushDefaultRoute: boolean - /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */ + /** + * Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. + */ ipamIpId?: string } export type CreateGatewayRequest = { - /** 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 Project to create the gateway in. */ + /** + * Scaleway Project to create the gateway in. + */ projectId?: string - /** Name for the gateway. */ + /** + * Name for the gateway. + */ name?: string - /** Tags for the gateway. */ + /** + * Tags for the gateway. + */ tags?: string[] - /** Gateway type (commercial offer type). */ + /** + * Gateway type (commercial offer type). + */ type: string - /** Existing IP address to attach to the gateway. */ + /** + * Existing IP address to attach to the gateway. + */ ipId?: string - /** Defines whether SMTP traffic should be allowed pass through the gateway. */ + /** + * Defines whether SMTP traffic should be allowed pass through the gateway. + */ enableSmtp: boolean - /** Defines whether SSH bastion should be enabled the gateway. */ + /** + * Defines whether SSH bastion should be enabled the gateway. + */ enableBastion: boolean - /** Port of the SSH bastion. */ + /** + * Port of the SSH bastion. + */ bastionPort?: number } 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 - /** Project to create the IP address in. */ + /** + * Project to create the IP address in. + */ projectId?: string - /** Tags to give to the IP address. */ + /** + * Tags to give to the IP address. + */ tags?: string[] } export type CreatePatRuleRequest = { - /** 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 Gateway on which to create the rule. */ + /** + * ID of the Gateway on which to create the rule. + */ gatewayId: string - /** Public port to listen on. */ + /** + * Public port to listen on. + */ publicPort: number - /** Private IP to forward data to. */ + /** + * Private IP to forward data to. + */ privateIp: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort: number - /** Protocol the rule should apply to. */ + /** + * Protocol the rule should apply to. + */ protocol?: PatRuleProtocol } export type DeleteBastionAllowedIPsRequest = { - /** 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 gateway on which to delete the allowed IP range. */ + /** + * ID of the gateway on which to delete the allowed IP range. + */ gatewayId: string - /** IP range to delete from SSH bastion's list of allowed IPs. */ + /** + * IP range to delete from SSH bastion's list of allowed IPs. + */ ipRange: string } export type DeleteGatewayNetworkRequest = { - /** 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 GatewayNetwork to delete. */ + /** + * ID of the GatewayNetwork to delete. + */ gatewayNetworkId: string } export type DeleteGatewayRequest = { - /** 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 gateway to delete. */ + /** + * ID of the gateway to delete. + */ gatewayId: string - /** Defines whether the PGW's IP should be deleted. */ + /** + * Defines whether the PGW's IP should be deleted. + */ deleteIp: boolean } 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 of the IP address to delete. */ + /** + * ID of the IP address to delete. + */ ipId: string } export type DeletePatRuleRequest = { - /** 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 PAT rule to delete. */ + /** + * ID of the PAT rule to delete. + */ patRuleId: string } export type GetGatewayNetworkRequest = { - /** 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 GatewayNetwork to fetch. */ + /** + * ID of the GatewayNetwork to fetch. + */ gatewayNetworkId: string } export type GetGatewayRequest = { - /** 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 gateway to fetch. */ + /** + * ID of the gateway to fetch. + */ gatewayId: string } 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 - /** ID of the IP address to get. */ + /** + * ID of the IP address to get. + */ ipId: string } export type GetPatRuleRequest = { - /** 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 PAT rule to get. */ + /** + * ID of the PAT rule to get. + */ patRuleId: string } export type ListGatewayNetworksRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListGatewayNetworksRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** GatewayNetworks per page. */ + /** + * GatewayNetworks per page. + */ pageSize?: number /** - * Filter for GatewayNetworks with these status. Use `unknown` to include all - * statuses. + * Filter for GatewayNetworks with these status. Use `unknown` to include all statuses. */ status?: GatewayNetworkStatus[] - /** Filter for GatewayNetworks connected to these gateways. */ + /** + * Filter for GatewayNetworks connected to these gateways. + */ gatewayIds?: string[] - /** Filter for GatewayNetworks connected to these Private Networks. */ + /** + * Filter for GatewayNetworks connected to these Private Networks. + */ privateNetworkIds?: string[] - /** Filter for GatewayNetworks with this `enable_masquerade` setting. */ + /** + * Filter for GatewayNetworks with this `enable_masquerade` setting. + */ masqueradeEnabled?: boolean } export interface ListGatewayNetworksResponse { - /** GatewayNetworks on this page. */ + /** + * GatewayNetworks on this page. + */ gatewayNetworks: GatewayNetwork[] - /** Total GatewayNetworks count matching the filter. */ + /** + * Total GatewayNetworks count matching the filter. + */ totalCount: number } export type ListGatewayTypesRequest = { - /** 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 ListGatewayTypesResponse { - /** Available types of Public Gateway. */ + /** + * Available types of Public Gateway. + */ types: GatewayType[] } export type ListGatewaysRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListGatewaysRequestOrderBy - /** Page number to return. */ + /** + * Page number to return. + */ page?: number - /** Gateways per page. */ + /** + * Gateways per page. + */ pageSize?: number - /** Include only gateways in this Organization. */ + /** + * Include only gateways in this Organization. + */ organizationId?: string - /** Include only gateways in this Project. */ + /** + * Include only gateways in this Project. + */ projectId?: string - /** Filter for gateways which have this search term in their name. */ + /** + * Filter for gateways which have this search term in their name. + */ name?: string - /** Filter for gateways with these tags. */ + /** + * Filter for gateways with these tags. + */ tags?: string[] - /** Filter for gateways of these types. */ + /** + * Filter for gateways of these types. + */ types?: string[] /** - * Filter for gateways with these status. Use `unknown` to include all - * statuses. + * Filter for gateways with these status. Use `unknown` to include all statuses. */ status?: GatewayStatus[] - /** Filter for gateways attached to these Private Networks. */ + /** + * Filter for gateways attached to these Private Networks. + */ privateNetworkIds?: string[] - /** Include also legacy gateways. */ + /** + * Include also legacy gateways. + */ includeLegacy?: boolean } export interface ListGatewaysResponse { - /** Gateways on this page. */ + /** + * Gateways on this page. + */ gateways: Gateway[] - /** Total count of gateways matching the filter. */ + /** + * Total count of gateways matching the filter. + */ totalCount: number } 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListIPsRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** IP addresses per page. */ + /** + * IP addresses per page. + */ pageSize?: number - /** Include only gateways in this Organization. */ + /** + * Include only gateways in this Organization. + */ organizationId?: string - /** Filter for IP addresses in this Project. */ + /** + * Filter for IP addresses in this Project. + */ projectId?: string - /** Filter for IP addresses with these tags. */ + /** + * Filter for IP addresses with these tags. + */ tags?: string[] - /** Filter for IP addresses that have a reverse containing this string. */ + /** + * Filter for IP addresses that have a reverse containing this string. + */ reverse?: string - /** Filter based on whether the IP is attached to a gateway or not. */ + /** + * Filter based on whether the IP is attached to a gateway or not. + */ isFree?: boolean } export interface ListIPsResponse { - /** IP addresses on this page. */ + /** + * IP addresses on this page. + */ ips: IP[] - /** Total count of IP addresses matching the filter. */ + /** + * Total count of IP addresses matching the filter. + */ totalCount: number } export type ListPatRulesRequest = { - /** 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 - /** Order in which to return results. */ + /** + * Order in which to return results. + */ orderBy?: ListPatRulesRequestOrderBy - /** Page number. */ + /** + * Page number. + */ page?: number - /** PAT rules per page. */ + /** + * PAT rules per page. + */ pageSize?: number - /** Filter for PAT rules on these gateways. */ + /** + * Filter for PAT rules on these gateways. + */ gatewayIds?: string[] - /** Filter for PAT rules targeting these private ips. */ + /** + * Filter for PAT rules targeting these private ips. + */ privateIps?: string[] - /** Filter for PAT rules with this protocol. */ + /** + * Filter for PAT rules with this protocol. + */ protocol?: PatRuleProtocol } export interface ListPatRulesResponse { - /** Array of PAT rules matching the filter. */ + /** + * Array of PAT rules matching the filter. + */ patRules: PatRule[] - /** Total count of PAT rules matching the filter. */ + /** + * Total count of PAT rules matching the filter. + */ totalCount: number } export type RefreshSSHKeysRequest = { - /** 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 gateway to refresh SSH keys on. */ + /** + * ID of the gateway to refresh SSH keys on. + */ gatewayId: string } export type SetBastionAllowedIPsRequest = { - /** 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 gateway on which to set the allowed IP range. */ + /** + * ID of the gateway on which to set the allowed IP range. + */ gatewayId: string /** - * New list of IP ranges (each range in CIDR notation) allowed to connect to - * the SSH bastion. + * New list of IP ranges (each range in CIDR notation) allowed to connect to the SSH bastion. */ ipRanges?: string[] } export interface SetBastionAllowedIPsResponse { - /** Ranges of IP addresses allowed to connect to the gateway's SSH bastion. */ + /** + * Ranges of IP addresses allowed to connect to the gateway's SSH bastion. + */ ipRanges: string[] } export type SetPatRulesRequest = { - /** 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 gateway on which to set the PAT rules. */ + /** + * ID of the gateway on which to set the PAT rules. + */ gatewayId: string - /** New list of PAT rules. */ + /** + * New list of PAT rules. + */ patRules: SetPatRulesRequestRule[] } export interface SetPatRulesResponse { - /** List of PAT rules. */ + /** + * List of PAT rules. + */ patRules: PatRule[] } export type UpdateGatewayNetworkRequest = { - /** 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 GatewayNetwork to update. */ + /** + * ID of the GatewayNetwork to update. + */ gatewayNetworkId: string - /** Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. */ + /** + * Defines whether to enable masquerade (dynamic NAT) on the GatewayNetwork. + */ enableMasquerade?: boolean - /** Enabling the default route also enables masquerading. */ + /** + * Enabling the default route also enables masquerading. + */ pushDefaultRoute?: boolean - /** Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. */ + /** + * Use this IPAM-booked IP ID as the Gateway's IP in this Private Network. + */ ipamIpId?: string } export type UpdateGatewayRequest = { - /** 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 gateway to update. */ + /** + * ID of the gateway to update. + */ gatewayId: string - /** Name for the gateway. */ + /** + * Name for the gateway. + */ name?: string - /** Tags for the gateway. */ + /** + * Tags for the gateway. + */ tags?: string[] - /** Defines whether SSH bastion should be enabled the gateway. */ + /** + * Defines whether SSH bastion should be enabled the gateway. + */ enableBastion?: boolean - /** Port of the SSH bastion. */ + /** + * Port of the SSH bastion. + */ bastionPort?: number - /** Defines whether SMTP traffic should be allowed to pass through the gateway. */ + /** + * Defines whether SMTP traffic should be allowed to pass through the gateway. + */ enableSmtp?: boolean } 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 IP address to update. */ + /** + * ID of the IP address to update. + */ ipId: string - /** Tags to give to the IP address. */ + /** + * Tags to give to the IP address. + */ tags?: string[] - /** Reverse to set on the address. Empty string to unset. */ + /** + * Reverse to set on the address. Empty string to unset. + */ reverse?: string - /** Gateway to attach the IP address to. Empty string to detach. */ + /** + * Gateway to attach the IP address to. Empty string to detach. + */ gatewayId?: string } export type UpdatePatRuleRequest = { - /** 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 PAT rule to update. */ + /** + * ID of the PAT rule to update. + */ patRuleId: string - /** Public port to listen on. */ + /** + * Public port to listen on. + */ publicPort?: number - /** Private IP to forward data to. */ + /** + * Private IP to forward data to. + */ privateIp?: string - /** Private port to translate to. */ + /** + * Private port to translate to. + */ privatePort?: number - /** Protocol the rule should apply to. */ + /** + * Protocol the rule should apply to. + */ protocol?: PatRuleProtocol } export type UpgradeGatewayRequest = { - /** 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 gateway to upgrade. */ + /** + * ID of the gateway to upgrade. + */ gatewayId: string - /** Gateway type (commercial offer). */ + /** + * Gateway type (commercial offer). + */ type?: string } diff --git a/packages/clients/src/api/webhosting/index.gen.ts b/packages/clients/src/api/webhosting/index.gen.ts index a86d42c0b..aff657f1e 100644 --- a/packages/clients/src/api/webhosting/index.gen.ts +++ b/packages/clients/src/api/webhosting/index.gen.ts @@ -1,6 +1,6 @@ /** - * This file is automatically generated from /scripts/generate.js PLEASE DO NOT - * EDIT HERE + * This file is automatically generated from /scripts/generate.js + * PLEASE DO NOT EDIT HERE */ export * as v1 from './v1/index.gen' diff --git a/packages/clients/src/api/webhosting/v1/api.gen.ts b/packages/clients/src/api/webhosting/v1/api.gen.ts index 2408be246..c702a59b6 100644 --- a/packages/clients/src/api/webhosting/v1/api.gen.ts +++ b/packages/clients/src/api/webhosting/v1/api.gen.ts @@ -112,8 +112,8 @@ const jsonContentHeaders = { /** * Web Hosting Control Panel API. - * - * This API allows you to manage your Web Hosting services. + +This API allows you to manage your Web Hosting services. */ export class ControlPanelAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -155,9 +155,8 @@ export class ControlPanelAPI extends ParentAPI { /** * Web Hosting Database API. - * - * This API allows you to manage your databases and database users for your Web - * Hosting services. + +This API allows you to manage your databases and database users for your Web Hosting services. */ export class DatabaseAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -335,8 +334,7 @@ export class DatabaseAPI extends ParentAPI { /** * "Change the password of a database user". * - * @param request - The request - * {@link DatabaseApiChangeDatabaseUserPasswordRequest} + * @param request - The request {@link DatabaseApiChangeDatabaseUserPasswordRequest} * @returns A Promise of DatabaseUser */ changeDatabaseUserPassword = ( @@ -408,8 +406,8 @@ export class DatabaseAPI extends ParentAPI { /** * Web Hosting Dns API. - * - * This API allows you to manage your Web Hosting services. + +This API allows you to manage your Web Hosting services. */ export class DnsAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -420,8 +418,7 @@ export class DnsAPI extends ParentAPI { ] /** - * Get DNS records. Get the set of DNS records of a specified domain - * associated with a Web Hosting plan's domain. + * Get DNS records. Get the set of DNS records of a specified domain associated with a Web Hosting plan's domain. * * @param request - The request {@link DnsApiGetDomainDnsRecordsRequest} * @returns A Promise of DnsRecords @@ -436,8 +433,7 @@ export class DnsAPI extends ParentAPI { ) /** - * Check whether you own this domain or not.. Check whether you own this - * domain or not. + * Check whether you own this domain or not.. Check whether you own this domain or not. * * @param request - The request {@link DnsApiCheckUserOwnsDomainRequest} * @returns A Promise of CheckUserOwnsDomainResponse @@ -459,8 +455,7 @@ export class DnsAPI extends ParentAPI { ) /** - * Synchronize your DNS records on the Elements Console and on cPanel.. - * Synchronize your DNS records on the Elements Console and on cPanel. + * Synchronize your DNS records on the Elements Console and on cPanel.. Synchronize your DNS records on the Elements Console and on cPanel. * * @param request - The request {@link DnsApiSyncDomainDnsRecordsRequest} * @returns A Promise of DnsRecords @@ -484,8 +479,7 @@ export class DnsAPI extends ParentAPI { ) /** - * Search for available domains based on domain name.. Search for available - * domains based on domain name. + * Search for available domains based on domain name.. Search for available domains based on domain name. * * @param request - The request {@link DnsApiSearchDomainsRequest} * @returns A Promise of SearchDomainsResponse @@ -507,10 +501,7 @@ export class DnsAPI extends ParentAPI { ) /** - * Retrieve detailed information about a specific domain, including its - * status, DNS configuration, and ownership.. Retrieve detailed information - * about a specific domain, including its status, DNS configuration, and - * ownership. + * Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership.. Retrieve detailed information about a specific domain, including its status, DNS configuration, and ownership. * * @param request - The request {@link DnsApiGetDomainRequest} * @returns A Promise of Domain @@ -553,8 +544,8 @@ export class DnsAPI extends ParentAPI { /** * Web Hosting Offer API. - * - * This API allows you to manage your offer for your Web Hosting services. + +This API allows you to manage your offer for your Web Hosting services. */ export class OfferAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -586,8 +577,7 @@ export class OfferAPI extends ParentAPI { ) /** - * List all available hosting offers along with their specific options.. List - * all available hosting offers along with their specific options. + * List all available hosting offers along with their specific options.. List all available hosting offers along with their specific options. * * @param request - The request {@link OfferApiListOffersRequest} * @returns A Promise of ListOffersResponse @@ -598,8 +588,8 @@ export class OfferAPI extends ParentAPI { /** * Web Hosting API. - * - * This API allows you to manage your Web Hosting services. + +This API allows you to manage your Web Hosting services. */ export class HostingAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -610,8 +600,7 @@ export class HostingAPI extends ParentAPI { ] /** - * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer - * type required via the `offer_id` parameter. + * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer type required via the `offer_id` parameter. * * @param request - The request {@link HostingApiCreateHostingRequest} * @returns A Promise of Hosting @@ -655,9 +644,7 @@ export class HostingAPI extends ParentAPI { ) /** - * List all Web Hosting plans. List all of your existing Web Hosting plans. - * Various filters are available to limit the results, including filtering by - * domain, status, tag and Project ID. + * List all Web Hosting plans. List all of your existing Web Hosting plans. Various filters are available to limit the results, including filtering by domain, status, tag and Project ID. * * @param request - The request {@link HostingApiListHostingsRequest} * @returns A Promise of ListHostingsResponse @@ -666,8 +653,7 @@ export class HostingAPI extends ParentAPI { enrichForPagination('hostings', this.pageOfListHostings, request) /** - * Get a Web Hosting plan. Get the details of one of your existing Web Hosting - * plans, specified by its `hosting_id`. + * Get a Web Hosting plan. Get the details of one of your existing Web Hosting plans, specified by its `hosting_id`. * * @param request - The request {@link HostingApiGetHostingRequest} * @returns A Promise of Hosting @@ -704,9 +690,7 @@ export class HostingAPI extends ParentAPI { ) /** - * Update a Web Hosting plan. Update the details of one of your existing Web - * Hosting plans, specified by its `hosting_id`. You can update parameters - * including the contact email address, tags, options and offer. + * Update a Web Hosting plan. Update the details of one of your existing Web Hosting plans, specified by its `hosting_id`. You can update parameters including the contact email address, tags, options and offer. * * @param request - The request {@link HostingApiUpdateHostingRequest} * @returns A Promise of Hosting @@ -725,10 +709,7 @@ export class HostingAPI extends ParentAPI { ) /** - * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its - * `hosting_id`. Note that deletion is not immediate: it will take place at - * the end of the calendar month, after which time your Web Hosting plan and - * all its data (files and emails) will be irreversibly lost. + * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its `hosting_id`. Note that deletion is not immediate: it will take place at the end of the calendar month, after which time your Web Hosting plan and all its data (files and emails) will be irreversibly lost. * * @param request - The request {@link HostingApiDeleteHostingRequest} * @returns A Promise of Hosting @@ -779,8 +760,7 @@ export class HostingAPI extends ParentAPI { ) /** - * Get the total counts of websites, databases, email accounts, and FTP - * accounts of a Web Hosting plan. + * Get the total counts of websites, databases, email accounts, and FTP accounts of a Web Hosting plan. * * @param request - The request {@link HostingApiGetResourceSummaryRequest} * @returns A Promise of ResourceSummary @@ -799,9 +779,8 @@ export class HostingAPI extends ParentAPI { /** * Web Hosting FTP Account API. - * - * This API allows you to manage your FTP accounts for your Web Hosting - * services. + +This API allows you to manage your FTP accounts for your Web Hosting services. */ export class FtpAccountAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -812,8 +791,7 @@ export class FtpAccountAPI extends ParentAPI { ] /** - * Create a new FTP account within your hosting plan.. Create a new FTP - * account within your hosting plan. + * Create a new FTP account within your hosting plan.. Create a new FTP account within your hosting plan. * * @param request - The request {@link FtpAccountApiCreateFtpAccountRequest} * @returns A Promise of FtpAccount @@ -857,8 +835,7 @@ export class FtpAccountAPI extends ParentAPI { ) /** - * List all FTP accounts within your hosting plan.. List all FTP accounts - * within your hosting plan. + * List all FTP accounts within your hosting plan.. List all FTP accounts within your hosting plan. * * @param request - The request {@link FtpAccountApiListFtpAccountsRequest} * @returns A Promise of ListFtpAccountsResponse @@ -867,8 +844,7 @@ export class FtpAccountAPI extends ParentAPI { enrichForPagination('ftpAccounts', this.pageOfListFtpAccounts, request) /** - * Delete a specific FTP account within your hosting plan.. Delete a specific - * FTP account within your hosting plan. + * Delete a specific FTP account within your hosting plan.. Delete a specific FTP account within your hosting plan. * * @param request - The request {@link FtpAccountApiRemoveFtpAccountRequest} * @returns A Promise of FtpAccount @@ -905,9 +881,8 @@ export class FtpAccountAPI extends ParentAPI { /** * Web Hosting Mail Account API. - * - * This API allows you to manage your mail accounts for your Web Hosting - * services. + +This API allows you to manage your mail accounts for your Web Hosting services. */ export class MailAccountAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -918,8 +893,7 @@ export class MailAccountAPI extends ParentAPI { ] /** - * Create a new mail account within your hosting plan.. Create a new mail - * account within your hosting plan. + * Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan. * * @param request - The request {@link MailAccountApiCreateMailAccountRequest} * @returns A Promise of MailAccount @@ -963,8 +937,7 @@ export class MailAccountAPI extends ParentAPI { ) /** - * List all mail accounts within your hosting plan.. List all mail accounts - * within your hosting plan. + * List all mail accounts within your hosting plan.. List all mail accounts within your hosting plan. * * @param request - The request {@link MailAccountApiListMailAccountsRequest} * @returns A Promise of ListMailAccountsResponse @@ -974,8 +947,7 @@ export class MailAccountAPI extends ParentAPI { ) => enrichForPagination('mailAccounts', this.pageOfListMailAccounts, request) /** - * Delete a mail account within your hosting plan.. Delete a mail account - * within your hosting plan. + * Delete a mail account within your hosting plan.. Delete a mail account within your hosting plan. * * @param request - The request {@link MailAccountApiRemoveMailAccountRequest} * @returns A Promise of MailAccount @@ -999,11 +971,9 @@ export class MailAccountAPI extends ParentAPI { ) /** - * Update the password of a mail account within your hosting plan.. Update the - * password of a mail account within your hosting plan. + * Update the password of a mail account within your hosting plan.. Update the password of a mail account within your hosting plan. * - * @param request - The request - * {@link MailAccountApiChangeMailAccountPasswordRequest} + * @param request - The request {@link MailAccountApiChangeMailAccountPasswordRequest} * @returns A Promise of MailAccount */ changeMailAccountPassword = ( @@ -1027,8 +997,8 @@ export class MailAccountAPI extends ParentAPI { /** * Web Hosting Website API. - * - * This API allows you to manage your websites for your Web Hosting services. + +This API allows you to manage your websites for your Web Hosting services. */ export class WebsiteAPI extends ParentAPI { /** Lists the available regions of the API. */ @@ -1058,8 +1028,7 @@ export class WebsiteAPI extends ParentAPI { ) /** - * List all websites for a specific hosting.. List all websites for a specific - * hosting. + * List all websites for a specific hosting.. List all websites for a specific hosting. * * @param request - The request {@link WebsiteApiListWebsitesRequest} * @returns A Promise of ListWebsitesResponse diff --git a/packages/clients/src/api/webhosting/v1/types.gen.ts b/packages/clients/src/api/webhosting/v1/types.gen.ts index c4ced7d4b..ce649b887 100644 --- a/packages/clients/src/api/webhosting/v1/types.gen.ts +++ b/packages/clients/src/api/webhosting/v1/types.gen.ts @@ -110,38 +110,59 @@ export type OfferOptionWarning = export type PlatformPlatformGroup = 'unknown_group' | 'default' | 'premium' export interface PlatformControlPanelUrls { - /** URL to connect to the hosting control panel dashboard. */ + /** + * URL to connect to the hosting control panel dashboard. + */ dashboard: string - /** URL to connect to the hosting Webmail interface. */ + /** + * URL to connect to the hosting Webmail interface. + */ webmail: string } export interface OfferOption { - /** Option ID. */ + /** + * Option ID. + */ id: string - /** Name of the option. */ + /** + * Name of the option. + */ name: OfferOptionName - /** Unique identifier used for billing. */ + /** + * Unique identifier used for billing. + */ billingOperationPath: string - /** Minimum value for the option in the offer. */ + /** + * Minimum value for the option in the offer. + */ minValue: number /** - * If a hosting_id was specified in the call, defines the current value of the - * option in the hosting. + * If a hosting_id was specified in the call, defines the current value of the option in the hosting. */ currentValue: number - /** Maximum value for the option in the offer. */ + /** + * Maximum value for the option in the offer. + */ maxValue: number - /** Defines a warning if the maximum value for the option has been reached. */ + /** + * Defines a warning if the maximum value for the option has been reached. + */ quotaWarning: OfferOptionWarning - /** Price of the option for 1 value. */ + /** + * Price of the option for 1 value. + */ price?: Money } export interface PlatformControlPanel { - /** Name of the control panel. */ + /** + * Name of the control panel. + */ name: string - /** URL to connect to cPanel dashboard and to Webmail interface. */ + /** + * URL to connect to cPanel dashboard and to Webmail interface. + */ urls?: PlatformControlPanelUrls } @@ -151,20 +172,24 @@ export interface CreateDatabaseRequestUser { } export interface AutoConfigDomainDns { - /** Whether or not to synchronize domain nameservers. */ + /** + * Whether or not to synchronize domain nameservers. + */ nameservers: boolean - /** Whether or not to synchronize web records. */ + /** + * Whether or not to synchronize web records. + */ webRecords: boolean - /** Whether or not to synchronize mail records. */ + /** + * Whether or not to synchronize mail records. + */ mailRecords: boolean /** - * Whether or not to synchronize all types of records. Takes priority over the - * other fields. + * Whether or not to synchronize all types of records. Takes priority over the other fields. */ allRecords: boolean /** - * No automatic domain configuration. Users must configure their domain for - * the Web Hosting to work. + * No automatic domain configuration. Users must configure their domain for the Web Hosting to work. */ none: boolean } @@ -177,9 +202,13 @@ export interface CreateHostingRequestDomainConfiguration { } export interface OfferOptionRequest { - /** Offer option ID. */ + /** + * Offer option ID. + */ id: string - /** The option requested quantity to set for the Web Hosting plan. */ + /** + * The option requested quantity to set for the Web Hosting plan. + */ quantity: number } @@ -189,233 +218,356 @@ export interface SyncDomainDnsRecordsRequestRecord { } export interface DnsRecord { - /** Record name. */ + /** + * Record name. + */ name: string - /** Record type. */ + /** + * Record type. + */ type: DnsRecordType - /** Record time-to-live. */ + /** + * Record time-to-live. + */ ttl: number - /** Record value. */ + /** + * Record value. + */ value: string - /** Record priority level. */ + /** + * Record priority level. + */ priority?: number - /** Record status. */ + /** + * Record status. + */ status: DnsRecordStatus /** - * Record representation as it appears in the zone file or DNS management - * system. + * Record representation as it appears in the zone file or DNS management system. */ rawData: string } export interface Nameserver { - /** Hostname of the nameserver. */ + /** + * Hostname of the nameserver. + */ hostname: string - /** Status of the nameserver. */ + /** + * Status of the nameserver. + */ status: NameserverStatus - /** Defines whether the nameserver is the default one. */ + /** + * Defines whether the nameserver is the default one. + */ isDefault: boolean } export interface HostingUser { - /** Main Web Hosting cPanel username. */ + /** + * Main Web Hosting cPanel username. + */ username: string /** - * One-time-password used for the first login or reset password, empty after - * first use. + * One-time-password used for the first login or reset password, empty after first use. */ oneTimePassword?: string - /** Contact email used for the hosting. */ + /** + * Contact email used for the hosting. + */ contactEmail: string } export interface Offer { - /** Offer ID. */ + /** + * Offer ID. + */ id: string - /** Offer name. */ + /** + * Offer name. + */ name: string - /** Unique identifier used for billing. */ + /** + * Unique identifier used for billing. + */ billingOperationPath: string - /** Options available for the offer. */ + /** + * Options available for the offer. + */ options: OfferOption[] - /** Price of the offer. */ + /** + * Price of the offer. + */ price?: Money /** - * If a hosting_id was specified in the call, defines whether the offer is - * available for a specified hosting plan to migrate (update) to. + * If a hosting_id was specified in the call, defines whether the offer is available for a specified hosting plan to migrate (update) to. */ available: boolean - /** Name of the control panel. */ + /** + * Name of the control panel. + */ controlPanelName: string - /** Indicates if the offer has reached its end of life. */ + /** + * Indicates if the offer has reached its end of life. + */ endOfLife: boolean /** - * Defines a warning if the maximum value for an option in the offer is - * exceeded. + * Defines a warning if the maximum value for an option in the offer is exceeded. */ quotaWarning: OfferOptionWarning } export interface Platform { - /** Hostname of the host platform. */ + /** + * Hostname of the host platform. + */ hostname: string - /** Number of the host platform. */ + /** + * Number of the host platform. + */ number: number - /** Group name of the hosting's host platform. */ + /** + * Group name of the hosting's host platform. + */ groupName: PlatformPlatformGroup - /** IPv4 address of the hosting's host platform. */ + /** + * IPv4 address of the hosting's host platform. + */ ipv4: string - /** IPv6 address of the hosting's host platform. */ + /** + * IPv6 address of the hosting's host platform. + */ ipv6: string - /** Details of the platform control panel. */ + /** + * Details of the platform control panel. + */ controlPanel?: PlatformControlPanel } export interface ControlPanel { - /** Control panel name. */ + /** + * Control panel name. + */ name: string - /** Define if the control panel type is available to order. */ + /** + * Define if the control panel type is available to order. + */ available: boolean - /** URL of the control panel's logo. */ + /** + * URL of the control panel's logo. + */ logoUrl: string - /** List of available languages for the control panel. */ + /** + * List of available languages for the control panel. + */ availableLanguages: StdLanguageCode[] } export interface DatabaseUser { - /** Name of the database user. */ + /** + * Name of the database user. + */ username: string - /** List of databases accessible by the user. */ + /** + * List of databases accessible by the user. + */ databases: string[] } export interface Database { - /** Name of the database. */ + /** + * Name of the database. + */ databaseName: string - /** List of users who have access to the database. */ + /** + * List of users who have access to the database. + */ users: string[] } export interface FtpAccount { - /** The username of the FTP account. */ + /** + * The username of the FTP account. + */ username: string - /** The path associated with the FTP account. */ + /** + * The path associated with the FTP account. + */ path: string } export interface HostingSummary { - /** ID of the Web Hosting plan. */ + /** + * ID of the Web Hosting plan. + */ id: string - /** ID of the Scaleway Project the Web Hosting plan belongs to. */ + /** + * ID of the Scaleway Project the Web Hosting plan belongs to. + */ projectId: string - /** Date on which the Web Hosting plan was created. */ + /** + * Date on which the Web Hosting plan was created. + */ createdAt?: Date - /** Date on which the Web Hosting plan was last updated. */ + /** + * Date on which the Web Hosting plan was last updated. + */ updatedAt?: Date - /** Status of the Web Hosting plan. */ + /** + * Status of the Web Hosting plan. + */ status: HostingStatus - /** Main domain associated with the Web Hosting plan. */ + /** + * Main domain associated with the Web Hosting plan. + */ domain: string - /** Whether the hosting is protected or not. */ + /** + * Whether the hosting is protected or not. + */ protected: boolean - /** @deprecated DNS status of the Web Hosting plan. */ + /** + * @deprecated DNS status of the Web Hosting plan. + */ dnsStatus?: DnsRecordsStatus - /** Name of the active offer for the Web Hosting plan. */ + /** + * Name of the active offer for the Web Hosting plan. + */ offerName: string - /** Main domain status of the Web Hosting plan. */ + /** + * Main domain status of the Web Hosting plan. + */ domainStatus: DomainStatus - /** Region where the Web Hosting plan is hosted. */ + /** + * Region where the Web Hosting plan is hosted. + */ region: ScwRegion } export interface MailAccount { - /** Domain part of the mail account address. */ + /** + * Domain part of the mail account address. + */ domain: string - /** Username part address of the mail account address. */ + /** + * Username part address of the mail account address. + */ username: string } export interface Website { - /** The domain of the website. */ + /** + * The domain of the website. + */ domain: string - /** The directory path of the website. */ + /** + * The directory path of the website. + */ path: string - /** The SSL status of the website. */ + /** + * The SSL status of the website. + */ sslStatus: boolean } export interface DomainAvailability { - /** Fully qualified domain name (FQDN). */ + /** + * Fully qualified domain name (FQDN). + */ name: string - /** DNS zone associated with the domain. */ + /** + * DNS zone associated with the domain. + */ zoneName: string - /** Availability status of the domain. */ + /** + * Availability status of the domain. + */ status: DomainAvailabilityStatus - /** A list of actions that can be performed on the domain. */ + /** + * A list of actions that can be performed on the domain. + */ availableActions: DomainAvailabilityAction[] - /** Whether a hosting can be created for this domain. */ + /** + * Whether a hosting can be created for this domain. + */ canCreateHosting: boolean - /** Price for registering the domain. */ + /** + * Price for registering the domain. + */ price?: Money } export interface CheckUserOwnsDomainResponse { - /** Indicates whether the specified project owns the domain. */ + /** + * Indicates whether the specified project owns the domain. + */ ownsDomain: boolean } export type ControlPanelApiListControlPanelsRequest = { /** - * Region to target. If none is 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 (must be a positive integer). */ + /** + * Page number (must be a positive integer). + */ page?: number /** - * Number of control panels to return (must be a positive integer lower or - * equal to 100). + * Number of control panels to return (must be a positive integer lower or equal to 100). */ pageSize?: number } export type DatabaseApiAssignDatabaseUserRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the database to be assigned. */ + /** + * Name of the database to be assigned. + */ databaseName: string - /** Name of the user to assign. */ + /** + * Name of the user to assign. + */ username: string } export type DatabaseApiChangeDatabaseUserPasswordRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the user to update. */ + /** + * Name of the user to update. + */ username: string - /** New password. */ + /** + * New password. + */ password: string } export type DatabaseApiCreateDatabaseRequest = { /** - * Region to target. If none is 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 hosting plan where the database will be created. */ + /** + * UUID of the hosting plan where the database will be created. + */ hostingId: string - /** Name of the database to be created. */ + /** + * Name of the database to be created. + */ databaseName: string /** * (Optional) Username and password to create a user and link to the database. @@ -433,681 +585,878 @@ export type DatabaseApiCreateDatabaseRequest = { export type DatabaseApiCreateDatabaseUserRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the user to create. */ + /** + * Name of the user to create. + */ username: string - /** Password of the user to create. */ + /** + * Password of the user to create. + */ password: string } export type DatabaseApiDeleteDatabaseRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the database to delete. */ + /** + * Name of the database to delete. + */ databaseName: string } export type DatabaseApiDeleteDatabaseUserRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the database user to delete. */ + /** + * Name of the database user to delete. + */ username: string } export type DatabaseApiGetDatabaseRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the database. */ + /** + * Name of the database. + */ databaseName: string } export type DatabaseApiGetDatabaseUserRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the database user to retrieve details. */ + /** + * Name of the database user to retrieve details. + */ username: string } export type DatabaseApiListDatabaseUsersRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Page number (must be a positive integer). */ + /** + * Page number (must be a positive integer). + */ page?: number /** - * Number of database users to return (must be a positive integer lower or - * equal to 100). + * Number of database users to return (must be a positive integer lower or equal to 100). */ pageSize?: number - /** Sort order of database users in the response. */ + /** + * Sort order of database users in the response. + */ orderBy?: ListDatabaseUsersRequestOrderBy } export type DatabaseApiListDatabasesRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Page number (must be a positive integer). */ + /** + * Page number (must be a positive integer). + */ page?: number /** - * Number of databases to return (must be a positive integer lower or equal to - * 100). + * Number of databases to return (must be a positive integer lower or equal to 100). */ pageSize?: number - /** Sort order of databases in the response. */ + /** + * Sort order of databases in the response. + */ orderBy?: ListDatabasesRequestOrderBy } export type DatabaseApiUnassignDatabaseUserRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Name of the database to be unassigned. */ + /** + * Name of the database to be unassigned. + */ databaseName: string - /** Name of the user to unassign. */ + /** + * Name of the user to unassign. + */ username: string } export type DnsApiCheckUserOwnsDomainRequest = { /** - * Region to target. If none is 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 for which ownership is to be verified. */ + /** + * Domain for which ownership is to be verified. + */ domain: string - /** ID of the project currently in use. */ + /** + * ID of the project currently in use. + */ projectId?: string } export type DnsApiGetDomainDnsRecordsRequest = { /** - * Region to target. If none is 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 associated with the DNS records. */ + /** + * Domain associated with the DNS records. + */ domain: string } export type DnsApiGetDomainRequest = { /** - * Region to target. If none is 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 name to get. */ + /** + * Domain name to get. + */ domainName: string /** - * ID of the Scaleway Project in which to get the domain to create the Web - * Hosting plan. + * ID of the Scaleway Project in which to get the domain to create the Web Hosting plan. */ projectId?: string } export type DnsApiSearchDomainsRequest = { /** - * Region to target. If none is 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 name to search. */ + /** + * Domain name to search. + */ domainName: string /** - * ID of the Scaleway Project in which to search the domain to create the Web - * Hosting plan. + * ID of the Scaleway Project in which to search the domain to create the Web Hosting plan. */ projectId?: string } export type DnsApiSyncDomainDnsRecordsRequest = { /** - * Region to target. If none is 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 for which the DNS records will be synchronized. */ + /** + * Domain for which the DNS records will be synchronized. + */ domain: string /** - * @deprecated Whether or not to synchronize the web records (deprecated, use - * auto_config_domain_dns). + * @deprecated Whether or not to synchronize the web records (deprecated, use auto_config_domain_dns). */ updateWebRecords?: boolean /** - * @deprecated Whether or not to synchronize the mail records (deprecated, use - * auto_config_domain_dns). + * @deprecated Whether or not to synchronize the mail records (deprecated, use auto_config_domain_dns). */ updateMailRecords?: boolean /** - * @deprecated Whether or not to synchronize all types of records. This one - * has priority (deprecated, use auto_config_domain_dns). + * @deprecated Whether or not to synchronize all types of records. This one has priority (deprecated, use auto_config_domain_dns). */ updateAllRecords?: boolean /** - * @deprecated Whether or not to synchronize domain nameservers (deprecated, - * use auto_config_domain_dns). + * @deprecated Whether or not to synchronize domain nameservers (deprecated, use auto_config_domain_dns). */ updateNameservers?: boolean - /** @deprecated Custom records to synchronize. */ + /** + * @deprecated Custom records to synchronize. + */ customRecords?: SyncDomainDnsRecordsRequestRecord[] - /** Whether or not to synchronize each types of records. */ + /** + * Whether or not to synchronize each types of records. + */ autoConfigDomainDns?: AutoConfigDomainDns } export interface DnsRecords { - /** List of DNS records. */ + /** + * List of DNS records. + */ records: DnsRecord[] - /** List of nameservers. */ + /** + * List of nameservers. + */ nameServers: Nameserver[] - /** Status of the records. */ + /** + * Status of the records. + */ status: DnsRecordsStatus /** - * @deprecated Records dns auto configuration settings (deprecated, use - * auto_config_domain_dns). + * @deprecated Records dns auto configuration settings (deprecated, use auto_config_domain_dns). */ dnsConfig?: DomainDnsAction[] - /** Whether or not to synchronize each types of records. */ + /** + * Whether or not to synchronize each types of records. + */ autoConfigDomainDns?: AutoConfigDomainDns } export interface Domain { - /** Name of the domain. */ + /** + * Name of the domain. + */ name: string - /** Current status of the domain. */ + /** + * Current status of the domain. + */ status: DomainStatus - /** Zone owner of the domain. */ + /** + * Zone owner of the domain. + */ owner: DomainZoneOwner - /** A list of actions that can be performed on the domain. */ + /** + * A list of actions that can be performed on the domain. + */ availableActions: DomainAction[] /** - * @deprecated A list of DNS-related actions that can be auto configured for - * the domain (deprecated, use auto_config_domain_dns instead). + * @deprecated A list of DNS-related actions that can be auto configured for the domain (deprecated, use auto_config_domain_dns instead). */ availableDnsActions?: DomainDnsAction[] - /** Whether or not to synchronize each type of record. */ + /** + * Whether or not to synchronize each type of record. + */ autoConfigDomainDns?: AutoConfigDomainDns } export type FtpAccountApiChangeFtpAccountPasswordRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Username of the FTP account. */ + /** + * Username of the FTP account. + */ username: string - /** New password for the FTP account. */ + /** + * New password for the FTP account. + */ password: string } export type FtpAccountApiCreateFtpAccountRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Username for the new FTP account. */ + /** + * Username for the new FTP account. + */ username: string - /** Path for the new FTP account. */ + /** + * Path for the new FTP account. + */ path: string - /** Password for the new FTP account. */ + /** + * Password for the new FTP account. + */ password: string } export type FtpAccountApiListFtpAccountsRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Page number (must be a positive integer). */ + /** + * Page number (must be a positive integer). + */ page?: number /** - * Number of FTP accounts to return (must be a positive integer lower or equal - * to 100). + * Number of FTP accounts to return (must be a positive integer lower or equal to 100). */ pageSize?: number - /** Sort order of FTP accounts in the response. */ + /** + * Sort order of FTP accounts in the response. + */ orderBy?: ListFtpAccountsRequestOrderBy - /** Domain to filter the FTP accounts. */ + /** + * Domain to filter the FTP accounts. + */ domain?: string } export type FtpAccountApiRemoveFtpAccountRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Username of the FTP account to be deleted. */ + /** + * Username of the FTP account to be deleted. + */ username: string } export interface Hosting { - /** ID of the Web Hosting plan. */ + /** + * ID of the Web Hosting plan. + */ id: string - /** ID of the Scaleway Project the Web Hosting plan belongs to. */ + /** + * ID of the Scaleway Project the Web Hosting plan belongs to. + */ projectId: string - /** Date on which the Web Hosting plan was last updated. */ + /** + * Date on which the Web Hosting plan was last updated. + */ updatedAt?: Date - /** Date on which the Web Hosting plan was created. */ + /** + * Date on which the Web Hosting plan was created. + */ createdAt?: Date - /** Status of the Web Hosting plan. */ + /** + * Status of the Web Hosting plan. + */ status: HostingStatus - /** Main domain associated with the Web Hosting plan. */ + /** + * Main domain associated with the Web Hosting plan. + */ domain: string - /** Details of the Web Hosting plan offer and options. */ + /** + * Details of the Web Hosting plan offer and options. + */ offer?: Offer - /** Details of the hosting platform. */ + /** + * Details of the hosting platform. + */ platform?: Platform - /** List of tags associated with the Web Hosting plan. */ + /** + * List of tags associated with the Web Hosting plan. + */ tags: string[] - /** @deprecated DNS status of the Web Hosting plan. */ + /** + * @deprecated DNS status of the Web Hosting plan. + */ dnsStatus?: DnsRecordsStatus - /** Current IPv4 address of the hosting. */ + /** + * Current IPv4 address of the hosting. + */ ipv4: string - /** Whether the hosting is protected or not. */ + /** + * Whether the hosting is protected or not. + */ protected: boolean - /** Details of the hosting user. */ + /** + * Details of the hosting user. + */ user?: HostingUser - /** Main domain status of the Web Hosting plan. */ + /** + * Main domain status of the Web Hosting plan. + */ domainStatus: DomainStatus - /** Region where the Web Hosting plan is hosted. */ + /** + * Region where the Web Hosting plan is hosted. + */ region: ScwRegion } export type HostingApiCreateHostingRequest = { /** - * Region to target. If none is 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 selected offer for the Web Hosting plan. */ + /** + * ID of the selected offer for the Web Hosting plan. + */ offerId: string - /** ID of the Scaleway Project in which to create the Web Hosting plan. */ + /** + * ID of the Scaleway Project in which to create the Web Hosting plan. + */ projectId?: string - /** Contact email for the Web Hosting client. */ + /** + * Contact email for the Web Hosting client. + */ email: string - /** List of tags for the Web Hosting plan. */ + /** + * List of tags for the Web Hosting plan. + */ tags?: string[] /** - * Domain name to link to the Web Hosting plan. You must already own this - * domain name, and have completed the DNS validation process beforehand. + * Domain name to link to the Web Hosting plan. You must already own this domain name, and have completed the DNS validation process beforehand. */ domain: string - /** List of the Web Hosting plan options IDs with their quantities. */ + /** + * List of the Web Hosting plan options IDs with their quantities. + */ offerOptions?: OfferOptionRequest[] - /** Default language for the control panel interface. */ + /** + * Default language for the control panel interface. + */ language?: StdLanguageCode /** - * @deprecated Indicates whether to update hosting domain name servers and DNS - * records for domains managed by Scaleway Elements (deprecated, use - * auto_config_domain_dns instead). + * @deprecated Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_config_domain_dns instead). */ domainConfiguration?: CreateHostingRequestDomainConfiguration /** - * Indicates whether to skip a welcome email to the contact email containing - * hosting info. + * Indicates whether to skip a welcome email to the contact email containing hosting info. */ skipWelcomeEmail?: boolean /** - * Indicates whether to update hosting domain name servers and DNS records for - * domains managed by Scaleway Elements (deprecated, use auto_update_* fields - * instead). + * Indicates whether to update hosting domain name servers and DNS records for domains managed by Scaleway Elements (deprecated, use auto_update_* fields instead). */ autoConfigDomainDns?: AutoConfigDomainDns } export type HostingApiCreateSessionRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hosting ID. */ + /** + * Hosting ID. + */ hostingId: string } export type HostingApiDeleteHostingRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hosting ID. */ + /** + * Hosting ID. + */ hostingId: string } export type HostingApiGetHostingRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hosting ID. */ + /** + * Hosting ID. + */ hostingId: string } export type HostingApiGetResourceSummaryRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hosting ID. */ + /** + * Hosting ID. + */ hostingId: string } export type HostingApiListHostingsRequest = { /** - * Region to target. If none is 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 (must be a positive - * integer). + * Page number to return, from the paginated results (must be a positive integer). */ page?: number /** - * Number of Web Hosting plans to return (must be a positive integer lower or - * equal to 100). + * Number of Web Hosting plans to return (must be a positive integer lower or equal to 100). */ pageSize?: number - /** Sort order for Web Hosting plans in the response. */ + /** + * Sort order for Web Hosting plans in the response. + */ orderBy?: ListHostingsRequestOrderBy /** - * Tags to filter for, only Web Hosting plans with matching tags will be - * returned. + * Tags to filter for, only Web Hosting plans with matching tags will be returned. */ tags?: string[] /** - * Statuses to filter for, only Web Hosting plans with matching statuses will - * be returned. + * Statuses to filter for, only Web Hosting plans with matching statuses will be returned. */ statuses?: HostingStatus[] /** - * Domain to filter for, only Web Hosting plans associated with this domain - * will be returned. + * Domain to filter for, only Web Hosting plans associated with this domain will be returned. */ domain?: string /** - * Project ID to filter for, only Web Hosting plans from this Project will be - * returned. + * Project ID to filter for, only Web Hosting plans from this Project will be returned. */ projectId?: string /** - * Organization ID to filter for, only Web Hosting plans from this - * Organization will be returned. + * Organization ID to filter for, only Web Hosting plans from this Organization will be returned. */ organizationId?: string /** - * Name of the control panel to filter for, only Web Hosting plans from this - * control panel will be returned. + * Name of the control panel to filter for, only Web Hosting plans from this control panel will be returned. */ controlPanels?: string[] } export type HostingApiResetHostingPasswordRequest = { /** - * Region to target. If none is 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 hosting. */ + /** + * UUID of the hosting. + */ hostingId: string } export type HostingApiUpdateHostingRequest = { /** - * Region to target. If none is passed will use default region from the - * config. + * Region to target. If none is passed will use default region from the config. */ region?: ScwRegion - /** Hosting ID. */ + /** + * Hosting ID. + */ hostingId: string - /** New contact email for the Web Hosting plan. */ + /** + * New contact email for the Web Hosting plan. + */ email?: string - /** New tags for the Web Hosting plan. */ + /** + * New tags for the Web Hosting plan. + */ tags?: string[] - /** List of the Web Hosting plan options IDs with their quantities. */ + /** + * List of the Web Hosting plan options IDs with their quantities. + */ offerOptions?: OfferOptionRequest[] - /** ID of the new offer for the Web Hosting plan. */ + /** + * ID of the new offer for the Web Hosting plan. + */ offerId?: string - /** Whether the hosting is protected or not. */ + /** + * Whether the hosting is protected or not. + */ protected?: boolean } export interface ListControlPanelsResponse { - /** Number of control panels returned. */ + /** + * Number of control panels returned. + */ totalCount: number - /** List of control panels. */ + /** + * List of control panels. + */ controlPanels: ControlPanel[] } export interface ListDatabaseUsersResponse { - /** Total number of database users. */ + /** + * Total number of database users. + */ totalCount: number - /** List of database users. */ + /** + * List of database users. + */ users: DatabaseUser[] } export interface ListDatabasesResponse { - /** Total number of databases. */ + /** + * Total number of databases. + */ totalCount: number - /** List of databases. */ + /** + * List of databases. + */ databases: Database[] } export interface ListFtpAccountsResponse { - /** Total number of FTP accounts. */ + /** + * Total number of FTP accounts. + */ totalCount: number - /** List of FTP accounts. */ + /** + * List of FTP accounts. + */ ftpAccounts: FtpAccount[] } export interface ListHostingsResponse { - /** Number of Web Hosting plans returned. */ + /** + * Number of Web Hosting plans returned. + */ totalCount: number - /** List of Web Hosting plans. */ + /** + * List of Web Hosting plans. + */ hostings: HostingSummary[] } export interface ListMailAccountsResponse { - /** Total number of mail accounts. */ + /** + * Total number of mail accounts. + */ totalCount: number - /** List of mail accounts. */ + /** + * List of mail accounts. + */ mailAccounts: MailAccount[] } export interface ListOffersResponse { - /** Total number of offers. */ + /** + * Total number of offers. + */ totalCount: number - /** List of offers. */ + /** + * List of offers. + */ offers: Offer[] } export interface ListWebsitesResponse { - /** Total number of websites. */ + /** + * Total number of websites. + */ totalCount: number - /** List of websites. */ + /** + * List of websites. + */ websites: Website[] } export type MailAccountApiChangeMailAccountPasswordRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Domain part of the mail account address. */ + /** + * Domain part of the mail account address. + */ domain: string - /** Username part of the mail account address. */ + /** + * Username part of the mail account address. + */ username: string - /** New password for the mail account. */ + /** + * New password for the mail account. + */ password: string } export type MailAccountApiCreateMailAccountRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Domain part of the mail account address. */ + /** + * Domain part of the mail account address. + */ domain: string - /** Username part address of the mail account address. */ + /** + * Username part address of the mail account address. + */ username: string - /** Password for the new mail account. */ + /** + * Password for the new mail account. + */ password: string } export type MailAccountApiListMailAccountsRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Page number (must be a positive integer). */ + /** + * Page number (must be a positive integer). + */ page?: number /** - * Number of mail accounts to return (must be a positive integer lower or - * equal to 100). + * Number of mail accounts to return (must be a positive integer lower or equal to 100). */ pageSize?: number - /** Sort order of mail accounts in the response. */ + /** + * Sort order of mail accounts in the response. + */ orderBy?: ListMailAccountsRequestOrderBy - /** Domain to filter the mail accounts. */ + /** + * Domain to filter the mail accounts. + */ domain?: string } export type MailAccountApiRemoveMailAccountRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Domain part of the mail account address. */ + /** + * Domain part of the mail account address. + */ domain: string - /** Username part of the mail account address. */ + /** + * Username part of the mail account address. + */ username: string } export type OfferApiListOffersRequest = { /** - * Region to target. If none is 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 (must be a positive integer). */ + /** + * Page number (must be a positive integer). + */ page?: number /** - * Number of websites to return (must be a positive integer lower or equal to - * 100). + * Number of websites to return (must be a positive integer lower or equal to 100). */ pageSize?: number - /** Sort order for Web Hosting offers in the response. */ + /** + * Sort order for Web Hosting offers in the response. + */ orderBy?: ListOffersRequestOrderBy - /** UUID of the hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId?: string - /** Name of the control panel(s) to filter for. */ + /** + * Name of the control panel(s) to filter for. + */ controlPanels?: string[] } export interface ResetHostingPasswordResponse { - /** New temporary password. */ + /** + * New temporary password. + */ oneTimePassword: string } export interface ResourceSummary { - /** Total number of active databases in the Web Hosting plan. */ + /** + * Total number of active databases in the Web Hosting plan. + */ databasesCount: number - /** Total number of active email accounts in the Web Hosting plan. */ + /** + * Total number of active email accounts in the Web Hosting plan. + */ mailAccountsCount: number - /** Total number of active FTP accounts in the Web Hosting plan. */ + /** + * Total number of active FTP accounts in the Web Hosting plan. + */ ftpAccountsCount: number - /** Total number of active domains in the the Web Hosting plan. */ + /** + * Total number of active domains in the Web Hosting plan. + */ websitesCount: number } export interface SearchDomainsResponse { - /** List of domains availability. */ + /** + * List of domains availability. + */ domainsAvailable: DomainAvailability[] } export interface Session { - /** Logged user's session URL. */ + /** + * Logged user's session URL. + */ url: string } export type WebsiteApiListWebsitesRequest = { /** - * Region to target. If none is 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 hosting plan. */ + /** + * UUID of the hosting plan. + */ hostingId: string - /** Page number (must be a positive integer). */ + /** + * Page number (must be a positive integer). + */ page?: number /** - * Number of websites to return (must be a positive integer lower or equal to - * 100). + * Number of websites to return (must be a positive integer lower or equal to 100). */ pageSize?: number - /** Sort order for Web Hosting websites in the response. */ + /** + * Sort order for Web Hosting websites in the response. + */ orderBy?: ListWebsitesRequestOrderBy }