From f681e9599a8be8501fbe5c714aecb3e24aba20c7 Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Fri, 3 Mar 2023 08:01:17 +0000 Subject: [PATCH] feat: update generated APIs --- .../clients/src/api/account/v2/types.gen.ts | 48 +- .../api/applesilicon/v1alpha1/types.gen.ts | 128 +- .../clients/src/api/baremetal/v1/types.gen.ts | 546 +++---- .../src/api/cockpit/v1beta1/types.gen.ts | 50 +- .../src/api/container/v1beta1/types.gen.ts | 158 +- .../src/api/domain/v2beta1/types.gen.ts | 178 +- .../src/api/flexibleip/v1alpha1/types.gen.ts | 130 +- .../src/api/function/v1beta1/types.gen.ts | 202 ++- .../clients/src/api/iam/v1alpha1/types.gen.ts | 448 ++--- .../clients/src/api/instance/v1/types.gen.ts | 791 ++++----- .../src/api/instance/v1/types.private.gen.ts | 144 +- packages/clients/src/api/iot/v1/types.gen.ts | 580 ++++--- packages/clients/src/api/k8s/v1/types.gen.ts | 548 ++++--- .../src/api/k8s/v1/types.private.gen.ts | 7 +- packages/clients/src/api/lb/v1/types.gen.ts | 1448 +++++++++-------- .../src/api/marketplace/v1/types.gen.ts | 48 +- .../src/api/marketplace/v2/types.gen.ts | 54 +- .../clients/src/api/mnq/v1alpha1/types.gen.ts | 170 +- packages/clients/src/api/rdb/v1/types.gen.ts | 950 ++++++----- .../clients/src/api/redis/v1/types.gen.ts | 328 ++-- .../clients/src/api/registry/v1/types.gen.ts | 210 ++- .../src/api/secret/v1alpha1/types.gen.ts | 215 ++- .../clients/src/api/tem/v1alpha1/types.gen.ts | 212 +-- packages/clients/src/api/test/v1/types.gen.ts | 10 +- packages/clients/src/api/vpc/v1/types.gen.ts | 66 +- .../clients/src/api/vpcgw/v1/types.gen.ts | 536 +++--- 26 files changed, 4521 insertions(+), 3684 deletions(-) diff --git a/packages/clients/src/api/account/v2/types.gen.ts b/packages/clients/src/api/account/v2/types.gen.ts index da978cd2a..4ca958513 100644 --- a/packages/clients/src/api/account/v2/types.gen.ts +++ b/packages/clients/src/api/account/v2/types.gen.ts @@ -7,69 +7,69 @@ export type ListProjectsRequestOrderBy = | 'name_asc' | 'name_desc' -/** List projects response */ +/** List projects response. */ export interface ListProjectsResponse { - /** The total number of projects */ + /** The total number of projects. */ totalCount: number - /** The paginated returned projects */ + /** The paginated returned projects. */ projects: Project[] } -/** Project */ +/** Project. */ export interface Project { - /** The ID of the project */ + /** The ID of the project. */ id: string - /** The name of the project */ + /** The name of the project. */ name: string - /** The organization ID of the project */ + /** The organization ID of the project. */ organizationId: string - /** The creation date of the project */ + /** The creation date of the project. */ createdAt?: Date - /** The update date of the project */ + /** The update date of the project. */ updatedAt?: Date - /** The description of the project */ + /** The description of the project. */ description: string } export type CreateProjectRequest = { - /** The name of the project */ + /** The name of the project. */ name: string - /** The organization ID of the project */ + /** The organization ID of the project. */ organizationId?: string - /** The description of the project */ + /** The description of the project. */ description?: string } export type ListProjectsRequest = { - /** The organization ID of the project */ + /** The organization ID of the project. */ organizationId?: string - /** The name of the project */ + /** The name of the project. */ name?: string - /** The page number for the returned projects */ + /** The page number for the returned projects. */ page?: number - /** The maximum number of project per page */ + /** The maximum number of project per page. */ pageSize?: number - /** The sort order of the returned projects */ + /** The sort order of the returned projects. */ orderBy?: ListProjectsRequestOrderBy - /** Filter out by a list of project ID */ + /** Filter out by a list of project ID. */ projectIds?: string[] } export type GetProjectRequest = { - /** The project ID of the project */ + /** The project ID of the project. */ projectId?: string } export type DeleteProjectRequest = { - /** The project ID of the project */ + /** The project ID of the project. */ projectId?: string } export type UpdateProjectRequest = { - /** The project ID of the project */ + /** The project ID of the project. */ projectId?: string - /** The name of the project */ + /** The name of the project. */ name?: string - /** The description of the project */ + /** The description of the project. */ description?: string } diff --git a/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts b/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts index 37a5ac95f..5226a6692 100644 --- a/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/applesilicon/v1alpha1/types.gen.ts @@ -22,81 +22,81 @@ export type ServerTypeStock = | 'low_stock' | 'high_stock' -/** List os response */ +/** List os response. */ export interface ListOSResponse { - /** Total number of os */ + /** Total number of os. */ totalCount: number - /** List of OS */ + /** List of OS. */ os: OS[] } -/** List server types response */ +/** List server types response. */ export interface ListServerTypesResponse { - /** The available server types */ + /** The available server types. */ serverTypes: ServerType[] } -/** List servers response */ +/** List servers response. */ export interface ListServersResponse { - /** The total number of servers */ + /** The total number of servers. */ totalCount: number - /** The paginated returned servers */ + /** The paginated returned servers. */ servers: Server[] } -/** Os */ +/** Os. */ export interface OS { - /** The OS unique ID */ + /** The OS unique ID. */ id: string - /** The OS name */ + /** The OS name. */ name: string - /** The OS name as it should be displayed */ + /** The OS name as it should be displayed. */ label: string - /** URL of the image */ + /** URL of the image. */ imageUrl: string - /** List of compatible server types */ + /** List of compatible server types. */ compatibleServerTypes: string[] } -/** Server */ +/** Server. */ export interface Server { - /** UUID of the server */ + /** UUID of the server. */ id: string - /** Type of the server */ + /** Type of the server. */ type: string - /** Name of the server */ + /** Name of the server. */ name: string - /** Project this server is associated with */ + /** Project this server is associated with. */ projectId: string - /** Organization this server is associated with */ + /** Organization this server is associated with. */ organizationId: string - /** IPv4 address of the server */ + /** IPv4 address of the server. */ ip: string - /** URL of the VNC */ + /** URL of the VNC. */ vncUrl: string - /** Current status of the server */ + /** Current status of the server. */ status: ServerStatus - /** The date at which the server was created */ + /** The date at which the server was created. */ createdAt?: Date - /** The date at which the server was last updated */ + /** The date at which the server was last updated. */ updatedAt?: Date - /** The date at which the server was last deleted */ + /** The date at which the server was last deleted. */ deletableAt?: Date - /** The zone of the server */ + /** The zone of the server. */ zone: Zone } -/** Server type */ +/** Server type. */ export interface ServerType { - /** CPU description */ + /** CPU description. */ cpu?: ServerTypeCPU - /** Size of the local disk of the server */ + /** Size of the local disk of the server. */ disk?: ServerTypeDisk - /** Name of the type */ + /** Name of the type. */ name: string - /** Size of memory available */ + /** Size of memory available. */ memory?: ServerTypeMemory - /** Current stock */ + /** Current stock. */ stock: ServerTypeStock /** Minimum duration of the lease in seconds (example. 3.4s). */ minimumLeaseDuration?: string @@ -118,105 +118,105 @@ export interface ServerTypeMemory { } export type ListServerTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone } export type GetServerTypeRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Server type identifier */ + /** Server type identifier. */ serverType: string } export type CreateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Create a server with this given name */ + /** Create a server with this given name. */ name?: string - /** Create a server in the given project ID */ + /** Create a server in the given project ID. */ projectId?: string - /** Create a server of the given type */ + /** Create a server of the given type. */ type: string } export type ListServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The sort order of the returned servers */ + /** The sort order of the returned servers. */ orderBy?: ListServersRequestOrderBy - /** List only servers of this project ID */ + /** List only servers of this project ID. */ projectId?: string - /** List only servers of this organization ID */ + /** List only servers of this organization ID. */ organizationId?: string - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ pageSize?: number } export type ListOSRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ pageSize?: number - /** List of compatible server type */ + /** List of compatible server type. */ serverType?: string /** * Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not - * "12") + * "12"). */ name?: string } export type GetOSRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the OS you want to get */ + /** UUID of the OS you want to get. */ osId: string } export type GetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server you want to get */ + /** UUID of the server you want to get. */ serverId: string } export type UpdateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server you want to update */ + /** UUID of the server you want to update. */ serverId: string - /** Updated name for your server */ + /** Updated name for your server. */ name: string } export type DeleteServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server you want to delete */ + /** UUID of the server you want to delete. */ serverId: string } export type RebootServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server you want to reboot */ + /** UUID of the server you want to reboot. */ serverId: string } export type ReinstallServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server you want to reinstall */ + /** UUID of the server you want to reinstall. */ serverId: string } diff --git a/packages/clients/src/api/baremetal/v1/types.gen.ts b/packages/clients/src/api/baremetal/v1/types.gen.ts index 13fcb5334..8e338345a 100644 --- a/packages/clients/src/api/baremetal/v1/types.gen.ts +++ b/packages/clients/src/api/baremetal/v1/types.gen.ts @@ -72,118 +72,118 @@ export type ServerStatus = export type SettingType = 'unknown' | 'smtp' -/** Bmc access */ +/** Bmc access. */ export interface BMCAccess { - /** URL to access to the server console */ + /** URL to access to the server console. */ url: string /** * The login to use for the BMC (Baseboard Management Controller) access - * authentification + * authentification. */ login: string /** * The password to use for the BMC (Baseboard Management Controller) access - * authentification + * authentification. */ password: string /** * The date after which the BMC (Baseboard Management Controller) access will - * be closed + * be closed. */ expiresAt?: Date } -/** Cpu */ +/** Cpu. */ export interface CPU { - /** Name of the CPU */ + /** Name of the CPU. */ name: string - /** Number of cores of the CPU */ + /** Number of cores of the CPU. */ coreCount: number - /** Number of threads of the CPU */ + /** Number of threads of the CPU. */ threadCount: number - /** Frequency of the CPU in MHz */ + /** Frequency of the CPU in MHz. */ frequency: number - /** Benchmark of the CPU */ + /** Benchmark of the CPU. */ benchmark: string } -/** Create server request. install */ +/** Create server request. install. */ export interface CreateServerRequestInstall { - /** ID of the OS to install on the server */ + /** ID of the OS to install on the server. */ osId: string - /** Hostname of the server */ + /** Hostname of the server. */ hostname: string - /** SSH key IDs authorized on the server */ + /** SSH key IDs authorized on the server. */ sshKeyIds: string[] - /** User used for the installation */ + /** User used for the installation. */ user?: string - /** Password used for the installation */ + /** Password used for the installation. */ password?: string - /** User used for the service to install */ + /** User used for the service to install. */ serviceUser?: string - /** Password used for the service to install */ + /** Password used for the service to install. */ servicePassword?: string } -/** Disk */ +/** Disk. */ export interface Disk { - /** Capacity of the disk in bytes */ + /** Capacity of the disk in bytes. */ capacity: number - /** Type of the disk */ + /** Type of the disk. */ type: string } -/** Get server metrics response */ +/** Get server metrics response. */ export interface GetServerMetricsResponse { - /** Timeseries of ping on the server */ + /** Timeseries of ping on the server. */ pings?: TimeSeries } -/** Ip */ +/** Ip. */ export interface IP { - /** ID of the IP */ + /** ID of the IP. */ id: string - /** Address of the IP */ + /** Address of the IP. */ address: string - /** Reverse IP value */ + /** Reverse IP value. */ reverse: string - /** Version of IP (v4 or v6) */ + /** Version of IP (v4 or v6). */ version: IPVersion - /** Status of the reverse */ + /** Status of the reverse. */ reverseStatus: IPReverseStatus - /** A message related to the reverse status, in case of an error for example */ + /** A message related to the reverse status, in case of an error for example. */ reverseStatusMessage: string } -/** List os response */ +/** List os response. */ export interface ListOSResponse { - /** Total count of matching OS */ + /** Total count of matching OS. */ totalCount: number - /** OS that match filters */ + /** OS that match filters. */ os: OS[] } -/** List offers response */ +/** List offers response. */ export interface ListOffersResponse { - /** Total count of matching offers */ + /** Total count of matching offers. */ totalCount: number - /** Offers that match filters */ + /** Offers that match filters. */ offers: Offer[] } -/** List options response */ +/** List options response. */ export interface ListOptionsResponse { - /** Total count of matching options */ + /** Total count of matching options. */ totalCount: number - /** Options that match filters */ + /** Options that match filters. */ options: Option[] } -/** List server events response */ +/** List server events response. */ export interface ListServerEventsResponse { - /** Total count of matching events */ + /** Total count of matching events. */ totalCount: number - /** Server events that match filters */ + /** Server events that match filters. */ events: ServerEvent[] } @@ -192,57 +192,57 @@ export interface ListServerPrivateNetworksResponse { totalCount: number } -/** List servers response */ +/** List servers response. */ export interface ListServersResponse { - /** Total count of matching servers */ + /** Total count of matching servers. */ totalCount: number - /** Servers that match filters */ + /** Servers that match filters. */ servers: Server[] } -/** List settings response */ +/** List settings response. */ export interface ListSettingsResponse { - /** Total count of matching sttings */ + /** Total count of matching sttings. */ totalCount: number - /** Settings that match filters */ + /** Settings that match filters. */ settings: Setting[] } -/** Memory */ +/** Memory. */ export interface Memory { - /** Capacity of the memory in bytes */ + /** Capacity of the memory in bytes. */ capacity: number - /** Type of the memory */ + /** Type of the memory. */ type: string - /** Frequency of the memory in MHz */ + /** Frequency of the memory in MHz. */ frequency: number - /** True if the memory is an error-correcting code memory */ + /** True if the memory is an error-correcting code memory. */ isEcc: boolean } -/** Os */ +/** Os. */ export interface OS { - /** ID of the OS */ + /** ID of the OS. */ id: string - /** Name of the OS */ + /** Name of the OS. */ name: string - /** Version of the OS */ + /** Version of the OS. */ version: string - /** URL of this os's logo */ + /** URL of this os's logo. */ logoUrl: string - /** Define the SSH requirements to install the OS */ + /** Define the SSH requirements to install the OS. */ ssh?: OSOSField - /** Define the username requirements to install the OS */ + /** Define the username requirements to install the OS. */ user?: OSOSField - /** Define the password requirements to install the OS */ + /** Define the password requirements to install the OS. */ password?: OSOSField - /** Define the username requirements to install the service */ + /** Define the username requirements to install the service. */ serviceUser?: OSOSField - /** Define the password requirements to install the service */ + /** Define the password requirements to install the service. */ servicePassword?: OSOSField - /** State of OS */ + /** State of OS. */ enabled: boolean - /** License required (check server options for pricing details) */ + /** License required (check server options for pricing details). */ licenseRequired: boolean } @@ -252,95 +252,95 @@ export interface OSOSField { defaultValue?: string } -/** Offer */ +/** Offer. */ export interface Offer { - /** ID of the offer */ + /** ID of the offer. */ id: string - /** Name of the offer */ + /** Name of the offer. */ name: string - /** Stock level */ + /** Stock level. */ stock: OfferStock - /** Public Bandwidth available in bits/s with the offer */ + /** Public Bandwidth available in bits/s with the offer. */ bandwidth: number - /** Commercial range of the offer */ + /** Commercial range of the offer. */ commercialRange: string /** * Price of the offer for the next 60 minutes (a server order at 11h32 will be - * payed until 12h32) + * payed until 12h32). */ pricePerHour?: Money - /** Price of the offer per months */ + /** Price of the offer per months. */ pricePerMonth?: Money - /** Disks specifications of the offer */ + /** Disks specifications of the offer. */ disks: Disk[] - /** True if the offer is currently available */ + /** True if the offer is currently available. */ enable: boolean - /** CPU specifications of the offer */ + /** CPU specifications of the offer. */ cpus: CPU[] - /** Memory specifications of the offer */ + /** Memory specifications of the offer. */ memories: Memory[] - /** Name of the quota associated to the offer */ + /** Name of the quota associated to the offer. */ quotaName: string - /** Persistent memory specifications of the offer */ + /** Persistent memory specifications of the offer. */ persistentMemories: PersistentMemory[] - /** Raid controller specifications of the offer */ + /** Raid controller specifications of the offer. */ raidControllers: RaidController[] - /** Array of incompatible OS ids */ + /** Array of incompatible OS ids. */ incompatibleOsIds: string[] - /** Period of subscription for the offer */ + /** Period of subscription for the offer. */ subscriptionPeriod: OfferSubscriptionPeriod - /** Operation path of the service */ + /** Operation path of the service. */ operationPath: string - /** Fee to pay on order */ + /** Fee to pay on order. */ fee?: Money - /** Options available on offer */ + /** Options available on offer. */ options: OfferOptionOffer[] - /** Private bandwidth available in bits/s with the offer */ + /** Private bandwidth available in bits/s with the offer. */ privateBandwidth: number - /** The offer is shared or not */ + /** The offer is shared or not. */ sharedBandwidth: boolean - /** Array of tags attached to the offer */ + /** Array of tags attached to the offer. */ tags: string[] } -/** Offer. option offer */ +/** Offer. option offer. */ export interface OfferOptionOffer { - /** ID of the option */ + /** ID of the option. */ id: string - /** Name of the option */ + /** Name of the option. */ name: string /** * If true the option is enabled and included by default in the offer If false - * the option is available for the offer but not included by default + * the option is available for the offer but not included by default. */ enabled: boolean - /** Period of subscription for the offer */ + /** Period of subscription for the offer. */ subscriptionPeriod: OfferSubscriptionPeriod - /** Price of the option */ + /** Price of the option. */ price?: Money - /** Boolean to know if option could be managed */ + /** Boolean to know if option could be managed. */ manageable: boolean - /** ID of the OS linked to the option */ + /** ID of the OS linked to the option. */ osId?: string } -/** Option */ +/** Option. */ export interface Option { - /** ID of the option */ + /** ID of the option. */ id: string - /** Name of the option */ + /** Name of the option. */ name: string - /** Is false if the option could not be added or removed */ + /** Is false if the option could not be added or removed. */ manageable: boolean } -/** Persistent memory */ +/** Persistent memory. */ export interface PersistentMemory { - /** Capacity of the memory in bytes */ + /** Capacity of the memory in bytes. */ capacity: number - /** Type of the memory */ + /** Type of the memory. */ type: string - /** Frequency of the memory in MHz */ + /** Frequency of the memory in MHz. */ frequency: number } @@ -349,123 +349,123 @@ export interface RaidController { raidLevel: string[] } -/** Server */ +/** Server. */ export interface Server { - /** ID of the server */ + /** ID of the server. */ id: string - /** Organization ID the server is attached to */ + /** Organization ID the server is attached to. */ organizationId: string - /** Project ID the server is attached to */ + /** Project ID the server is attached to. */ projectId: string - /** Name of the server */ + /** Name of the server. */ name: string - /** Description of the server */ + /** Description of the server. */ description: string - /** Date of last modification of the server */ + /** Date of last modification of the server. */ updatedAt?: Date - /** Date of creation of the server */ + /** Date of creation of the server. */ createdAt?: Date - /** Status of the server */ + /** Status of the server. */ status: ServerStatus - /** Offer ID of the server */ + /** Offer ID of the server. */ offerId: string - /** Offer name of the server */ + /** Offer name of the server. */ offerName: string - /** Array of customs tags attached to the server */ + /** Array of customs tags attached to the server. */ tags: string[] - /** Array of IPs attached to the server */ + /** Array of IPs attached to the server. */ ips: IP[] - /** Domain of the server */ + /** Domain of the server. */ domain: string - /** Boot type of the server */ + /** Boot type of the server. */ bootType: ServerBootType - /** The zone in which is the server */ + /** The zone in which is the server. */ zone: Zone - /** Configuration of installation */ + /** Configuration of installation. */ install?: ServerInstall - /** Server status of ping */ + /** Server status of ping. */ pingStatus: ServerPingStatus - /** Options enabled on server */ + /** Options enabled on server. */ options: ServerOption[] - /** Configuration of rescue boot */ + /** Configuration of rescue boot. */ rescueServer?: ServerRescueServer } -/** Server event */ +/** Server event. */ export interface ServerEvent { - /** ID of the server for whom the action will be applied */ + /** ID of the server for whom the action will be applied. */ id: string - /** The action that will be applied to the server */ + /** The action that will be applied to the server. */ action: string - /** Date of last modification of the action */ + /** Date of last modification of the action. */ updatedAt?: Date - /** Date of creation of the action */ + /** Date of creation of the action. */ createdAt?: Date } -/** Server. install */ +/** Server. install. */ export interface ServerInstall { - /** ID of the OS */ + /** ID of the OS. */ osId: string - /** Host defined in the server install */ + /** Host defined in the server install. */ hostname: string - /** SSH public key IDs defined in the server install */ + /** SSH public key IDs defined in the server install. */ sshKeyIds: string[] - /** Status of the server install */ + /** Status of the server install. */ status: ServerInstallStatus /** * User defined in the server install or the default one if none were - * specified + * specified. */ user: string /** * Service user defined in the server install or the default one if none were - * specified + * specified. */ serviceUser: string - /** The address of the installed service */ + /** The address of the installed service. */ serviceUrl: string } -/** Server. option */ +/** Server. option. */ export interface ServerOption { - /** ID of the option */ + /** ID of the option. */ id: string - /** Name of the option */ + /** Name of the option. */ name: string - /** Status of the option */ + /** Status of the option. */ status: ServerOptionOptionStatus - /** Is false if the option could not be added or removed */ + /** Is false if the option could not be added or removed. */ manageable: boolean - /** Auto expiration date for compatible options */ + /** Auto expiration date for compatible options. */ expiresAt?: Date } -/** Server private network */ +/** Server private network. */ export interface ServerPrivateNetwork { - /** The private network ID */ + /** The private network ID. */ id: string - /** The private network project ID */ + /** The private network project ID. */ projectId: string - /** The server ID */ + /** The server ID. */ serverId: string - /** The private network ID */ + /** The private network ID. */ privateNetworkId: string - /** The VLAN ID associated to the private network */ + /** The VLAN ID associated to the private network. */ vlan?: number - /** The configuration status of the private network */ + /** The configuration status of the private network. */ status: ServerPrivateNetworkStatus - /** The private network creation date */ + /** The private network creation date. */ createdAt?: Date - /** The date the private network was last modified */ + /** The date the private network was last modified. */ updatedAt?: Date } -/** Server. rescue server */ +/** Server. rescue server. */ export interface ServerRescueServer { - /** Rescue user name */ + /** Rescue user name. */ user: string - /** Rescue password */ + /** Rescue password. */ password: string } @@ -473,52 +473,52 @@ export interface SetServerPrivateNetworksResponse { serverPrivateNetworks: ServerPrivateNetwork[] } -/** Setting */ +/** Setting. */ export interface Setting { - /** ID of the setting */ + /** ID of the setting. */ id: string - /** Type of the setting */ + /** Type of the setting. */ type: SettingType - /** ID of the project ID */ + /** ID of the project ID. */ projectId: string - /** The setting is enable or disable */ + /** The setting is enable or disable. */ enabled: boolean } export type ListServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Page number */ + /** Page number. */ page?: number - /** Number of server per page */ + /** Number of server per page. */ pageSize?: number - /** Order of the servers */ + /** Order of the servers. */ orderBy?: ListServersRequestOrderBy - /** Filter by tags */ + /** Filter by tags. */ tags?: string[] - /** Filter by status */ + /** Filter by status. */ status?: string[] - /** Filter by name */ + /** Filter by name. */ name?: string - /** Filter by organization ID */ + /** Filter by organization ID. */ organizationId?: string - /** Filter by project ID */ + /** Filter by project ID. */ projectId?: string - /** Filter by option ID */ + /** Filter by option ID. */ optionId?: string } export type GetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server */ + /** ID of the server. */ serverId: string } export type CreateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Offer ID of the new server */ + /** Offer ID of the new server. */ offerId: string /** * @deprecated Organization ID with which the server will be created. @@ -534,281 +534,281 @@ export type CreateServerRequest = { * could be set. */ projectId?: string - /** Name of the server (≠hostname) */ + /** Name of the server (≠hostname). */ name: string - /** Description associated to the server, max 255 characters */ + /** Description associated to the server, max 255 characters. */ description: string - /** Tags to associate to the server */ + /** Tags to associate to the server. */ tags?: string[] - /** Configuration of installation */ + /** Configuration of installation. */ install?: CreateServerRequestInstall - /** IDs of options to enable on server */ + /** IDs of options to enable on server. */ optionIds?: string[] } export type UpdateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server to update */ + /** ID of the server to update. */ serverId: string - /** Name of the server (≠hostname), not updated if null */ + /** Name of the server (≠hostname), not updated if null. */ name?: string /** * Description associated to the server, max 255 characters, not updated if - * null + * null. */ description?: string - /** Tags associated to the server, not updated if null */ + /** Tags associated to the server, not updated if null. */ tags?: string[] } export type InstallServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Server ID to install */ + /** Server ID to install. */ serverId: string - /** ID of the OS to install on the server */ + /** ID of the OS to install on the server. */ osId: string - /** Hostname of the server */ + /** Hostname of the server. */ hostname: string - /** SSH key IDs authorized on the server */ + /** SSH key IDs authorized on the server. */ sshKeyIds: string[] - /** User used for the installation */ + /** User used for the installation. */ user?: string - /** Password used for the installation */ + /** Password used for the installation. */ password?: string - /** User used for the service to install */ + /** User used for the service to install. */ serviceUser?: string - /** Password used for the service to install */ + /** Password used for the service to install. */ servicePassword?: string } export type GetServerMetricsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Server ID to get the metrics */ + /** Server ID to get the metrics. */ serverId: string } export type DeleteServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server to delete */ + /** ID of the server to delete. */ serverId: string } export type RebootServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server to reboot */ + /** ID of the server to reboot. */ serverId: string - /** The type of boot */ + /** The type of boot. */ bootType?: ServerBootType } export type StartServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server to start */ + /** ID of the server to start. */ serverId: string - /** The type of boot */ + /** The type of boot. */ bootType?: ServerBootType } export type StopServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server to stop */ + /** ID of the server to stop. */ serverId: string } export type ListServerEventsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server events searched */ + /** ID of the server events searched. */ serverId: string - /** Page number */ + /** Page number. */ page?: number - /** Number of server events per page */ + /** Number of server events per page. */ pageSize?: number - /** Order of the server events */ + /** Order of the server events. */ orderBy?: ListServerEventsRequestOrderBy } export type StartBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server */ + /** ID of the server. */ serverId: string - /** The IP authorized to connect to the given server */ + /** The IP authorized to connect to the given server. */ ip: string } export type GetBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server */ + /** ID of the server. */ serverId: string } export type StopBMCAccessRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server */ + /** ID of the server. */ serverId: string } export type UpdateIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server */ + /** ID of the server. */ serverId: string - /** ID of the IP to update */ + /** ID of the IP to update. */ ipId: string - /** New reverse IP to update, not updated if null */ + /** New reverse IP to update, not updated if null. */ reverse?: string } export type AddOptionServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server */ + /** ID of the server. */ serverId: string - /** ID of the option to add */ + /** ID of the option to add. */ optionId: string - /** Auto expire the option after this date */ + /** Auto expire the option after this date. */ expiresAt?: Date } export type DeleteOptionServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the server */ + /** ID of the server. */ serverId: string - /** ID of the option to delete */ + /** ID of the option to delete. */ optionId: string } export type ListOffersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Page number */ + /** Page number. */ page?: number - /** Number of offers per page */ + /** Number of offers per page. */ pageSize?: number - /** Period of subscription to filter offers */ + /** Period of subscription to filter offers. */ subscriptionPeriod?: OfferSubscriptionPeriod } export type GetOfferRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the researched Offer */ + /** ID of the researched Offer. */ offerId: string } export type GetOptionRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the option */ + /** ID of the option. */ optionId: string } export type ListOptionsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Page number */ + /** Page number. */ page?: number - /** Number of options per page */ + /** Number of options per page. */ pageSize?: number - /** Filter options by offer_id */ + /** Filter options by offer_id. */ offerId?: string - /** Filter options by name */ + /** Filter options by name. */ name?: string } export type ListSettingsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Page number */ + /** Page number. */ page?: number - /** Set the maximum list size */ + /** Set the maximum list size. */ pageSize?: number - /** Order the response */ + /** Order the response. */ orderBy?: ListSettingsRequestOrderBy - /** ID of the project */ + /** ID of the project. */ projectId?: string } export type UpdateSettingRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the setting */ + /** ID of the setting. */ settingId: string - /** Enable/Disable the setting */ + /** Enable/Disable the setting. */ enabled?: boolean } export type ListOSRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Page number */ + /** Page number. */ page?: number - /** Number of OS per page */ + /** Number of OS per page. */ pageSize?: number - /** Filter OS by offer ID */ + /** Filter OS by offer ID. */ offerId?: string } export type GetOSRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the OS */ + /** ID of the OS. */ osId: string } export type PrivateNetworkApiAddServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The ID of the server */ + /** The ID of the server. */ serverId: string - /** The ID of the private network */ + /** The ID of the private network. */ privateNetworkId: string } export type PrivateNetworkApiSetServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The ID of the server */ + /** The ID of the server. */ serverId: string - /** The IDs of the private networks */ + /** The IDs of the private networks. */ privateNetworkIds: string[] } export type PrivateNetworkApiListServerPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The sort order for the returned private networks */ + /** The sort order for the returned private networks. */ orderBy?: ListServerPrivateNetworksRequestOrderBy - /** The page number for the returned private networks */ + /** The page number for the returned private networks. */ page?: number - /** The maximum number of private networks per page */ + /** The maximum number of private networks per page. */ pageSize?: number - /** Filter private networks by server ID */ + /** Filter private networks by server ID. */ serverId?: string - /** Filter private networks by private network ID */ + /** Filter private networks by private network ID. */ privateNetworkId?: string - /** Filter private networks by organization ID */ + /** Filter private networks by organization ID. */ organizationId?: string - /** Filter private networks by project ID */ + /** Filter private networks by project ID. */ projectId?: string } export type PrivateNetworkApiDeleteServerPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The ID of the server */ + /** The ID of the server. */ serverId: string - /** The ID of the private network */ + /** The ID of the private network. */ privateNetworkId: string } diff --git a/packages/clients/src/api/cockpit/v1beta1/types.gen.ts b/packages/clients/src/api/cockpit/v1beta1/types.gen.ts index 8a2f8cd46..07d169015 100644 --- a/packages/clients/src/api/cockpit/v1beta1/types.gen.ts +++ b/packages/clients/src/api/cockpit/v1beta1/types.gen.ts @@ -19,23 +19,23 @@ export type ListTokensRequestOrderBy = | 'name_asc' | 'name_desc' -/** Cockpit */ +/** Cockpit. */ export interface Cockpit { - /** Project ID */ + /** Project ID. */ projectId: string - /** Created at */ + /** Created at. */ createdAt?: Date - /** Updated at */ + /** Updated at. */ updatedAt?: Date - /** Endpoints */ + /** Endpoints. */ endpoints?: CockpitEndpoints - /** Status */ + /** Status. */ status: CockpitStatus - /** Managed alerts enabled */ + /** Managed alerts enabled. */ managedAlertsEnabled: boolean } -/** Cockpit. endpoints */ +/** Cockpit. endpoints. */ export interface CockpitEndpoints { metricsUrl: string logsUrl: string @@ -43,7 +43,7 @@ export interface CockpitEndpoints { grafanaUrl: string } -/** Alert contact point */ +/** Alert contact point. */ export interface ContactPoint { /** * Alert contact point configuration. @@ -57,7 +57,7 @@ export interface ContactPointEmail { to: string } -/** Grafana user */ +/** Grafana user. */ export interface GrafanaUser { id: number login: string @@ -65,31 +65,31 @@ export interface GrafanaUser { password?: string } -/** List contact points response */ +/** List contact points response. */ export interface ListContactPointsResponse { - /** Total count of contact points */ + /** Total count of contact points. */ totalCount: number - /** Contact points array */ + /** Contact points array. */ contactPoints: ContactPoint[] - /** Has receivers other than default */ + /** Has receivers other than default. */ hasAdditionalReceivers: boolean - /** Has unmanaged contact points */ + /** Has unmanaged contact points. */ hasAdditionalContactPoints: boolean } -/** List grafana users response */ +/** List grafana users response. */ export interface ListGrafanaUsersResponse { totalCount: number grafanaUsers: GrafanaUser[] } -/** List tokens response */ +/** List tokens response. */ export interface ListTokensResponse { totalCount: number tokens: Token[] } -/** Token */ +/** Token. */ export interface Token { id: string projectId: string @@ -100,7 +100,7 @@ export interface Token { secretKey?: string } -/** Token scopes */ +/** Token scopes. */ export interface TokenScopes { queryMetrics: boolean writeMetrics: boolean @@ -149,24 +149,24 @@ export type DeleteTokenRequest = { } export type CreateContactPointRequest = { - /** Project ID */ + /** Project ID. */ projectId?: string - /** Contact point to create */ + /** Contact point to create. */ contactPoint?: ContactPoint } export type ListContactPointsRequest = { - /** Page number */ + /** Page number. */ page?: number - /** Page size */ + /** Page size. */ pageSize?: number - /** Project ID */ + /** Project ID. */ projectId?: string } export type DeleteContactPointRequest = { projectId?: string - /** Contact point to delete */ + /** Contact point to delete. */ contactPoint?: ContactPoint } diff --git a/packages/clients/src/api/container/v1beta1/types.gen.ts b/packages/clients/src/api/container/v1beta1/types.gen.ts index 82a7952e5..c0ce5e0ae 100644 --- a/packages/clients/src/api/container/v1beta1/types.gen.ts +++ b/packages/clients/src/api/container/v1beta1/types.gen.ts @@ -82,7 +82,7 @@ export type TokenStatus = | 'error' | 'creating' -/** Container */ +/** Container. */ export interface Container { id: string name: string @@ -114,7 +114,7 @@ export interface Container { region: Region } -/** Cron */ +/** Cron. */ export interface Cron { id: string containerId: string @@ -124,7 +124,7 @@ export interface Cron { name: string } -/** Domain */ +/** Domain. */ export interface Domain { id: string hostname: string @@ -134,31 +134,31 @@ export interface Domain { errorMessage?: string } -/** List containers response */ +/** List containers response. */ export interface ListContainersResponse { containers: Container[] totalCount: number } -/** List crons response */ +/** List crons response. */ export interface ListCronsResponse { crons: Cron[] totalCount: number } -/** List domains response */ +/** List domains response. */ export interface ListDomainsResponse { domains: Domain[] totalCount: number } -/** List logs response */ +/** List logs response. */ export interface ListLogsResponse { logs: Log[] totalCount: number } -/** List namespaces response */ +/** List namespaces response. */ export interface ListNamespacesResponse { namespaces: Namespace[] totalCount: number @@ -169,20 +169,20 @@ export interface ListTokensResponse { totalCount: number } -/** Log */ +/** Log. */ export interface Log { message: string timestamp?: Date id: string - /** Contains the severity of the log (info, debug, error, ...) */ + /** Contains the severity of the log (info, debug, error, ...). */ level: string - /** Source of the log (core runtime or user code) */ + /** Source of the log (core runtime or user code). */ source: string - /** Can be stdout or stderr */ + /** Can be stdout or stderr. */ stream: LogStream } -/** Namespace */ +/** Namespace. */ export interface Namespace { id: string name: string @@ -208,7 +208,7 @@ export interface SecretHashedValue { hashedValue: string } -/** Token */ +/** Token. */ export interface Token { id: string token: string @@ -224,7 +224,10 @@ export interface Token { } 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?: Region page?: number pageSize?: number @@ -235,13 +238,19 @@ export type ListNamespacesRequest = { } 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?: Region namespaceId: string } export type CreateNamespaceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region name?: string environmentVariables?: Record @@ -251,7 +260,10 @@ export type CreateNamespaceRequest = { } 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?: Region namespaceId: string environmentVariables?: Record @@ -260,13 +272,19 @@ export type UpdateNamespaceRequest = { } 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?: Region namespaceId: string } export type ListContainersRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region page?: number pageSize?: number @@ -278,13 +296,19 @@ export type ListContainersRequest = { } export type GetContainerRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region containerId: string } export type CreateContainerRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region namespaceId: string name?: string @@ -311,7 +335,10 @@ export type CreateContainerRequest = { } export type UpdateContainerRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region containerId: string environmentVariables?: Record @@ -338,19 +365,28 @@ export type UpdateContainerRequest = { } export type DeleteContainerRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region containerId: string } export type DeployContainerRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region containerId: 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?: Region page?: number pageSize?: number @@ -359,13 +395,19 @@ export type ListCronsRequest = { } 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?: Region cronId: string } 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?: Region containerId: string schedule: string @@ -374,7 +416,10 @@ export type CreateCronRequest = { } 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?: Region cronId: string containerId?: string @@ -384,13 +429,19 @@ export type UpdateCronRequest = { } 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?: Region cronId: string } export type ListLogsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region containerId: string page?: number @@ -399,7 +450,10 @@ export type ListLogsRequest = { } 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?: Region page?: number pageSize?: number @@ -408,26 +462,38 @@ export type ListDomainsRequest = { } 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?: Region domainId: string } export type CreateDomainRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region hostname: string containerId: 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?: Region domainId: string } export type IssueJWTRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */ containerId?: string @@ -437,7 +503,10 @@ export type IssueJWTRequest = { } 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?: Region /** One-of ('scope'): at most one of 'containerId', 'namespaceId' could be set. */ containerId?: string @@ -448,13 +517,19 @@ export type CreateTokenRequest = { } 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?: Region tokenId: string } 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?: Region page?: number pageSize?: number @@ -464,7 +539,10 @@ export type ListTokensRequest = { } 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?: Region tokenId: string } diff --git a/packages/clients/src/api/domain/v2beta1/types.gen.ts b/packages/clients/src/api/domain/v2beta1/types.gen.ts index 26b285bca..37f904e25 100644 --- a/packages/clients/src/api/domain/v2beta1/types.gen.ts +++ b/packages/clients/src/api/domain/v2beta1/types.gen.ts @@ -208,7 +208,7 @@ export interface AvailableDomain { tld?: Tld } -/** Check contacts compatibility response */ +/** Check contacts compatibility response. */ export interface CheckContactsCompatibilityResponse { compatible: boolean ownerCheckResult?: CheckContactsCompatibilityResponseContactCheckResult @@ -221,10 +221,10 @@ export interface CheckContactsCompatibilityResponseContactCheckResult { errorMessage?: string } -/** Clear dns zone records response */ +/** Clear dns zone records response. */ export interface ClearDNSZoneRecordsResponse {} -/** Contact */ +/** Contact. */ export interface Contact { id: string legalForm: ContactLegalForm @@ -366,16 +366,16 @@ export interface DSRecordPublicKey { key: string } -/** Delete dns zone response */ +/** Delete dns zone response. */ export interface DeleteDNSZoneResponse {} -/** Delete external domain response */ +/** Delete external domain response. */ export interface DeleteExternalDomainResponse {} -/** Delete ssl certificate response */ +/** Delete ssl certificate response. */ export interface DeleteSSLCertificateResponse {} -/** Domain */ +/** Domain. */ export interface Domain { domain: string organizationId: string @@ -515,19 +515,19 @@ export interface DomainSummary { organizationId: string } -/** Get dns zone tsig key response */ +/** Get dns zone tsig key response. */ export interface GetDNSZoneTsigKeyResponse { name: string key: string algorithm: string } -/** Get dns zone version diff response */ +/** Get dns zone version diff response. */ export interface GetDNSZoneVersionDiffResponse { changes: RecordChange[] } -/** Get domain auth code response */ +/** Get domain auth code response. */ export interface GetDomainAuthCodeResponse { authCode: string } @@ -543,7 +543,7 @@ export interface ImportProviderDNSZoneRequestOnlineV1 { token: string } -/** Import provider dns zone response */ +/** Import provider dns zone response. */ export interface ImportProviderDNSZoneResponse { records: DomainRecord[] } @@ -563,78 +563,78 @@ export interface ImportRawDNSZoneRequestTsigKey { algorithm: string } -/** Import raw dns zone response */ +/** Import raw dns zone response. */ export interface ImportRawDNSZoneResponse { records: DomainRecord[] } -/** List contacts response */ +/** List contacts response. */ export interface ListContactsResponse { totalCount: number contacts: ContactRoles[] } -/** List dns zone nameservers response */ +/** List dns zone nameservers response. */ export interface ListDNSZoneNameserversResponse { - /** The returned DNS zone nameservers */ + /** The returned DNS zone nameservers. */ ns: Nameserver[] } -/** List dns zone records response */ +/** List dns zone records response. */ export interface ListDNSZoneRecordsResponse { - /** The total number of DNS zone records */ + /** The total number of DNS zone records. */ totalCount: number - /** The paginated returned DNS zone records */ + /** The paginated returned DNS zone records. */ records: DomainRecord[] } -/** List dns zone version records response */ +/** List dns zone version records response. */ export interface ListDNSZoneVersionRecordsResponse { - /** The total number of DNS zones versions records */ + /** The total number of DNS zones versions records. */ totalCount: number records: DomainRecord[] } -/** List dns zone versions response */ +/** List dns zone versions response. */ export interface ListDNSZoneVersionsResponse { - /** The total number of DNS zones versions */ + /** The total number of DNS zones versions. */ totalCount: number versions: DNSZoneVersion[] } -/** List dns zones response */ +/** List dns zones response. */ export interface ListDNSZonesResponse { - /** The total number of DNS zones */ + /** The total number of DNS zones. */ totalCount: number - /** The paginated returned DNS zones */ + /** The paginated returned DNS zones. */ dnsZones: DNSZone[] } -/** List domain hosts response */ +/** List domain hosts response. */ export interface ListDomainHostsResponse { totalCount: number hosts: Host[] } -/** List domains response */ +/** List domains response. */ export interface ListDomainsResponse { totalCount: number domains: DomainSummary[] } -/** List renewable domains response */ +/** List renewable domains response. */ export interface ListRenewableDomainsResponse { totalCount: number domains: RenewableDomain[] } -/** List ssl certificates response */ +/** List ssl certificates response. */ export interface ListSSLCertificatesResponse { totalCount: number certificates: SSLCertificate[] } -/** List tasks response */ +/** List tasks response. */ export interface ListTasksResponse { totalCount: number tasks: Task[] @@ -731,9 +731,9 @@ export interface RecordIdentifier { ttl?: number } -/** Refresh dns zone response */ +/** Refresh dns zone response. */ export interface RefreshDNSZoneResponse { - /** The returned DNS zones */ + /** The returned DNS zones. */ dnsZones: DNSZone[] } @@ -758,7 +758,7 @@ export interface RenewableDomain { tld?: Tld } -/** Restore dns zone version response */ +/** Restore dns zone version response. */ export interface RestoreDNSZoneVersionResponse {} export interface SSLCertificate { @@ -771,9 +771,9 @@ export interface SSLCertificate { expiredAt?: Date } -/** Search available domains response */ +/** Search available domains response. */ export interface SearchAvailableDomainsResponse { - /** Array of available domains */ + /** Array of available domains. */ availableDomains: AvailableDomain[] } @@ -815,137 +815,137 @@ export interface UpdateContactRequestQuestion { answer?: string } -/** Update dns zone nameservers response */ +/** Update dns zone nameservers response. */ export interface UpdateDNSZoneNameserversResponse { - /** The returned DNS zone nameservers */ + /** The returned DNS zone nameservers. */ ns: Nameserver[] } -/** Update dns zone records response */ +/** Update dns zone records response. */ export interface UpdateDNSZoneRecordsResponse { - /** The returned DNS zone records */ + /** The returned DNS zone records. */ records: DomainRecord[] } export type ListDNSZonesRequest = { - /** The organization ID on which to filter the returned DNS zones */ + /** The organization ID on which to filter the returned DNS zones. */ organizationId?: string - /** The project ID on which to filter the returned DNS zones */ + /** The project ID on which to filter the returned DNS zones. */ projectId?: string - /** The sort order of the returned DNS zones */ + /** The sort order of the returned DNS zones. */ orderBy?: ListDNSZonesRequestOrderBy - /** The page number for the returned DNS zones */ + /** The page number for the returned DNS zones. */ page?: number - /** The maximum number of DNS zones per page */ + /** The maximum number of DNS zones per page. */ pageSize?: number - /** The domain on which to filter the returned DNS zones */ + /** The domain on which to filter the returned DNS zones. */ domain: string - /** The DNS zone on which to filter the returned DNS zones */ + /** The DNS zone on which to filter the returned DNS zones. */ dnsZone: string } export type CreateDNSZoneRequest = { - /** The domain of the DNS zone to create */ + /** The domain of the DNS zone to create. */ domain: string - /** The subdomain of the DNS zone to create */ + /** The subdomain of the DNS zone to create. */ subdomain: string - /** The project ID where the DNS zone will be created */ + /** The project ID where the DNS zone will be created. */ projectId?: string } export type UpdateDNSZoneRequest = { - /** The DNS zone to update */ + /** The DNS zone to update. */ dnsZone: string - /** The new DNS zone */ + /** The new DNS zone. */ newDnsZone: string - /** The project ID of the new DNS zone */ + /** The project ID of the new DNS zone. */ projectId?: string } export type CloneDNSZoneRequest = { - /** The DNS zone to clone */ + /** The DNS zone to clone. */ dnsZone: string - /** The destinaton DNS zone */ + /** The destinaton DNS zone. */ destDnsZone: string - /** Whether or not the destination DNS zone will be overwritten */ + /** Whether or not the destination DNS zone will be overwritten. */ overwrite: boolean - /** The project ID of the destination DNS zone */ + /** The project ID of the destination DNS zone. */ projectId?: string } export type DeleteDNSZoneRequest = { - /** The DNS zone to delete */ + /** The DNS zone to delete. */ dnsZone: string - /** The project ID of the DNS zone to delete */ + /** The project ID of the DNS zone to delete. */ projectId?: string } export type ListDNSZoneRecordsRequest = { - /** The DNS zone on which to filter the returned DNS zone records */ + /** The DNS zone on which to filter the returned DNS zone records. */ dnsZone: string - /** The project ID on which to filter the returned DNS zone records */ + /** The project ID on which to filter the returned DNS zone records. */ projectId?: string - /** The sort order of the returned DNS zone records */ + /** The sort order of the returned DNS zone records. */ orderBy?: ListDNSZoneRecordsRequestOrderBy - /** The page number for the returned DNS zone records */ + /** The page number for the returned DNS zone records. */ page?: number - /** The maximum number of DNS zone records per page */ + /** The maximum number of DNS zone records per page. */ pageSize?: number - /** The name on which to filter the returned DNS zone records */ + /** The name on which to filter the returned DNS zone records. */ name: string - /** The record type on which to filter the returned DNS zone records */ + /** The record type on which to filter the returned DNS zone records. */ type?: DomainRecordType - /** The record ID on which to filter the returned DNS zone records */ + /** The record ID on which to filter the returned DNS zone records. */ id?: string } export type UpdateDNSZoneRecordsRequest = { - /** The DNS zone where the DNS zone records will be updated */ + /** The DNS zone where the DNS zone records will be updated. */ dnsZone: string - /** The changes made to the records */ + /** The changes made to the records. */ changes: RecordChange[] - /** Whether or not to return all the records */ + /** Whether or not to return all the records. */ returnAllRecords?: boolean /** * Forbid the creation of the target zone if not existing (default action is - * yes) + * yes). */ disallowNewZoneCreation: boolean /** * Don't use the autoincremenent serial but the provided one (0 to keep the - * same) + * same). */ serial?: number } export type ListDNSZoneNameserversRequest = { - /** The DNS zone on which to filter the returned DNS zone nameservers */ + /** The DNS zone on which to filter the returned DNS zone nameservers. */ dnsZone: string - /** The project ID on which to filter the returned DNS zone nameservers */ + /** The project ID on which to filter the returned DNS zone nameservers. */ projectId?: string } export type UpdateDNSZoneNameserversRequest = { - /** The DNS zone where the DNS zone nameservers will be updated */ + /** The DNS zone where the DNS zone nameservers will be updated. */ dnsZone: string - /** The new DNS zone nameservers */ + /** The new DNS zone nameservers. */ ns: Nameserver[] } export type ClearDNSZoneRecordsRequest = { - /** The DNS zone to clear */ + /** The DNS zone to clear. */ dnsZone: string } export type ExportRawDNSZoneRequest = { - /** The DNS zone to export */ + /** The DNS zone to export. */ dnsZone: string - /** Format for DNS zone */ + /** Format for DNS zone. */ format?: RawFormat } export type ImportRawDNSZoneRequest = { - /** The DNS zone to import */ + /** The DNS zone to import. */ dnsZone: string /** @deprecated */ content?: string @@ -973,27 +973,27 @@ export type ImportProviderDNSZoneRequest = { } export type RefreshDNSZoneRequest = { - /** The DNS zone to refresh */ + /** The DNS zone to refresh. */ dnsZone: string - /** Whether or not to recreate the DNS zone */ + /** Whether or not to recreate the DNS zone. */ recreateDnsZone: boolean - /** Whether or not to recreate the sub DNS zone */ + /** Whether or not to recreate the sub DNS zone. */ recreateSubDnsZone: boolean } export type ListDNSZoneVersionsRequest = { dnsZone: string - /** The page number for the returned DNS zones versions */ + /** The page number for the returned DNS zones versions. */ page?: number - /** The maximum number of DNS zones versions per page */ + /** The maximum number of DNS zones versions per page. */ pageSize?: number } export type ListDNSZoneVersionRecordsRequest = { dnsZoneVersionId: string - /** The page number for the returned DNS zones versions records */ + /** The page number for the returned DNS zones versions records. */ page?: number - /** The maximum number of DNS zones versions records per page */ + /** The maximum number of DNS zones versions records per page. */ pageSize?: number } @@ -1304,11 +1304,11 @@ export type RegistrarApiDisableDomainDNSSECRequest = { } export type RegistrarApiSearchAvailableDomainsRequest = { - /** A list of domain to search, TLD is optional */ + /** A list of domain to search, TLD is optional. */ domains: string[] - /** Array of tlds to search on */ + /** Array of tlds to search on. */ tlds?: string[] - /** Search exact match */ + /** Search exact match. */ strictSearch: boolean } diff --git a/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts b/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts index d905d92d9..f72b55e28 100644 --- a/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/flexibleip/v1alpha1/types.gen.ts @@ -23,37 +23,37 @@ export type MACAddressStatus = export type MACAddressType = 'unknown_type' | 'vmware' | 'xen' | 'kvm' -/** Attach flexible i ps response */ +/** Attach flexible i ps response. */ export interface AttachFlexibleIPsResponse { - /** Total count of Flexible IPs being updated */ + /** Total count of Flexible IPs being updated. */ totalCount: number - /** Listing of Flexible IPs in updating state */ + /** Listing of Flexible IPs in updating state. */ flexibleIps: FlexibleIP[] } -/** Detach flexible i ps response */ +/** Detach flexible i ps response. */ export interface DetachFlexibleIPsResponse { - /** Total count of Flexible IPs being detached */ + /** Total count of Flexible IPs being detached. */ totalCount: number - /** Listing of Flexible IPs in detaching state */ + /** Listing of Flexible IPs in detaching state. */ flexibleIps: FlexibleIP[] } -/** Flexible ip */ +/** Flexible ip. */ export interface FlexibleIP { - /** ID of the Flexible IP */ + /** ID of the Flexible IP. */ id: string - /** Organization ID the Flexible IP is attached to */ + /** Organization ID the Flexible IP is attached to. */ organizationId: string - /** Project ID the Flexible IP is attached to */ + /** Project ID the Flexible IP is attached to. */ projectId: string - /** Description of the Flexible IP */ + /** Description of the Flexible IP. */ description: string - /** Tags associated with the Flexible IP */ + /** Tags associated with the Flexible IP. */ tags: string[] - /** Date of last update of the Flexible IP */ + /** Date of last update of the Flexible IP. */ updatedAt?: Date - /** Date of creation of the Flexible IP */ + /** Date of creation of the Flexible IP. */ createdAt?: Date /** * - Ready : Flexible IP is created and ready to be attached to a server or to @@ -63,126 +63,126 @@ export interface FlexibleIP { * - Attached: Flexible IP is attached to a server * - Error: a Flexible IP operation resulted in an error * - Detaching: Flexible IP is being detached from a server - * - Locked: Flexible IP resource is locked + * - Locked: Flexible IP resource is locked. */ status: FlexibleIPStatus - /** IP of the Flexible IP */ + /** IP of the Flexible IP. */ ipAddress: string - /** MAC address of the Flexible IP */ + /** MAC address of the Flexible IP. */ macAddress?: MACAddress - /** ID of the server linked to the Flexible IP */ + /** ID of the server linked to the Flexible IP. */ serverId?: string - /** Reverse DNS value */ + /** Reverse DNS value. */ reverse: string - /** Flexible IP Availability Zone */ + /** Flexible IP Availability Zone. */ zone: Zone } -/** List flexible i ps response */ +/** List flexible i ps response. */ export interface ListFlexibleIPsResponse { - /** Total count of matching Flexible IPs */ + /** Total count of matching Flexible IPs. */ totalCount: number - /** Listing of Flexible IPs */ + /** Listing of Flexible IPs. */ flexibleIps: FlexibleIP[] } -/** Mac address */ +/** Mac address. */ export interface MACAddress { - /** ID of the Flexible IP */ + /** ID of the Flexible IP. */ id: string - /** MAC address of the Virtual MAC */ + /** MAC address of the Virtual MAC. */ macAddress: string - /** Virtual MAC type */ + /** Virtual MAC type. */ macType: MACAddressType - /** Virtual MAC status */ + /** Virtual MAC status. */ status: MACAddressStatus - /** Date of last update of the Virtual MAC */ + /** Date of last update of the Virtual MAC. */ updatedAt?: Date - /** Date of creation of the Virtual MAC */ + /** Date of creation of the Virtual MAC. */ createdAt?: Date - /** MAC Addr IP Availability Zone */ + /** MAC Addr IP Availability Zone. */ zone: Zone } export type CreateFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the project to associate with the Flexible IP */ + /** ID of the project to associate with the Flexible IP. */ projectId?: string - /** Description to associate with the Flexible IP, max 255 characters */ + /** Description to associate with the Flexible IP, max 255 characters. */ description: string - /** Tags to associate to the Flexible IP */ + /** Tags to associate to the Flexible IP. */ tags?: string[] - /** Server ID on which to attach the created Flexible IP */ + /** Server ID on which to attach the created Flexible IP. */ serverId?: string - /** Reverse DNS value */ + /** Reverse DNS value. */ reverse?: string - /** If true, creates a Flexible IP with an ipv6 address */ + /** If true, creates a Flexible IP with an ipv6 address. */ isIpv6: boolean } export type GetFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Flexible IP ID */ + /** Flexible IP ID. */ fipId: string } export type ListFlexibleIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The sort order of the returned Flexible IPs */ + /** The sort order of the returned Flexible IPs. */ orderBy?: ListFlexibleIPsRequestOrderBy - /** The page number for the returned Flexible IPs */ + /** The page number for the returned Flexible IPs. */ page?: number - /** The maximum number of Flexible IPs per page */ + /** The maximum number of Flexible IPs per page. */ pageSize?: number - /** Filter Flexible IPs with one or more matching tags */ + /** Filter Flexible IPs with one or more matching tags. */ tags?: string[] - /** Filter Flexible IPs by status */ + /** Filter Flexible IPs by status. */ status?: FlexibleIPStatus[] - /** Filter Flexible IPs by server IDs */ + /** Filter Flexible IPs by server IDs. */ serverIds?: string[] - /** Filter Flexible IPs by organization ID */ + /** Filter Flexible IPs by organization ID. */ organizationId?: string - /** Filter Flexible IPs by project ID */ + /** Filter Flexible IPs by project ID. */ projectId?: string } export type UpdateFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the Flexible IP to update */ + /** ID of the Flexible IP to update. */ fipId: string - /** Description to associate with the Flexible IP, max 255 characters */ + /** Description to associate with the Flexible IP, max 255 characters. */ description?: string - /** Tags to associate with the Flexible IP */ + /** Tags to associate with the Flexible IP. */ tags?: string[] - /** Reverse DNS value */ + /** Reverse DNS value. */ reverse?: string } export type DeleteFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the Flexible IP to delete */ + /** ID of the Flexible IP to delete. */ fipId: string } export type AttachFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** * Multiple IDs can be provided as long as Flexible IPs belong to the same MAC * groups (see details about MAC groups). */ fipsIds: string[] - /** A server ID on which to attach the Flexible IPs */ + /** A server ID on which to attach the Flexible IPs. */ serverId: string } export type DetachFlexibleIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** * Multiple IDs can be provided as long as Flexible IPs belong to the same MAC @@ -192,16 +192,16 @@ export type DetachFlexibleIPRequest = { } export type GenerateMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Flexible IP ID on which to generate a Virtual MAC */ + /** Flexible IP ID on which to generate a Virtual MAC. */ fipId: string - /** TODO */ + /** TODO. */ macType: MACAddressType } export type DuplicateMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** Flexible IPs need to be attached to the same server. */ fipId: string @@ -210,14 +210,14 @@ export type DuplicateMACAddrRequest = { } export type MoveMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone fipId: string dstFipId: string } export type DeleteMACAddrRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** * If the Flexible IP belongs to a MAC group, the MAC will be removed from the diff --git a/packages/clients/src/api/function/v1beta1/types.gen.ts b/packages/clients/src/api/function/v1beta1/types.gen.ts index cc6f672a9..f5b4e6e31 100644 --- a/packages/clients/src/api/function/v1beta1/types.gen.ts +++ b/packages/clients/src/api/function/v1beta1/types.gen.ts @@ -151,7 +151,7 @@ export interface CreateTriggerRequestSqsClientConfig { secretKey: string } -/** Cron */ +/** Cron. */ export interface Cron { id: string functionId: string @@ -161,7 +161,7 @@ export interface Cron { name: string } -/** Domain */ +/** Domain. */ export interface Domain { id: string hostname: string @@ -176,7 +176,7 @@ export interface DownloadURL { headers: Record } -/** Function */ +/** Function. */ export interface Function { id: string name: string @@ -207,37 +207,37 @@ export interface Function { runtimeMessage: string } -/** List crons response */ +/** List crons response. */ export interface ListCronsResponse { crons: Cron[] totalCount: number } -/** List domains response */ +/** List domains response. */ export interface ListDomainsResponse { domains: Domain[] totalCount: number } -/** List function runtimes response */ +/** List function runtimes response. */ export interface ListFunctionRuntimesResponse { runtimes: Runtime[] totalCount: number } -/** List functions response */ +/** List functions response. */ export interface ListFunctionsResponse { functions: Function[] totalCount: number } -/** List logs response */ +/** List logs response. */ export interface ListLogsResponse { logs: Log[] totalCount: number } -/** List namespaces response */ +/** List namespaces response. */ export interface ListNamespacesResponse { namespaces: Namespace[] totalCount: number @@ -253,20 +253,20 @@ export interface ListTriggersResponse { totalCount: number } -/** Log */ +/** Log. */ export interface Log { message: string timestamp?: Date id: string - /** Contains the severity of the log (info, debug, error, ...) */ + /** Contains the severity of the log (info, debug, error, ...). */ level: string - /** Source of the log (core runtime or user code) */ + /** Source of the log (core runtime or user code). */ source: string - /** Can be stdout or stderr */ + /** Can be stdout or stderr. */ stream: LogStream } -/** Namespace */ +/** Namespace. */ export interface Namespace { id: string name: string @@ -304,7 +304,7 @@ export interface SecretHashedValue { hashedValue: string } -/** Token */ +/** Token. */ export interface Token { id: string token: string @@ -386,14 +386,17 @@ export interface UpdateTriggerRequestSqsClientConfig { secretKey: string } -/** Upload url */ +/** Upload url. */ export interface UploadURL { url: string headers: Record } 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?: Region page?: number pageSize?: number @@ -404,13 +407,19 @@ export type ListNamespacesRequest = { } 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?: Region namespaceId: string } export type CreateNamespaceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region name?: string environmentVariables?: Record @@ -420,7 +429,10 @@ export type CreateNamespaceRequest = { } 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?: Region namespaceId: string environmentVariables?: Record @@ -429,13 +441,19 @@ export type UpdateNamespaceRequest = { } 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?: Region namespaceId: string } 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?: Region page?: number pageSize?: number @@ -447,13 +465,19 @@ export type ListFunctionsRequest = { } 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?: Region 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?: Region name?: string namespaceId: string @@ -478,7 +502,10 @@ export type CreateFunctionRequest = { } 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?: Region functionId: string environmentVariables?: Record @@ -503,37 +530,55 @@ export type UpdateFunctionRequest = { } 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?: Region functionId: 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?: Region functionId: string } 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?: Region } 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?: Region functionId: string contentLength: number } 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?: Region functionId: 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?: Region page?: number pageSize?: number @@ -542,13 +587,19 @@ export type ListCronsRequest = { } 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?: Region cronId: string } 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?: Region functionId: string schedule: string @@ -557,7 +608,10 @@ export type CreateCronRequest = { } 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?: Region cronId: string functionId?: string @@ -567,13 +621,19 @@ export type UpdateCronRequest = { } 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?: Region cronId: string } export type ListLogsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region functionId: string page?: number @@ -582,7 +642,10 @@ export type ListLogsRequest = { } 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?: Region page?: number pageSize?: number @@ -591,26 +654,38 @@ export type ListDomainsRequest = { } 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?: Region domainId: string } export type CreateDomainRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region hostname: string functionId: 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?: Region domainId: string } export type IssueJWTRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */ functionId?: string @@ -620,7 +695,10 @@ export type IssueJWTRequest = { } 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?: Region /** One-of ('scope'): at most one of 'functionId', 'namespaceId' could be set. */ functionId?: string @@ -631,13 +709,19 @@ export type CreateTokenRequest = { } 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?: Region tokenId: string } 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?: Region page?: number pageSize?: number @@ -647,13 +731,19 @@ export type ListTokensRequest = { } 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?: Region tokenId: string } 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?: Region name: string description: string @@ -676,13 +766,19 @@ export type CreateTriggerRequest = { } 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?: Region triggerId: string } 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?: Region page?: number pageSize?: number @@ -705,7 +801,10 @@ export type ListTriggersRequest = { } 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?: Region triggerId: string name?: string @@ -728,7 +827,10 @@ export type UpdateTriggerRequest = { } 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?: Region triggerId: string } diff --git a/packages/clients/src/api/iam/v1alpha1/types.gen.ts b/packages/clients/src/api/iam/v1alpha1/types.gen.ts index 2da7f4ed0..c3343c5b4 100644 --- a/packages/clients/src/api/iam/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/iam/v1alpha1/types.gen.ts @@ -77,11 +77,11 @@ export type UserStatus = 'unknown_status' | 'invitation_pending' | 'activated' export type UserType = 'unknown_type' | 'guest' | 'owner' -/** Api key */ +/** Api key. */ export interface APIKey { - /** Access key of API key */ + /** Access key of API key. */ accessKey: string - /** Secret key of API Key */ + /** Secret key of API Key. */ secretKey?: string /** * ID of application bearer. @@ -95,103 +95,103 @@ 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 - /** Creation date and time of API key */ + /** Creation date and time of API key. */ createdAt?: Date - /** Last update date and time of API key */ + /** Last update date and time of API key. */ updatedAt?: Date - /** Expiration date and time of API key */ + /** Expiration date and time of API key. */ expiresAt?: Date - /** The default project ID specified for this API key */ + /** The default project ID specified for this API key. */ defaultProjectId: string - /** Whether or not the API key is editable */ + /** Whether or not the API key is editable. */ editable: boolean - /** IP Address of the device which created the API key */ + /** IP Address of the device which created the API key. */ creationIp: string } -/** Application */ +/** Application. */ export interface Application { - /** ID of application */ + /** ID of application. */ id: string - /** Name of application */ + /** Name of application. */ name: string - /** Description of the application */ + /** Description of the application. */ description: string - /** Creation date of application */ + /** Creation date of application. */ createdAt?: Date - /** Last update date of application */ + /** Last update date of application. */ updatedAt?: Date - /** ID of organization */ + /** ID of organization. */ organizationId: string - /** Whether or not the application is editable */ + /** Whether or not the application is editable. */ editable: boolean - /** Number of API keys owned by the application */ + /** Number of API keys owned by the application. */ nbApiKeys: number } -/** Group */ +/** Group. */ export interface Group { - /** ID of group */ + /** ID of group. */ id: string - /** Creation date and time of group */ + /** Creation date and time of group. */ createdAt?: Date - /** Last update date and time of group */ + /** Last update date and time of group. */ updatedAt?: Date - /** ID of organization linked to the group */ + /** ID of organization linked to the group. */ organizationId: string - /** Name of group */ + /** Name of 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[] } -/** Jwt */ +/** Jwt. */ 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 } -/** List api keys response */ +/** List api keys response. */ 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 } -/** List applications response */ +/** List applications response. */ export interface ListApplicationsResponse { - /** List of applications */ + /** List of applications. */ applications: Application[] - /** Total count of applications */ + /** Total count of applications. */ totalCount: number } -/** List groups response */ +/** List groups response. */ export interface ListGroupsResponse { - /** List of groups */ + /** List of groups. */ groups: Group[] - /** Total count of groups */ + /** Total count of groups. */ totalCount: number } @@ -200,89 +200,89 @@ export interface ListJWTsResponse { totalCount: number } -/** List permission sets response */ +/** List permission sets response. */ 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 } -/** List policies response */ +/** List policies response. */ export interface ListPoliciesResponse { - /** List of policies */ + /** List of policies. */ policies: Policy[] - /** Total count of policies */ + /** Total count of policies. */ totalCount: number } -/** List quota response */ +/** List quota response. */ export interface ListQuotaResponse { - /** List of quota */ + /** List of quota. */ quota: Quotum[] - /** Total count of quota */ + /** Total count of quota. */ totalCount: number } -/** List rules response */ +/** List rules response. */ export interface ListRulesResponse { - /** Rules of the policy */ + /** Rules of the policy. */ rules: Rule[] - /** Total count of rules */ + /** Total count of rules. */ totalCount: number } -/** List ssh keys response */ +/** List ssh keys response. */ 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 } -/** List users response */ +/** List users response. */ export interface ListUsersResponse { - /** List of users */ + /** List of users. */ users: User[] - /** Total count of users */ + /** Total count of users. */ totalCount: number } -/** Permission set */ +/** Permission set. */ export interface PermissionSet { - /** Id of permission set */ + /** Id of permission set. */ id: string - /** Name of permission set */ + /** Name of permission set. */ name: string - /** Scope of permission set */ + /** Scope of permission set. */ scopeType: PermissionSetScopeType - /** Description of permission set */ + /** Description of permission set. */ description: string - /** Categories of permission set */ + /** Categories of permission set. */ categories?: string[] } -/** Policy */ +/** Policy. */ export interface Policy { - /** Id of policy */ + /** Id of policy. */ id: string - /** Name of policy */ + /** Name of policy. */ name: string - /** Description of policy */ + /** Description of policy. */ description: string - /** Organization ID of policy */ + /** Organization ID of policy. */ organizationId: string - /** Creation date and time of policy */ + /** Creation date and time of policy. */ createdAt?: Date - /** Last update date and time of policy */ + /** Last update date and time of policy. */ updatedAt?: Date - /** Editable status of policy */ + /** Editable status of policy. */ editable: boolean - /** Number of rules of policy */ + /** Number of rules of policy. */ nbRules: number - /** Number of scopes of policy */ + /** Number of scopes of policy. */ nbScopes: number - /** Number of permission sets of policy */ + /** Number of permission sets of policy. */ nbPermissionSets: number /** * ID of user, owner of the policy. @@ -314,9 +314,9 @@ export interface Policy { noPrincipal?: boolean } -/** Quotum */ +/** Quotum. */ export interface Quotum { - /** Name of the quotum */ + /** Name of the quotum. */ name: string /** * Max limit of the quotum. @@ -332,13 +332,13 @@ export interface Quotum { unlimited?: boolean } -/** Rule */ +/** Rule. */ 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 /** * List of project IDs scoped to the rule. @@ -363,9 +363,9 @@ export interface Rule { accountRootUserId?: string } -/** Rule specs */ +/** Rule specs. */ export interface RuleSpecs { - /** Names of permission sets bound to the rule */ + /** Names of permission sets bound to the rule. */ permissionSetNames?: string[] /** * List of project IDs scoped to the rule. @@ -383,97 +383,97 @@ export interface RuleSpecs { organizationId?: string } -/** Ssh key */ +/** Ssh key. */ 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 SSH key */ + /** Fingerprint of 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 } -/** Set rules response */ +/** Set rules response. */ export interface SetRulesResponse { - /** Rules of policy */ + /** Rules of policy. */ rules: Rule[] } -/** User */ +/** User. */ export interface User { - /** ID of user */ + /** ID of user. */ id: string - /** Email of user */ + /** Email of user. */ email: string - /** Creation date of user */ + /** Creation date of user. */ createdAt?: Date - /** Last update date of user */ + /** Last update date of user. */ updatedAt?: Date - /** ID of organization */ + /** ID of organization. */ organizationId: string - /** Deletion status of user. Owner user cannot be deleted */ + /** Deletion status of user. Owner user cannot be deleted. */ deletable: boolean - /** Last login date */ + /** Last login date. */ lastLoginAt?: Date - /** Type of the user */ + /** Type of the user. */ type: UserType - /** 2FA enabled */ + /** 2FA enabled. */ twoFactorEnabled: boolean - /** Status of invitation for the user */ + /** Status of invitation for the user. */ status: UserStatus } export type ListSSHKeysRequest = { - /** Sort order of SSH keys */ + /** Sort order of SSH keys. */ orderBy?: ListSSHKeysRequestOrderBy - /** Requested page number. Value must be greater or equals to 1 */ + /** Requested page number. Value must be greater or equals 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 - /** Filter out disabled SSH keys or not */ + /** Filter out disabled SSH keys or not. */ disabled?: boolean } export type CreateSSHKeyRequest = { - /** The name of the SSH key. Max length is 1000 */ + /** The name of the SSH key. Max length is 1000. */ name?: string /** * SSH public key. Currently ssh-rsa, ssh-dss (DSA), ssh-ed25519 and ecdsa - * keys with NIST curves are supported. Max length is 65000 + * keys with NIST curves are supported. Max length is 65000. */ publicKey: string - /** Project owning the resource */ + /** Project owning the resource. */ projectId?: string } export type GetSSHKeyRequest = { - /** The ID of the SSH key */ + /** The ID of the SSH key. */ sshKeyId: string } 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 } @@ -482,118 +482,118 @@ export type DeleteSSHKeyRequest = { } 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 - /** Number of page. Value must be greater or equals to 1 */ + /** Number of page. Value must be greater or equals to 1. */ page?: number - /** ID of organization to filter */ + /** ID of organization to filter. */ organizationId?: string - /** Filter out by a list of ID */ + /** Filter out by a list of ID. */ userIds?: string[] } export type GetUserRequest = { - /** ID of user to find */ + /** ID of user to find. */ userId: string } export type DeleteUserRequest = { - /** ID of user to delete */ + /** ID of user to delete. */ userId: string } 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 - /** Number of page. Value must be greater to 1 */ + /** Number of page. Value must be greater to 1. */ page?: number - /** Name of application to filter */ + /** Name of application to filter. */ name?: string - /** ID of organization to filter */ + /** ID of organization to filter. */ organizationId?: string - /** Filter out editable applications or not */ + /** Filter out editable applications or not. */ editable?: boolean - /** Filter out by a list of ID */ + /** Filter out by a list of ID. */ applicationIds?: string[] } export type CreateApplicationRequest = { - /** Name of application to create (max length is 64 chars) */ + /** Name of application to create (max length is 64 chars). */ name?: string - /** ID of organization */ + /** ID of organization. */ organizationId?: string - /** Description of application (max length is 200 chars) */ + /** Description of application (max length is 200 chars). */ description: string } export type GetApplicationRequest = { - /** ID of application to find */ + /** ID of application to find. */ applicationId: string } export type UpdateApplicationRequest = { - /** ID of application to update */ + /** ID of application to update. */ applicationId: string - /** New name of application (max length is 64 chars) */ + /** New name of application (max length is 64 chars). */ name?: string - /** New description of application (max length is 200 chars) */ + /** New description of application (max length is 200 chars). */ description?: string } export type DeleteApplicationRequest = { - /** ID of application to delete */ + /** ID of application to delete. */ applicationId: string } export type ListGroupsRequest = { - /** Sort order of groups */ + /** Sort order of groups. */ orderBy?: ListGroupsRequestOrderBy - /** Requested page number. Value must be greater or equals to 1 */ + /** Requested page number. Value must be greater or equals 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 out by a list of application ID */ + /** Filter out by a list of application ID. */ applicationIds?: string[] - /** Filter out by a list of user ID */ + /** Filter out by a list of user ID. */ userIds?: string[] - /** Filter out by a list of group ID */ + /** Filter out by a list of group ID. */ groupIds?: 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 + * 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 } export type GetGroupRequest = { - /** ID of group */ + /** ID of group. */ groupId: string } export type UpdateGroupRequest = { - /** ID of group to update */ + /** ID of group to update. */ groupId: string /** * New name for the group (max length is 64 chars). MUST be unique inside an - * organization + * 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 } @@ -604,7 +604,7 @@ export type SetGroupMembersRequest = { } export type AddGroupMemberRequest = { - /** ID of group */ + /** ID of group. */ groupId: string /** * ID of the user to add. @@ -621,7 +621,7 @@ export type AddGroupMemberRequest = { } export type RemoveGroupMemberRequest = { - /** ID of group */ + /** ID of group. */ groupId: string /** * ID of the user to remove. @@ -638,41 +638,41 @@ export type RemoveGroupMemberRequest = { } export type DeleteGroupRequest = { - /** ID of group to delete */ + /** ID of group to delete. */ groupId: string } 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 - /** Number of page. Value must be greater to 1 */ + /** Number of page. Value must be greater to 1. */ page?: number - /** ID of organization to filter */ + /** ID of organization to filter. */ organizationId?: string - /** Filter out editable policies or not */ + /** Filter out editable policies or not. */ editable?: boolean - /** Filter out by a list of user ID */ + /** Filter out by a list of user ID. */ userIds?: string[] - /** Filter out by a list of group ID */ + /** Filter out by a list of group ID. */ groupIds?: string[] - /** Filter out by a list of application ID */ + /** Filter out by a list of application ID. */ applicationIds?: string[] - /** True when the policy do not belong to any principal */ + /** True when the policy do not belong to any principal. */ noPrincipal?: boolean - /** Name of policy to fetch */ + /** Name of policy to fetch. */ policyName?: string } export type CreatePolicyRequest = { - /** Name of policy to create (max length is 64 chars) */ + /** Name of policy to create (max length is 64 chars). */ name?: string - /** Description of policy to create (max length is 200 chars) */ + /** Description of policy to create (max length is 200 chars). */ description: string - /** ID of organization */ + /** ID of organization. */ organizationId?: string - /** Rules of the policy to create */ + /** Rules of the policy to create. */ rules?: RuleSpecs[] /** * ID of user, owner of the policy. @@ -705,16 +705,16 @@ export type CreatePolicyRequest = { } export type GetPolicyRequest = { - /** Id of policy to search */ + /** Id of policy to search. */ policyId: string } export type UpdatePolicyRequest = { - /** Id of policy to update */ + /** Id of policy to update. */ policyId: string - /** New name of policy (max length is 64 chars) */ + /** New name of policy (max length is 64 chars). */ name?: string - /** New description of policy (max length is 200 chars) */ + /** New description of policy (max length is 200 chars). */ description?: string /** * New ID of user, owner of the policy. @@ -747,7 +747,7 @@ export type UpdatePolicyRequest = { } export type DeletePolicyRequest = { - /** Id of policy to delete */ + /** Id of policy to delete. */ policyId: string } @@ -756,40 +756,40 @@ export type ClonePolicyRequest = { } 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 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 - /** Number of page. Value must be greater to 1 */ + /** Number of page. Value must be greater to 1. */ page?: 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 - /** Number of page. Value must be greater to 1 */ + /** Number of page. Value must be greater to 1. */ page?: number - /** Filter by organization ID */ + /** Filter by organization ID. */ organizationId?: string } export type ListAPIKeysRequest = { - /** Criteria for sorting results */ + /** Criteria for sorting results. */ orderBy?: ListAPIKeysRequestOrderBy - /** Number of page. Value must be greater or equals to 1 */ + /** Number of page. Value must be greater or equals 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 an application bearer. @@ -803,17 +803,17 @@ export type ListAPIKeysRequest = { * One-of ('bearer'): at most one of 'applicationId', 'userId' could be set. */ userId?: string - /** Filter out editable API keys or not */ + /** Filter out editable API keys or not. */ editable?: boolean - /** Filter out expired API keys or not */ + /** Filter out expired API keys or not. */ expired?: boolean - /** Filter out by access key */ + /** Filter out by access key. */ accessKey?: string - /** Filter out by description */ + /** Filter out by description. */ description?: string - /** Filter out by bearer ID */ + /** Filter out by bearer ID. */ bearerId?: string - /** Filter out by type of bearer */ + /** Filter out by type of bearer. */ bearerType?: BearerType } @@ -830,70 +830,70 @@ 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 - /** The default project ID to use with object storage */ + /** The default project ID to use with object storage. */ defaultProjectId?: string - /** The description of the API key (max length is 200 chars) */ + /** The description of the API key (max length is 200 chars). */ description: string } export type GetAPIKeyRequest = { - /** Access key to search for */ + /** Access key to search for. */ accessKey: string } export type UpdateAPIKeyRequest = { - /** Access key to update */ + /** Access key to update. */ accessKey: string - /** The new default project ID to set */ + /** The new default project ID to set. */ defaultProjectId?: string - /** The new description to update */ + /** The new description to update. */ description?: string } export type DeleteAPIKeyRequest = { - /** Access key to delete */ + /** Access key to delete. */ accessKey: string } 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 - /** Number of page. Value must be greater to 1 */ + /** Number of page. Value must be greater to 1. */ page?: number - /** Filter by organization ID */ + /** Filter by organization ID. */ organizationId?: string } export type GetQuotumRequest = { - /** Name of the quotum to get */ + /** Name of the quotum to get. */ quotumName: string - /** ID of the organization */ + /** ID of the organization. */ organizationId?: string } 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 - /** Number of page. Value must be greater to 1 */ + /** Number of page. Value must be greater to 1. */ page?: number - /** Filter out expired JWTs or not */ + /** Filter out expired JWTs or not. */ expired?: boolean } export type GetJWTRequest = { - /** JWT ID of the JWT to get */ + /** JWT ID of the JWT to get. */ jti: string } export type DeleteJWTRequest = { - /** JWT ID of the JWT to delete */ + /** JWT ID of the JWT to delete. */ jti: string } diff --git a/packages/clients/src/api/instance/v1/types.gen.ts b/packages/clients/src/api/instance/v1/types.gen.ts index 514186aa0..33f184bcb 100644 --- a/packages/clients/src/api/instance/v1/types.gen.ts +++ b/packages/clients/src/api/instance/v1/types.gen.ts @@ -86,37 +86,37 @@ export type VolumeState = export type VolumeVolumeType = 'l_ssd' | 'b_ssd' | 'unified' -/** Bootscript */ +/** Bootscript. */ export interface Bootscript { - /** The bootscript arguments */ + /** The bootscript arguments. */ bootcmdargs: string /** * Dispmay if the bootscript is the default bootscript if no other boot option - * is configured + * is configured. */ default: boolean /** * Provide information regarding a Device Tree Binary (dtb) for use with C1 - * servers + * servers. */ dtb: string - /** The bootscript ID */ + /** The bootscript ID. */ id: string - /** The initrd (initial ramdisk) configuration */ + /** The initrd (initial ramdisk) configuration. */ initrd: string - /** The server kernel version */ + /** The server kernel version. */ kernel: string - /** The bootscript organization ID */ + /** The bootscript organization ID. */ organization: string - /** The bootscript project ID */ + /** The bootscript project ID. */ project: string - /** Provide information if the bootscript is public */ + /** Provide information if the bootscript is public. */ public: boolean - /** The bootscript title */ + /** The bootscript title. */ title: string - /** The bootscript arch */ + /** The bootscript arch. */ arch: Arch - /** The zone in which is the bootscript */ + /** The zone in which is the bootscript. */ zone: Zone } @@ -265,35 +265,35 @@ export interface Ip { zone: Zone } -/** List bootscripts response */ +/** List bootscripts response. */ export interface ListBootscriptsResponse { - /** Total number of bootscripts */ + /** Total number of bootscripts. */ totalCount: number - /** List of bootscripts */ + /** List of bootscripts. */ bootscripts: Bootscript[] } -/** List images response */ +/** List images response. */ export interface ListImagesResponse { - /** Total number of images */ + /** Total number of images. */ totalCount: number - /** List of images */ + /** List of images. */ images: Image[] } -/** List ips response */ +/** List ips response. */ export interface ListIpsResponse { - /** Total number of ips */ + /** Total number of ips. */ totalCount: number - /** List of ips */ + /** List of ips. */ ips: Ip[] } -/** List placement groups response */ +/** List placement groups response. */ export interface ListPlacementGroupsResponse { - /** Total number of placement groups */ + /** Total number of placement groups. */ totalCount: number - /** List of placement groups */ + /** List of placement groups. */ placementGroups: PlacementGroup[] } @@ -302,19 +302,19 @@ export interface ListPrivateNICsResponse { totalCount: number } -/** List security group rules response */ +/** List security group rules response. */ export interface ListSecurityGroupRulesResponse { - /** Total number of security groups */ + /** Total number of security groups. */ totalCount: number - /** List of security rules */ + /** List of security rules. */ rules: SecurityGroupRule[] } -/** List security groups response */ +/** List security groups response. */ export interface ListSecurityGroupsResponse { - /** Total number of security groups */ + /** Total number of security groups. */ totalCount: number - /** List of security groups */ + /** List of security groups. */ securityGroups: SecurityGroup[] } @@ -326,71 +326,71 @@ export interface ListServerUserDataResponse { userData: string[] } -/** List servers response */ +/** List servers response. */ export interface ListServersResponse { - /** Total number of servers */ + /** Total number of servers. */ totalCount: number - /** List of servers */ + /** List of servers. */ servers: Server[] } -/** List servers types response */ +/** List servers types response. */ export interface ListServersTypesResponse { - /** Total number of server types */ + /** Total number of server types. */ totalCount: number - /** List of server types */ + /** List of server types. */ servers: Record } -/** List snapshots response */ +/** List snapshots response. */ export interface ListSnapshotsResponse { - /** Total number of snapshots */ + /** Total number of snapshots. */ totalCount: number - /** List of snapshots */ + /** List of snapshots. */ snapshots: Snapshot[] } -/** List volumes response */ +/** List volumes response. */ export interface ListVolumesResponse { - /** Total number of volumes */ + /** Total number of volumes. */ totalCount: number - /** List of volumes */ + /** List of volumes. */ volumes: Volume[] } -/** List volumes types response */ +/** List volumes types response. */ export interface ListVolumesTypesResponse { - /** Total number of volume types */ + /** Total number of volume types. */ totalCount: number - /** Map of volume types */ + /** Map of volume types. */ volumes: Record } -/** Placement group */ +/** Placement group. */ export interface PlacementGroup { - /** The placement group unique ID */ + /** The placement group unique ID. */ id: string - /** The placement group name */ + /** The placement group name. */ name: string - /** The placement group organization ID */ + /** The placement group organization ID. */ organization: string - /** The placement group project ID */ + /** The placement group project ID. */ project: string - /** The placement group tags */ + /** The placement group tags. */ tags: string[] /** * Select the failling mode when the placement cannot be respected, either - * optional or enforced + * optional or enforced. */ policyMode: PlacementGroupPolicyMode /** * Select the behavior of the placement group, either low_latency (group) or - * max_availability (spread) + * max_availability (spread). */ policyType: PlacementGroupPolicyType - /** Returns true if the policy is respected, false otherwise */ + /** Returns true if the policy is respected, false otherwise. */ policyRespected: boolean - /** The zone in which is the placement group */ + /** The zone in which is the placement group. */ zone: Zone } @@ -400,60 +400,60 @@ export interface PlacementGroupServer { policyRespected: boolean } -/** Private nic */ +/** Private nic. */ export interface PrivateNIC { - /** The private NIC unique ID */ + /** The private NIC unique ID. */ id: string - /** The server the private NIC is attached to */ + /** The server the private NIC is attached to. */ serverId: string - /** The private network where the private NIC is attached */ + /** The private network where the private NIC is attached. */ privateNetworkId: string - /** The private NIC MAC address */ + /** The private NIC MAC address. */ macAddress: string - /** The private NIC state */ + /** The private NIC state. */ state: PrivateNICState - /** The private NIC tags */ + /** The private NIC tags. */ tags: string[] } -/** Security group */ +/** Security group. */ export interface SecurityGroup { - /** The security groups' unique ID */ + /** The security groups' unique ID. */ id: string - /** The security groups name */ + /** The security groups name. */ name: string - /** The security groups description */ + /** The security groups description. */ description: string - /** True if SMTP is blocked on IPv4 and IPv6 */ + /** True if SMTP is blocked on IPv4 and IPv6. */ enableDefaultSecurity: boolean - /** The default inbound policy */ + /** The default inbound policy. */ inboundDefaultPolicy: SecurityGroupPolicy - /** The default outbound policy */ + /** The default outbound policy. */ outboundDefaultPolicy: SecurityGroupPolicy - /** The security groups organization ID */ + /** The security groups organization ID. */ organization: string - /** The security group project ID */ + /** The security group project ID. */ project: string - /** The security group tags */ + /** The security group tags. */ tags: string[] /** * @deprecated True if it is your default security group for this organization - * ID + * ID. */ organizationDefault?: boolean - /** True if it is your default security group for this project ID */ + /** True if it is your default security group for this project ID. */ projectDefault: boolean - /** The security group creation date */ + /** The security group creation date. */ creationDate?: Date - /** The security group modification date */ + /** The security group modification date. */ modificationDate?: Date - /** List of servers attached to this security group */ + /** List of servers attached to this security group. */ servers: ServerSummary[] - /** True if the security group is stateful */ + /** True if the security group is stateful. */ stateful: boolean - /** Security group state */ + /** Security group state. */ state: SecurityGroupState - /** The zone in which is the security group */ + /** The zone in which is the security group. */ zone: Zone } @@ -480,69 +480,69 @@ export interface SecurityGroupTemplate { name: string } -/** Server */ +/** Server. */ export interface Server { - /** The server unique ID */ + /** The server unique ID. */ id: string - /** The server name */ + /** The server name. */ name: string - /** The server organization ID */ + /** The server organization ID. */ organization: string - /** The server project ID */ + /** The server project ID. */ project: string - /** Provide as list of allowed actions on the server */ + /** Provide as list of allowed actions on the server. */ allowedActions: ServerAction[] - /** The server associated tags */ + /** The server associated tags. */ tags: string[] - /** The server commercial type (eg. GP1-M) */ + /** The server commercial type (eg. GP1-M). */ commercialType: string - /** The server creation date */ + /** The server creation date. */ creationDate?: Date - /** True if a dynamic IP is required */ + /** True if a dynamic IP is required. */ dynamicIpRequired: boolean - /** True if IPv6 is enabled */ + /** True if IPv6 is enabled. */ enableIpv6: boolean - /** The server host name */ + /** The server host name. */ hostname: string - /** Provide information on the server image */ + /** Provide information on the server image. */ image?: Image - /** The server protection option is activated */ + /** The server protection option is activated. */ protected: boolean - /** The server private IP address */ + /** The server private IP address. */ privateIp?: string - /** Information about the public IP */ + /** Information about the public IP. */ publicIp?: ServerIp - /** The server modification date */ + /** The server modification date. */ modificationDate?: Date - /** The server state */ + /** The server state. */ state: ServerState - /** The server location */ + /** The server location. */ location?: ServerLocation - /** The server IPv6 address */ + /** The server IPv6 address. */ ipv6?: ServerIpv6 - /** @deprecated The server bootscript */ + /** @deprecated The server bootscript. */ bootscript?: Bootscript - /** The server boot type */ + /** The server boot type. */ bootType: BootType - /** The server volumes */ + /** The server volumes. */ volumes: Record - /** The server security group */ + /** The server security group. */ securityGroup?: SecurityGroupSummary - /** The server planned maintenances */ + /** The server planned maintenances. */ maintenances: ServerMaintenance[] - /** The server state_detail */ + /** The server state_detail. */ stateDetail: string - /** The server arch */ + /** The server arch. */ arch: Arch - /** The server placement group */ + /** The server placement group. */ placementGroup?: PlacementGroup - /** The server private NICs */ + /** The server private NICs. */ privateNics: PrivateNIC[] - /** The zone in which is the server */ + /** The zone in which is the server. */ zone: Zone } -/** Server action request. volume backup template */ +/** Server action request. volume backup template. */ export interface ServerActionRequestVolumeBackupTemplate { /** * Overrides the volume_type of the snapshot for this volume. If omitted, the @@ -555,23 +555,23 @@ export interface ServerActionResponse { task?: Task } -/** Server. ip */ +/** Server. ip. */ export interface ServerIp { - /** The unique ID of the IP address */ + /** The unique ID of the IP address. */ id: string - /** The server public IPv4 IP-Address */ + /** The server public IPv4 IP-Address. */ address: string - /** True if the IP address is dynamic */ + /** True if the IP address is dynamic. */ dynamic: boolean } -/** Server. ipv6 */ +/** Server. ipv6. */ export interface ServerIpv6 { - /** The server IPv6 IP-Address */ + /** The server IPv6 IP-Address. */ address: string - /** The IPv6 IP-addresses gateway */ + /** The IPv6 IP-addresses gateway. */ gateway: string - /** The IPv6 IP-addresses CIDR netmask */ + /** The IPv6 IP-addresses CIDR netmask. */ netmask: string } @@ -592,73 +592,73 @@ export interface ServerSummary { name: string } -/** Server type */ +/** Server type. */ export interface ServerType { - /** @deprecated Estimated monthly price, for a 30 days month, in Euro */ + /** @deprecated Estimated monthly price, for a 30 days month, in Euro. */ monthlyPrice?: number - /** Hourly price in Euro */ + /** Hourly price in Euro. */ hourlyPrice: number - /** Alternative instance name if any */ + /** Alternative instance name if any. */ altNames: string[] - /** Additional volume constraints */ + /** Additional volume constraints. */ perVolumeConstraint?: ServerTypeVolumeConstraintsByType - /** Initial volume constraints */ + /** Initial volume constraints. */ volumesConstraint?: ServerTypeVolumeConstraintSizes - /** Number of CPU */ + /** Number of CPU. */ ncpus: number - /** Number of GPU */ + /** Number of GPU. */ gpu?: number - /** Available RAM in bytes */ + /** Available RAM in bytes. */ ram: number - /** CPU architecture */ + /** CPU architecture. */ arch: Arch - /** True if it is a baremetal instance */ + /** True if it is a baremetal instance. */ baremetal: boolean - /** Network available for the instance */ + /** Network available for the instance. */ network?: ServerTypeNetwork - /** Capabilities */ + /** Capabilities. */ capabilities?: ServerTypeCapabilities } -/** Server type. capabilities */ +/** Server type. capabilities. */ export interface ServerTypeCapabilities { - /** True if server supports block storage */ + /** True if server supports block storage. */ blockStorage?: boolean - /** List of supported boot types */ + /** List of supported boot types. */ bootTypes: BootType[] } -/** Server type. network */ +/** Server type. network. */ export interface ServerTypeNetwork { - /** List of available network interfaces */ + /** List of available network interfaces. */ interfaces: ServerTypeNetworkInterface[] - /** Total maximum internal bandwidth in bits per seconds */ + /** Total maximum internal bandwidth in bits per seconds. */ sumInternalBandwidth?: number - /** Total maximum internet bandwidth in bits per seconds */ + /** Total maximum internet bandwidth in bits per seconds. */ sumInternetBandwidth?: number - /** True if IPv6 is enabled */ + /** True if IPv6 is enabled. */ ipv6Support: boolean } -/** Server type. network. interface */ +/** Server type. network. interface. */ export interface ServerTypeNetworkInterface { - /** Maximum internal bandwidth in bits per seconds */ + /** Maximum internal bandwidth in bits per seconds. */ internalBandwidth?: number - /** Maximum internet bandwidth in bits per seconds */ + /** Maximum internet bandwidth in bits per seconds. */ internetBandwidth?: number } -/** Server type. volume constraint sizes */ +/** Server type. volume constraint sizes. */ export interface ServerTypeVolumeConstraintSizes { - /** Minimum volume size in bytes */ + /** Minimum volume size in bytes. */ minSize: number - /** Maximum volume size in bytes */ + /** Maximum volume size in bytes. */ maxSize: number } -/** Server type. volume constraints by type */ +/** Server type. volume constraints by type. */ export interface ServerTypeVolumeConstraintsByType { - /** Local SSD volumes */ + /** Local SSD volumes. */ lSsd?: ServerTypeVolumeConstraintSizes } @@ -670,43 +670,43 @@ export interface SetPlacementGroupServersResponse { servers: PlacementGroupServer[] } -/** Set security group rules request. rule */ +/** Set security group rules request. rule. */ export interface SetSecurityGroupRulesRequestRule { /** * UUID of the security rule to update. If no value is provided, a new rule - * will be created + * will be created. */ id?: string - /** Action to apply when the rule matches a packet */ + /** Action to apply when the rule matches a packet. */ action: SecurityGroupRuleAction - /** Protocol family this rule applies to */ + /** Protocol family this rule applies to. */ protocol: SecurityGroupRuleProtocol - /** Direction the rule applies to */ + /** Direction the rule applies to. */ direction: SecurityGroupRuleDirection - /** The range of IP address this rules applies to */ + /** The range of IP address this rules applies to. */ ipRange: string /** * Beginning of the range of ports this rule applies to (inclusive). This - * value will be set to null if protocol is ICMP or ANY + * value will be set to null if protocol is ICMP or ANY. */ destPortFrom?: number /** * End of the range of ports this rule applies to (inclusive). This value will * be set to null if protocol is ICMP or ANY, or if it is equal to - * dest_port_from + * dest_port_from. */ destPortTo?: number /** * Position of this rule in the security group rules list. If several rules - * are passed with the same position, the resulting order is undefined + * are passed with the same position, the resulting order is undefined. */ position: number /** * Indicates if this rule is editable. Rules with the value false will be - * ignored + * ignored. */ editable?: boolean - /** Zone of the rule. This field is ignored */ + /** Zone of the rule. This field is ignored. */ zone: Zone } @@ -714,61 +714,61 @@ export interface SetSecurityGroupRulesResponse { rules: SecurityGroupRule[] } -/** Snapshot */ +/** Snapshot. */ export interface Snapshot { - /** The snapshot ID */ + /** The snapshot ID. */ id: string - /** The snapshot name */ + /** The snapshot name. */ name: string - /** The snapshot organization ID */ + /** The snapshot organization ID. */ organization: string - /** The snapshot project ID */ + /** The snapshot project ID. */ project: string - /** The snapshot tags */ + /** The snapshot tags. */ tags: string[] - /** The snapshot volume type */ + /** The snapshot volume type. */ volumeType: VolumeVolumeType - /** The snapshot size */ + /** The snapshot size. */ size: number - /** The snapshot state */ + /** The snapshot state. */ state: SnapshotState - /** The volume on which the snapshot is based on */ + /** The volume on which the snapshot is based on. */ baseVolume?: SnapshotBaseVolume - /** The snapshot creation date */ + /** The snapshot creation date. */ creationDate?: Date - /** The snapshot modification date */ + /** The snapshot modification date. */ modificationDate?: Date - /** The snapshot zone */ + /** The snapshot zone. */ zone: Zone - /** The reason for the failed snapshot import */ + /** The reason for the failed snapshot import. */ errorReason?: string } -/** Snapshot. base volume */ +/** Snapshot. base volume. */ export interface SnapshotBaseVolume { - /** The volume ID on which the snapshot is based on */ + /** The volume ID on which the snapshot is based on. */ id: string - /** The volume name on which the snapshot is based on */ + /** The volume name on which the snapshot is based on. */ name: string } -/** Task */ +/** Task. */ export interface Task { - /** The unique ID of the task */ + /** The unique ID of the task. */ id: string - /** The description of the task */ + /** The description of the task. */ description: string - /** The progress of the task in percent */ + /** The progress of the task in percent. */ progress: number - /** The task start date */ + /** The task start date. */ startedAt?: Date - /** The task end date */ + /** The task end date. */ terminatedAt?: Date - /** The task status */ + /** The task status. */ status: TaskStatus hrefFrom: string hrefResult: string - /** The zone in which is the task */ + /** The zone in which is the task. */ zone: Zone } @@ -792,33 +792,33 @@ export interface UpdateVolumeResponse { volume?: Volume } -/** Volume */ +/** Volume. */ export interface Volume { - /** The volume unique ID */ + /** The volume unique ID. */ id: string - /** The volume name */ + /** The volume name. */ name: string - /** @deprecated Show the volume NBD export URI */ + /** @deprecated Show the volume NBD export URI. */ exportUri?: string - /** The volume disk size */ + /** The volume disk size. */ size: number - /** The volume type */ + /** The volume type. */ volumeType: VolumeVolumeType - /** The volume creation date */ + /** The volume creation date. */ creationDate?: Date - /** The volume modification date */ + /** The volume modification date. */ modificationDate?: Date - /** The volume organization ID */ + /** The volume organization ID. */ organization: string - /** The volume project ID */ + /** The volume project ID. */ project: string - /** The volume tags */ + /** The volume tags. */ tags: string[] - /** The server attached to the volume */ + /** The server attached to the volume. */ server?: ServerSummary - /** The volume state */ + /** The volume state. */ state: VolumeState - /** The zone in which is the volume */ + /** The zone in which is the volume. */ zone: Zone } @@ -838,23 +838,23 @@ export interface VolumeServer { zone: Zone } -/** Volume server template */ +/** Volume server template. */ export interface VolumeServerTemplate { - /** UUID of the volume */ + /** UUID of the volume. */ id: string - /** Force the server to boot on this volume */ + /** Force the server to boot on this volume. */ boot: boolean - /** Name of the volume */ + /** Name of the volume. */ name: string - /** Disk size of the volume, must be a multiple of 512 */ + /** Disk size of the volume, must be a multiple of 512. */ size: number - /** Type of the volume */ + /** Type of the volume. */ volumeType: VolumeVolumeType - /** The ID of the snapshot on which this volume will be based */ + /** The ID of the snapshot on which this volume will be based. */ baseSnapshot: string - /** Organization ID of the volume */ + /** Organization ID of the volume. */ organization: string - /** Project ID of the volume */ + /** Project ID of the volume. */ project: string } @@ -865,15 +865,15 @@ export interface VolumeSummary { volumeType: VolumeVolumeType } -/** Volume template */ +/** Volume template. */ export interface VolumeTemplate { - /** UUID of the volume */ + /** UUID of the volume. */ id: string - /** Name of the volume */ + /** Name of the volume. */ name: string - /** Disk size of the volume, must be a multiple of 512 */ + /** Disk size of the volume, must be a multiple of 512. */ size: number - /** Type of the volume */ + /** Type of the volume. */ volumeType: VolumeVolumeType /** * @deprecated Organization ID of the volume. @@ -907,89 +907,89 @@ export interface VolumeTypeConstraints { } export type GetServerTypesAvailabilityRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone perPage?: number page?: number } export type ListServersTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone perPage?: number page?: number } export type ListVolumesTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone perPage?: number page?: number } export type ListServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ perPage?: number - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number - /** List only servers of this organization ID */ + /** List only servers of this organization ID. */ organization?: string - /** List only servers of this project ID */ + /** List only servers of this project ID. */ project?: string /** * Filter servers by name (for eg. "server1" will return "server100" and - * "server1" but not "foo") + * "server1" but not "foo"). */ name?: string - /** List servers by private_ip */ + /** List servers by private_ip. */ privateIp?: string - /** List servers that are not attached to a public IP */ + /** List servers that are not attached to a public IP. */ withoutIp?: boolean - /** List servers of this commercial type */ + /** List servers of this commercial type. */ commercialType?: string - /** List servers in this state */ + /** List servers in this state. */ state?: ServerState /** * List servers with these exact tags (to filter with several tags, use commas - * to separate them) + * to separate them). */ tags?: string[] - /** List servers in this Private Network */ + /** List servers in this Private Network. */ privateNetwork?: string - /** Define the order of the returned servers */ + /** Define the order of the returned servers. */ order?: ListServersRequestOrder } export type DeleteServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone serverId: string } export type GetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server you want to get */ + /** UUID of the server you want to get. */ serverId: string } export type ListServerActionsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone serverId: string } export type ServerActionRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server */ + /** UUID of the server. */ serverId: string - /** The action to perform on the server */ + /** The action to perform on the server. */ action?: ServerAction /** * The name of the backup you want to create. This field should only be @@ -1004,23 +1004,23 @@ export type ServerActionRequest = { } export type ListServerUserDataRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server */ + /** UUID of the server. */ serverId: string } export type DeleteServerUserDataRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server */ + /** UUID of the server. */ serverId: string - /** Key of the user data to delete */ + /** Key of the user data to delete. */ key: string } export type ListImagesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone organization?: string perPage?: number @@ -1033,24 +1033,24 @@ export type ListImagesRequest = { } export type GetImageRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the image you want to get */ + /** UUID of the image you want to get. */ imageId: string } export type CreateImageRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Name of the image */ + /** Name of the image. */ name?: string - /** UUID of the snapshot */ + /** UUID of the snapshot. */ rootVolume: string - /** Architecture of the image */ + /** Architecture of the image. */ arch: Arch - /** @deprecated Default bootscript of the image */ + /** @deprecated Default bootscript of the image. */ defaultBootscript?: string - /** Additional volumes of the image */ + /** Additional volumes of the image. */ extraVolumes?: Record /** * @deprecated Organization ID of the image. @@ -1066,21 +1066,21 @@ export type CreateImageRequest = { * could be set. */ project?: string - /** The tags of the image */ + /** The tags of the image. */ tags?: string[] - /** True to create a public image */ + /** True to create a public image. */ public?: boolean } export type DeleteImageRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the image you want to delete */ + /** UUID of the image you want to delete. */ imageId: string } export type ListSnapshotsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone organization?: string perPage?: number @@ -1091,13 +1091,13 @@ export type ListSnapshotsRequest = { } export type CreateSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Name of the snapshot */ + /** Name of the snapshot. */ name?: string - /** UUID of the volume */ + /** UUID of the volume. */ volumeId?: string - /** The tags of the snapshot */ + /** The tags of the snapshot. */ tags?: string[] /** * @deprecated Organization ID of the snapshot. @@ -1118,68 +1118,71 @@ export type CreateSnapshotRequest = { * the original volume will be used. */ volumeType?: SnapshotVolumeType - /** Bucket name for snapshot imports */ + /** Bucket name for snapshot imports. */ bucket?: string - /** Object key for snapshot imports */ + /** Object key for snapshot imports. */ key?: string - /** Imported snapshot size, must be a multiple of 512 */ + /** Imported snapshot size, must be a multiple of 512. */ size?: number } export type GetSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the snapshot you want to get */ + /** UUID of the snapshot you want to get. */ snapshotId: string } export type DeleteSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the snapshot you want to delete */ + /** UUID of the snapshot you want to delete. */ snapshotId: string } export type ExportSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The snapshot ID */ + /** The snapshot ID. */ snapshotId: string - /** S3 bucket name */ + /** S3 bucket name. */ bucket: string - /** S3 object key */ + /** S3 object key. */ key: string } export type ListVolumesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Filter by volume type */ + /** Filter by volume type. */ volumeType?: VolumeVolumeType /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ perPage?: number - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number - /** Filter volume by organization ID */ + /** Filter volume by organization ID. */ organization?: string - /** Filter volume by project ID */ + /** Filter volume by project ID. */ project?: string /** * Filter volumes with these exact tags (to filter with several tags, use - * commas to separate them) + * commas to separate them). */ tags?: string[] - /** Filter volume by name (for eg. "vol" will return "myvolume" but not "data") */ + /** + * Filter volume by name (for eg. "vol" will return "myvolume" but not + * "data"). + */ name?: string } export type CreateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The volume name */ + /** The volume name. */ name?: string /** * @deprecated The volume organization ID. @@ -1195,9 +1198,9 @@ export type CreateVolumeRequest = { * could be set. */ project?: string - /** The volume tags */ + /** The volume tags. */ tags?: string[] - /** The volume type */ + /** The volume type. */ volumeType?: VolumeVolumeType /** * The volume disk size, must be a multiple of 512. @@ -1223,63 +1226,63 @@ export type CreateVolumeRequest = { } export type GetVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the volume you want to get */ + /** UUID of the volume you want to get. */ volumeId: string } export type UpdateVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the volume */ + /** UUID of the volume. */ volumeId: string - /** The volume name */ + /** The volume name. */ name?: string - /** The tags of the volume */ + /** The tags of the volume. */ tags?: string[] - /** The volume disk size, must be a multiple of 512 */ + /** The volume disk size, must be a multiple of 512. */ size?: number } export type DeleteVolumeRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the volume you want to delete */ + /** UUID of the volume you want to delete. */ volumeId: string } export type ListSecurityGroupsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Name of the security group */ + /** Name of the security group. */ name?: string - /** The security group organization ID */ + /** The security group organization ID. */ organization?: string - /** The security group project ID */ + /** The security group project ID. */ project?: string /** * List security groups with these exact tags (to filter with several tags, - * use commas to separate them) + * use commas to separate them). */ tags?: string[] - /** Filter security groups with this value for project_default */ + /** Filter security groups with this value for project_default. */ projectDefault?: boolean /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ perPage?: number - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number } export type CreateSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Name of the security group */ + /** Name of the security group. */ name?: string - /** Description of the security group */ + /** Description of the security group. */ description: string /** * @deprecated Organization ID the security group belongs to. @@ -1295,7 +1298,7 @@ export type CreateSecurityGroupRequest = { * could be set. */ project?: string - /** The tags of the security group */ + /** The tags of the security group. */ tags?: string[] /** * @deprecated Whether this security group becomes the default security group @@ -1313,121 +1316,121 @@ export type CreateSecurityGroupRequest = { * 'projectDefault' could be set. */ projectDefault?: boolean - /** Whether the security group is stateful or not */ + /** Whether the security group is stateful or not. */ stateful: boolean - /** Default policy for inbound rules */ + /** Default policy for inbound rules. */ inboundDefaultPolicy?: SecurityGroupPolicy - /** Default policy for outbound rules */ + /** Default policy for outbound rules. */ outboundDefaultPolicy?: SecurityGroupPolicy - /** True to block SMTP on IPv4 and IPv6 */ + /** True to block SMTP on IPv4 and IPv6. */ enableDefaultSecurity?: boolean } export type GetSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the security group you want to get */ + /** UUID of the security group you want to get. */ securityGroupId: string } export type DeleteSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the security group you want to delete */ + /** UUID of the security group you want to delete. */ securityGroupId: string } export type ListDefaultSecurityGroupRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone } export type ListSecurityGroupRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the security group */ + /** UUID of the security group. */ securityGroupId: string /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ perPage?: number - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number } export type CreateSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the security group */ + /** UUID of the security group. */ securityGroupId: string protocol: SecurityGroupRuleProtocol direction: SecurityGroupRuleDirection action: SecurityGroupRuleAction ipRange: string - /** The beginning of the range of ports to apply this rule to (inclusive) */ + /** The beginning of the range of ports to apply this rule to (inclusive). */ destPortFrom?: number - /** The end of the range of ports to apply this rule to (inclusive) */ + /** The end of the range of ports to apply this rule to (inclusive). */ destPortTo?: number - /** The position of this rule in the security group rules list */ + /** The position of this rule in the security group rules list. */ position: number - /** Indicates if this rule is editable (will be ignored) */ + /** Indicates if this rule is editable (will be ignored). */ editable: boolean } export type SetSecurityGroupRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the security group to update the rules on */ + /** UUID of the security group to update the rules on. */ securityGroupId: string - /** List of rules to update in the security group */ + /** List of rules to update in the security group. */ rules?: SetSecurityGroupRulesRequestRule[] } export type DeleteSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone securityGroupId: string securityGroupRuleId: string } export type GetSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone securityGroupId: string securityGroupRuleId: string } export type ListPlacementGroupsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ perPage?: number - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number - /** List only placement groups of this organization ID */ + /** List only placement groups of this organization ID. */ organization?: string - /** List only placement groups of this project ID */ + /** List only placement groups of this project ID. */ project?: string /** * List placement groups with these exact tags (to filter with several tags, - * use commas to separate them) + * use commas to separate them). */ tags?: string[] /** * Filter placement groups by name (for eg. "cluster1" will return - * "cluster100" and "cluster1" but not "foo") + * "cluster100" and "cluster1" but not "foo"). */ name?: string } export type CreatePlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Name of the placement group */ + /** Name of the placement group. */ name?: string /** * @deprecated Organization ID of the placement group. @@ -1443,23 +1446,23 @@ export type CreatePlacementGroupRequest = { * could be set. */ project?: string - /** The tags of the placement group */ + /** The tags of the placement group. */ tags?: string[] - /** The operating mode of the placement group */ + /** The operating mode of the placement group. */ policyMode?: PlacementGroupPolicyMode - /** The policy type of the placement group */ + /** The policy type of the placement group. */ policyType?: PlacementGroupPolicyType } export type GetPlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the placement group you want to get */ + /** UUID of the placement group you want to get. */ placementGroupId: string } export type SetPlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone placementGroupId: string name: string @@ -1471,73 +1474,73 @@ export type SetPlacementGroupRequest = { } export type UpdatePlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the placement group */ + /** UUID of the placement group. */ placementGroupId: string - /** Name of the placement group */ + /** Name of the placement group. */ name?: string - /** The tags of the placement group */ + /** The tags of the placement group. */ tags?: string[] - /** The operating mode of the placement group */ + /** The operating mode of the placement group. */ policyMode?: PlacementGroupPolicyMode - /** The policy type of the placement group */ + /** The policy type of the placement group. */ policyType?: PlacementGroupPolicyType } export type DeletePlacementGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the placement group you want to delete */ + /** UUID of the placement group you want to delete. */ placementGroupId: string } export type GetPlacementGroupServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone placementGroupId: string } export type SetPlacementGroupServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone placementGroupId: string servers?: string[] } export type UpdatePlacementGroupServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the placement group */ + /** UUID of the placement group. */ placementGroupId: string servers: string[] } 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?: Zone - /** The project ID the IPs are reserved in */ + /** The project ID the IPs are reserved in. */ project?: string - /** The organization ID the IPs are reserved in */ + /** The organization ID the IPs are reserved in. */ organization?: string /** * Filter IPs with these exact tags (to filter with several tags, use commas - * to separate them) + * to separate them). */ tags?: string[] - /** Filter on the IP address (Works as a LIKE operation on the IP address) */ + /** Filter on the IP address (Works as a LIKE operation on the IP address). */ name?: string /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ perPage?: number - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: 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?: Zone /** * @deprecated The organization ID the IP is reserved in. @@ -1553,96 +1556,96 @@ export type CreateIpRequest = { * could be set. */ project?: string - /** The tags of the IP */ + /** The tags of the IP. */ tags?: string[] - /** UUID of the server you want to attach the IP to */ + /** UUID of the server you want to attach the IP to. */ server?: 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?: Zone - /** The IP ID or address to get */ + /** The IP ID or address to get. */ ip: string } export type UpdateIpRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** IP ID or IP address */ + /** IP ID or IP address. */ ip: string - /** Reverse domain name */ + /** Reverse domain name. */ reverse?: string | null - /** An array of keywords you want to tag this IP with */ + /** An array of keywords you want to tag this IP with. */ tags?: string[] server?: string | null } 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?: Zone - /** The ID or the address of the IP to delete */ + /** The ID or the address of the IP to delete. */ ip: string } export type ListPrivateNICsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The server the private NIC is attached to */ + /** The server the private NIC is attached to. */ serverId: string - /** The private NIC tags */ + /** The private NIC tags. */ tags?: string[] /** * A positive integer lower or equal to 100 to select the number of items to - * return + * return. */ perPage?: number - /** A positive integer to choose the page to return */ + /** A positive integer to choose the page to return. */ page?: number } export type CreatePrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server the private NIC will be attached to */ + /** UUID of the server the private NIC will be attached to. */ serverId: string - /** UUID of the private network where the private NIC will be attached */ + /** UUID of the private network where the private NIC will be attached. */ privateNetworkId: string - /** The private NIC tags */ + /** The private NIC tags. */ tags?: string[] } export type GetPrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The server the private NIC is attached to */ + /** The server the private NIC is attached to. */ serverId: string - /** The private NIC unique ID */ + /** The private NIC unique ID. */ privateNicId: string } export type UpdatePrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server the private NIC will be attached to */ + /** UUID of the server the private NIC will be attached to. */ serverId: string - /** The private NIC unique ID */ + /** The private NIC unique ID. */ privateNicId: string - /** Tags used to select private NIC/s */ + /** Tags used to select private NIC/s. */ tags?: string[] } export type DeletePrivateNICRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The server the private NIC is attached to */ + /** The server the private NIC is attached to. */ serverId: string - /** The private NIC unique ID */ + /** The private NIC unique ID. */ privateNicId: string } export type ListBootscriptsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone arch?: string title?: string @@ -1653,13 +1656,13 @@ export type ListBootscriptsRequest = { } export type GetBootscriptRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone bootscriptId: string } export type GetDashboardRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone organization?: string project?: string diff --git a/packages/clients/src/api/instance/v1/types.private.gen.ts b/packages/clients/src/api/instance/v1/types.private.gen.ts index ad5f4af00..81f89eb7a 100644 --- a/packages/clients/src/api/instance/v1/types.private.gen.ts +++ b/packages/clients/src/api/instance/v1/types.private.gen.ts @@ -33,53 +33,53 @@ import type { VolumeSummary, VolumeVolumeType, } from './types.gen' -/** Set image response */ +/** Set image response. */ export interface SetImageResponse { image?: Image } -/** Set security group response */ +/** Set security group response. */ export interface SetSecurityGroupResponse { securityGroup?: SecurityGroup } -/** Set security group rule response */ +/** Set security group rule response. */ export interface SetSecurityGroupRuleResponse { rule?: SecurityGroupRule } -/** Set server response */ +/** Set server response. */ export interface SetServerResponse { server?: Server } -/** Set snapshot response */ +/** Set snapshot response. */ export interface SetSnapshotResponse { snapshot?: Snapshot } export type CreateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The server name */ + /** The server name. */ name?: string - /** Define if a dynamic IP is required for the instance */ + /** Define if a dynamic IP is required for the instance. */ dynamicIpRequired?: boolean - /** Define the server commercial type (i.e. GP1-S) */ + /** Define the server commercial type (i.e. GP1-S). */ commercialType: string - /** The server image ID or label */ + /** The server image ID or label. */ image: string - /** The volumes attached to the server */ + /** The volumes attached to the server. */ volumes?: Record - /** True if IPv6 is enabled on the server */ + /** True if IPv6 is enabled on the server. */ enableIpv6: boolean - /** The ID of the reserved IP to attach to the server */ + /** The ID of the reserved IP to attach to the server. */ publicIp?: string - /** The boot type to use */ + /** The boot type to use. */ bootType?: BootType /** * @deprecated The bootscript ID to use when `boot_type` is set to - * `bootscript` + * `bootscript`. */ bootscript?: string /** @@ -96,84 +96,84 @@ export type CreateServerRequest = { * could be set. */ project?: string - /** The server tags */ + /** The server tags. */ tags?: string[] - /** The security group ID */ + /** The security group ID. */ securityGroup?: string - /** Placement group ID if server must be part of a placement group */ + /** Placement group ID if server must be part of a placement group. */ placementGroup?: string } export type SetServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The server unique ID */ + /** The server unique ID. */ id: string - /** The server name */ + /** The server name. */ name: string - /** The server organization ID */ + /** The server organization ID. */ organization?: string - /** The server project ID */ + /** The server project ID. */ project?: string - /** Provide as list of allowed actions on the server */ + /** Provide as list of allowed actions on the server. */ allowedActions?: ServerAction[] - /** The server associated tags */ + /** The server associated tags. */ tags?: string[] - /** The server commercial type (eg. GP1-M) */ + /** The server commercial type (eg. GP1-M). */ commercialType: string - /** The server creation date */ + /** The server creation date. */ creationDate?: Date - /** True if a dynamic IP is required */ + /** True if a dynamic IP is required. */ dynamicIpRequired: boolean - /** True if IPv6 is enabled */ + /** True if IPv6 is enabled. */ enableIpv6: boolean - /** The server host name */ + /** The server host name. */ hostname: string - /** Provide information on the server image */ + /** Provide information on the server image. */ image?: Image - /** The server protection option is activated */ + /** The server protection option is activated. */ protected: boolean - /** The server private IP address */ + /** The server private IP address. */ privateIp?: string - /** Information about the public IP */ + /** Information about the public IP. */ publicIp?: ServerIp - /** The server modification date */ + /** The server modification date. */ modificationDate?: Date - /** The server state */ + /** The server state. */ state?: ServerState - /** The server location */ + /** The server location. */ location?: ServerLocation - /** The server IPv6 address */ + /** The server IPv6 address. */ ipv6?: ServerIpv6 - /** @deprecated The server bootscript */ + /** @deprecated The server bootscript. */ bootscript?: Bootscript - /** The server boot type */ + /** The server boot type. */ bootType?: BootType - /** The server volumes */ + /** The server volumes. */ volumes?: Record - /** The server security group */ + /** The server security group. */ securityGroup?: SecurityGroupSummary - /** The server planned maintenances */ + /** The server planned maintenances. */ maintenances?: ServerMaintenance[] - /** The server state_detail */ + /** The server state_detail. */ stateDetail: string - /** The server arch */ + /** The server arch. */ arch?: Arch - /** The server placement group */ + /** The server placement group. */ placementGroup?: PlacementGroup - /** The server private NICs */ + /** The server private NICs. */ privateNics?: PrivateNIC[] } export type UpdateServerRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the server */ + /** UUID of the server. */ serverId: string - /** Name of the server */ + /** Name of the server. */ name?: string bootType?: BootType - /** Tags of the server */ + /** Tags of the server. */ tags?: string[] volumes?: Record /** @deprecated */ @@ -182,14 +182,14 @@ export type UpdateServerRequest = { enableIpv6?: boolean protected?: boolean securityGroup?: SecurityGroupTemplate - /** Placement group ID if server must be part of a placement group */ + /** Placement group ID if server must be part of a placement group. */ placementGroup?: string | null - /** The server private NICs */ + /** The server private NICs. */ privateNics?: PrivateNIC[] } export type SetImageRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone id: string name: string @@ -209,7 +209,7 @@ export type SetImageRequest = { } export type SetSnapshotRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone snapshotId: string id: string @@ -226,42 +226,42 @@ export type SetSnapshotRequest = { } export type SetSecurityGroupRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The ID of the security group (will be ignored) */ + /** The ID of the security group (will be ignored). */ id: string - /** The name of the security group */ + /** The name of the security group. */ name: string - /** The tags of the security group */ + /** The tags of the security group. */ tags?: string[] - /** The creation date of the security group (will be ignored) */ + /** The creation date of the security group (will be ignored). */ creationDate?: Date - /** The modification date of the security group (will be ignored) */ + /** The modification date of the security group (will be ignored). */ modificationDate?: Date - /** The description of the security group */ + /** The description of the security group. */ description: string - /** True to block SMTP on IPv4 and IPv6 */ + /** True to block SMTP on IPv4 and IPv6. */ enableDefaultSecurity: boolean - /** The default inbound policy */ + /** The default inbound policy. */ inboundDefaultPolicy?: SecurityGroupPolicy - /** The default outbound policy */ + /** The default outbound policy. */ outboundDefaultPolicy?: SecurityGroupPolicy - /** The security groups organization ID */ + /** The security groups organization ID. */ organization?: string - /** The security group project ID */ + /** The security group project ID. */ project?: string - /** @deprecated Please use project_default instead */ + /** @deprecated Please use project_default instead. */ organizationDefault?: boolean - /** True use this security group for future instances created in this project */ + /** True use this security group for future instances created in this project. */ projectDefault: boolean - /** The servers attached to this security group */ + /** The servers attached to this security group. */ servers?: ServerSummary[] - /** True to set the security group as stateful */ + /** True to set the security group as stateful. */ stateful: boolean } export type SetSecurityGroupRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone securityGroupId: string securityGroupRuleId: string diff --git a/packages/clients/src/api/iot/v1/types.gen.ts b/packages/clients/src/api/iot/v1/types.gen.ts index ec868aee4..007a96fa3 100644 --- a/packages/clients/src/api/iot/v1/types.gen.ts +++ b/packages/clients/src/api/iot/v1/types.gen.ts @@ -87,19 +87,19 @@ export interface Certificate { key: string } -/** Create device response */ +/** Create device response. */ export interface CreateDeviceResponse { - /** Created device information */ + /** Created device information. */ device?: Device - /** Device certificate */ + /** Device certificate. */ certificate?: Certificate } -/** Create network response */ +/** Create network response. */ export interface CreateNetworkResponse { - /** Created network */ + /** Created network. */ network?: Network - /** Endpoint Key to keep secret. This cannot be retrieved later */ + /** Endpoint Key to keep secret. This cannot be retrieved later. */ secret: string } @@ -126,51 +126,51 @@ export interface CreateRouteRequestS3Config { strategy: RouteS3ConfigS3Strategy } -/** Device */ +/** Device. */ export interface Device { - /** Device ID, also used as MQTT Client ID or Username */ + /** Device ID, also used as MQTT Client ID or Username. */ id: string - /** Device name */ + /** Device name. */ name: string - /** Device description */ + /** Device description. */ description: string - /** Device status */ + /** Device status. */ status: DeviceStatus - /** Hub ID */ + /** Hub ID. */ hubId: string - /** Device last connection/activity date */ + /** Device last connection/activity date. */ lastActivityAt?: Date - /** Whether the device is connected to the Hub or not */ + /** Whether the device is connected to the Hub or not. */ isConnected: boolean - /** Whether to allow device to connect without TLS mutual authentication */ + /** Whether to allow device to connect without TLS mutual authentication. */ allowInsecure: boolean /** * Whether to allow multiple physical devices to connect with this device's - * credentials + * credentials. */ allowMultipleConnections: boolean - /** Filter-sets to restrict the topics the device can publish/subscribe to */ + /** Filter-sets to restrict the topics the device can publish/subscribe to. */ messageFilters?: DeviceMessageFilters /** * Assigning a custom certificate allows a device to authenticate using that * specific certificate without checking the hub's CA certificate. */ hasCustomCertificate: boolean - /** Device add date */ + /** Device add date. */ createdAt?: Date - /** Device last modification date */ + /** Device last modification date. */ updatedAt?: Date } -/** Device. message filters */ +/** Device. message filters. */ export interface DeviceMessageFilters { - /** Filtering rule to restrict topics the device can publish to */ + /** Filtering rule to restrict topics the device can publish to. */ publish?: DeviceMessageFiltersRule - /** Filtering rule to restrict topics the device can subscribe to */ + /** Filtering rule to restrict topics the device can subscribe to. */ subscribe?: DeviceMessageFiltersRule } -/** Device. message filters. rule */ +/** Device. message filters. rule. */ export interface DeviceMessageFiltersRule { /** * If accept, the set will accept all topics in the topics list, but no other. @@ -180,22 +180,22 @@ export interface DeviceMessageFiltersRule { policy: DeviceMessageFiltersRulePolicy /** * List of topics to accept or reject. It must be valid MQTT topics and up to - * 65535 characters + * 65535 characters. */ topics?: string[] } -/** Get device certificate response */ +/** Get device certificate response. */ export interface GetDeviceCertificateResponse { - /** Created device information */ + /** Created device information. */ device?: Device - /** Device certificate */ + /** Device certificate. */ certificatePem: string } -/** Get device metrics response */ +/** Get device metrics response. */ export interface GetDeviceMetricsResponse { - /** Metrics for a device over the requested period */ + /** Metrics for a device over the requested period. */ metrics: TimeSeries[] } @@ -203,27 +203,27 @@ export interface GetHubCAResponse { caCertPem: string } -/** Get hub metrics response */ +/** Get hub metrics response. */ export interface GetHubMetricsResponse { - /** Metrics for a hub over the requested period */ + /** Metrics for a hub over the requested period. */ metrics: TimeSeries[] } -/** Hub */ +/** Hub. */ export interface Hub { - /** Hub ID */ + /** Hub ID. */ id: string - /** Hub name */ + /** Hub name. */ name: string - /** Current status of the Hub */ + /** Current status of the Hub. */ status: HubStatus - /** Hub feature set */ + /** Hub feature set. */ productPlan: HubProductPlan - /** Whether the hub has been enabled */ + /** Whether the hub has been enabled. */ enabled: boolean - /** Number of registered devices */ + /** Number of registered devices. */ deviceCount: number - /** Number of currently connected devices */ + /** Number of currently connected devices. */ connectedDeviceCount: number /** * Devices should be connected to this host, port may be 1883 (MQTT), 8883 @@ -231,19 +231,19 @@ export interface Hub { * TLS). */ endpoint: string - /** Disable Hub events */ + /** Disable Hub events. */ disableEvents: boolean - /** Hub events topic prefix */ + /** Hub events topic prefix. */ eventsTopicPrefix: string - /** Region of the Hub */ + /** Region of the Hub. */ region: Region - /** Hub creation date */ + /** Hub creation date. */ createdAt?: Date - /** Hub last modification date */ + /** Hub last modification date. */ updatedAt?: Date - /** Project owning the resource */ + /** Project owning the resource. */ projectId: string - /** Organization owning the resource */ + /** Organization owning the resource. */ organizationId: string /** * When an unknown device connects to your hub using a valid certificate @@ -272,92 +272,92 @@ export interface HubTwinsGraphiteConfig { pushUri: string } -/** List devices response */ +/** List devices response. */ export interface ListDevicesResponse { - /** Total number of devices */ + /** Total number of devices. */ totalCount: number - /** A page of devices */ + /** A page of devices. */ devices: Device[] } -/** List hubs response */ +/** List hubs response. */ export interface ListHubsResponse { - /** Total number of hubs */ + /** Total number of hubs. */ totalCount: number - /** A page of hubs */ + /** A page of hubs. */ hubs: Hub[] } -/** List networks response */ +/** List networks response. */ export interface ListNetworksResponse { - /** Total number of Networks */ + /** Total number of Networks. */ totalCount: number - /** A page of networks */ + /** A page of networks. */ networks: Network[] } -/** List routes response */ +/** List routes response. */ export interface ListRoutesResponse { - /** Total number of routes */ + /** Total number of routes. */ totalCount: number - /** A page of routes */ + /** A page of routes. */ routes: RouteSummary[] } -/** List twin documents response */ +/** List twin documents response. */ export interface ListTwinDocumentsResponse { - /** Twin's document list */ + /** Twin's document list. */ documents: ListTwinDocumentsResponseDocumentSummary[] } -/** List twin documents response. document summary */ +/** List twin documents response. document summary. */ export interface ListTwinDocumentsResponseDocumentSummary { - /** Document's name */ + /** Document's name. */ documentName: string } -/** Network */ +/** Network. */ export interface Network { - /** Network ID */ + /** Network ID. */ id: string - /** Network name */ + /** Network name. */ name: string - /** Type of network to connect with */ + /** Type of network to connect with. */ type: NetworkNetworkType - /** Endpoint to use for interacting with the network */ + /** Endpoint to use for interacting with the network. */ endpoint: string - /** Hub ID to connect the Network to */ + /** Hub ID to connect the Network to. */ hubId: string - /** Network creation date */ + /** Network creation date. */ createdAt?: Date /** This prefix will be prepended to all topics for this Network. */ topicPrefix: string } -/** Renew device certificate response */ +/** Renew device certificate response. */ export interface RenewDeviceCertificateResponse { - /** Created device information */ + /** Created device information. */ device?: Device - /** Device certificate */ + /** Device certificate. */ certificate?: Certificate } -/** Route */ +/** Route. */ export interface Route { - /** Route ID */ + /** Route ID. */ id: string - /** Route name */ + /** Route name. */ name: string - /** ID of the route's hub */ + /** ID of the route's hub. */ hubId: string /** * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters + * 65535 characters. */ topic: string - /** Route type */ + /** Route type. */ type: RouteRouteType - /** Route creation date */ + /** Route creation date. */ createdAt?: Date /** * When using S3 Route, S3-specific configuration fields. @@ -380,77 +380,77 @@ export interface Route { * could be set. */ restConfig?: RouteRestConfig - /** Route last update date */ + /** Route last update date. */ updatedAt?: Date } -/** Route. database config */ +/** Route. database config. */ export interface RouteDatabaseConfig { /** * Database engine the route will connect to. If not specified, will default - * to 'PostgreSQL' + * to 'PostgreSQL'. */ engine: RouteDatabaseConfigEngine - /** Database host */ + /** Database host. */ host: string - /** Database port */ + /** Database port. */ port: number - /** Database name */ + /** Database name. */ dbname: string - /** Database username. Make sure this account can execute the provided query */ + /** Database username. Make sure this account can execute the provided query. */ username: string - /** Database password */ + /** Database password. */ password: string /** * SQL query to be executed ($TOPIC and $PAYLOAD variables are available, see - * documentation) + * documentation). */ query: string } -/** Route. rest config */ +/** Route. rest config. */ export interface RouteRestConfig { - /** HTTP Verb used to call REST URI */ + /** HTTP Verb used to call REST URI. */ verb: RouteRestConfigHttpVerb - /** URI of the REST endpoint */ + /** URI of the REST endpoint. */ uri: string - /** HTTP call extra headers */ + /** HTTP call extra headers. */ headers: Record } -/** Route.s3 config */ +/** Route.s3 config. */ export interface RouteS3Config { - /** Region of the S3 route's destination bucket (eg 'fr-par') */ + /** Region of the S3 route's destination bucket (eg 'fr-par'). */ bucketRegion: string - /** Name of the S3 route's destination bucket */ + /** Name of the S3 route's destination bucket. */ bucketName: string - /** Optional string to prefix object names with */ + /** Optional string to prefix object names with. */ objectPrefix: string /** * How the S3 route's objects will be created: one per topic or one per - * message + * message. */ strategy: RouteS3ConfigS3Strategy } -/** Route summary */ +/** Route summary. */ export interface RouteSummary { - /** Route ID */ + /** Route ID. */ id: string - /** Route name */ + /** Route name. */ name: string - /** ID of the route's hub */ + /** ID of the route's hub. */ hubId: string /** * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters + * 65535 characters. */ topic: string - /** Route type */ + /** Route type. */ type: RouteRouteType - /** Route creation date */ + /** Route creation date. */ createdAt?: Date - /** Route last update date */ + /** Route last update date. */ updatedAt?: Date } @@ -459,15 +459,15 @@ export interface SetDeviceCertificateResponse { certificatePem: string } -/** Twin document */ +/** Twin document. */ export interface TwinDocument { - /** Document's parent twin ID */ + /** Document's parent twin ID. */ twinId: string - /** Document's name */ + /** Document's name. */ documentName: string - /** Document's new version */ + /** Document's new version. */ version: number - /** Document's new data */ + /** Document's new data. */ data?: Record } @@ -495,34 +495,40 @@ export interface UpdateRouteRequestS3Config { } export type ListHubsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Page number */ + /** Page number. */ page?: number - /** Page size. The maximum value is 100 */ + /** Page size. The maximum value is 100. */ pageSize?: number - /** Ordering of requested hub */ + /** Ordering of requested hub. */ orderBy?: ListHubsRequestOrderBy - /** Filter on project */ + /** Filter on project. */ projectId?: string - /** Filter on the organization */ + /** Filter on the organization. */ organizationId?: string - /** Filter on the name */ + /** Filter on the name. */ name?: string } export type CreateHubRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub name (up to 255 characters) */ + /** Hub name (up to 255 characters). */ name?: string - /** Organization/project owning the resource */ + /** Organization/project owning the resource. */ projectId?: string - /** Hub feature set */ + /** Hub feature set. */ productPlan: HubProductPlan - /** Disable Hub events */ + /** Disable Hub events. */ disableEvents?: boolean - /** Hub events topic prefix (default '$SCW/events') */ + /** Hub events topic prefix (default '$SCW/events'). */ eventsTopicPrefix?: string /** * BETA - not implemented yet. @@ -534,26 +540,32 @@ export type CreateHubRequest = { } export type GetHubRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub ID */ + /** Hub ID. */ hubId: string } export type UpdateHubRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub ID */ + /** Hub ID. */ hubId: string - /** Hub name (up to 255 characters) */ + /** Hub name (up to 255 characters). */ name?: string - /** Hub feature set */ + /** Hub feature set. */ productPlan?: HubProductPlan - /** Disable Hub events */ + /** Disable Hub events. */ disableEvents?: boolean - /** Hub events topic prefix */ + /** Hub events topic prefix. */ eventsTopicPrefix?: string - /** Enable device auto provisioning */ + /** Enable device auto provisioning. */ enableDeviceAutoProvisioning?: boolean /** * BETA - not implemented yet. @@ -565,43 +577,58 @@ export type UpdateHubRequest = { } export type EnableHubRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub ID */ + /** Hub ID. */ hubId: string } export type DisableHubRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub ID */ + /** Hub ID. */ hubId: string } export type DeleteHubRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub ID */ + /** Hub ID. */ hubId: string - /** Force deletion of devices added to this hub instead of rejecting operation */ + /** Force deletion of devices added to this hub instead of rejecting operation. */ deleteDevices?: boolean } export type GetHubMetricsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub ID */ + /** Hub ID. */ hubId: string - /** Start date used to compute the best scale for the returned metrics */ + /** Start date used to compute the best scale for the returned metrics. */ startDate: Date } export type SetHubCARequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Hub ID */ + /** Hub ID. */ hubId: string - /** The CA's PEM-encoded certificate */ + /** The CA's PEM-encoded certificate. */ caCertPem: string /** * The challenge is a PEM-encoded certificate to prove the possession of the @@ -612,158 +639,200 @@ export type SetHubCARequest = { } export type GetHubCARequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region hubId: string } export type ListDevicesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Page number */ + /** Page number. */ page?: number - /** Page size. The maximum value is 100 */ + /** Page size. The maximum value is 100. */ pageSize?: number - /** Ordering of requested devices */ + /** Ordering of requested devices. */ orderBy?: ListDevicesRequestOrderBy - /** Filter on the name */ + /** Filter on the name. */ name?: string - /** Filter on the hub */ + /** Filter on the hub. */ hubId?: string - /** Filter on the allow_insecure flag */ + /** Filter on the allow_insecure flag. */ allowInsecure?: boolean - /** Device status (enabled, disabled, etc.) */ + /** Device status (enabled, disabled, etc.). */ status?: DeviceStatus } export type CreateDeviceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device name */ + /** Device name. */ name?: string - /** ID of the device's hub */ + /** ID of the device's hub. */ hubId: string /** * Allow plain and server-authenticated SSL connections in addition to - * mutually-authenticated ones + * mutually-authenticated ones. */ allowInsecure: boolean - /** Allow multiple physical devices to connect with this device's credentials */ + /** Allow multiple physical devices to connect with this device's credentials. */ allowMultipleConnections: boolean /** * Filter-sets to authorize or deny the device to publish/subscribe to - * specific topics + * specific topics. */ messageFilters?: DeviceMessageFilters - /** Device description */ + /** Device description. */ description?: string } export type GetDeviceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string } export type UpdateDeviceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string - /** Device description */ + /** Device description. */ description?: string /** * Allow plain and server-authenticated SSL connections in addition to - * mutually-authenticated ones + * mutually-authenticated ones. */ allowInsecure?: boolean - /** Allow multiple physical devices to connect with this device's credentials */ + /** Allow multiple physical devices to connect with this device's credentials. */ allowMultipleConnections?: boolean - /** Filter-sets to restrict the topics the device can publish/subscribe to */ + /** Filter-sets to restrict the topics the device can publish/subscribe to. */ messageFilters?: DeviceMessageFilters - /** Change Hub for this device, additional fees may apply, see IoT Hub pricing */ + /** Change Hub for this device, additional fees may apply, see IoT Hub pricing. */ hubId?: string } export type EnableDeviceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string } export type DisableDeviceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string } export type RenewDeviceCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string } export type SetDeviceCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string - /** The PEM-encoded custom certificate */ + /** The PEM-encoded custom certificate. */ certificatePem: string } export type GetDeviceCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string } export type DeleteDeviceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string } export type GetDeviceMetricsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Device ID */ + /** Device ID. */ deviceId: string - /** Start date used to compute the best scale for the returned metrics */ + /** Start date used to compute the best scale for the returned metrics. */ startDate: Date } export type ListRoutesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Page number */ + /** Page number. */ page?: number - /** Page size. The maximum value is 100 */ + /** Page size. The maximum value is 100. */ pageSize?: number - /** Ordering of requested routes */ + /** Ordering of requested routes. */ orderBy?: ListRoutesRequestOrderBy - /** Filter on the hub */ + /** Filter on the hub. */ hubId?: string - /** Filter on route's name */ + /** Filter on route's name. */ name?: 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?: Region - /** Route name */ + /** Route name. */ name?: string - /** ID of the route's hub */ + /** ID of the route's hub. */ hubId: string /** * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters + * 65535 characters. */ topic: string /** @@ -790,15 +859,18 @@ export type CreateRouteRequest = { } 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?: Region - /** Route id */ + /** Route id. */ routeId: string - /** Route name */ + /** Route name. */ name?: string /** * Topic the route subscribes to. It must be a valid MQTT topic and up to - * 65535 characters + * 65535 characters. */ topic?: string /** @@ -825,78 +897,102 @@ export type UpdateRouteRequest = { } 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?: Region - /** Route ID */ + /** Route ID. */ routeId: 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?: Region - /** Route ID */ + /** Route ID. */ routeId: string } export type ListNetworksRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Page number */ + /** Page number. */ page?: number - /** Page size. The maximum value is 100 */ + /** Page size. The maximum value is 100. */ pageSize?: number - /** Ordering of requested routes */ + /** Ordering of requested routes. */ orderBy?: ListNetworksRequestOrderBy - /** Filter on Network name */ + /** Filter on Network name. */ name?: string - /** Filter on the hub */ + /** Filter on the hub. */ hubId?: string - /** Filter on the topic prefix */ + /** Filter on the topic prefix. */ topicPrefix?: string } export type CreateNetworkRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Network name */ + /** Network name. */ name?: string - /** Type of network to connect with */ + /** Type of network to connect with. */ type: NetworkNetworkType - /** Hub ID to connect the Network to */ + /** Hub ID to connect the Network to. */ hubId: string - /** Topic prefix for the Network */ + /** Topic prefix for the Network. */ topicPrefix: string } export type GetNetworkRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Network ID */ + /** Network ID. */ networkId: string } export type DeleteNetworkRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Network ID */ + /** Network ID. */ networkId: string } export type GetTwinDocumentRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Twin ID */ + /** Twin ID. */ twinId: string - /** Document name */ + /** Document name. */ documentName: string } export type PutTwinDocumentRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Twin ID */ + /** Twin ID. */ twinId: string - /** Document name */ + /** Document name. */ documentName: string /** * If set, ensures that the document's current version matches before @@ -908,11 +1004,14 @@ export type PutTwinDocumentRequest = { } export type PatchTwinDocumentRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Twin ID */ + /** Twin ID. */ twinId: string - /** Document name */ + /** Document name. */ documentName: string /** * If set, ensures that the document's current version matches before @@ -931,24 +1030,33 @@ export type PatchTwinDocumentRequest = { } export type DeleteTwinDocumentRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Twin ID */ + /** Twin ID. */ twinId: string - /** Document name */ + /** Document name. */ documentName: string } export type ListTwinDocumentsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Twin ID */ + /** Twin ID. */ twinId: string } export type DeleteTwinDocumentsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Twin ID */ + /** Twin ID. */ twinId: string } diff --git a/packages/clients/src/api/k8s/v1/types.gen.ts b/packages/clients/src/api/k8s/v1/types.gen.ts index 2984dff4e..21ff40f85 100644 --- a/packages/clients/src/api/k8s/v1/types.gen.ts +++ b/packages/clients/src/api/k8s/v1/types.gen.ts @@ -101,51 +101,51 @@ export type PoolVolumeType = 'default_volume_type' | 'l_ssd' | 'b_ssd' export type Runtime = 'unknown_runtime' | 'docker' | 'containerd' | 'crio' -/** Cluster */ +/** Cluster. */ export interface Cluster { - /** The ID of the cluster */ + /** The ID of the cluster. */ id: string - /** The type of the cluster */ + /** The type of the cluster. */ type: string - /** The name of the cluster */ + /** The name of the cluster. */ name: string - /** The status of the cluster */ + /** The status of the cluster. */ status: ClusterStatus - /** The Kubernetes version of the cluster */ + /** The Kubernetes version of the cluster. */ version: string - /** The region in which the cluster is */ + /** The region in which the cluster is. */ region: Region - /** The ID of the organization owning the cluster */ + /** The ID of the organization owning the cluster. */ organizationId: string - /** The ID of the project owning the cluster */ + /** The ID of the project owning the cluster. */ projectId: string - /** The tags associated with the cluster */ + /** The tags associated with the cluster. */ tags: string[] - /** The Container Network Interface (CNI) plugin running in the cluster */ + /** The Container Network Interface (CNI) plugin running in the cluster. */ cni: CNI - /** The description of the cluster */ + /** The description of the cluster. */ description: string - /** The Kubernetes API server URL of the cluster */ + /** The Kubernetes API server URL of the cluster. */ clusterUrl: string - /** The DNS wildcard resovling all the ready nodes of the cluster */ + /** The DNS wildcard resovling all the ready nodes of the cluster. */ dnsWildcard: string - /** The date at which the cluster was created */ + /** The date at which the cluster was created. */ createdAt?: Date - /** The date at which the cluster was last updated */ + /** The date at which the cluster was last updated. */ updatedAt?: Date - /** The autoscaler config for the cluster */ + /** The autoscaler config for the cluster. */ autoscalerConfig?: ClusterAutoscalerConfig - /** @deprecated The enablement of the Kubernetes Dashboard in the cluster */ + /** @deprecated The enablement of the Kubernetes Dashboard in the cluster. */ dashboardEnabled?: boolean - /** @deprecated The ingress controller used in the cluster */ + /** @deprecated The ingress controller used in the cluster. */ ingress?: Ingress - /** The auto upgrade configuration of the cluster */ + /** The auto upgrade configuration of the cluster. */ autoUpgrade?: ClusterAutoUpgrade - /** True if a new Kubernetes version is available */ + /** True if a new Kubernetes version is available. */ upgradeAvailable: boolean - /** List of enabled feature gates */ + /** List of enabled feature gates. */ featureGates: string[] - /** List of enabled admission plugins */ + /** List of enabled admission plugins. */ admissionPlugins: string[] /** * This feature is in ALPHA state, it may be deleted or modified. This @@ -156,35 +156,35 @@ export interface Cluster { openIdConnectConfig?: ClusterOpenIDConnectConfig /** * Additional Subject Alternative Names for the Kubernetes API server - * certificate + * certificate. */ apiserverCertSans: string[] } -/** Cluster. auto upgrade */ +/** Cluster. auto upgrade. */ export interface ClusterAutoUpgrade { - /** Whether or not auto upgrade is enabled for the cluster */ + /** Whether or not auto upgrade is enabled for the cluster. */ enabled: boolean - /** The maintenance window of the cluster auto upgrades */ + /** The maintenance window of the cluster auto upgrades. */ maintenanceWindow?: MaintenanceWindow } -/** Cluster. autoscaler config */ +/** Cluster. autoscaler config. */ export interface ClusterAutoscalerConfig { - /** Disable the cluster autoscaler */ + /** Disable the cluster autoscaler. */ scaleDownDisabled: boolean - /** How long after scale up that scale down evaluation resumes */ + /** How long after scale up that scale down evaluation resumes. */ scaleDownDelayAfterAdd: string - /** Type of resource estimator to be used in scale up */ + /** Type of resource estimator to be used in scale up. */ estimator: AutoscalerEstimator - /** Type of node group expander to be used in scale up */ + /** Type of node group expander to be used in scale up. */ expander: AutoscalerExpander /** * Ignore DaemonSet pods when calculating resource utilization for scaling - * down + * down. */ ignoreDaemonsetsUtilization: boolean - /** Detect similar node groups and balance the number of nodes between them */ + /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups: boolean /** * Pods with priority below cutoff will be expendable. They can be killed @@ -192,21 +192,21 @@ export interface ClusterAutoscalerConfig { * Pods with null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff: number - /** How long a node should be unneeded before it is eligible for scale down */ + /** How long a node should be unneeded before it is eligible for scale down. */ scaleDownUnneededTime: string /** * Node utilization level, defined as sum of requested resources divided by - * capacity, below which a node can be considered for scale down + * capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold: number /** * Maximum number of seconds the cluster autoscaler waits for pod termination - * when trying to scale down a node + * when trying to scale down a node. */ maxGracefulTerminationSec: number } -/** Cluster. open id connect config */ +/** Cluster. open id connect config. */ export interface ClusterOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing @@ -216,7 +216,7 @@ export interface ClusterOpenIDConnectConfig { * should point to the level below .well-known/openid-configuration. */ issuerUrl: string - /** A client id that all tokens must be issued for */ + /** A client id that all tokens must be issued for. */ clientId: string /** * JWT claim to use as the user name. By default `sub`, which is expected to @@ -235,7 +235,7 @@ export interface ClusterOpenIDConnectConfig { * value `-` can be used to disable all prefixing. */ usernamePrefix: string - /** JWT claim to use as the user's group */ + /** JWT claim to use as the user's group. */ groupsClaim: string[] /** * Prefix prepended to group claims to prevent clashes with existing names @@ -251,30 +251,30 @@ export interface ClusterOpenIDConnectConfig { requiredClaim: string[] } -/** Create cluster request. auto upgrade */ +/** Create cluster request. auto upgrade. */ export interface CreateClusterRequestAutoUpgrade { - /** Whether or not auto upgrade is enabled for the cluster */ + /** Whether or not auto upgrade is enabled for the cluster. */ enable: boolean - /** The maintenance window of the cluster auto upgrades */ + /** The maintenance window of the cluster auto upgrades. */ maintenanceWindow?: MaintenanceWindow } -/** Create cluster request. autoscaler config */ +/** Create cluster request. autoscaler config. */ export interface CreateClusterRequestAutoscalerConfig { - /** Disable the cluster autoscaler */ + /** Disable the cluster autoscaler. */ scaleDownDisabled?: boolean - /** How long after scale up that scale down evaluation resumes */ + /** How long after scale up that scale down evaluation resumes. */ scaleDownDelayAfterAdd?: string - /** Type of resource estimator to be used in scale up */ + /** Type of resource estimator to be used in scale up. */ estimator: AutoscalerEstimator - /** Type of node group expander to be used in scale up */ + /** Type of node group expander to be used in scale up. */ expander: AutoscalerExpander /** * Ignore DaemonSet pods when calculating resource utilization for scaling - * down + * down. */ ignoreDaemonsetsUtilization?: boolean - /** Detect similar node groups and balance the number of nodes between them */ + /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups?: boolean /** * Pods with priority below cutoff will be expendable. They can be killed @@ -282,21 +282,21 @@ export interface CreateClusterRequestAutoscalerConfig { * Pods with null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff?: number - /** How long a node should be unneeded before it is eligible for scale down */ + /** How long a node should be unneeded before it is eligible for scale down. */ scaleDownUnneededTime?: string /** * Node utilization level, defined as sum of requested resources divided by - * capacity, below which a node can be considered for scale down + * capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold?: number /** * Maximum number of seconds the cluster autoscaler waits for pod termination - * when trying to scale down a node + * when trying to scale down a node. */ maxGracefulTerminationSec?: number } -/** Create cluster request. open id connect config */ +/** Create cluster request. open id connect config. */ export interface CreateClusterRequestOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing @@ -306,7 +306,7 @@ export interface CreateClusterRequestOpenIDConnectConfig { * should point to the level below .well-known/openid-configuration. */ issuerUrl: string - /** A client id that all tokens must be issued for */ + /** A client id that all tokens must be issued for. */ clientId: string /** * JWT claim to use as the user name. By default `sub`, which is expected to @@ -325,7 +325,7 @@ export interface CreateClusterRequestOpenIDConnectConfig { * value `-` can be used to disable all prefixing. */ usernamePrefix?: string - /** JWT claim to use as the user's group */ + /** JWT claim to use as the user's group. */ groupsClaim?: string[] /** * Prefix prepended to group claims to prevent clashes with existing names @@ -341,9 +341,9 @@ export interface CreateClusterRequestOpenIDConnectConfig { requiredClaim?: string[] } -/** Create cluster request. pool config */ +/** Create cluster request. pool config. */ export interface CreateClusterRequestPoolConfig { - /** The name of the pool */ + /** The name of the pool. */ name: string /** * The node type is the type of Scaleway Instance wanted for the pool. Nodes @@ -352,11 +352,11 @@ export interface CreateClusterRequestPoolConfig { * cloud providers. */ nodeType: string - /** The placement group ID in which all the nodes of the pool will be created */ + /** The placement group ID in which all the nodes of the pool will be created. */ placementGroupId?: string - /** The enablement of the autoscaling feature for the pool */ + /** The enablement of the autoscaling feature for the pool. */ autoscaling: boolean - /** The size (number of nodes) of the pool */ + /** The size (number of nodes) of the pool. */ size: number /** * The minimum size of the pool. Note that this field will be used only when @@ -373,18 +373,18 @@ export interface CreateClusterRequestPoolConfig { * that `docker` is deprecated since 1.20 and will be removed in 1.24. */ containerRuntime: Runtime - /** The enablement of the autohealing feature for the pool */ + /** The enablement of the autohealing feature for the pool. */ autohealing: boolean - /** The tags associated with the pool */ + /** The tags associated with the pool. */ tags: string[] /** * The Kubelet arguments to be used by this pool. Note that this feature is to - * be considered as experimental + * be considered as experimental. */ kubeletArgs: Record - /** The Pool upgrade policy */ + /** The Pool upgrade policy. */ upgradePolicy?: CreateClusterRequestPoolConfigUpgradePolicy - /** The Zone in which the Pool's node will be spawn in */ + /** The Zone in which the Pool's node will be spawn in. */ zone: Zone /** * The system volume disk type, we provide two different types of volume @@ -396,15 +396,15 @@ export interface CreateClusterRequestPoolConfig { * and resilient cluster. */ rootVolumeType: PoolVolumeType - /** The system volume disk size */ + /** The system volume disk size. */ rootVolumeSize?: number } -/** Create cluster request. pool config. upgrade policy */ +/** Create cluster request. pool config. upgrade policy. */ export interface CreateClusterRequestPoolConfigUpgradePolicy { - /** The maximum number of nodes that can be not ready at the same time */ + /** The maximum number of nodes that can be not ready at the same time. */ maxUnavailable?: number - /** The maximum number of nodes to be created during the upgrade */ + /** The maximum number of nodes to be created during the upgrade. */ maxSurge?: number } @@ -423,101 +423,101 @@ export interface ExternalNode { kubeletConfig: string } -/** List cluster available versions response */ +/** List cluster available versions response. */ export interface ListClusterAvailableVersionsResponse { - /** The available Kubernetes version for the cluster */ + /** The available Kubernetes version for the cluster. */ versions: Version[] } -/** List clusters response */ +/** List clusters response. */ export interface ListClustersResponse { - /** The total number of clusters */ + /** The total number of clusters. */ totalCount: number - /** The paginated returned clusters */ + /** The paginated returned clusters. */ clusters: Cluster[] } -/** List nodes response */ +/** List nodes response. */ export interface ListNodesResponse { - /** The total number of nodes */ + /** The total number of nodes. */ totalCount: number - /** The paginated returned nodes */ + /** The paginated returned nodes. */ nodes: Node[] } -/** List pools response */ +/** List pools response. */ export interface ListPoolsResponse { - /** The total number of pools that exists for the cluster */ + /** The total number of pools that exists for the cluster. */ totalCount: number - /** The paginated returned pools */ + /** The paginated returned pools. */ pools: Pool[] } -/** List versions response */ +/** List versions response. */ export interface ListVersionsResponse { - /** The available Kubernetes versions */ + /** The available Kubernetes versions. */ versions: Version[] } -/** Maintenance window */ +/** Maintenance window. */ export interface MaintenanceWindow { - /** The start hour of the 2-hour maintenance window */ + /** The start hour of the 2-hour maintenance window. */ startHour: number - /** The day of the week for the maintenance window */ + /** The day of the week for the maintenance window. */ day: MaintenanceWindowDayOfTheWeek } -/** Node */ +/** Node. */ export interface Node { - /** The ID of the node */ + /** The ID of the node. */ id: string - /** The pool ID of the node */ + /** The pool ID of the node. */ poolId: string - /** The cluster ID of the node */ + /** The cluster ID of the node. */ clusterId: string /** * It is prefixed by instance type and location information (see * https://pkg.go.dev/k8s.io/api/core/v1#NodeSpec.ProviderID). */ providerId: string - /** The cluster region of the node */ + /** The cluster region of the node. */ region: Region - /** The name of the node */ + /** The name of the node. */ name: string - /** @deprecated The public IPv4 address of the node */ + /** @deprecated The public IPv4 address of the node. */ publicIpV4?: string - /** @deprecated The public IPv6 address of the node */ + /** @deprecated The public IPv6 address of the node. */ publicIpV6?: string /** * @deprecated These conditions contains the Node Problem Detector conditions, * as well as some in house conditions. */ conditions?: Record - /** The status of the node */ + /** The status of the node. */ status: NodeStatus - /** Details of the error, if any occured when managing the node */ + /** Details of the error, if any occured when managing the node. */ errorMessage?: string - /** The date at which the node was created */ + /** The date at which the node was created. */ createdAt?: Date - /** The date at which the node was last updated */ + /** The date at which the node was last updated. */ updatedAt?: Date } -/** Pool */ +/** Pool. */ export interface Pool { - /** The ID of the pool */ + /** The ID of the pool. */ id: string - /** The cluster ID of the pool */ + /** The cluster ID of the pool. */ clusterId: string - /** The date at which the pool was created */ + /** The date at which the pool was created. */ createdAt?: Date - /** The date at which the pool was last updated */ + /** The date at which the pool was last updated. */ updatedAt?: Date - /** The name of the pool */ + /** The name of the pool. */ name: string - /** The status of the pool */ + /** The status of the pool. */ status: PoolStatus - /** The version of the pool */ + /** The version of the pool. */ version: string /** * The node type is the type of Scaleway Instance wanted for the pool. Nodes @@ -526,9 +526,9 @@ export interface Pool { * cloud providers. */ nodeType: string - /** The enablement of the autoscaling feature for the pool */ + /** The enablement of the autoscaling feature for the pool. */ autoscaling: boolean - /** The size (number of nodes) of the pool */ + /** The size (number of nodes) of the pool. */ size: number /** * The minimum size of the pool. Note that this field will be used only when @@ -545,20 +545,20 @@ export interface Pool { * that `docker` is deprecated since 1.20 and will be removed in 1.24. */ containerRuntime: Runtime - /** The enablement of the autohealing feature for the pool */ + /** The enablement of the autohealing feature for the pool. */ autohealing: boolean - /** The tags associated with the pool */ + /** The tags associated with the pool. */ tags: string[] - /** The placement group ID in which all the nodes of the pool will be created */ + /** The placement group ID in which all the nodes of the pool will be created. */ placementGroupId?: string /** * The Kubelet arguments to be used by this pool. Note that this feature is to - * be considered as experimental + * be considered as experimental. */ kubeletArgs: Record - /** The Pool upgrade policy */ + /** The Pool upgrade policy. */ upgradePolicy?: PoolUpgradePolicy - /** The Zone in which the Pool's node will be spawn in */ + /** The Zone in which the Pool's node will be spawn in. */ zone: Zone /** * The system volume disk type, we provide two different types of volume @@ -570,9 +570,9 @@ export interface Pool { * and resilient cluster. */ rootVolumeType: PoolVolumeType - /** The system volume disk size */ + /** The system volume disk size. */ rootVolumeSize?: number - /** The cluster region of the pool */ + /** The cluster region of the pool. */ region: Region } @@ -581,30 +581,30 @@ export interface PoolUpgradePolicy { maxSurge: number } -/** Update cluster request. auto upgrade */ +/** Update cluster request. auto upgrade. */ export interface UpdateClusterRequestAutoUpgrade { - /** Whether or not auto upgrade is enabled for the cluster */ + /** Whether or not auto upgrade is enabled for the cluster. */ enable?: boolean - /** The maintenance window of the cluster auto upgrades */ + /** The maintenance window of the cluster auto upgrades. */ maintenanceWindow?: MaintenanceWindow } -/** Update cluster request. autoscaler config */ +/** Update cluster request. autoscaler config. */ export interface UpdateClusterRequestAutoscalerConfig { - /** Disable the cluster autoscaler */ + /** Disable the cluster autoscaler. */ scaleDownDisabled?: boolean - /** How long after scale up that scale down evaluation resumes */ + /** How long after scale up that scale down evaluation resumes. */ scaleDownDelayAfterAdd?: string - /** Type of resource estimator to be used in scale up */ + /** Type of resource estimator to be used in scale up. */ estimator: AutoscalerEstimator - /** Type of node group expander to be used in scale up */ + /** Type of node group expander to be used in scale up. */ expander: AutoscalerExpander /** * Ignore DaemonSet pods when calculating resource utilization for scaling - * down + * down. */ ignoreDaemonsetsUtilization?: boolean - /** Detect similar node groups and balance the number of nodes between them */ + /** Detect similar node groups and balance the number of nodes between them. */ balanceSimilarNodeGroups?: boolean /** * Pods with priority below cutoff will be expendable. They can be killed @@ -612,21 +612,21 @@ export interface UpdateClusterRequestAutoscalerConfig { * Pods with null priority (PodPriority disabled) are non expendable. */ expendablePodsPriorityCutoff?: number - /** How long a node should be unneeded before it is eligible for scale down */ + /** How long a node should be unneeded before it is eligible for scale down. */ scaleDownUnneededTime?: string /** * Node utilization level, defined as sum of requested resources divided by - * capacity, below which a node can be considered for scale down + * capacity, below which a node can be considered for scale down. */ scaleDownUtilizationThreshold?: number /** * Maximum number of seconds the cluster autoscaler waits for pod termination - * when trying to scale down a node + * when trying to scale down a node. */ maxGracefulTerminationSec?: number } -/** Update cluster request. open id connect config */ +/** Update cluster request. open id connect config. */ export interface UpdateClusterRequestOpenIDConnectConfig { /** * URL of the provider which allows the API server to discover public signing @@ -636,7 +636,7 @@ export interface UpdateClusterRequestOpenIDConnectConfig { * should point to the level below .well-known/openid-configuration. */ issuerUrl?: string - /** A client id that all tokens must be issued for */ + /** A client id that all tokens must be issued for. */ clientId?: string /** * JWT claim to use as the user name. By default `sub`, which is expected to @@ -655,7 +655,7 @@ export interface UpdateClusterRequestOpenIDConnectConfig { * value `-` can be used to disable all prefixing. */ usernamePrefix?: string - /** JWT claim to use as the user's group */ + /** JWT claim to use as the user's group. */ groupsClaim?: string[] /** * Prefix prepended to group claims to prevent clashes with existing names @@ -676,51 +676,57 @@ export interface UpdatePoolRequestUpgradePolicy { maxSurge?: number } -/** Version */ +/** Version. */ export interface Version { - /** The name of the Kubernetes version */ + /** The name of the Kubernetes version. */ name: string - /** The label of the Kubernetes version */ + /** The label of the Kubernetes version. */ label: string - /** The region in which this version is available */ + /** The region in which this version is available. */ region: Region - /** The supported Container Network Interface (CNI) plugins for this version */ + /** The supported Container Network Interface (CNI) plugins for this version. */ availableCnis: CNI[] - /** @deprecated The supported Ingress Controllers for this version */ + /** @deprecated The supported Ingress Controllers for this version. */ availableIngresses?: Ingress[] - /** The supported container runtimes for this version */ + /** The supported container runtimes for this version. */ availableContainerRuntimes: Runtime[] - /** The supported feature gates for this version */ + /** The supported feature gates for this version. */ availableFeatureGates: string[] - /** The supported admission plugins for this version */ + /** The supported admission plugins for this version. */ availableAdmissionPlugins: string[] - /** The supported kubelet arguments for this version */ + /** The supported kubelet arguments for this version. */ availableKubeletArgs: Record } export type ListClustersRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The organization ID on which to filter the returned clusters */ + /** The organization ID on which to filter the returned clusters. */ organizationId?: string - /** The project ID on which to filter the returned clusters */ + /** The project ID on which to filter the returned clusters. */ projectId?: string - /** The sort order of the returned clusters */ + /** The sort order of the returned clusters. */ orderBy?: ListClustersRequestOrderBy - /** The page number for the returned clusters */ + /** The page number for the returned clusters. */ page?: number - /** The maximum number of clusters per page */ + /** The maximum number of clusters per page. */ pageSize?: number - /** The name on which to filter the returned clusters */ + /** The name on which to filter the returned clusters. */ name?: string - /** The status on which to filter the returned clusters */ + /** The status on which to filter the returned clusters. */ status?: ClusterStatus - /** The type on which to filter the returned clusters */ + /** The type on which to filter the returned clusters. */ type?: string } export type CreateClusterRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** * @deprecated The organization ID where the cluster will be created. @@ -738,21 +744,21 @@ export type CreateClusterRequest = { projectId?: string /** The type of the cluster (possible values are kapsule, multicloud). */ type: string - /** The name of the cluster */ + /** The name of the cluster. */ name?: string - /** The description of the cluster */ + /** The description of the cluster. */ description: string - /** The tags associated with the cluster */ + /** The tags associated with the cluster. */ tags?: string[] - /** The Kubernetes version of the cluster */ + /** The Kubernetes version of the cluster. */ version: string - /** The Container Network Interface (CNI) plugin that will run in the cluster */ + /** The Container Network Interface (CNI) plugin that will run in the cluster. */ cni: CNI - /** @deprecated The enablement of the Kubernetes Dashboard in the cluster */ + /** @deprecated The enablement of the Kubernetes Dashboard in the cluster. */ enableDashboard?: boolean - /** @deprecated The Ingress Controller that will run in the cluster */ + /** @deprecated The Ingress Controller that will run in the cluster. */ ingress?: Ingress - /** The pools to be created along with the cluster */ + /** The pools to be created along with the cluster. */ pools?: CreateClusterRequestPoolConfig[] /** * This field allows to specify some configuration for the autoscaler, which @@ -766,9 +772,9 @@ export type CreateClusterRequest = { * current minor one. */ autoUpgrade?: CreateClusterRequestAutoUpgrade - /** List of feature gates to enable */ + /** List of feature gates to enable. */ featureGates?: string[] - /** List of admission plugins to enable */ + /** List of admission plugins to enable. */ admissionPlugins?: string[] /** * This feature is in ALPHA state, it may be deleted or modified. This @@ -779,31 +785,37 @@ export type CreateClusterRequest = { openIdConnectConfig?: CreateClusterRequestOpenIDConnectConfig /** * Additional Subject Alternative Names for the Kubernetes API server - * certificate + * certificate. */ apiserverCertSans?: string[] } export type GetClusterRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the requested cluster */ + /** The ID of the requested cluster. */ clusterId: string } export type UpdateClusterRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the cluster to update */ + /** The ID of the cluster to update. */ clusterId: string /** * This field allows to update the external name of the cluster. The internal * name (used for instance in hostname) won't change. */ name?: string - /** The new description of the cluster */ + /** The new description of the cluster. */ description?: string - /** The new tags associated with the cluster */ + /** The new tags associated with the cluster. */ tags?: string[] /** * This field allows to update some configuration for the autoscaler, which is @@ -811,18 +823,18 @@ export type UpdateClusterRequest = { * [cluster-autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/). */ autoscalerConfig?: UpdateClusterRequestAutoscalerConfig - /** @deprecated The new value of the Kubernetes Dashboard enablement */ + /** @deprecated The new value of the Kubernetes Dashboard enablement. */ enableDashboard?: boolean - /** @deprecated The new Ingress Controller for the cluster */ + /** @deprecated The new Ingress Controller for the cluster. */ ingress?: Ingress /** * The new auto upgrade configuration of the cluster. Note that all fields * need to be set. */ autoUpgrade?: UpdateClusterRequestAutoUpgrade - /** List of feature gates to enable */ + /** List of feature gates to enable. */ featureGates?: string[] - /** List of admission plugins to enable */ + /** List of admission plugins to enable. */ admissionPlugins?: string[] /** * This feature is in ALPHA state, it may be deleted or modified. This @@ -833,27 +845,33 @@ export type UpdateClusterRequest = { openIdConnectConfig?: UpdateClusterRequestOpenIDConnectConfig /** * Additional Subject Alternative Names for the Kubernetes API server - * certificate + * certificate. */ apiserverCertSans?: string[] } export type DeleteClusterRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the cluster to delete */ + /** The ID of the cluster to delete. */ clusterId: string /** * Set true if you want to delete all volumes (including retain volume type) - * and loadbalancers whose name start with cluster ID + * and loadbalancers whose name start with cluster ID. */ withAdditionalResources: boolean } export type UpgradeClusterRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the cluster to upgrade */ + /** The ID of the cluster to upgrade. */ clusterId: string /** * The new Kubernetes version of the cluster. Note that the version shoud @@ -869,45 +887,57 @@ export type UpgradeClusterRequest = { } export type ListClusterAvailableVersionsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** * The ID of the cluster which the available Kuberentes versions will be - * listed from + * listed from. */ clusterId: string } export type ResetClusterAdminTokenRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the cluster of which the admin token will be renewed */ + /** The ID of the cluster of which the admin token will be renewed. */ clusterId: string } export type ListPoolsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the cluster from which the pools will be listed from */ + /** The ID of the cluster from which the pools will be listed from. */ clusterId: string - /** The sort order of the returned pools */ + /** The sort order of the returned pools. */ orderBy?: ListPoolsRequestOrderBy - /** The page number for the returned pools */ + /** The page number for the returned pools. */ page?: number - /** The maximum number of pools per page */ + /** The maximum number of pools per page. */ pageSize?: number - /** The name on which to filter the returned pools */ + /** The name on which to filter the returned pools. */ name?: string - /** The status on which to filter the returned pools */ + /** The status on which to filter the returned pools. */ status?: PoolStatus } export type CreatePoolRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the cluster in which the pool will be created */ + /** The ID of the cluster in which the pool will be created. */ clusterId: string - /** The name of the pool */ + /** The name of the pool. */ name?: string /** * The node type is the type of Scaleway Instance wanted for the pool. Nodes @@ -916,11 +946,11 @@ export type CreatePoolRequest = { * cloud providers. */ nodeType: string - /** The placement group ID in which all the nodes of the pool will be created */ + /** The placement group ID in which all the nodes of the pool will be created. */ placementGroupId?: string - /** The enablement of the autoscaling feature for the pool */ + /** The enablement of the autoscaling feature for the pool. */ autoscaling: boolean - /** The size (number of nodes) of the pool */ + /** The size (number of nodes) of the pool. */ size: number /** * The minimum size of the pool. Note that this field will be used only when @@ -937,18 +967,18 @@ export type CreatePoolRequest = { * that `docker` is deprecated since 1.20 and will be removed in 1.24. */ containerRuntime?: Runtime - /** The enablement of the autohealing feature for the pool */ + /** The enablement of the autohealing feature for the pool. */ autohealing: boolean - /** The tags associated with the pool */ + /** The tags associated with the pool. */ tags?: string[] /** * The Kubelet arguments to be used by this pool. Note that this feature is to - * be considered as experimental + * be considered as experimental. */ kubeletArgs?: Record - /** The Pool upgrade policy */ + /** The Pool upgrade policy. */ upgradePolicy?: CreatePoolRequestUpgradePolicy - /** The Zone in which the Pool's node will be spawn in */ + /** The Zone in which the Pool's node will be spawn in. */ zone?: Zone /** * The system volume disk type, we provide two different types of volume @@ -960,124 +990,160 @@ export type CreatePoolRequest = { * and resilient cluster. */ rootVolumeType?: PoolVolumeType - /** The system volume disk size */ + /** The system volume disk size. */ rootVolumeSize?: number } export type GetPoolRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the requested pool */ + /** The ID of the requested pool. */ poolId: string } export type UpgradePoolRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the pool to upgrade */ + /** The ID of the pool to upgrade. */ poolId: string - /** The new Kubernetes version for the pool */ + /** The new Kubernetes version for the pool. */ version: string } export type UpdatePoolRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the pool to update */ + /** The ID of the pool to update. */ poolId: string - /** The new value for the enablement of autoscaling for the pool */ + /** The new value for the enablement of autoscaling for the pool. */ autoscaling?: boolean - /** The new size for the pool */ + /** The new size for the pool. */ size?: number - /** The new minimun size for the pool */ + /** The new minimun size for the pool. */ minSize?: number - /** The new maximum size for the pool */ + /** The new maximum size for the pool. */ maxSize?: number - /** The new value for the enablement of autohealing for the pool */ + /** The new value for the enablement of autohealing for the pool. */ autohealing?: boolean - /** The new tags associated with the pool */ + /** The new tags associated with the pool. */ tags?: string[] /** * The new Kubelet arguments to be used by this pool. Note that this feature - * is to be considered as experimental + * is to be considered as experimental. */ kubeletArgs?: Record - /** The Pool upgrade policy */ + /** The Pool upgrade policy. */ upgradePolicy?: UpdatePoolRequestUpgradePolicy } export type DeletePoolRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the pool to delete */ + /** The ID of the pool to delete. */ poolId: string } export type CreateExternalNodeRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region poolId: string } export type ListNodesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The cluster ID from which the nodes will be listed from */ + /** The cluster ID from which the nodes will be listed from. */ clusterId: string - /** The pool ID on which to filter the returned nodes */ + /** The pool ID on which to filter the returned nodes. */ poolId?: string - /** The sort order of the returned nodes */ + /** The sort order of the returned nodes. */ orderBy?: ListNodesRequestOrderBy - /** The page number for the returned nodes */ + /** The page number for the returned nodes. */ page?: number - /** The maximum number of nodes per page */ + /** The maximum number of nodes per page. */ pageSize?: number - /** The name on which to filter the returned nodes */ + /** The name on which to filter the returned nodes. */ name?: string - /** The status on which to filter the returned nodes */ + /** The status on which to filter the returned nodes. */ status?: NodeStatus } export type GetNodeRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the requested node */ + /** The ID of the requested node. */ nodeId: string } export type ReplaceNodeRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the node to replace */ + /** The ID of the node to replace. */ nodeId: string } export type RebootNodeRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the node to reboot */ + /** The ID of the node to reboot. */ nodeId: string } export type DeleteNodeRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the node to replace */ + /** The ID of the node to replace. */ nodeId: string - /** Skip draining node from its workload */ + /** Skip draining node from its workload. */ skipDrain: boolean - /** Add a new node after the deletion of this node */ + /** Add a new node after the deletion of this node. */ replace: boolean } export type ListVersionsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region } export type GetVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The requested version name */ + /** The requested version name. */ versionName: string } diff --git a/packages/clients/src/api/k8s/v1/types.private.gen.ts b/packages/clients/src/api/k8s/v1/types.private.gen.ts index 71195f7db..bb202c29c 100644 --- a/packages/clients/src/api/k8s/v1/types.private.gen.ts +++ b/packages/clients/src/api/k8s/v1/types.private.gen.ts @@ -3,8 +3,11 @@ import type { Region } from '../../../bridge' export type GetClusterKubeConfigRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The ID of the cluster to download the kubeconfig from */ + /** The ID of the cluster to download the kubeconfig from. */ clusterId: string } diff --git a/packages/clients/src/api/lb/v1/types.gen.ts b/packages/clients/src/api/lb/v1/types.gen.ts index cf9767d75..0c211fb02 100644 --- a/packages/clients/src/api/lb/v1/types.gen.ts +++ b/packages/clients/src/api/lb/v1/types.gen.ts @@ -136,43 +136,43 @@ export type StickySessionsType = 'none' | 'cookie' | 'table' /** * The use of Access Control Lists (ACL) provide a flexible solution to perform * a action generally consist in blocking or allow a request based on ip (and - * URL on HTTP) + * URL on HTTP). */ export interface Acl { - /** ID of your ACL ressource */ + /** ID of your ACL ressource. */ id: string - /** Name of you ACL ressource */ + /** Name of you ACL ressource. */ name: string /** * The ACL match rule. At least `ip_subnet` or `http_filter` and - * `http_filter_value` are required + * `http_filter_value` are required. */ match?: AclMatch - /** Action to undertake when an ACL filter matches */ + /** Action to undertake when an ACL filter matches. */ action?: AclAction - /** See the Frontend object description */ + /** See the Frontend object description. */ frontend?: Frontend - /** Order between your Acls (ascending order, 0 is first acl executed) */ + /** Order between your Acls (ascending order, 0 is first acl executed). */ index: number - /** Date at which the ACL was created */ + /** Date at which the ACL was created. */ createdAt?: Date - /** Date at which the ACL was last updated */ + /** Date at which the ACL was last updated. */ updatedAt?: Date - /** Description of your ACL ressource */ + /** Description of your ACL ressource. */ description: string } -/** Acl action */ +/** Acl action. */ export interface AclAction { - /** The action type */ + /** The action type. */ type: AclActionType - /** Redirect parameters when using an ACL with `redirect` action */ + /** Redirect parameters when using an ACL with `redirect` action. */ redirect?: AclActionRedirect } -/** Acl action redirect */ +/** Acl action redirect. */ export interface AclActionRedirect { - /** Redirect type */ + /** Redirect type. */ type: AclActionRedirectRedirectType /** * An URL can be used in case of a location redirect (e.g. @@ -185,19 +185,22 @@ export interface AclActionRedirect { * - `{{ host }}` for the current request's Host header * - `{{ query }}` for the current request's query string * - `{{ path }}` for the current request's URL path - * - `{{ scheme }}` for the current request's scheme + * - `{{ scheme }}` for the current request's scheme. */ target: string /** * HTTP redirect code to use. Valid values are 301, 302, 303, 307 and 308. - * Default value is 302 + * Default value is 302. */ code?: number } -/** Acl match */ +/** Acl match. */ export interface AclMatch { - /** A list of IPs or CIDR v4/v6 addresses of the client of the session to match */ + /** + * A list of IPs or CIDR v4/v6 addresses of the client of the session to + * match. + */ ipSubnet: string[] /** * The HTTP filter to match. This filter is supported only if your backend @@ -206,145 +209,145 @@ export interface AclMatch { * part). */ httpFilter: AclHttpFilter - /** A list of possible values to match for the given HTTP filter */ + /** A list of possible values to match for the given HTTP filter. */ httpFilterValue: string[] /** * A exra parameter. You can use this field with http_header_match acl type to - * set the header name to filter + * set the header name to filter. */ httpFilterOption?: string - /** If set to `true`, the ACL matching condition will be of type "UNLESS" */ + /** If set to `true`, the ACL matching condition will be of type "UNLESS". */ invert: boolean } -/** Acl spec */ +/** Acl spec. */ export interface AclSpec { - /** Name of your ACL resource */ + /** Name of your ACL resource. */ name: string - /** Action to undertake when an ACL filter matches */ + /** Action to undertake when an ACL filter matches. */ action: AclAction /** * The ACL match rule. At least `ip_subnet` or `http_filter` and - * `http_filter_value` are required + * `http_filter_value` are required. */ match?: AclMatch - /** Order between your Acls (ascending order, 0 is first acl executed) */ + /** Order between your Acls (ascending order, 0 is first acl executed). */ index: number - /** Description of your ACL ressource */ + /** Description of your ACL ressource. */ description: string } -/** Backend */ +/** Backend. */ export interface Backend { - /** Load balancer Backend ID */ + /** Load balancer Backend ID. */ id: string - /** Load balancer Backend name */ + /** Load balancer Backend name. */ name: string - /** Type of backend protocol */ + /** Type of backend protocol. */ forwardProtocol: Protocol - /** User sessions will be forwarded to this port of backend servers */ + /** User sessions will be forwarded to this port of backend servers. */ forwardPort: number - /** Load balancer algorithm used to select the backend server */ + /** Load balancer algorithm used to select the backend server. */ forwardPortAlgorithm: ForwardPortAlgorithm - /** Enables cookie-based session persistence */ + /** Enables cookie-based session persistence. */ stickySessions: StickySessionsType - /** Cookie name for sticky sessions */ + /** Cookie name for sticky sessions. */ stickySessionsCookieName: string - /** Health Check used to verify backend servers status */ + /** Health Check used to verify backend servers status. */ healthCheck?: HealthCheck - /** Servers IP addresses attached to the backend */ + /** Servers IP addresses attached to the backend. */ pool: string[] - /** Load balancer the backend is attached to */ + /** Load balancer the backend is attached to. */ lb?: Lb - /** @deprecated Deprecated in favor of proxy_protocol field */ + /** @deprecated Deprecated in favor of proxy_protocol field. */ sendProxyV2?: boolean /** * Maximum server connection inactivity time (allowed time the server has to - * process the request) + * process the request). */ timeoutServer?: string - /** Maximum initial server connection establishment time */ + /** Maximum initial server connection establishment time. */ timeoutConnect?: string /** * Maximum tunnel inactivity time after Websocket is established (take - * precedence over client and server timeout) + * precedence over client and server timeout). */ timeoutTunnel?: string - /** Defines what occurs when a backend server is marked down */ + /** Defines what occurs when a backend server is marked down. */ onMarkedDownAction: OnMarkedDownAction /** * PROXY protocol, forward client's address (must be supported by backend - * servers software) + * servers software). */ proxyProtocol: ProxyProtocol - /** Date at which the backend was created */ + /** Date at which the backend was created. */ createdAt?: Date - /** Date at which the backend was updated */ + /** Date at which the backend was updated. */ updatedAt?: Date /** * Scaleway S3 bucket website to be served in case all backend servers are - * down + * down. */ failoverHost?: string - /** Enable SSL between load balancer and backend servers */ + /** Enable SSL between load balancer and backend servers. */ sslBridging?: boolean - /** Whether or not the server certificate should be verified */ + /** Whether or not the server certificate should be verified. */ ignoreSslServerVerify?: boolean } /** * State and statistics of your backend server like last health check status, - * server uptime, result state of your backend server + * server uptime, result state of your backend server. */ export interface BackendServerStats { - /** ID of your Load balancer cluster server */ + /** ID of your Load balancer cluster server. */ instanceId: string - /** ID of your Backend */ + /** ID of your Backend. */ backendId: string - /** IPv4 or IPv6 address of the server backend */ + /** IPv4 or IPv6 address of the server backend. */ ip: string - /** Server operational state (stopped/starting/running/stopping) */ + /** Server operational state (stopped/starting/running/stopping). */ serverState: BackendServerStatsServerState - /** Time since last operational change */ + /** Time since last operational change. */ serverStateChangedAt?: Date - /** Last health check status (unknown/neutral/failed/passed/condpass) */ + /** Last health check status (unknown/neutral/failed/passed/condpass). */ lastHealthCheckStatus: BackendServerStatsHealthCheckStatus } -/** SSL certificate */ +/** SSL certificate. */ export interface Certificate { - /** Type of certificate (Let's encrypt or custom) */ + /** Type of certificate (Let's encrypt or custom). */ type: CertificateType - /** Certificate ID */ + /** Certificate ID. */ id: string - /** Main domain name of certificate */ + /** Main domain name of certificate. */ commonName: string - /** Alternative domain names */ + /** Alternative domain names. */ subjectAlternativeName: string[] - /** Identifier (SHA-1) of the certificate */ + /** Identifier (SHA-1) of the certificate. */ fingerprint: string - /** Validity bounds */ + /** Validity bounds. */ notValidBefore?: Date - /** Validity bounds */ + /** Validity bounds. */ notValidAfter?: Date - /** Status of certificate */ + /** Status of certificate. */ status: CertificateStatus - /** Load balancer object */ + /** Load balancer object. */ lb?: Lb - /** Certificate name */ + /** Certificate name. */ name: string - /** Date at which the certificate was created */ + /** Date at which the certificate was created. */ createdAt?: Date - /** Date at which the certificate was last updated */ + /** Date at which the certificate was last updated. */ updatedAt?: Date /** * Additional information on the status (e.g. in case of certificate - * generation failure) + * generation failure). */ statusDetails?: string } -/** Import a custom SSL certificate */ +/** Import a custom SSL certificate. */ export interface CreateCertificateRequestCustomCertificate { /** * The full PEM-formatted include an entire certificate chain including public @@ -357,43 +360,43 @@ export interface CreateCertificateRequestCustomCertificate { export interface CreateCertificateRequestLetsencryptConfig { /** * Main domain name of certificate (make sure this domain exists and resolves - * to your load balancer HA IP) + * to your load balancer HA IP). */ commonName: string /** * Alternative domain names (make sure all domain names exists and resolves to - * your load balancer HA IP) + * your load balancer HA IP). */ subjectAlternativeName: string[] } -/** Frontend */ +/** Frontend. */ export interface Frontend { - /** Load balancer Frontend ID */ + /** Load balancer Frontend ID. */ id: string - /** Load balancer Frontend name */ + /** Load balancer Frontend name. */ name: string - /** TCP port to listen on the front side */ + /** TCP port to listen on the front side. */ inboundPort: number - /** Backend resource the Frontend is attached to */ + /** Backend resource the Frontend is attached to. */ backend?: Backend - /** Load balancer the frontend is attached to */ + /** Load balancer the frontend is attached to. */ lb?: Lb - /** Maximum inactivity time on the client side */ + /** Maximum inactivity time on the client side. */ timeoutClient?: string - /** @deprecated Certificate, deprecated in favor of certificate_ids array */ + /** @deprecated Certificate, deprecated in favor of certificate_ids array. */ certificate?: Certificate - /** List of certificate IDs to bind on the frontend */ + /** List of certificate IDs to bind on the frontend. */ certificateIds: string[] - /** Date at which the frontend was created */ + /** Date at which the frontend was created. */ createdAt?: Date - /** Date at which the frontend was updated */ + /** Date at which the frontend was updated. */ updatedAt?: Date - /** Whether or not HTTP3 protocol is enabled */ + /** Whether or not HTTP3 protocol is enabled. */ enableHttp3: boolean } -/** Health check */ +/** Health check. */ export interface HealthCheck { /** * The check requires MySQL >=3.22, for older versions, use TCP check. @@ -421,7 +424,7 @@ export interface HealthCheck { redisConfig?: HealthCheckRedisConfig /** * Number of consecutive unsuccessful health checks, after which the server - * will be considered dead + * will be considered dead. */ checkMaxRetries: number /** @@ -456,48 +459,48 @@ export interface HealthCheck { * could be set. */ httpsConfig?: HealthCheckHttpsConfig - /** TCP port to use for the backend server health check */ + /** TCP port to use for the backend server health check. */ port: number - /** Maximum time a backend server has to reply to the health check */ + /** Maximum time a backend server has to reply to the health check. */ checkTimeout?: string - /** Time between two consecutive health checks */ + /** Time between two consecutive health checks. */ checkDelay?: string /** * It defines whether the health check should be done considering the proxy - * protocol + * protocol. */ checkSendProxy: boolean } -/** Health check. http config */ +/** Health check. http config. */ export interface HealthCheckHttpConfig { - /** HTTP uri used for Healthcheck to the backend servers */ + /** HTTP uri used for Healthcheck to the backend servers. */ uri: string - /** HTTP method used for Healthcheck to the backend servers */ + /** HTTP method used for Healthcheck to the backend servers. */ method: string /** * A health check response will be considered as valid if the response's - * status code match + * status code match. */ code?: number - /** HTTP host header used with the request */ + /** HTTP host header used with the request. */ hostHeader: string } -/** Health check. https config */ +/** Health check. https config. */ export interface HealthCheckHttpsConfig { - /** HTTP uri used for Healthcheck to the backend servers */ + /** HTTP uri used for Healthcheck to the backend servers. */ uri: string - /** HTTP method used for Healthcheck to the backend servers */ + /** HTTP method used for Healthcheck to the backend servers. */ method: string /** * A health check response will be considered as valid if the response's - * status code match + * status code match. */ code?: number - /** HTTP host header used with the request */ + /** HTTP host header used with the request. */ hostHeader: string - /** Specifies the SNI to use to do health checks over SSL */ + /** Specifies the SNI to use to do health checks over SSL. */ sni: string } @@ -515,94 +518,94 @@ export interface HealthCheckRedisConfig {} export interface HealthCheckTcpConfig {} -/** Instance */ +/** Instance. */ export interface Instance { - /** Underlying Instance ID */ + /** Underlying Instance ID. */ id: string - /** Instance status */ + /** Instance status. */ status: InstanceStatus - /** Instance IP address */ + /** Instance IP address. */ ipAddress: string - /** Date at which the Instance was created */ + /** Date at which the Instance was created. */ createdAt?: Date - /** Date at which the Instance was updated */ + /** Date at which the Instance was updated. */ updatedAt?: Date - /** @deprecated The region the instance is in */ + /** @deprecated The region the instance is in. */ region?: Region - /** The zone the instance is in */ + /** The zone the instance is in. */ zone: Zone } -/** Ip */ +/** Ip. */ export interface Ip { - /** Flexible IP ID */ + /** Flexible IP ID. */ id: string - /** IP address */ + /** IP address. */ ipAddress: string - /** Organization ID */ + /** Organization ID. */ organizationId: string - /** Project ID */ + /** Project ID. */ projectId: string - /** Load balancer ID */ + /** Load balancer ID. */ lbId?: string - /** Reverse FQDN */ + /** Reverse FQDN. */ reverse: string - /** @deprecated The region the Flexible IP is in */ + /** @deprecated The region the Flexible IP is in. */ region?: Region - /** The zone the Flexible IP is in */ + /** The zone the Flexible IP is in. */ zone: Zone } -/** Lb */ +/** Lb. */ export interface Lb { - /** Underlying Instance ID */ + /** Underlying Instance ID. */ id: string - /** Load balancer name */ + /** Load balancer name. */ name: string - /** Load balancer description */ + /** Load balancer description. */ description: string - /** Load balancer status */ + /** Load balancer status. */ status: LbStatus - /** List of underlying instances */ + /** List of underlying instances. */ instances: Instance[] - /** Organization ID */ + /** Organization ID. */ organizationId: string - /** Project ID */ + /** Project ID. */ projectId: string - /** List of IPs attached to the Load balancer */ + /** List of IPs attached to the Load balancer. */ ip: Ip[] - /** Load balancer tags */ + /** Load balancer tags. */ tags: string[] - /** Number of frontends the Load balancer has */ + /** Number of frontends the Load balancer has. */ frontendCount: number - /** Number of backends the Load balancer has */ + /** Number of backends the Load balancer has. */ backendCount: number - /** Load balancer offer type */ + /** Load balancer offer type. */ type: string - /** Subscriber information */ + /** Subscriber information. */ subscriber?: Subscriber /** * Determines the minimal SSL version which needs to be supported on client - * side + * side. */ sslCompatibilityLevel: SSLCompatibilityLevel - /** Date at which the Load balancer was created */ + /** Date at which the Load balancer was created. */ createdAt?: Date - /** Date at which the Load balancer was updated */ + /** Date at which the Load balancer was updated. */ updatedAt?: Date - /** Number of private networks attached to the Load balancer */ + /** Number of private networks attached to the Load balancer. */ privateNetworkCount: number - /** Number of routes the Load balancer has */ + /** Number of routes the Load balancer has. */ routeCount: number - /** @deprecated The region the Load balancer is in */ + /** @deprecated The region the Load balancer is in. */ region?: Region - /** The zone the Load balancer is in */ + /** The zone the Load balancer is in. */ zone: Zone } -/** Lb stats */ +/** Lb stats. */ export interface LbStats { - /** List stats object of your Load balancer */ + /** List stats object of your Load balancer. */ backendServersStats: BackendServerStats[] } @@ -615,97 +618,97 @@ export interface LbType { zone: Zone } -/** List acl response */ +/** List acl response. */ export interface ListAclResponse { - /** List of Acl object (see Acl object description) */ + /** List of Acl object (see Acl object description). */ acls: Acl[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** List backend stats response */ +/** List backend stats response. */ export interface ListBackendStatsResponse { - /** List backend stats object of your Load balancer */ + /** List backend stats object of your Load balancer. */ backendServersStats: BackendServerStats[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** List backends response */ +/** List backends response. */ export interface ListBackendsResponse { - /** List Backend objects of a load balancer */ + /** List Backend objects of a load balancer. */ backends: Backend[] - /** Total count, wihtout pagination */ + /** Total count, wihtout pagination. */ totalCount: number } -/** List certificates response */ +/** List certificates response. */ export interface ListCertificatesResponse { - /** List of certificates */ + /** List of certificates. */ certificates: Certificate[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** List frontends response */ +/** List frontends response. */ export interface ListFrontendsResponse { - /** List frontends object of your Load balancer */ + /** List frontends object of your Load balancer. */ frontends: Frontend[] - /** Total count, wihtout pagination */ + /** Total count, wihtout pagination. */ totalCount: number } -/** List ips response */ +/** List ips response. */ export interface ListIpsResponse { - /** List IP address object */ + /** List IP address object. */ ips: Ip[] - /** Total count, wihtout pagination */ + /** Total count, wihtout pagination. */ totalCount: number } -/** List lb private networks response */ +/** List lb private networks response. */ export interface ListLbPrivateNetworksResponse { - /** Private networks of a given load balancer */ + /** Private networks of a given load balancer. */ privateNetwork: PrivateNetwork[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** List lb types response */ +/** List lb types response. */ export interface ListLbTypesResponse { - /** Different types of LB */ + /** Different types of LB. */ lbTypes: LbType[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** Get list of Load balancers */ +/** Get list of Load balancers. */ export interface ListLbsResponse { - /** List of Load balancer */ + /** List of Load balancer. */ lbs: Lb[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** List routes response */ +/** List routes response. */ export interface ListRoutesResponse { - /** List of Routes object */ + /** List of Routes object. */ routes: Route[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** List subscriber response */ +/** List subscriber response. */ export interface ListSubscriberResponse { - /** List of Subscribers object */ + /** List of Subscribers object. */ subscribers: Subscriber[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** Private network */ +/** Private network. */ export interface PrivateNetwork { - /** LoadBalancer object */ + /** LoadBalancer object. */ lb?: Lb /** * Local ip address of load balancer instance. @@ -728,13 +731,13 @@ export interface PrivateNetwork { * 'ipamConfig' could be set. */ ipamConfig?: PrivateNetworkIpamConfig - /** Instance private network id */ + /** Instance private network id. */ privateNetworkId: string - /** Status (running, to create...) of private network connection */ + /** Status (running, to create...) of private network connection. */ status: PrivateNetworkStatus - /** Date at which the PN was created */ + /** Date at which the PN was created. */ createdAt?: Date - /** Date at which the PN was last updated */ + /** Date at which the PN was last updated. */ updatedAt?: Date } @@ -746,23 +749,23 @@ export interface PrivateNetworkStaticConfig { ipAddress: string[] } -/** Route */ +/** Route. */ export interface Route { - /** Id of match ressource */ + /** Id of match ressource. */ id: string - /** Id of frontend */ + /** Id of frontend. */ frontendId: string - /** Id of backend */ + /** Id of backend. */ backendId: string - /** Value to match a redirection */ + /** Value to match a redirection. */ match?: RouteMatch - /** Date at which the route was created */ + /** Date at which the route was created. */ createdAt?: Date - /** Date at which the route was last updated */ + /** Date at which the route was last updated. */ updatedAt?: Date } -/** Route. match */ +/** Route. match. */ export interface RouteMatch { /** * Server Name Indication TLS extension (SNI) field from an incoming @@ -780,19 +783,19 @@ export interface RouteMatch { hostHeader?: string } -/** Set acls response */ +/** Set acls response. */ export interface SetAclsResponse { - /** List of ACLs object (see ACL object description) */ + /** List of ACLs object (see ACL object description). */ acls: Acl[] - /** The total number of items */ + /** The total number of items. */ totalCount: number } -/** Subscriber */ +/** Subscriber. */ export interface Subscriber { - /** Subscriber ID */ + /** Subscriber ID. */ id: string - /** Subscriber name */ + /** Subscriber name. */ name: string /** * Email address of subscriber. @@ -810,37 +813,43 @@ export interface Subscriber { webhookConfig?: SubscriberWebhookConfig } -/** Email alert of subscriber */ +/** Email alert of subscriber. */ export interface SubscriberEmailConfig { - /** Email who receive alert */ + /** Email who receive alert. */ email: string } -/** Webhook alert of subscriber */ +/** Webhook alert of subscriber. */ export interface SubscriberWebhookConfig { - /** URI who receive POST request */ + /** URI who receive POST request. */ uri: string } export type ListLbsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Use this to search by name */ + /** Use this to search by name. */ name?: string - /** Response order */ + /** Response order. */ orderBy?: ListLbsRequestOrderBy - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Page number */ + /** Page number. */ page?: number - /** Filter LBs by organization ID */ + /** Filter LBs by organization ID. */ organizationId?: string - /** Filter LBs by project ID */ + /** Filter LBs by project ID. */ projectId?: string } export type CreateLbRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** * @deprecated Owner of resources. @@ -856,19 +865,19 @@ export type CreateLbRequest = { * could be set. */ projectId?: string - /** Resource names */ + /** Resource names. */ name?: string - /** Resource description */ + /** Resource description. */ description: string /** * Just like for compute instances, when you destroy a load balancer, you can * keep its highly available IP address and reuse it for another load balancer - * later + * later. */ ipId?: string - /** List of keyword */ + /** List of keyword. */ tags?: string[] - /** Load balancer offer type */ + /** Load balancer offer type. */ type: string /** * Enforces minimal SSL version (in SSL/TLS offloading context). @@ -888,22 +897,28 @@ export type CreateLbRequest = { } export type GetLbRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string } export type UpdateLbRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Resource name */ + /** Resource name. */ name: string - /** Resource description */ + /** Resource description. */ description: string - /** List of keywords */ + /** List of keywords. */ tags?: string[] /** * Enforces minimal SSL version (in SSL/TLS offloading context). @@ -923,40 +938,52 @@ export type UpdateLbRequest = { } export type DeleteLbRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Set true if you don't want to keep this IP address */ + /** Set true if you don't want to keep this IP address. */ releaseIp: boolean } export type MigrateLbRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Load balancer type (check /lb-types to list all type) */ + /** Load balancer type (check /lb-types to list all type). */ type: string } export type ListIPsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Use this to search by IP address */ + /** Use this to search by IP address. */ ipAddress?: string - /** Filter IPs by organization id */ + /** Filter IPs by organization id. */ organizationId?: string - /** Filter IPs by project ID */ + /** Filter IPs by project ID. */ projectId?: string } export type CreateIpRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** * @deprecated Owner of resources. @@ -972,84 +999,99 @@ export type CreateIpRequest = { * could be set. */ projectId?: string - /** Reverse domain name */ + /** Reverse domain name. */ reverse?: string } export type GetIpRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** IP address ID */ + /** IP address ID. */ ipId: string } export type ReleaseIpRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** IP address ID */ + /** IP address ID. */ ipId: string } export type UpdateIpRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** IP address ID */ + /** IP address ID. */ ipId: string - /** Reverse DNS */ + /** Reverse DNS. */ reverse?: string } export type ListBackendsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Use this to search by name */ + /** Use this to search by name. */ name?: string - /** Response order */ + /** Response order. */ orderBy?: ListBackendsRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type CreateBackendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Resource name */ + /** Resource name. */ name?: string - /** Backend protocol. TCP or HTTP */ + /** Backend protocol. TCP or HTTP. */ forwardProtocol: Protocol - /** User sessions will be forwarded to this port of backend servers */ + /** User sessions will be forwarded to this port of backend servers. */ forwardPort: number - /** Load balancing algorithm */ + /** Load balancing algorithm. */ forwardPortAlgorithm: ForwardPortAlgorithm - /** Enables cookie-based session persistence */ + /** Enables cookie-based session persistence. */ stickySessions: StickySessionsType - /** Cookie name for sticky sessions */ + /** Cookie name for sticky sessions. */ stickySessionsCookieName: string - /** See the Healthcheck object description */ + /** See the Healthcheck object description. */ healthCheck: HealthCheck - /** Backend server IP addresses list (IPv4 or IPv6) */ + /** Backend server IP addresses list (IPv4 or IPv6). */ serverIp: string[] /** @deprecated Deprecated in favor of proxy_protocol field ! */ sendProxyV2?: boolean /** * Maximum server connection inactivity time (allowed time the server has to - * process the request) + * process the request). */ timeoutServer?: string - /** Maximum initial server connection establishment time */ + /** Maximum initial server connection establishment time. */ timeoutConnect?: string /** * Maximum tunnel inactivity time after Websocket is established (take - * precedence over client and server timeout) + * precedence over client and server timeout). */ timeoutTunnel?: string - /** Modify what occurs when a backend server is marked down */ + /** Modify what occurs when a backend server is marked down. */ onMarkedDownAction?: OnMarkedDownAction /** * The PROXY protocol informs the other end about the incoming connection, so @@ -1069,51 +1111,57 @@ export type CreateBackendRequest = { * is `https://failover-website.s3-website.fr-par.scw.cloud/`. */ failoverHost?: string - /** Enable SSL between load balancer and backend servers */ + /** Enable SSL between load balancer and backend servers. */ sslBridging?: boolean - /** Set to true to ignore server certificate verification */ + /** Set to true to ignore server certificate verification. */ ignoreSslServerVerify?: boolean } export type GetBackendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Backend ID */ + /** Backend ID. */ backendId: string } export type UpdateBackendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Backend ID to update */ + /** Backend ID to update. */ backendId: string - /** Resource name */ + /** Resource name. */ name: string - /** Backend protocol. TCP or HTTP */ + /** Backend protocol. TCP or HTTP. */ forwardProtocol: Protocol - /** User sessions will be forwarded to this port of backend servers */ + /** User sessions will be forwarded to this port of backend servers. */ forwardPort: number - /** Load balancing algorithm */ + /** Load balancing algorithm. */ forwardPortAlgorithm: ForwardPortAlgorithm - /** Enable cookie-based session persistence */ + /** Enable cookie-based session persistence. */ stickySessions: StickySessionsType - /** Cookie name for sticky sessions */ + /** Cookie name for sticky sessions. */ stickySessionsCookieName: string /** @deprecated Deprecated in favor of proxy_protocol field! */ sendProxyV2?: boolean /** * Maximum server connection inactivity time (allowed time the server has to - * process the request) + * process the request). */ timeoutServer?: string - /** Maximum initial server connection establishment time */ + /** Maximum initial server connection establishment time. */ timeoutConnect?: string /** * Maximum tunnel inactivity time after Websocket is established (take - * precedence over client and server timeout) + * precedence over client and server timeout). */ timeoutTunnel?: string - /** Modify what occurs when a backend server is marked down */ + /** Modify what occurs when a backend server is marked down. */ onMarkedDownAction?: OnMarkedDownAction /** * The PROXY protocol informs the other end about the incoming connection, so @@ -1133,60 +1181,75 @@ export type UpdateBackendRequest = { * is `https://failover-website.s3-website.fr-par.scw.cloud/`. */ failoverHost?: string - /** Enable SSL between load balancer and backend servers */ + /** Enable SSL between load balancer and backend servers. */ sslBridging?: boolean - /** Set to true to ignore server certificate verification */ + /** Set to true to ignore server certificate verification. */ ignoreSslServerVerify?: boolean } export type DeleteBackendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the backend to delete */ + /** ID of the backend to delete. */ backendId: string } export type AddBackendServersRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set all IPs to add on your backend */ + /** Set all IPs to add on your backend. */ serverIp: string[] } export type RemoveBackendServersRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set all IPs to remove of your backend */ + /** Set all IPs to remove of your backend. */ serverIp: string[] } export type SetBackendServersRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set all IPs to add on your backend and remove all other */ + /** Set all IPs to add on your backend and remove all other. */ serverIp: string[] } export type UpdateHealthCheckRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Specify the port used to health check */ + /** Specify the port used to health check. */ port: number - /** Time between two consecutive health checks */ + /** Time between two consecutive health checks. */ checkDelay: string - /** Maximum time a backend server has to reply to the health check */ + /** Maximum time a backend server has to reply to the health check. */ checkTimeout: string /** * Number of consecutive unsuccessful health checks, after which the server - * will be considered dead + * will be considered dead. */ checkMaxRetries: number /** @@ -1247,226 +1310,280 @@ export type UpdateHealthCheckRequest = { httpsConfig?: HealthCheckHttpsConfig /** * It defines whether the health check should be done considering the proxy - * protocol + * protocol. */ checkSendProxy: boolean } export type ListFrontendsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Use this to search by name */ + /** Use this to search by name. */ name?: string - /** Response order */ + /** Response order. */ orderBy?: ListFrontendsRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type CreateFrontendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Resource name */ + /** Resource name. */ name?: string - /** TCP port to listen on the front side */ + /** TCP port to listen on the front side. */ inboundPort: number - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set the maximum inactivity time on the client side */ + /** Set the maximum inactivity time on the client side. */ timeoutClient?: string /** @deprecated Certificate ID, deprecated in favor of certificate_ids array ! */ certificateId?: string - /** List of certificate IDs to bind on the frontend */ + /** List of certificate IDs to bind on the frontend. */ certificateIds?: string[] - /** Activate HTTP 3 protocol (beta) */ + /** Activate HTTP 3 protocol (beta). */ enableHttp3: boolean } export type GetFrontendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Frontend ID */ + /** Frontend ID. */ frontendId: string } export type UpdateFrontendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Frontend ID */ + /** Frontend ID. */ frontendId: string - /** Resource name */ + /** Resource name. */ name: string - /** TCP port to listen on the front side */ + /** TCP port to listen on the front side. */ inboundPort: number - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Client session maximum inactivity time */ + /** Client session maximum inactivity time. */ timeoutClient?: string /** @deprecated Certificate ID, deprecated in favor of `certificate_ids` array! */ certificateId?: string - /** List of certificate IDs to bind on the frontend */ + /** List of certificate IDs to bind on the frontend. */ certificateIds?: string[] - /** Activate HTTP 3 protocol (beta) */ + /** Activate HTTP 3 protocol (beta). */ enableHttp3: boolean } export type DeleteFrontendRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Frontend ID to delete */ + /** Frontend ID to delete. */ frontendId: string } export type ListRoutesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Response order */ + /** Response order. */ orderBy?: ListRoutesRequestOrderBy - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Page number */ + /** Page number. */ page?: number frontendId?: 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?: Region - /** Origin of redirection */ + /** Origin of redirection. */ frontendId: string - /** Destination of destination */ + /** Destination of destination. */ backendId: string - /** Value to match a redirection */ + /** Value to match a redirection. */ match?: RouteMatch } 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?: Region - /** Id of route to get */ + /** Id of route to get. */ routeId: 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?: Region - /** Route id to update */ + /** Route id to update. */ routeId: string - /** Backend id of redirection */ + /** Backend id of redirection. */ backendId: string - /** Value to match a redirection */ + /** Value to match a redirection. */ match?: RouteMatch } 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?: Region - /** Route id to delete */ + /** Route id to delete. */ routeId: string } export type GetLbStatsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string } export type ListBackendStatsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type ListAclsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of your frontend */ + /** ID of your frontend. */ frontendId: string - /** Response order */ + /** Response order. */ orderBy?: ListAclRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Filter acl per name */ + /** Filter acl per name. */ name?: string } export type CreateAclRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of your frontend */ + /** ID of your frontend. */ frontendId: string - /** Name of your ACL ressource */ + /** Name of your ACL ressource. */ name?: string - /** Action to undertake when an ACL filter matches */ + /** Action to undertake when an ACL filter matches. */ action: AclAction /** * The ACL match rule. You can have one of those three cases: * * - `ip_subnet` is defined * - `http_filter` and `http_filter_value` are defined - * - `ip_subnet`, `http_filter` and `http_filter_value` are defined + * - `ip_subnet`, `http_filter` and `http_filter_value` are defined. */ match?: AclMatch - /** Order between your Acls (ascending order, 0 is first acl executed) */ + /** Order between your Acls (ascending order, 0 is first acl executed). */ index: number - /** Description of your ACL ressource */ + /** Description of your ACL ressource. */ description: 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?: Region - /** ID of your ACL ressource */ + /** ID of your ACL ressource. */ aclId: string } export type UpdateAclRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of your ACL ressource */ + /** ID of your ACL ressource. */ aclId: string - /** Name of your ACL ressource */ + /** Name of your ACL ressource. */ name: string - /** Action to undertake when an ACL filter matches */ + /** Action to undertake when an ACL filter matches. */ action: AclAction /** * The ACL match rule. At least `ip_subnet` or `http_filter` and - * `http_filter_value` are required + * `http_filter_value` are required. */ match?: AclMatch - /** Order between your Acls (ascending order, 0 is first acl executed) */ + /** Order between your Acls (ascending order, 0 is first acl executed). */ index: number - /** Description of your ACL ressource */ + /** Description of your ACL ressource. */ description?: string } export type DeleteAclRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of your ACL ressource */ + /** ID of your ACL ressource. */ aclId: string } export type CreateCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Certificate name */ + /** Certificate name. */ name?: string /** * Let's Encrypt type. @@ -1485,56 +1602,74 @@ export type CreateCertificateRequest = { } export type ListCertificatesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Response order */ + /** Response order. */ orderBy?: ListCertificatesRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Use this to search by name */ + /** Use this to search by name. */ name?: string } export type GetCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Certificate ID */ + /** Certificate ID. */ certificateId: string } export type UpdateCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Certificate ID */ + /** Certificate ID. */ certificateId: string - /** Certificate name */ + /** Certificate name. */ name: string } export type DeleteCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Certificate ID */ + /** Certificate ID. */ certificateId: string } export type ListLbTypesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type CreateSubscriberRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Subscriber name */ + /** Subscriber name. */ name: string /** * Email address configuration. @@ -1567,35 +1702,44 @@ export type CreateSubscriberRequest = { } export type GetSubscriberRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Subscriber ID */ + /** Subscriber ID. */ subscriberId: string } export type ListSubscriberRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Response order */ + /** Response order. */ orderBy?: ListSubscriberRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Use this to search by name */ + /** Use this to search by name. */ name: string - /** Filter Subscribers by organization ID */ + /** Filter Subscribers by organization ID. */ organizationId?: string - /** Filter Subscribers by project ID */ + /** Filter Subscribers by project ID. */ projectId?: string } export type UpdateSubscriberRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Assign the resource to a project IDs */ + /** Assign the resource to a project IDs. */ subscriberId: string - /** Subscriber name */ + /** Subscriber name. */ name: string /** * Email address configuration. @@ -1614,47 +1758,62 @@ export type UpdateSubscriberRequest = { } export type DeleteSubscriberRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Subscriber ID */ + /** Subscriber ID. */ subscriberId: string } export type SubscribeToLbRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Subscriber ID */ + /** Subscriber ID. */ subscriberId: string } export type UnsubscribeFromLbRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string } export type ListLbPrivateNetworksRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Response order */ + /** Response order. */ orderBy?: ListPrivateNetworksRequestOrderBy - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Page number */ + /** Page number. */ page?: number } export type AttachPrivateNetworkRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Set your instance private network id */ + /** Set your instance private network id. */ privateNetworkId: string /** * Define two local ip address of your choice for each load balancer instance. @@ -1680,33 +1839,36 @@ export type AttachPrivateNetworkRequest = { } export type DetachPrivateNetworkRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Set your instance private network id */ + /** Set your instance private network id. */ privateNetworkId: string } export type ZonedApiListLbsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Use this to search by name */ + /** Use this to search by name. */ name?: string - /** Response order */ + /** Response order. */ orderBy?: ListLbsRequestOrderBy - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Page number */ + /** Page number. */ page?: number - /** Filter LBs by organization ID */ + /** Filter LBs by organization ID. */ organizationId?: string - /** Filter LBs by project ID */ + /** Filter LBs by project ID. */ projectId?: string } export type ZonedApiCreateLbRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** * @deprecated Owner of resources. @@ -1722,19 +1884,19 @@ export type ZonedApiCreateLbRequest = { * could be set. */ projectId?: string - /** Resource names */ + /** Resource names. */ name?: string - /** Resource description */ + /** Resource description. */ description: string /** * Just like for compute instances, when you destroy a load balancer, you can * keep its highly available IP address and reuse it for another load balancer - * later + * later. */ ipId?: string - /** List of keyword */ + /** List of keyword. */ tags?: string[] - /** Load balancer offer type */ + /** Load balancer offer type. */ type: string /** * Enforces minimal SSL version (in SSL/TLS offloading context). @@ -1754,22 +1916,22 @@ export type ZonedApiCreateLbRequest = { } export type ZonedApiGetLbRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string } export type ZonedApiUpdateLbRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Resource name */ + /** Resource name. */ name: string - /** Resource description */ + /** Resource description. */ description: string - /** List of keywords */ + /** List of keywords. */ tags?: string[] /** * Enforces minimal SSL version (in SSL/TLS offloading context). @@ -1789,40 +1951,40 @@ export type ZonedApiUpdateLbRequest = { } export type ZonedApiDeleteLbRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Set true if you don't want to keep this IP address */ + /** Set true if you don't want to keep this IP address. */ releaseIp: boolean } export type ZonedApiMigrateLbRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Load balancer type (check /lb-types to list all type) */ + /** Load balancer type (check /lb-types to list all type). */ type: string } export type ZonedApiListIPsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Use this to search by IP address */ + /** Use this to search by IP address. */ ipAddress?: string - /** Filter IPs by organization id */ + /** Filter IPs by organization id. */ organizationId?: string - /** Filter IPs by project ID */ + /** Filter IPs by project ID. */ projectId?: string } export type ZonedApiCreateIpRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone /** * @deprecated Owner of resources. @@ -1838,84 +2000,84 @@ export type ZonedApiCreateIpRequest = { * could be set. */ projectId?: string - /** Reverse domain name */ + /** Reverse domain name. */ reverse?: string } export type ZonedApiGetIpRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** IP address ID */ + /** IP address ID. */ ipId: string } export type ZonedApiReleaseIpRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** IP address ID */ + /** IP address ID. */ ipId: string } export type ZonedApiUpdateIpRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** IP address ID */ + /** IP address ID. */ ipId: string - /** Reverse DNS */ + /** Reverse DNS. */ reverse?: string } export type ZonedApiListBackendsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Use this to search by name */ + /** Use this to search by name. */ name?: string - /** Response order */ + /** Response order. */ orderBy?: ListBackendsRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type ZonedApiCreateBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Resource name */ + /** Resource name. */ name?: string - /** Backend protocol. TCP or HTTP */ + /** Backend protocol. TCP or HTTP. */ forwardProtocol: Protocol - /** User sessions will be forwarded to this port of backend servers */ + /** User sessions will be forwarded to this port of backend servers. */ forwardPort: number - /** Load balancing algorithm */ + /** Load balancing algorithm. */ forwardPortAlgorithm: ForwardPortAlgorithm - /** Enables cookie-based session persistence */ + /** Enables cookie-based session persistence. */ stickySessions: StickySessionsType - /** Cookie name for sticky sessions */ + /** Cookie name for sticky sessions. */ stickySessionsCookieName: string - /** See the Healthcheck object description */ + /** See the Healthcheck object description. */ healthCheck: HealthCheck - /** Backend server IP addresses list (IPv4 or IPv6) */ + /** Backend server IP addresses list (IPv4 or IPv6). */ serverIp: string[] /** @deprecated Deprecated in favor of proxy_protocol field ! */ sendProxyV2?: boolean /** * Maximum server connection inactivity time (allowed time the server has to - * process the request) + * process the request). */ timeoutServer?: string - /** Maximum initial server connection establishment time */ + /** Maximum initial server connection establishment time. */ timeoutConnect?: string /** * Maximum tunnel inactivity time after Websocket is established (take - * precedence over client and server timeout) + * precedence over client and server timeout). */ timeoutTunnel?: string - /** Modify what occurs when a backend server is marked down */ + /** Modify what occurs when a backend server is marked down. */ onMarkedDownAction?: OnMarkedDownAction /** * The PROXY protocol informs the other end about the incoming connection, so @@ -1935,51 +2097,51 @@ export type ZonedApiCreateBackendRequest = { * is `https://failover-website.s3-website.fr-par.scw.cloud/`. */ failoverHost?: string - /** Enable SSL between load balancer and backend servers */ + /** Enable SSL between load balancer and backend servers. */ sslBridging?: boolean - /** Set to true to ignore server certificate verification */ + /** Set to true to ignore server certificate verification. */ ignoreSslServerVerify?: boolean } export type ZonedApiGetBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Backend ID */ + /** Backend ID. */ backendId: string } export type ZonedApiUpdateBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Backend ID to update */ + /** Backend ID to update. */ backendId: string - /** Resource name */ + /** Resource name. */ name: string - /** Backend protocol. TCP or HTTP */ + /** Backend protocol. TCP or HTTP. */ forwardProtocol: Protocol - /** User sessions will be forwarded to this port of backend servers */ + /** User sessions will be forwarded to this port of backend servers. */ forwardPort: number - /** Load balancing algorithm */ + /** Load balancing algorithm. */ forwardPortAlgorithm: ForwardPortAlgorithm - /** Enable cookie-based session persistence */ + /** Enable cookie-based session persistence. */ stickySessions: StickySessionsType - /** Cookie name for sticky sessions */ + /** Cookie name for sticky sessions. */ stickySessionsCookieName: string /** @deprecated Deprecated in favor of proxy_protocol field! */ sendProxyV2?: boolean /** * Maximum server connection inactivity time (allowed time the server has to - * process the request) + * process the request). */ timeoutServer?: string - /** Maximum initial server connection establishment time */ + /** Maximum initial server connection establishment time. */ timeoutConnect?: string /** * Maximum tunnel inactivity time after Websocket is established (take - * precedence over client and server timeout) + * precedence over client and server timeout). */ timeoutTunnel?: string - /** Modify what occurs when a backend server is marked down */ + /** Modify what occurs when a backend server is marked down. */ onMarkedDownAction?: OnMarkedDownAction /** * The PROXY protocol informs the other end about the incoming connection, so @@ -1999,60 +2161,60 @@ export type ZonedApiUpdateBackendRequest = { * is `https://failover-website.s3-website.fr-par.scw.cloud/`. */ failoverHost?: string - /** Enable SSL between load balancer and backend servers */ + /** Enable SSL between load balancer and backend servers. */ sslBridging?: boolean - /** Set to true to ignore server certificate verification */ + /** Set to true to ignore server certificate verification. */ ignoreSslServerVerify?: boolean } export type ZonedApiDeleteBackendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the backend to delete */ + /** ID of the backend to delete. */ backendId: string } export type ZonedApiAddBackendServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set all IPs to add on your backend */ + /** Set all IPs to add on your backend. */ serverIp: string[] } export type ZonedApiRemoveBackendServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set all IPs to remove of your backend */ + /** Set all IPs to remove of your backend. */ serverIp: string[] } export type ZonedApiSetBackendServersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set all IPs to add on your backend and remove all other */ + /** Set all IPs to add on your backend and remove all other. */ serverIp: string[] } export type ZonedApiUpdateHealthCheckRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Specify the port used to health check */ + /** Specify the port used to health check. */ port: number - /** Time between two consecutive health checks */ + /** Time between two consecutive health checks. */ checkDelay: string - /** Maximum time a backend server has to reply to the health check */ + /** Maximum time a backend server has to reply to the health check. */ checkTimeout: string /** * Number of consecutive unsuccessful health checks, after which the server - * will be considered dead + * will be considered dead. */ checkMaxRetries: number /** @@ -2113,235 +2275,235 @@ export type ZonedApiUpdateHealthCheckRequest = { httpsConfig?: HealthCheckHttpsConfig /** * It defines whether the health check should be done considering the proxy - * protocol + * protocol. */ checkSendProxy: boolean } export type ZonedApiListFrontendsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Use this to search by name */ + /** Use this to search by name. */ name?: string - /** Response order */ + /** Response order. */ orderBy?: ListFrontendsRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type ZonedApiCreateFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Resource name */ + /** Resource name. */ name?: string - /** TCP port to listen on the front side */ + /** TCP port to listen on the front side. */ inboundPort: number - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Set the maximum inactivity time on the client side */ + /** Set the maximum inactivity time on the client side. */ timeoutClient?: string /** @deprecated Certificate ID, deprecated in favor of certificate_ids array ! */ certificateId?: string - /** List of certificate IDs to bind on the frontend */ + /** List of certificate IDs to bind on the frontend. */ certificateIds?: string[] - /** Activate HTTP 3 protocol (beta) */ + /** Activate HTTP 3 protocol (beta). */ enableHttp3: boolean } export type ZonedApiGetFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Frontend ID */ + /** Frontend ID. */ frontendId: string } export type ZonedApiUpdateFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Frontend ID */ + /** Frontend ID. */ frontendId: string - /** Resource name */ + /** Resource name. */ name: string - /** TCP port to listen on the front side */ + /** TCP port to listen on the front side. */ inboundPort: number - /** Backend ID */ + /** Backend ID. */ backendId: string - /** Client session maximum inactivity time */ + /** Client session maximum inactivity time. */ timeoutClient?: string /** @deprecated Certificate ID, deprecated in favor of `certificate_ids` array! */ certificateId?: string - /** List of certificate IDs to bind on the frontend */ + /** List of certificate IDs to bind on the frontend. */ certificateIds?: string[] - /** Activate HTTP 3 protocol (beta) */ + /** Activate HTTP 3 protocol (beta). */ enableHttp3: boolean } export type ZonedApiDeleteFrontendRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Frontend ID to delete */ + /** Frontend ID to delete. */ frontendId: string } export type ZonedApiListRoutesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Response order */ + /** Response order. */ orderBy?: ListRoutesRequestOrderBy - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Page number */ + /** Page number. */ page?: number frontendId?: string } export type ZonedApiCreateRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Origin of redirection */ + /** Origin of redirection. */ frontendId: string - /** Destination of destination */ + /** Destination of destination. */ backendId: string - /** Value to match a redirection */ + /** Value to match a redirection. */ match?: RouteMatch } export type ZonedApiGetRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Id of route to get */ + /** Id of route to get. */ routeId: string } export type ZonedApiUpdateRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Route id to update */ + /** Route id to update. */ routeId: string - /** Backend id of redirection */ + /** Backend id of redirection. */ backendId: string - /** Value to match a redirection */ + /** Value to match a redirection. */ match?: RouteMatch } export type ZonedApiDeleteRouteRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Route id to delete */ + /** Route id to delete. */ routeId: string } export type ZonedApiGetLbStatsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string } export type ZonedApiListBackendStatsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type ZonedApiListAclsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of your frontend */ + /** ID of your frontend. */ frontendId: string - /** Response order */ + /** Response order. */ orderBy?: ListAclRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Filter acl per name */ + /** Filter acl per name. */ name?: string } export type ZonedApiCreateAclRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of your frontend */ + /** ID of your frontend. */ frontendId: string - /** Name of your ACL ressource */ + /** Name of your ACL ressource. */ name?: string - /** Action to undertake when an ACL filter matches */ + /** Action to undertake when an ACL filter matches. */ action: AclAction /** * The ACL match rule. You can have one of those three cases: * * - `ip_subnet` is defined * - `http_filter` and `http_filter_value` are defined - * - `ip_subnet`, `http_filter` and `http_filter_value` are defined + * - `ip_subnet`, `http_filter` and `http_filter_value` are defined. */ match?: AclMatch - /** Order between your Acls (ascending order, 0 is first acl executed) */ + /** Order between your Acls (ascending order, 0 is first acl executed). */ index: number - /** Description of your ACL ressource */ + /** Description of your ACL ressource. */ description: string } export type ZonedApiGetAclRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of your ACL ressource */ + /** ID of your ACL ressource. */ aclId: string } export type ZonedApiUpdateAclRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of your ACL ressource */ + /** ID of your ACL ressource. */ aclId: string - /** Name of your ACL ressource */ + /** Name of your ACL ressource. */ name: string - /** Action to undertake when an ACL filter matches */ + /** Action to undertake when an ACL filter matches. */ action: AclAction /** * The ACL match rule. At least `ip_subnet` or `http_filter` and - * `http_filter_value` are required + * `http_filter_value` are required. */ match?: AclMatch - /** Order between your Acls (ascending order, 0 is first acl executed) */ + /** Order between your Acls (ascending order, 0 is first acl executed). */ index: number - /** Description of your ACL ressource */ + /** Description of your ACL ressource. */ description?: string } export type ZonedApiDeleteAclRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of your ACL ressource */ + /** ID of your ACL ressource. */ aclId: string } export type ZonedApiSetAclsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The Frontend to change ACL to */ + /** The Frontend to change ACL to. */ frontendId: string - /** Array of ACLs to erease the existing ACLs */ + /** Array of ACLs to erease the existing ACLs. */ acls: AclSpec[] } export type ZonedApiCreateCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Certificate name */ + /** Certificate name. */ name?: string /** * Let's Encrypt type. @@ -2360,56 +2522,56 @@ export type ZonedApiCreateCertificateRequest = { } export type ZonedApiListCertificatesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Response order */ + /** Response order. */ orderBy?: ListCertificatesRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Use this to search by name */ + /** Use this to search by name. */ name?: string } export type ZonedApiGetCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Certificate ID */ + /** Certificate ID. */ certificateId: string } export type ZonedApiUpdateCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Certificate ID */ + /** Certificate ID. */ certificateId: string - /** Certificate name */ + /** Certificate name. */ name: string } export type ZonedApiDeleteCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Certificate ID */ + /** Certificate ID. */ certificateId: string } export type ZonedApiListLbTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number } export type ZonedApiCreateSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Subscriber name */ + /** Subscriber name. */ name: string /** * Email address configuration. @@ -2442,35 +2604,35 @@ export type ZonedApiCreateSubscriberRequest = { } export type ZonedApiGetSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Subscriber ID */ + /** Subscriber ID. */ subscriberId: string } export type ZonedApiListSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Response order */ + /** Response order. */ orderBy?: ListSubscriberRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Use this to search by name */ + /** Use this to search by name. */ name: string - /** Filter Subscribers by organization ID */ + /** Filter Subscribers by organization ID. */ organizationId?: string - /** Filter Subscribers by project ID */ + /** Filter Subscribers by project ID. */ projectId?: string } export type ZonedApiUpdateSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Assign the resource to a project IDs */ + /** Assign the resource to a project IDs. */ subscriberId: string - /** Subscriber name */ + /** Subscriber name. */ name: string /** * Email address configuration. @@ -2489,47 +2651,47 @@ export type ZonedApiUpdateSubscriberRequest = { } export type ZonedApiDeleteSubscriberRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Subscriber ID */ + /** Subscriber ID. */ subscriberId: string } export type ZonedApiSubscribeToLbRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Subscriber ID */ + /** Subscriber ID. */ subscriberId: string } export type ZonedApiUnsubscribeFromLbRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string } export type ZonedApiListLbPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Response order */ + /** Response order. */ orderBy?: ListPrivateNetworksRequestOrderBy - /** The number of items to return */ + /** The number of items to return. */ pageSize?: number - /** Page number */ + /** Page number. */ page?: number } export type ZonedApiAttachPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Set your instance private network id */ + /** Set your instance private network id. */ privateNetworkId: string /** * Define two local ip address of your choice for each load balancer instance. @@ -2555,10 +2717,10 @@ export type ZonedApiAttachPrivateNetworkRequest = { } export type ZonedApiDetachPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Load balancer ID */ + /** Load balancer ID. */ lbId: string - /** Set your instance private network id */ + /** Set your instance private network id. */ privateNetworkId: string } diff --git a/packages/clients/src/api/marketplace/v1/types.gen.ts b/packages/clients/src/api/marketplace/v1/types.gen.ts index 51df30119..70fc6dbf4 100644 --- a/packages/clients/src/api/marketplace/v1/types.gen.ts +++ b/packages/clients/src/api/marketplace/v1/types.gen.ts @@ -10,29 +10,29 @@ export interface GetVersionResponse { version?: Version } -/** Image */ +/** Image. */ export interface Image { - /** UUID of this image */ + /** UUID of this image. */ id: string - /** Name of the image */ + /** Name of the image. */ name: string - /** Text description of this image */ + /** Text description of this image. */ description: string - /** URL of this image's logo */ + /** URL of this image's logo. */ logo: string - /** List of categories this image belongs to */ + /** List of categories this image belongs to. */ categories: string[] - /** Creation date of this image */ + /** Creation date of this image. */ creationDate?: Date - /** Date of the last modification of this image */ + /** Date of the last modification of this image. */ modificationDate?: Date - /** Expiration date of this image */ + /** Expiration date of this image. */ validUntil?: Date /** Typically an identifier for a distribution (ex. "ubuntu_focal"). */ label: string - /** List of versions of this image */ + /** List of versions of this image. */ versions: Version[] - /** Organization this image belongs to */ + /** Organization this image belongs to. */ organization?: Organization currentPublicVersion: string } @@ -47,15 +47,15 @@ export interface ListVersionsResponse { totalCount: number } -/** Local image */ +/** Local image. */ export interface LocalImage { /** Version you will typically use to define an image in an API call. */ id: string - /** List of all commercial types that are compatible with this local image */ + /** List of all commercial types that are compatible with this local image. */ compatibleCommercialTypes: string[] - /** Supported architecture for this local image */ + /** Supported architecture for this local image. */ arch: string - /** Availability Zone where this local image is available */ + /** Availability Zone where this local image is available. */ zone: Zone } @@ -64,32 +64,32 @@ export interface Organization { name: string } -/** Version */ +/** Version. */ export interface Version { - /** UUID of this version */ + /** UUID of this version. */ id: string - /** Name of this version */ + /** Name of this version. */ name: string - /** Creation date of this image version */ + /** Creation date of this image version. */ creationDate?: Date - /** Date of the last modification of this version */ + /** Date of the last modification of this version. */ modificationDate?: Date - /** List of local images available in this version */ + /** List of local images available in this version. */ localImages: LocalImage[] } export type ListImagesRequest = { /** * A positive integer lower or equal to 100 to select the number of items to - * display + * display. */ perPage?: number - /** A positive integer to choose the page to display */ + /** A positive integer to choose the page to display. */ page?: number } export type GetImageRequest = { - /** Display the image name */ + /** Display the image name. */ imageId: string } diff --git a/packages/clients/src/api/marketplace/v2/types.gen.ts b/packages/clients/src/api/marketplace/v2/types.gen.ts index 5c283a55c..829f85da4 100644 --- a/packages/clients/src/api/marketplace/v2/types.gen.ts +++ b/packages/clients/src/api/marketplace/v2/types.gen.ts @@ -20,23 +20,23 @@ export interface Category { description: string } -/** Image */ +/** Image. */ export interface Image { - /** UUID of this image */ + /** UUID of this image. */ id: string - /** Name of the image */ + /** Name of the image. */ name: string - /** Text description of this image */ + /** Text description of this image. */ description: string - /** URL of this image's logo */ + /** URL of this image's logo. */ logo: string - /** List of categories this image belongs to */ + /** List of categories this image belongs to. */ categories: string[] - /** Creation date of this image */ + /** Creation date of this image. */ createdAt?: Date - /** Date of the last modification of this image */ + /** Date of the last modification of this image. */ updatedAt?: Date - /** Expiration date of this image */ + /** Expiration date of this image. */ validUntil?: Date /** Typically an identifier for a distribution (ex. "ubuntu_focal"). */ label: string @@ -62,54 +62,54 @@ export interface ListVersionsResponse { totalCount: number } -/** Local image */ +/** Local image. */ export interface LocalImage { /** Version you will typically use to define an image in an API call. */ id: string - /** List of all commercial types that are compatible with this local image */ + /** List of all commercial types that are compatible with this local image. */ compatibleCommercialTypes: string[] - /** Supported architecture for this local image */ + /** Supported architecture for this local image. */ arch: string - /** Availability Zone where this local image is available */ + /** Availability Zone where this local image is available. */ zone: Zone - /** Image label this image belongs to */ + /** Image label this image belongs to. */ label: string } -/** Version */ +/** Version. */ export interface Version { - /** UUID of this version */ + /** UUID of this version. */ id: string - /** Name of this version */ + /** Name of this version. */ name: string - /** Creation date of this image version */ + /** Creation date of this image version. */ createdAt?: Date - /** Date of the last modification of this version */ + /** Date of the last modification of this version. */ updatedAt?: Date - /** Date this version was officially published */ + /** Date this version was officially published. */ publishedAt?: Date } export type ListImagesRequest = { /** * A positive integer lower or equal to 100 to select the number of items to - * display + * display. */ pageSize?: number - /** A positive integer to choose the page to display */ + /** A positive integer to choose the page to display. */ page?: number - /** Ordering to use */ + /** Ordering to use. */ orderBy?: ListImagesRequestOrderBy - /** Choose for which machine architecture to return images */ + /** Choose for which machine architecture to return images. */ arch?: string - /** Choose the category of images to get */ + /** Choose the category of images to get. */ category?: string - /** Choose to include end-of-life images */ + /** Choose to include end-of-life images. */ includeEol: boolean } export type GetImageRequest = { - /** Display the image name */ + /** Display the image name. */ imageId: string } diff --git a/packages/clients/src/api/mnq/v1alpha1/types.gen.ts b/packages/clients/src/api/mnq/v1alpha1/types.gen.ts index a724218ca..84c03ec76 100644 --- a/packages/clients/src/api/mnq/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/mnq/v1alpha1/types.gen.ts @@ -22,15 +22,15 @@ export type ListNamespacesRequestOrderBy = export type NamespaceProtocol = 'unknown' | 'nats' | 'sqs_sns' -/** Credential */ +/** Credential. */ export interface Credential { - /** Credential ID */ + /** Credential ID. */ id: string - /** Credential name */ + /** Credential name. */ name: string - /** Namespace containing the Credential */ + /** Namespace containing the Credential. */ namespaceId: string - /** Protocol associated to the Credential */ + /** Protocol associated to the Credential. */ protocol: NamespaceProtocol /** * Credentials file used to connect to the NATS service. @@ -48,31 +48,31 @@ export interface Credential { sqsSnsCredentials?: CredentialSQSSNSCreds } -/** Credential.nats creds file */ +/** Credential.nats creds file. */ export interface CredentialNATSCredsFile { - /** Raw content of the NATS credentials file */ + /** Raw content of the NATS credentials file. */ content: string } -/** Credential.sqssns creds */ +/** Credential.sqssns creds. */ export interface CredentialSQSSNSCreds { - /** ID of the key */ + /** ID of the key. */ accessKey: string - /** Secret value of the key */ + /** Secret value of the key. */ secretKey?: string - /** List of permissions associated to this Credential */ + /** List of permissions associated to this Credential. */ permissions?: Permissions } -/** Credential summary */ +/** Credential summary. */ export interface CredentialSummary { - /** Credential ID */ + /** Credential ID. */ id: string - /** Credential name */ + /** Credential name. */ name: string - /** Namespace containing the Credential */ + /** Namespace containing the Credential. */ namespaceId: string - /** Protocol associated to the Credential */ + /** Protocol associated to the Credential. */ protocol: NamespaceProtocol /** * Credential used to connect to the SQS/SNS service. @@ -82,115 +82,133 @@ export interface CredentialSummary { sqsSnsCredentials?: CredentialSummarySQSSNSCreds } -/** Credential summary.sqssns creds */ +/** Credential summary.sqssns creds. */ export interface CredentialSummarySQSSNSCreds { - /** ID of the key */ + /** ID of the key. */ accessKey: string - /** List of permissions associated to this Credential */ + /** List of permissions associated to this Credential. */ permissions?: Permissions } -/** List credentials response */ +/** List credentials response. */ export interface ListCredentialsResponse { - /** Total number of existing Credentials */ + /** Total number of existing Credentials. */ totalCount: number - /** A page of Credentials */ + /** A page of Credentials. */ credentials: CredentialSummary[] } -/** List namespaces response */ +/** List namespaces response. */ export interface ListNamespacesResponse { - /** Total number of existing Namespaces */ + /** Total number of existing Namespaces. */ totalCount: number - /** A page of Namespaces */ + /** A page of Namespaces. */ namespaces: Namespace[] } -/** Namespace */ +/** Namespace. */ export interface Namespace { - /** Namespace ID */ + /** Namespace ID. */ id: string - /** Namespace name */ + /** Namespace name. */ name: string - /** Endpoint of the service matching the Namespace protocol */ + /** Endpoint of the service matching the Namespace protocol. */ endpoint: string - /** Namespace protocol */ + /** Namespace protocol. */ protocol: NamespaceProtocol - /** Project containing the Namespace */ + /** Project containing the Namespace. */ projectId: string - /** Region where the Namespace is deployed */ + /** Region where the Namespace is deployed. */ region: Region - /** Namespace creation date */ + /** Namespace creation date. */ createdAt?: Date - /** Namespace last modification date */ + /** Namespace last modification date. */ updatedAt?: Date } -/** Permissions */ +/** Permissions. */ export interface Permissions { - /** Defines if user can publish messages to the service */ + /** Defines if user can publish messages to the service. */ canPublish?: boolean - /** Defines if user can receive messages from the service */ + /** Defines if user can receive messages from the service. */ canReceive?: boolean - /** Defines if user can manage the associated resource(s) */ + /** Defines if user can manage the associated resource(s). */ canManage?: boolean } 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?: Region - /** Will list only the Namespaces owned by the specified organization */ + /** Will list only the Namespaces owned by the specified organization. */ organizationId?: string - /** Will list only the Namespaces contained into the specified project */ + /** Will list only the Namespaces contained into the specified project. */ projectId?: string - /** Indicate the page number of results to be returned */ + /** Indicate the page number of results to be returned. */ page?: number - /** Maximum number of results returned by page */ + /** Maximum number of results returned by page. */ pageSize?: number - /** Field used for sorting results */ + /** Field used for sorting results. */ orderBy?: ListNamespacesRequestOrderBy } 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?: Region - /** Namespace name */ + /** Namespace name. */ name?: string - /** Namespace protocol */ + /** Namespace protocol. */ protocol: NamespaceProtocol - /** Project containing the Namespace */ + /** Project containing the Namespace. */ projectId?: string } export type UpdateNamespaceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Namespace to update */ + /** ID of the Namespace to update. */ namespaceId: string - /** Namespace name */ + /** Namespace name. */ name?: string } export type GetNamespaceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Namespace to get */ + /** ID of the Namespace to get. */ namespaceId: 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?: Region - /** ID of the Namespace to delete */ + /** ID of the Namespace to delete. */ namespaceId: string } export type CreateCredentialRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Namespace containing the Credential */ + /** Namespace containing the Credential. */ namespaceId: string - /** Credential name */ + /** Credential name. */ name?: string /** * List of permissions associated to this Credential. @@ -201,31 +219,40 @@ export type CreateCredentialRequest = { } export type DeleteCredentialRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Credential to delete */ + /** ID of the Credential to delete. */ credentialId: string } export type ListCredentialsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Namespace containing the Credential */ + /** Namespace containing the Credential. */ namespaceId?: string - /** Indicate the page number of results to be returned */ + /** Indicate the page number of results to be returned. */ page?: number - /** Maximum number of results returned by page */ + /** Maximum number of results returned by page. */ pageSize?: number - /** Field used for sorting results */ + /** Field used for sorting results. */ orderBy?: ListCredentialsRequestOrderBy } export type UpdateCredentialRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Credential to update */ + /** ID of the Credential to update. */ credentialId: string - /** Credential name */ + /** Credential name. */ name?: string /** * List of permissions associated to this Credential. @@ -236,8 +263,11 @@ export type UpdateCredentialRequest = { } export type GetCredentialRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Credential to get */ + /** ID of the Credential to get. */ credentialId: string } diff --git a/packages/clients/src/api/rdb/v1/types.gen.ts b/packages/clients/src/api/rdb/v1/types.gen.ts index d52d9234e..47ad4d944 100644 --- a/packages/clients/src/api/rdb/v1/types.gen.ts +++ b/packages/clients/src/api/rdb/v1/types.gen.ts @@ -99,7 +99,7 @@ export type NodeTypeStock = export type Permission = 'readonly' | 'readwrite' | 'all' | 'custom' | 'none' -/** Read replica. status */ +/** Read replica. status. */ export type ReadReplicaStatus = | 'unknown' | 'provisioning' @@ -136,15 +136,15 @@ export interface ACLRuleRequest { description: string } -/** Add instance acl rules response */ +/** Add instance acl rules response. */ export interface AddInstanceACLRulesResponse { - /** Rules enabled on the instance */ + /** Rules enabled on the instance. */ rules: ACLRule[] } -/** Add instance settings response */ +/** Add instance settings response. */ export interface AddInstanceSettingsResponse { - /** Settings available on the instance */ + /** Settings available on the instance. */ settings: InstanceSetting[] } @@ -154,77 +154,77 @@ export interface BackupSchedule { disabled: boolean } -/** Database */ +/** Database. */ export interface Database { - /** Name of the database */ + /** Name of the database. */ name: string - /** Name of the owner of the database */ + /** Name of the owner of the database. */ owner: string - /** Whether or not the database is managed or not */ + /** Whether or not the database is managed or not. */ managed: boolean - /** Size of the database */ + /** Size of the database. */ size: number } -/** Database backup */ +/** Database backup. */ export interface DatabaseBackup { - /** UUID of the database backup */ + /** UUID of the database backup. */ id: string - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Name of the database of this backup */ + /** Name of the database of this backup. */ databaseName: string - /** Name of the backup */ + /** Name of the backup. */ name: string - /** Status of the backup */ + /** Status of the backup. */ status: DatabaseBackupStatus - /** Size of the database backup */ + /** Size of the database backup. */ size?: number - /** Expiration date (Format ISO 8601) */ + /** Expiration date (Format ISO 8601). */ expiresAt?: Date - /** Creation date (Format ISO 8601) */ + /** Creation date (Format ISO 8601). */ createdAt?: Date - /** Updated date (Format ISO 8601) */ + /** Updated date (Format ISO 8601). */ updatedAt?: Date - /** Name of the instance of the backup */ + /** Name of the instance of the backup. */ instanceName: string - /** URL you can download the backup from */ + /** URL you can download the backup from. */ downloadUrl?: string - /** Expiration date of the download link */ + /** Expiration date of the download link. */ downloadUrlExpiresAt?: Date - /** Region of this database backup */ + /** Region of this database backup. */ region: Region - /** Store logical backups in the same region as the source database instance */ + /** Store logical backups in the same region as the source database instance. */ sameRegion: boolean } -/** Database engine */ +/** Database engine. */ export interface DatabaseEngine { - /** Engine name */ + /** Engine name. */ name: string - /** Engine logo URL */ + /** Engine logo URL. */ logoUrl: string - /** Available versions */ + /** Available versions. */ versions: EngineVersion[] - /** Region of this database engine */ + /** Region of this database engine. */ region: Region } -/** Delete instance acl rules response */ +/** Delete instance acl rules response. */ export interface DeleteInstanceACLRulesResponse { - /** ACL rules present on the instance */ + /** ACL rules present on the instance. */ rules: ACLRule[] } -/** Delete instance settings response */ +/** Delete instance settings response. */ export interface DeleteInstanceSettingsResponse { - /** Settings names to delete from the instance */ + /** Settings names to delete from the instance. */ settings: InstanceSetting[] } -/** Endpoint */ +/** Endpoint. */ export interface Endpoint { - /** UUID of the endpoint */ + /** UUID of the endpoint. */ id: string /** * IPv4 address of the endpoint. @@ -232,9 +232,9 @@ export interface Endpoint { * One-of ('address'): at most one of 'ip', 'hostname' could be set. */ ip?: string - /** TCP port of the endpoint */ + /** TCP port of the endpoint. */ port: number - /** Name of the endpoint */ + /** Name of the endpoint. */ name?: string /** * Private network details. One at the most per RDB instance or read replica @@ -273,17 +273,17 @@ export interface EndpointDirectAccessDetails {} export interface EndpointLoadBalancerDetails {} -/** Endpoint. private network details */ +/** Endpoint. private network details. */ export interface EndpointPrivateNetworkDetails { - /** UUID of the private network */ + /** UUID of the private network. */ privateNetworkId: string - /** CIDR notation of the endpoint IPv4 address */ + /** CIDR notation of the endpoint IPv4 address. */ serviceIp: string - /** Private network zone */ + /** Private network zone. */ zone: Zone } -/** Endpoint spec */ +/** Endpoint spec. */ export interface EndpointSpec { /** * Load balancer endpoint specifications. Public endpoint for RDB instances @@ -306,9 +306,9 @@ export interface EndpointSpec { export interface EndpointSpecLoadBalancer {} -/** Endpoint spec. private network */ +/** Endpoint spec. private network. */ export interface EndpointSpecPrivateNetwork { - /** UUID of the private network to be connected to the database instance */ + /** UUID of the private network to be connected to the database instance. */ privateNetworkId: string /** * Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and @@ -317,119 +317,119 @@ export interface EndpointSpecPrivateNetwork { serviceIp: string } -/** Engine setting */ +/** Engine setting. */ export interface EngineSetting { - /** Setting name from database engine */ + /** Setting name from database engine. */ name: string - /** Value set when not specified */ + /** Value set when not specified. */ defaultValue: string - /** Setting can be applied without restarting */ + /** Setting can be applied without restarting. */ hotConfigurable: boolean - /** Setting description */ + /** Setting description. */ description: string - /** Setting type */ + /** Setting type. */ propertyType: EngineSettingPropertyType - /** Setting base unit */ + /** Setting base unit. */ unit?: string - /** Validation regex for string type settings */ + /** Validation regex for string type settings. */ stringConstraint?: string - /** Minimum value for int types */ + /** Minimum value for int types. */ intMin?: number - /** Maximum value for int types */ + /** Maximum value for int types. */ intMax?: number - /** Minimum value for float types */ + /** Minimum value for float types. */ floatMin?: number - /** Maximum value for float types */ + /** Maximum value for float types. */ floatMax?: number } -/** Engine version */ +/** Engine version. */ export interface EngineVersion { - /** Database engine version */ + /** Database engine version. */ version: string - /** Database engine name */ + /** Database engine name. */ name: string - /** End of life date */ + /** End of life date. */ endOfLife?: Date - /** Engine settings available to be set */ + /** Engine settings available to be set. */ availableSettings: EngineSetting[] - /** Disabled versions cannot be created */ + /** Disabled versions cannot be created. */ disabled: boolean - /** Beta status of engine version */ + /** Beta status of engine version. */ beta: boolean - /** Engine settings available to be set at database initialisation */ + /** Engine settings available to be set at database initialisation. */ availableInitSettings: EngineSetting[] } -/** Instance */ +/** Instance. */ export interface Instance { - /** Creation date (Format ISO 8601) */ + /** Creation date (Format ISO 8601). */ createdAt?: Date - /** Volumes of the instance */ + /** Volumes of the instance. */ volume?: Volume - /** Region the instance is in */ + /** Region the instance is in. */ region: Region - /** UUID of the instance */ + /** UUID of the instance. */ id: string - /** Name of the instance */ + /** Name of the instance. */ name: string - /** Organization ID the instance belongs to */ + /** Organization ID the instance belongs to. */ organizationId: string - /** Project ID the instance belongs to */ + /** Project ID the instance belongs to. */ projectId: string - /** Status of the instance */ + /** Status of the instance. */ status: InstanceStatus - /** Database engine of the database (PostgreSQL, MySQL, ...) */ + /** Database engine of the database (PostgreSQL, MySQL, ...). */ engine: string - /** Available database engine versions for upgrade */ + /** Available database engine versions for upgrade. */ upgradableVersion: UpgradableVersion[] - /** @deprecated Endpoint of the instance */ + /** @deprecated Endpoint of the instance. */ endpoint?: Endpoint - /** List of tags applied to the instance */ + /** List of tags applied to the instance. */ tags: string[] - /** Advanced settings of the instance */ + /** Advanced settings of the instance. */ settings: InstanceSetting[] - /** Backup schedule of the instance */ + /** Backup schedule of the instance. */ backupSchedule?: BackupSchedule - /** Whether or not High-Availability is enabled */ + /** Whether or not High-Availability is enabled. */ isHaCluster: boolean - /** Read replicas of the instance */ + /** Read replicas of the instance. */ readReplicas: ReadReplica[] - /** Node type of the instance */ + /** Node type of the instance. */ nodeType: string - /** List of engine settings to be set at database initialisation */ + /** List of engine settings to be set at database initialisation. */ initSettings: InstanceSetting[] - /** List of instance endpoints */ + /** List of instance endpoints. */ endpoints: Endpoint[] - /** Logs policy of the instance */ + /** Logs policy of the instance. */ logsPolicy?: LogsPolicy - /** Store logical backups in the same region as the database instance */ + /** Store logical backups in the same region as the database instance. */ backupSameRegion: boolean - /** List of instance maintenances */ + /** List of instance maintenances. */ maintenances: Maintenance[] } -/** Instance log */ +/** Instance log. */ export interface InstanceLog { - /** Presigned S3 URL to download your log file */ + /** Presigned S3 URL to download your log file. */ downloadUrl?: string - /** UUID of the instance log */ + /** UUID of the instance log. */ id: string - /** Status of the logs in a given instance */ + /** Status of the logs in a given instance. */ status: InstanceLogStatus - /** Name of the undelying node */ + /** Name of the undelying node. */ nodeName: string - /** Expiration date (Format ISO 8601) */ + /** Expiration date (Format ISO 8601). */ expiresAt?: Date - /** Creation date (Format ISO 8601) */ + /** Creation date (Format ISO 8601). */ createdAt?: Date - /** Region the instance is in */ + /** Region the instance is in. */ region: Region } -/** Instance metrics */ +/** Instance metrics. */ export interface InstanceMetrics { - /** Time series of metrics of a given instance */ + /** Time series of metrics of a given instance. */ timeseries: TimeSeries[] } @@ -438,41 +438,41 @@ export interface InstanceSetting { value: string } -/** List database backups response */ +/** List database backups response. */ export interface ListDatabaseBackupsResponse { - /** List of database backups */ + /** List of database backups. */ databaseBackups: DatabaseBackup[] - /** Total count of database backups available */ + /** Total count of database backups available. */ totalCount: number } -/** List database engines response */ +/** List database engines response. */ export interface ListDatabaseEnginesResponse { - /** List of the available database engines */ + /** List of the available database engines. */ engines: DatabaseEngine[] - /** Total count of database engines available */ + /** Total count of database engines available. */ totalCount: number } -/** List databases response */ +/** List databases response. */ export interface ListDatabasesResponse { - /** List of the databases */ + /** List of the databases. */ databases: Database[] - /** Total count of databases present on a given instance */ + /** Total count of databases present on a given instance. */ totalCount: number } -/** List instance acl rules response */ +/** List instance acl rules response. */ export interface ListInstanceACLRulesResponse { - /** List of the ACL rules present on a given instance */ + /** List of the ACL rules present on a given instance. */ rules: ACLRule[] - /** Total count of ACL rules present on a given instance */ + /** Total count of ACL rules present on a given instance. */ totalCount: number } -/** List instance logs details response */ +/** List instance logs details response. */ export interface ListInstanceLogsDetailsResponse { - /** Remote instance logs details */ + /** Remote instance logs details. */ details: ListInstanceLogsDetailsResponseInstanceLogDetail[] } @@ -481,155 +481,155 @@ export interface ListInstanceLogsDetailsResponseInstanceLogDetail { size: number } -/** List instance logs response */ +/** List instance logs response. */ export interface ListInstanceLogsResponse { - /** Available logs in a given instance */ + /** Available logs in a given instance. */ instanceLogs: InstanceLog[] } -/** List instances response */ +/** List instances response. */ export interface ListInstancesResponse { - /** List all instances available in a given organization/project */ + /** List all instances available in a given organization/project. */ instances: Instance[] - /** Total count of instances available in a given organization/project */ + /** Total count of instances available in a given organization/project. */ totalCount: number } -/** List node types response */ +/** List node types response. */ export interface ListNodeTypesResponse { - /** Types of the node */ + /** Types of the node. */ nodeTypes: NodeType[] - /** Total count of node-types available */ + /** Total count of node-types available. */ totalCount: number } -/** List privileges response */ +/** List privileges response. */ export interface ListPrivilegesResponse { - /** Privileges of a given user in a given database in a given instance */ + /** Privileges of a given user in a given database in a given instance. */ privileges: Privilege[] - /** Total count of privileges present on a given database */ + /** Total count of privileges present on a given database. */ totalCount: number } -/** List snapshots response */ +/** List snapshots response. */ export interface ListSnapshotsResponse { - /** List of snapshots */ + /** List of snapshots. */ snapshots: Snapshot[] - /** Total count of snapshots available */ + /** Total count of snapshots available. */ totalCount: number } -/** List users response */ +/** List users response. */ export interface ListUsersResponse { - /** List of users in a given instance */ + /** List of users in a given instance. */ users: User[] - /** Total count of users present on a given instance */ + /** Total count of users present on a given instance. */ totalCount: number } -/** Logs policy */ +/** Logs policy. */ export interface LogsPolicy { - /** Max age (in day) of remote logs to keep on the database instance */ + /** Max age (in day) of remote logs to keep on the database instance. */ maxAgeRetention?: number - /** Max disk size of remote logs to keep on the database instance */ + /** Max disk size of remote logs to keep on the database instance. */ totalDiskRetention?: number } -/** Maintenance */ +/** Maintenance. */ export interface Maintenance { - /** Start date of the maintenance window */ + /** Start date of the maintenance window. */ startsAt?: Date - /** End date of the maintenance window */ + /** End date of the maintenance window. */ stopsAt?: Date - /** Closed maintenance date */ + /** Closed maintenance date. */ closedAt?: Date - /** Maintenance information message */ + /** Maintenance information message. */ reason: string - /** Status of the maintenance */ + /** Status of the maintenance. */ status: MaintenanceStatus } -/** Node type */ +/** Node type. */ export interface NodeType { - /** Node Type name identifier */ + /** Node Type name identifier. */ name: string - /** Current stock status for the Node Type */ + /** Current stock status for the Node Type. */ stockStatus: NodeTypeStock - /** Current specs of the offer */ + /** Current specs of the offer. */ description: string - /** Number of virtual CPUs */ + /** Number of virtual CPUs. */ vcpus: number - /** Quantity of RAM */ + /** Quantity of RAM. */ memory: number - /** @deprecated {undefined} Deprecated Node Type volume constraints */ + /** @deprecated {undefined} Deprecated Node Type volume constraints. */ volumeConstraint?: NodeTypeVolumeConstraintSizes - /** @deprecated The Node Type is compliant with Block Storage */ + /** @deprecated The Node Type is compliant with Block Storage. */ isBssdCompatible?: boolean - /** The Node Type is currently disabled */ + /** The Node Type is currently disabled. */ disabled: boolean - /** The Node Type is currently in beta */ + /** The Node Type is currently in beta. */ beta: boolean - /** Available storage options for the Node Type */ + /** Available storage options for the Node Type. */ availableVolumeTypes: NodeTypeVolumeType[] - /** The Node Type can be used only with high availability option */ + /** The Node Type can be used only with high availability option. */ isHaRequired: boolean - /** Generation associated the NodeType offer */ + /** Generation associated the NodeType offer. */ generation: NodeTypeGeneration - /** Region the Node Type is in */ + /** Region the Node Type is in. */ region: Region } -/** Node type. volume constraint sizes */ +/** Node type. volume constraint sizes. */ export interface NodeTypeVolumeConstraintSizes { - /** [deprecated] Mimimum size required for the Volume */ + /** [deprecated] Mimimum size required for the Volume. */ minSize: number - /** [deprecated] Maximum size required for the Volume */ + /** [deprecated] Maximum size required for the Volume. */ maxSize: number } -/** Node type. volume type */ +/** Node type. volume type. */ export interface NodeTypeVolumeType { - /** Volume Type */ + /** Volume Type. */ type: VolumeType - /** The description of the Volume */ + /** The description of the Volume. */ description: string - /** Mimimum size required for the Volume */ + /** Mimimum size required for the Volume. */ minSize: number - /** Maximum size required for the Volume */ + /** Maximum size required for the Volume. */ maxSize: number - /** Minimum increment level for a Block Storage volume size */ + /** Minimum increment level for a Block Storage volume size. */ chunkSize: number } -/** Prepare instance logs response */ +/** Prepare instance logs response. */ export interface PrepareInstanceLogsResponse { - /** Instance logs for a given instance between a start and an end date */ + /** Instance logs for a given instance between a start and an end date. */ instanceLogs: InstanceLog[] } -/** Privilege */ +/** Privilege. */ export interface Privilege { - /** Permission (Read, Read/Write, All, Custom) */ + /** Permission (Read, Read/Write, All, Custom). */ permission: Permission - /** Name of the database */ + /** Name of the database. */ databaseName: string - /** Name of the user */ + /** Name of the user. */ userName: string } -/** Read replica */ +/** Read replica. */ export interface ReadReplica { - /** UUID of the read replica */ + /** UUID of the read replica. */ id: string - /** Display read replica connection information */ + /** Display read replica connection information. */ endpoints: Endpoint[] - /** Read replica status */ + /** Read replica status. */ status: ReadReplicaStatus - /** Region the read replica is in */ + /** Region the read replica is in. */ region: Region } -/** Read replica endpoint spec */ +/** Read replica endpoint spec. */ export interface ReadReplicaEndpointSpec { /** * Direct access endpoint specifications. Public endpoint reserved for read @@ -651,9 +651,9 @@ export interface ReadReplicaEndpointSpec { export interface ReadReplicaEndpointSpecDirectAccess {} -/** Read replica endpoint spec. private network */ +/** Read replica endpoint spec. private network. */ export interface ReadReplicaEndpointSpecPrivateNetwork { - /** UUID of the private network to be connected to the read replica */ + /** UUID of the private network to be connected to the read replica. */ privateNetworkId: string /** * Endpoint IPv4 adress with a CIDR notation. Check documentation about IP and @@ -662,41 +662,41 @@ export interface ReadReplicaEndpointSpecPrivateNetwork { serviceIp: string } -/** Set instance acl rules response */ +/** Set instance acl rules response. */ export interface SetInstanceACLRulesResponse { - /** ACLs rules configured for an instance */ + /** ACLs rules configured for an instance. */ rules: ACLRule[] } -/** Set instance settings response */ +/** Set instance settings response. */ export interface SetInstanceSettingsResponse { - /** Settings configured for a given instance */ + /** Settings configured for a given instance. */ settings: InstanceSetting[] } -/** Snapshot */ +/** Snapshot. */ export interface Snapshot { - /** UUID of the snapshot */ + /** UUID of the snapshot. */ id: string - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Name of the snapshot */ + /** Name of the snapshot. */ name: string - /** Status of the snapshot */ + /** Status of the snapshot. */ status: SnapshotStatus - /** Size of the snapshot */ + /** Size of the snapshot. */ size?: number - /** Expiration date (Format ISO 8601) */ + /** Expiration date (Format ISO 8601). */ expiresAt?: Date - /** Creation date (Format ISO 8601) */ + /** Creation date (Format ISO 8601). */ createdAt?: Date - /** Updated date (Format ISO 8601) */ + /** Updated date (Format ISO 8601). */ updatedAt?: Date - /** Name of the instance of the snapshot */ + /** Name of the instance of the snapshot. */ instanceName: string - /** Source node type */ + /** Source node type. */ nodeType: string - /** Region of this snapshot */ + /** Region of this snapshot. */ region: Region } @@ -707,18 +707,18 @@ export interface UpgradableVersion { minorVersion: string } -/** User */ +/** User. */ export interface User { /** * Name of the user (Length must be between 1 and 63 characters, The max * Length is 32 for MySQL engines, First character must be an alphabet * character (a-zA-Z), Your Username cannot start with '_rdb', Only - * a-zA-Z0-9_$- characters are accepted) + * a-zA-Z0-9_$- characters are accepted). */ name: string /** * Whether or not a user got administrative privileges on the database - * instance + * instance. */ isAdmin: boolean } @@ -729,106 +729,136 @@ export interface Volume { } export type ListDatabaseEnginesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Name of the Database Engine */ + /** Name of the Database Engine. */ name?: string - /** Version of the Database Engine */ + /** Version of the Database Engine. */ version?: string page?: number pageSize?: number } export type ListNodeTypesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Whether or not to include disabled types */ + /** Whether or not to include disabled types. */ includeDisabledTypes: boolean page?: number pageSize?: number } export type ListDatabaseBackupsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Name of the database backups */ + /** Name of the database backups. */ name?: string - /** Criteria to use when ordering database backups listing */ + /** Criteria to use when ordering database backups listing. */ orderBy?: ListDatabaseBackupsRequestOrderBy - /** UUID of the instance */ + /** UUID of the instance. */ instanceId?: string - /** Organization ID the database backups belongs to */ + /** Organization ID the database backups belongs to. */ organizationId?: string - /** Project ID the database backups belongs to */ + /** Project ID the database backups belongs to. */ projectId?: string page?: number pageSize?: number } export type CreateDatabaseBackupRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Name of the database you want to make a backup of */ + /** Name of the database you want to make a backup of. */ databaseName: string - /** Name of the backup */ + /** Name of the backup. */ name?: string - /** Expiration date (Format ISO 8601) */ + /** Expiration date (Format ISO 8601). */ expiresAt?: Date } export type GetDatabaseBackupRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the database backup */ + /** UUID of the database backup. */ databaseBackupId: string } export type UpdateDatabaseBackupRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the database backup to update */ + /** UUID of the database backup to update. */ databaseBackupId: string - /** Name of the Database Backup */ + /** Name of the Database Backup. */ name?: string - /** Expiration date (Format ISO 8601) */ + /** Expiration date (Format ISO 8601). */ expiresAt?: Date } export type DeleteDatabaseBackupRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the database backup to delete */ + /** UUID of the database backup to delete. */ databaseBackupId: string } export type RestoreDatabaseBackupRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Backup of a logical database */ + /** Backup of a logical database. */ databaseBackupId: string /** * Defines the destination database in order to restore into a specified * database, the default destination is set to the origin database of the - * backup + * backup. */ databaseName?: string - /** Defines the rdb instance where the backup has to be restored */ + /** Defines the rdb instance where the backup has to be restored. */ instanceId: string } export type ExportDatabaseBackupRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the database backup you want to export */ + /** UUID of the database backup you want to export. */ databaseBackupId: string } export type UpgradeInstanceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to upgrade */ + /** UUID of the instance you want to upgrade. */ instanceId: string /** * Node type of the instance you want to upgrade to. @@ -869,31 +899,40 @@ export type UpgradeInstanceRequest = { } export type ListInstancesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** List instance that have a given tags */ + /** List instance that have a given tags. */ tags?: string[] - /** List instance that match a given name pattern */ + /** List instance that match a given name pattern. */ name?: string - /** Criteria to use when ordering instance listing */ + /** Criteria to use when ordering instance listing. */ orderBy?: ListInstancesRequestOrderBy - /** Please use `project_id` instead */ + /** Please use `project_id` instead. */ organizationId?: string - /** Project ID to list the instance of */ + /** Project ID to list the instance of. */ projectId?: string page?: number pageSize?: number } export type GetInstanceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string } export type CreateInstanceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** * @deprecated Please use `project_id` instead. @@ -909,466 +948,595 @@ export type CreateInstanceRequest = { * could be set. */ projectId?: string - /** Name of the instance */ + /** Name of the instance. */ name?: string - /** Database engine of the database (PostgreSQL, MySQL, ...) */ + /** Database engine of the database (PostgreSQL, MySQL, ...). */ engine: string - /** Name of the user created when the instance is created */ + /** Name of the user created when the instance is created. */ userName: string - /** Password of the user */ + /** Password of the user. */ password: string - /** Type of node to use for the instance */ + /** Type of node to use for the instance. */ nodeType: string - /** Whether or not High-Availability is enabled */ + /** Whether or not High-Availability is enabled. */ isHaCluster: boolean - /** Whether or not backups are disabled */ + /** Whether or not backups are disabled. */ disableBackup: boolean - /** Tags to apply to the instance */ + /** Tags to apply to the instance. */ tags?: string[] - /** List of engine settings to be set at database initialisation */ + /** List of engine settings to be set at database initialisation. */ initSettings?: InstanceSetting[] - /** Type of volume where data are stored (lssd, bssd, ...) */ + /** Type of volume where data are stored (lssd, bssd, ...). */ volumeType?: VolumeType - /** Volume size when volume_type is not lssd */ + /** Volume size when volume_type is not lssd. */ volumeSize: number /** * One or multiple EndpointSpec used to expose your database instance. A - * load_balancer public endpoint is systematically created + * load_balancer public endpoint is systematically created. */ initEndpoints?: EndpointSpec[] - /** Store logical backups in the same region as the database instance */ + /** Store logical backups in the same region as the database instance. */ backupSameRegion: boolean } export type UpdateInstanceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance to update */ + /** UUID of the instance to update. */ instanceId: string - /** In hours */ + /** In hours. */ backupScheduleFrequency?: number - /** In days */ + /** In days. */ backupScheduleRetention?: number - /** Whether or not the backup schedule is disabled */ + /** Whether or not the backup schedule is disabled. */ isBackupScheduleDisabled?: boolean - /** Name of the instance */ + /** Name of the instance. */ name?: string - /** Tags of a given instance */ + /** Tags of a given instance. */ tags?: string[] - /** Logs policy of the instance */ + /** Logs policy of the instance. */ logsPolicy?: LogsPolicy - /** Store logical backups in the same region as the database instance */ + /** Store logical backups in the same region as the database instance. */ backupSameRegion?: boolean } export type DeleteInstanceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance to delete */ + /** UUID of the instance to delete. */ instanceId: string } export type CloneInstanceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to clone */ + /** UUID of the instance you want to clone. */ instanceId: string - /** Name of the clone instance */ + /** Name of the clone instance. */ name: string - /** Node type of the clone */ + /** Node type of the clone. */ nodeType?: string } export type RestartInstanceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to restart */ + /** UUID of the instance you want to restart. */ instanceId: string } export type GetInstanceCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string } export type RenewInstanceCertificateRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want logs of */ + /** UUID of the instance you want logs of. */ instanceId: string } export type GetInstanceMetricsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Start date to gather metrics from */ + /** Start date to gather metrics from. */ startDate?: Date - /** End date to gather metrics from */ + /** End date to gather metrics from. */ endDate?: Date - /** Name of the metric to gather */ + /** Name of the metric to gather. */ metricName?: string } export type CreateReadReplicaRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want a read replica of */ + /** UUID of the instance you want a read replica of. */ instanceId: string - /** Specification of the endpoint you want to create */ + /** Specification of the endpoint you want to create. */ endpointSpec?: ReadReplicaEndpointSpec[] } export type GetReadReplicaRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the read replica */ + /** UUID of the read replica. */ readReplicaId: string } export type DeleteReadReplicaRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the read replica */ + /** UUID of the read replica. */ readReplicaId: string } export type ResetReadReplicaRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the read replica */ + /** UUID of the read replica. */ readReplicaId: string } export type CreateReadReplicaEndpointRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the read replica */ + /** UUID of the read replica. */ readReplicaId: string - /** Specification of the endpoint you want to create */ + /** Specification of the endpoint you want to create. */ endpointSpec: ReadReplicaEndpointSpec[] } export type PrepareInstanceLogsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want logs of */ + /** UUID of the instance you want logs of. */ instanceId: string /** * Start datetime of your log. Format: - * `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` + * `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z`. */ startDate?: Date /** * End datetime of your log. Format: - * `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z` + * `{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z`. */ endDate?: Date } export type ListInstanceLogsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want logs of */ + /** UUID of the instance you want logs of. */ instanceId: string - /** Criteria to use when ordering instance logs listing */ + /** Criteria to use when ordering instance logs listing. */ orderBy?: ListInstanceLogsRequestOrderBy } export type GetInstanceLogRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance_log you want */ + /** UUID of the instance_log you want. */ instanceLogId: string } export type PurgeInstanceLogsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want logs of */ + /** UUID of the instance you want logs of. */ instanceId: string - /** Specific log name to purge */ + /** Specific log name to purge. */ logName?: string } export type ListInstanceLogsDetailsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want logs of */ + /** UUID of the instance you want logs of. */ instanceId: string } export type AddInstanceSettingsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to add settings to */ + /** UUID of the instance you want to add settings to. */ instanceId: string - /** Settings to add on the instance */ + /** Settings to add on the instance. */ settings: InstanceSetting[] } export type DeleteInstanceSettingsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance to delete settings from */ + /** UUID of the instance to delete settings from. */ instanceId: string - /** Settings names to delete */ + /** Settings names to delete. */ settingNames: string[] } export type SetInstanceSettingsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance where the settings has to be set */ + /** UUID of the instance where the settings has to be set. */ instanceId: string - /** Settings to define for the instance */ + /** Settings to define for the instance. */ settings: InstanceSetting[] } export type ListInstanceACLRulesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string page?: number pageSize?: number } export type AddInstanceACLRulesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to add acl rules to */ + /** UUID of the instance you want to add acl rules to. */ instanceId: string - /** ACLs rules to add to the instance */ + /** ACLs rules to add to the instance. */ rules: ACLRuleRequest[] } export type SetInstanceACLRulesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance where the ACL rules has to be set */ + /** UUID of the instance where the ACL rules has to be set. */ instanceId: string - /** ACL rules to define for the instance */ + /** ACL rules to define for the instance. */ rules: ACLRuleRequest[] } export type DeleteInstanceACLRulesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to delete an ACL rules from */ + /** UUID of the instance you want to delete an ACL rules from. */ instanceId: string - /** ACL rules IP present on the instance */ + /** ACL rules IP present on the instance. */ aclRuleIps: string[] } export type ListUsersRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Name of the user */ + /** Name of the user. */ name?: string - /** Criteria to use when ordering users listing */ + /** Criteria to use when ordering users listing. */ orderBy?: ListUsersRequestOrderBy page?: number pageSize?: number } export type CreateUserRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to create a user in */ + /** UUID of the instance you want to create a user in. */ instanceId: string - /** Name of the user you want to create */ + /** Name of the user you want to create. */ name: string - /** Password of the user you want to create */ + /** Password of the user you want to create. */ password: string - /** Whether the user you want to create will have administrative privileges */ + /** Whether the user you want to create will have administrative privileges. */ isAdmin: boolean } export type UpdateUserRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance the user belongs to */ + /** UUID of the instance the user belongs to. */ instanceId: string - /** Name of the database user */ + /** Name of the database user. */ name: string - /** Password of the database user */ + /** Password of the database user. */ password?: string - /** Whether or not this user got administrative privileges */ + /** Whether or not this user got administrative privileges. */ isAdmin?: boolean } export type DeleteUserRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance to delete a user from */ + /** UUID of the instance to delete a user from. */ instanceId: string - /** Name of the user */ + /** Name of the user. */ name: string } export type ListDatabasesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance to list database of */ + /** UUID of the instance to list database of. */ instanceId: string - /** Name of the database */ + /** Name of the database. */ name?: string - /** Whether or not the database is managed */ + /** Whether or not the database is managed. */ managed?: boolean - /** User that owns this database */ + /** User that owns this database. */ owner?: string - /** Criteria to use when ordering database listing */ + /** Criteria to use when ordering database listing. */ orderBy?: ListDatabasesRequestOrderBy page?: number pageSize?: number } export type CreateDatabaseRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance where to create the database */ + /** UUID of the instance where to create the database. */ instanceId: string - /** Name of the database */ + /** Name of the database. */ name: string } export type DeleteDatabaseRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance where to delete the database */ + /** UUID of the instance where to delete the database. */ instanceId: string - /** Name of the database to delete */ + /** Name of the database to delete. */ name: string } export type ListPrivilegesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Criteria to use when ordering privileges listing */ + /** Criteria to use when ordering privileges listing. */ orderBy?: ListPrivilegesRequestOrderBy page?: number pageSize?: number - /** Name of the database */ + /** Name of the database. */ databaseName?: string - /** Name of the user */ + /** Name of the user. */ userName?: string } export type SetPrivilegeRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Name of the database */ + /** Name of the database. */ databaseName: string - /** Name of the user */ + /** Name of the user. */ userName: string - /** Permission to set (Read, Read/Write, All, Custom) */ + /** Permission to set (Read, Read/Write, All, Custom). */ permission?: Permission } export type ListSnapshotsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Name of the snapshot */ + /** Name of the snapshot. */ name?: string - /** Criteria to use when ordering snapshot listing */ + /** Criteria to use when ordering snapshot listing. */ orderBy?: ListSnapshotsRequestOrderBy - /** UUID of the instance */ + /** UUID of the instance. */ instanceId?: string - /** Organization ID the snapshots belongs to */ + /** Organization ID the snapshots belongs to. */ organizationId?: string - /** Project ID the snapshots belongs to */ + /** Project ID the snapshots belongs to. */ projectId?: string page?: number pageSize?: number } export type GetSnapshotRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the snapshot */ + /** UUID of the snapshot. */ snapshotId: string } export type CreateSnapshotRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance */ + /** UUID of the instance. */ instanceId: string - /** Name of the snapshot */ + /** Name of the snapshot. */ name?: string - /** Expiration date (Format ISO 8601) */ + /** Expiration date (Format ISO 8601). */ expiresAt?: Date } export type UpdateSnapshotRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the snapshot to update */ + /** UUID of the snapshot to update. */ snapshotId: string - /** Name of the snapshot */ + /** Name of the snapshot. */ name?: string - /** Expiration date (Format ISO 8601) */ + /** Expiration date (Format ISO 8601). */ expiresAt?: Date } export type DeleteSnapshotRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the snapshot to delete */ + /** UUID of the snapshot to delete. */ snapshotId: string } export type CreateInstanceFromSnapshotRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Block snapshot of the instance */ + /** Block snapshot of the instance. */ snapshotId: string - /** Name of the instance created with the snapshot */ + /** Name of the instance created with the snapshot. */ instanceName: string - /** Whether or not High-Availability is enabled on the new instance */ + /** Whether or not High-Availability is enabled on the new instance. */ isHaCluster?: boolean - /** The node type used to restore the snapshot */ + /** The node type used to restore the snapshot. */ nodeType?: string } export type CreateEndpointRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the instance you want to add endpoint to */ + /** UUID of the instance you want to add endpoint to. */ instanceId: string - /** Specification of the endpoint you want to create */ + /** Specification of the endpoint you want to create. */ endpointSpec?: EndpointSpec } export type DeleteEndpointRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region /** This endpoint can also be used to delete a read replica endpoint. */ endpointId: string } export type GetEndpointRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the endpoint you want to get */ + /** UUID of the endpoint you want to get. */ endpointId: string } export type MigrateEndpointRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** UUID of the endpoint you want to migrate */ + /** UUID of the endpoint you want to migrate. */ endpointId: string - /** UUID of the instance you want to attach the endpoint to */ + /** UUID of the instance you want to attach the endpoint to. */ instanceId: string } diff --git a/packages/clients/src/api/redis/v1/types.gen.ts b/packages/clients/src/api/redis/v1/types.gen.ts index 8e561f7a5..e593c7852 100644 --- a/packages/clients/src/api/redis/v1/types.gen.ts +++ b/packages/clients/src/api/redis/v1/types.gen.ts @@ -32,135 +32,135 @@ export type NodeTypeStock = | 'out_of_stock' | 'available' -/** Acl rule */ +/** Acl rule. */ export interface ACLRule { - /** ID of the rule */ + /** ID of the rule. */ id: string - /** IPv4 network address of the rule */ + /** IPv4 network address of the rule. */ ipCidr?: string - /** Description of the rule */ + /** Description of the rule. */ description?: string } -/** Acl rule spec */ +/** Acl rule spec. */ export interface ACLRuleSpec { - /** IPv4 network address of the rule */ + /** IPv4 network address of the rule. */ ipCidr: string - /** Description of the rule */ + /** Description of the rule. */ description: string } -/** Add acl rules response */ +/** Add acl rules response. */ export interface AddAclRulesResponse { - /** ACL Rules enabled on the cluster */ + /** ACL Rules enabled on the cluster. */ aclRules: ACLRule[] - /** Total count of acl rules of the cluster */ + /** Total count of acl rules of the cluster. */ totalCount: number } -/** Add endpoints response */ +/** Add endpoints response. */ export interface AddEndpointsResponse { - /** Endpoints defined on the cluster */ + /** Endpoints defined on the cluster. */ endpoints: Endpoint[] - /** Total count of endpoints of the cluster */ + /** Total count of endpoints of the cluster. */ totalCount: number } -/** Available cluster setting */ +/** Available cluster setting. */ export interface AvailableClusterSetting { - /** Name of the setting */ + /** Name of the setting. */ name: string - /** Default value of the setting */ + /** Default value of the setting. */ defaultValue?: string - /** Type of the setting */ + /** Type of the setting. */ type: AvailableClusterSettingPropertyType - /** Description of the setting */ + /** Description of the setting. */ description: string - /** Optional maximum value of the setting */ + /** Optional maximum value of the setting. */ maxValue?: number - /** Optional minimum value of the setting */ + /** Optional minimum value of the setting. */ minValue?: number - /** Optional validation rule of the setting */ + /** Optional validation rule of the setting. */ regex?: string - /** Whether the setting is deprecated */ + /** Whether the setting is deprecated. */ deprecated: boolean } -/** Cluster */ +/** Cluster. */ export interface Cluster { - /** UUID of the cluster */ + /** UUID of the cluster. */ id: string - /** Name of the cluster */ + /** Name of the cluster. */ name: string - /** Project ID the cluster belongs to */ + /** Project ID the cluster belongs to. */ projectId: string - /** Status of the cluster */ + /** Status of the cluster. */ status: ClusterStatus - /** Redis™ engine version of the cluster */ + /** Redis™ engine version of the cluster. */ version: string - /** List of cluster endpoints */ + /** List of cluster endpoints. */ endpoints: Endpoint[] - /** List of tags applied to the cluster */ + /** List of tags applied to the cluster. */ tags: string[] - /** Node type of the cluster */ + /** Node type of the cluster. */ nodeType: string - /** Creation date (Format ISO 8601) */ + /** Creation date (Format ISO 8601). */ createdAt?: Date - /** Update date (Format ISO 8601) */ + /** Update date (Format ISO 8601). */ updatedAt?: Date - /** Whether or not TLS is enabled */ + /** Whether or not TLS is enabled. */ tlsEnabled: boolean - /** List of cluster settings */ + /** List of cluster settings. */ clusterSettings: ClusterSetting[] - /** List of acl rules */ + /** List of acl rules. */ aclRules: ACLRule[] - /** Number of nodes of the cluster */ + /** Number of nodes of the cluster. */ clusterSize: number - /** Zone of the cluster */ + /** Zone of the cluster. */ zone: Zone - /** Name of the user associated to the cluster */ + /** Name of the user associated to the cluster. */ userName: string - /** List of versions the cluster can be migrated to */ + /** List of versions the cluster can be migrated to. */ upgradableVersions: string[] } -/** Cluster metrics response */ +/** Cluster metrics response. */ export interface ClusterMetricsResponse { - /** Time series of metrics of a given cluster */ + /** Time series of metrics of a given cluster. */ timeseries: TimeSeries[] } -/** Cluster setting */ +/** Cluster setting. */ export interface ClusterSetting { - /** Value of the setting */ + /** Value of the setting. */ value: string - /** Name of the setting */ + /** Name of the setting. */ name: string } -/** Cluster settings response */ +/** Cluster settings response. */ export interface ClusterSettingsResponse { - /** Settings configured for a given cluster */ + /** Settings configured for a given cluster. */ settings: ClusterSetting[] } -/** Cluster version */ +/** Cluster version. */ export interface ClusterVersion { - /** Redis™ engine version */ + /** Redis™ engine version. */ version: string - /** End of life date */ + /** End of life date. */ endOfLifeAt?: Date - /** Cluster settings available to be set */ + /** Cluster settings available to be set. */ availableSettings: AvailableClusterSetting[] - /** Redis™ logo url */ + /** Redis™ logo url. */ logoUrl: string - /** Zone of the Managed Database for Redis™ */ + /** Zone of the Managed Database for Redis™. */ zone: Zone } -/** Endpoint */ +/** Endpoint. */ export interface Endpoint { - /** TCP port of the endpoint */ + /** TCP port of the endpoint. */ port: number /** * Private network details. @@ -176,13 +176,13 @@ export interface Endpoint { * be set. */ publicNetwork?: PublicNetwork - /** Lis of IPv4 address of the endpoint */ + /** Lis of IPv4 address of the endpoint. */ ips: string[] - /** UUID of the endpoint */ + /** UUID of the endpoint. */ id: string } -/** Endpoint spec */ +/** Endpoint spec. */ export interface EndpointSpec { /** * Private network spec details. @@ -200,9 +200,9 @@ export interface EndpointSpec { publicNetwork?: EndpointSpecPublicNetworkSpec } -/** Endpoint spec. private network spec */ +/** Endpoint spec. private network spec. */ export interface EndpointSpecPrivateNetworkSpec { - /** UUID of the private network to be connected to the cluster */ + /** UUID of the private network to be connected to the cluster. */ id: string /** * Endpoint IPv4 adress with a CIDR notation. You must provide at least one @@ -211,97 +211,97 @@ export interface EndpointSpecPrivateNetworkSpec { serviceIps: string[] } -/** Endpoint spec. public network spec */ +/** Endpoint spec. public network spec. */ export interface EndpointSpecPublicNetworkSpec {} -/** List cluster versions response */ +/** List cluster versions response. */ export interface ListClusterVersionsResponse { - /** List of the available Redis™ engine versions */ + /** List of the available Redis™ engine versions. */ versions: ClusterVersion[] - /** Total count of available Redis™ engine versions */ + /** Total count of available Redis™ engine versions. */ totalCount: number } -/** List clusters response */ +/** List clusters response. */ export interface ListClustersResponse { - /** List all clusters */ + /** List all clusters. */ clusters: Cluster[] - /** Total count of clusters */ + /** Total count of clusters. */ totalCount: number } -/** List node types response */ +/** List node types response. */ export interface ListNodeTypesResponse { - /** Types of the node */ + /** Types of the node. */ nodeTypes: NodeType[] - /** Total count of node-types available */ + /** Total count of node-types available. */ totalCount: number } -/** Node type */ +/** Node type. */ export interface NodeType { - /** Node Type name identifier */ + /** Node Type name identifier. */ name: string - /** Current stock status for the Node Type */ + /** Current stock status for the Node Type. */ stockStatus: NodeTypeStock - /** Current specs of the offer */ + /** Current specs of the offer. */ description: string - /** Number of virtual CPUs */ + /** Number of virtual CPUs. */ vcpus: number - /** Quantity of RAM */ + /** Quantity of RAM. */ memory: number - /** The Node Type is currently disabled */ + /** The Node Type is currently disabled. */ disabled: boolean - /** The Node Type is currently in beta */ + /** The Node Type is currently in beta. */ beta: boolean - /** Zone the Node Type is in */ + /** Zone the Node Type is in. */ zone: Zone } -/** Private network */ +/** Private network. */ export interface PrivateNetwork { - /** UUID of the private network */ + /** UUID of the private network. */ id: string - /** List of IPv4 CIDR notation addresses of the endpoint */ + /** List of IPv4 CIDR notation addresses of the endpoint. */ serviceIps: string[] - /** Private network zone */ + /** Private network zone. */ zone: Zone } export interface PublicNetwork {} -/** Set acl rules response */ +/** Set acl rules response. */ export interface SetAclRulesResponse { - /** ACL Rules enabled on the cluster */ + /** ACL Rules enabled on the cluster. */ aclRules: ACLRule[] } -/** Set endpoints response */ +/** Set endpoints response. */ export interface SetEndpointsResponse { - /** Endpoints defined on the cluster */ + /** Endpoints defined on the cluster. */ endpoints: Endpoint[] } export type CreateClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The project ID on which to create the cluster */ + /** The project ID on which to create the cluster. */ projectId?: string - /** Name of the cluster */ + /** Name of the cluster. */ name?: string - /** Redis™ engine version of the cluster */ + /** Redis™ engine version of the cluster. */ version: string - /** Tags to apply to the cluster */ + /** Tags to apply to the cluster. */ tags?: string[] - /** Type of node to use for the cluster */ + /** Type of node to use for the cluster. */ nodeType: string - /** Name of the user created when the cluster is created */ + /** Name of the user created when the cluster is created. */ userName: string - /** Password of the user */ + /** Password of the user. */ password: string - /** Number of nodes for the cluster */ + /** Number of nodes for the cluster. */ clusterSize?: number - /** List of ACLRuleSpec used to secure your publicly exposed cluster */ + /** List of ACLRuleSpec used to secure your publicly exposed cluster. */ aclRules?: ACLRuleSpec[] /** * Zero or multiple EndpointSpec used to expose your cluster publicly and @@ -309,57 +309,57 @@ export type CreateClusterRequest = { * publicly exposed by default. */ endpoints?: EndpointSpec[] - /** Whether or not TLS is enabled */ + /** Whether or not TLS is enabled. */ tlsEnabled: boolean - /** List of cluster settings to be set at cluster initialisation */ + /** List of cluster settings to be set at cluster initialisation. */ clusterSettings?: ClusterSetting[] } export type UpdateClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster to update */ + /** UUID of the cluster to update. */ clusterId: string - /** Name of the cluster */ + /** Name of the cluster. */ name?: string - /** Tags of a given cluster */ + /** Tags of a given cluster. */ tags?: string[] - /** Name of the cluster user */ + /** Name of the cluster user. */ userName?: string - /** Password of the cluster user */ + /** Password of the cluster user. */ password?: string } export type GetClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster */ + /** UUID of the cluster. */ clusterId: string } export type ListClustersRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Tags of the clusters to filter upon */ + /** Tags of the clusters to filter upon. */ tags?: string[] - /** Name of the clusters to filter upon */ + /** Name of the clusters to filter upon. */ name?: string - /** Criteria to use when ordering cluster listing */ + /** Criteria to use when ordering cluster listing. */ orderBy?: ListClustersRequestOrderBy - /** Project ID to list the cluster of */ + /** Project ID to list the cluster of. */ projectId?: string - /** Organization ID to list the cluster of */ + /** Organization ID to list the cluster of. */ organizationId?: string - /** Version of the clusters to filter upon */ + /** Version of the clusters to filter upon. */ version?: string page?: number pageSize?: number } export type MigrateClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster to update */ + /** UUID of the cluster to update. */ clusterId: string /** * Redis™ engine version of the cluster. @@ -385,156 +385,156 @@ export type MigrateClusterRequest = { } export type DeleteClusterRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster to delete */ + /** UUID of the cluster to delete. */ clusterId: string } export type GetClusterMetricsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster */ + /** UUID of the cluster. */ clusterId: string - /** Start date to gather metrics from */ + /** Start date to gather metrics from. */ startAt?: Date - /** End date to gather metrics from */ + /** End date to gather metrics from. */ endAt?: Date - /** Name of the metric to gather */ + /** Name of the metric to gather. */ metricName?: string } export type ListNodeTypesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Whether or not to include disabled types */ + /** Whether or not to include disabled types. */ includeDisabledTypes: boolean page?: number pageSize?: number } export type ListClusterVersionsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** Whether or not to include disabled Redis™ engine versions */ + /** Whether or not to include disabled Redis™ engine versions. */ includeDisabled: boolean - /** Whether or not to include beta Redis™ engine versions */ + /** Whether or not to include beta Redis™ engine versions. */ includeBeta: boolean - /** Whether or not to include deprecated Redis™ engine versions */ + /** Whether or not to include deprecated Redis™ engine versions. */ includeDeprecated: boolean - /** List Redis™ engine versions that match a given name pattern */ + /** List Redis™ engine versions that match a given name pattern. */ version?: string page?: number pageSize?: number } export type GetClusterCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster */ + /** UUID of the cluster. */ clusterId: string } export type RenewClusterCertificateRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster */ + /** UUID of the cluster. */ clusterId: string } export type AddClusterSettingsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster you want to add settings to */ + /** UUID of the cluster you want to add settings to. */ clusterId: string - /** Settings to add on the cluster */ + /** Settings to add on the cluster. */ settings: ClusterSetting[] } export type DeleteClusterSettingRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster where the settings has to be set */ + /** UUID of the cluster where the settings has to be set. */ clusterId: string - /** Setting name to delete */ + /** Setting name to delete. */ settingName: string } export type SetClusterSettingsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster where the settings has to be set */ + /** UUID of the cluster where the settings has to be set. */ clusterId: string - /** Settings to define for the cluster */ + /** Settings to define for the cluster. */ settings: ClusterSetting[] } export type SetAclRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster where the ACL rules has to be set */ + /** UUID of the cluster where the ACL rules has to be set. */ clusterId: string - /** ACLs rules to define for the cluster */ + /** ACLs rules to define for the cluster. */ aclRules: ACLRuleSpec[] } export type AddAclRulesRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster you want to add acl rules to */ + /** UUID of the cluster you want to add acl rules to. */ clusterId: string - /** ACLs rules to add to the cluster */ + /** ACLs rules to add to the cluster. */ aclRules: ACLRuleSpec[] } export type DeleteAclRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the acl rule you want to delete */ + /** UUID of the acl rule you want to delete. */ aclId: string } export type GetAclRuleRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the acl rule you want to get */ + /** UUID of the acl rule you want to get. */ aclId: string } export type SetEndpointsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster where the endpoints has to be set */ + /** UUID of the cluster where the endpoints has to be set. */ clusterId: string - /** Endpoints to define for the cluster */ + /** Endpoints to define for the cluster. */ endpoints: EndpointSpec[] } export type AddEndpointsRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the cluster you want to add endpoints to */ + /** UUID of the cluster you want to add endpoints to. */ clusterId: string - /** Endpoints to add to the cluster */ + /** Endpoints to add to the cluster. */ endpoints: EndpointSpec[] } export type DeleteEndpointRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the endpoint you want to delete */ + /** UUID of the endpoint you want to delete. */ endpointId: string } export type GetEndpointRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** UUID of the endpoint you want to get */ + /** UUID of the endpoint you want to get. */ endpointId: string } export type UpdateEndpointRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone endpointId: string /** diff --git a/packages/clients/src/api/registry/v1/types.gen.ts b/packages/clients/src/api/registry/v1/types.gen.ts index 6ce218343..63372454b 100644 --- a/packages/clients/src/api/registry/v1/types.gen.ts +++ b/packages/clients/src/api/registry/v1/types.gen.ts @@ -39,22 +39,22 @@ export type NamespaceStatus = export type TagStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked' -/** Image */ +/** Image. */ export interface Image { - /** The unique ID of the Image */ + /** The unique ID of the Image. */ id: string - /** The Image name, unique in a namespace */ + /** The Image name, unique in a namespace. */ name: string - /** The unique ID of the Namespace the image belongs to */ + /** The unique ID of the Namespace the image belongs to. */ namespaceId: string - /** The status of the image */ + /** The status of the image. */ status: ImageStatus - /** Details of the image status */ + /** Details of the image status. */ statusMessage?: string /** * A `public` image is pullable from internet without authentication, opposed * to a `private` image. `inherit` will use the namespace `is_public` - * parameter + * parameter. */ visibility: ImageVisibility /** @@ -63,127 +63,136 @@ export interface Image { * two images is counted twice. */ size: number - /** Creation date */ + /** Creation date. */ createdAt?: Date - /** Last modification date, from the user or the service */ + /** Last modification date, from the user or the service. */ updatedAt?: Date - /** List of docker tags of the image */ + /** List of docker tags of the image. */ tags: string[] } -/** List images response */ +/** List images response. */ export interface ListImagesResponse { - /** Paginated list of images matching filters */ + /** Paginated list of images matching filters. */ images: Image[] - /** Total number of images matching filters */ + /** Total number of images matching filters. */ totalCount: number } -/** List namespaces response */ +/** List namespaces response. */ export interface ListNamespacesResponse { - /** Paginated list of namespaces matching filters */ + /** Paginated list of namespaces matching filters. */ namespaces: Namespace[] - /** Total number of namespaces matching filters */ + /** Total number of namespaces matching filters. */ totalCount: number } -/** List tags response */ +/** List tags response. */ export interface ListTagsResponse { - /** Paginated list of tags matching filters */ + /** Paginated list of tags matching filters. */ tags: Tag[] - /** Total number of tags matching filters */ + /** Total number of tags matching filters. */ totalCount: number } -/** Namespace */ +/** Namespace. */ export interface Namespace { - /** The unique ID of the namespace */ + /** The unique ID of the namespace. */ id: string - /** The name of the namespace, unique in a region accross all organizations */ + /** The name of the namespace, unique in a region accross all organizations. */ name: string - /** Description of the namespace */ + /** Description of the namespace. */ description: string - /** Owner of the namespace */ + /** Owner of the namespace. */ organizationId: string - /** Project of the namespace */ + /** Project of the namespace. */ projectId: string - /** Namespace status */ + /** Namespace status. */ status: NamespaceStatus - /** Namespace status details */ + /** Namespace status details. */ statusMessage: string - /** Endpoint reachable by docker */ + /** Endpoint reachable by docker. */ endpoint: string - /** Namespace visibility policy */ + /** Namespace visibility policy. */ isPublic: boolean /** * Total size of the namespace, calculated as the sum of the size of all - * images in the namespace + * images in the namespace. */ size: number - /** Creation date */ + /** Creation date. */ createdAt?: Date - /** Last modification date, from the user or the service */ + /** Last modification date, from the user or the service. */ updatedAt?: Date - /** Number of images in the namespace */ + /** Number of images in the namespace. */ imageCount: number - /** Region the namespace belongs to */ + /** Region the namespace belongs to. */ region: Region } -/** Tag */ +/** Tag. */ export interface Tag { - /** The unique ID of the tag */ + /** The unique ID of the tag. */ id: string - /** Tag name, unique for an image */ + /** Tag name, unique for an image. */ name: string - /** Image ID this tag belongs to */ + /** Image ID this tag belongs to. */ imageId: string - /** Tag status */ + /** Tag status. */ status: TagStatus /** * Hash of the tag actual content. Several tags of a same image may have the - * same digest + * same digest. */ digest: string - /** Creation date */ + /** Creation date. */ createdAt?: Date - /** Last modification date, from the user or the service */ + /** Last modification date, from the user or the service. */ updatedAt?: Date } 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?: Region - /** A positive integer to choose the page to display */ + /** A positive integer to choose the page to display. */ page?: number /** * A positive integer lower or equal to 100 to select the number of items to - * display + * display. */ pageSize?: number - /** Field by which to order the display of Images */ + /** Field by which to order the display of Images. */ orderBy?: ListNamespacesRequestOrderBy - /** Filter by Organization ID */ + /** Filter by Organization ID. */ organizationId?: string - /** Filter by Project ID */ + /** Filter by Project ID. */ projectId?: string - /** Filter by the namespace name (exact match) */ + /** Filter by the namespace name (exact match). */ name?: string } export 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?: Region - /** The unique ID of the Namespace */ + /** The unique ID of the Namespace. */ namespaceId: string } export type CreateNamespaceRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Define a namespace name */ + /** Define a namespace name. */ name?: string - /** Define a description */ + /** Define a description. */ description: string /** * @deprecated Assign the namespace owner (deprecated). @@ -199,110 +208,137 @@ export type CreateNamespaceRequest = { * could be set. */ projectId?: string - /** Define the default visibility policy */ + /** Define the default visibility policy. */ isPublic: boolean } 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?: Region - /** Namespace ID to update */ + /** Namespace ID to update. */ namespaceId: string - /** Define a description */ + /** Define a description. */ description?: string - /** Define the default visibility policy */ + /** Define the default visibility policy. */ isPublic?: boolean } 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?: Region - /** The unique ID of the Namespace */ + /** The unique ID of the Namespace. */ namespaceId: string } export type ListImagesRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** A positive integer to choose the page to display */ + /** A positive integer to choose the page to display. */ page?: number /** * A positive integer lower or equal to 100 to select the number of items to - * display + * display. */ pageSize?: number - /** Field by which to order the display of Images */ + /** Field by which to order the display of Images. */ orderBy?: ListImagesRequestOrderBy - /** Filter by the Namespace ID */ + /** Filter by the Namespace ID. */ namespaceId?: string - /** Filter by the Image name (exact match) */ + /** Filter by the Image name (exact match). */ name?: string - /** Filter by Organization ID */ + /** Filter by Organization ID. */ organizationId?: string - /** Filter by Project ID */ + /** Filter by Project ID. */ projectId?: string } export type GetImageRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The unique ID of the Image */ + /** The unique ID of the Image. */ imageId: string } export type UpdateImageRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Image ID to update */ + /** Image ID to update. */ imageId: string /** * A `public` image is pullable from internet without authentication, opposed * to a `private` image. `inherit` will use the namespace `is_public` - * parameter + * parameter. */ visibility?: ImageVisibility } export type DeleteImageRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The unique ID of the Image */ + /** The unique ID of the Image. */ imageId: string } export type ListTagsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The unique ID of the image */ + /** The unique ID of the image. */ imageId: string - /** A positive integer to choose the page to display */ + /** A positive integer to choose the page to display. */ page?: number /** * A positive integer lower or equal to 100 to select the number of items to - * display + * display. */ pageSize?: number - /** Field by which to order the display of Images */ + /** Field by which to order the display of Images. */ orderBy?: ListTagsRequestOrderBy - /** Filter by the tag name (exact match) */ + /** Filter by the tag name (exact match). */ name?: string } export type GetTagRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The unique ID of the Tag */ + /** The unique ID of the Tag. */ tagId: string } export type DeleteTagRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** The unique ID of the tag */ + /** The unique ID of the tag. */ tagId: string /** * If two tags share the same digest the deletion will fail unless this - * parameter is set to true + * parameter is set to true. */ force: boolean } diff --git a/packages/clients/src/api/secret/v1alpha1/types.gen.ts b/packages/clients/src/api/secret/v1alpha1/types.gen.ts index b70259b14..a41765baa 100644 --- a/packages/clients/src/api/secret/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/secret/v1alpha1/types.gen.ts @@ -18,61 +18,61 @@ export type SecretVersionStatus = | 'disabled' | 'destroyed' -/** Access secret version response */ +/** Access secret version response. */ export interface AccessSecretVersionResponse { - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion */ + /** Revision of the SecretVersion. */ revision: number - /** The base64-encoded secret payload of the SecretVersion */ + /** The base64-encoded secret payload of the SecretVersion. */ data: string } -/** List secret versions response */ +/** List secret versions response. */ export interface ListSecretVersionsResponse { - /** Count of all SecretVersions */ + /** Count of all SecretVersions. */ totalCount: number - /** Single page of SecretVersions */ + /** Single page of SecretVersions. */ versions: SecretVersion[] } -/** List secrets response */ +/** List secrets response. */ export interface ListSecretsResponse { - /** Count of all Secrets matching the requested criteria */ + /** Count of all Secrets matching the requested criteria. */ totalCount: number - /** Single page of Secrets matching the requested criteria */ + /** Single page of Secrets matching the requested criteria. */ secrets: Secret[] } -/** Secret */ +/** Secret. */ export interface Secret { - /** ID of the Secret */ + /** ID of the Secret. */ id: string - /** ID of the project containing the Secret */ + /** ID of the project containing the Secret. */ projectId: string - /** Name of the Secret */ + /** Name of the Secret. */ name: string /** - `ready`: the Secret is ready. `locked`: the Secret is locked. */ status: SecretStatus - /** The time at which the Secret was created */ + /** The time at which the Secret was created. */ createdAt?: Date - /** The time at which the Secret was updated */ + /** The time at which the Secret was updated. */ updatedAt?: Date - /** List of tags associated to this Secret */ + /** List of tags associated to this Secret. */ tags: string[] - /** Region of the Secret */ + /** Region of the Secret. */ region: Region - /** The number of versions for this Secret */ + /** The number of versions for this Secret. */ versionCount: number - /** Description of the Secret */ + /** Description of the Secret. */ description?: string } -/** Secret version */ +/** Secret version. */ export interface SecretVersion { - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion */ + /** Revision of the SecretVersion. */ revision: number /** * - `unknown`: the SecretVersion is in an invalid state. `enabled`: the @@ -81,64 +81,79 @@ export interface SecretVersion { * permanently destroyed. */ status: SecretVersionStatus - /** The time at which the SecretVersion was created */ + /** The time at which the SecretVersion was created. */ createdAt?: Date - /** The time at which the SecretVersion was updated */ + /** The time at which the SecretVersion was updated. */ updatedAt?: Date - /** Description of the SecretVersion */ + /** Description of the SecretVersion. */ description?: string } export type CreateSecretRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the project containing the Secret */ + /** ID of the project containing the Secret. */ projectId?: string - /** Name of the Secret */ + /** Name of the Secret. */ name: string - /** List of tags associated to this Secret */ + /** List of tags associated to this Secret. */ tags?: string[] - /** Description of the Secret */ + /** Description of the Secret. */ description?: string } export type GetSecretRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string } export type GetSecretByNameRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Name of the Secret */ + /** Name of the Secret. */ secretName: string } export type UpdateSecretRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** New name of the Secret (optional) */ + /** New name of the Secret (optional). */ name?: string - /** New list of tags associated to this Secret (optional) */ + /** New list of tags associated to this Secret (optional). */ tags?: string[] - /** Description of the Secret */ + /** Description of the Secret. */ description?: string } export type ListSecretsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of an organization to filter on (optional) */ + /** ID of an organization to filter on (optional). */ organizationId?: string - /** ID of a project to filter on (optional) */ + /** ID of a project to filter on (optional). */ projectId?: string - /** Secret name to filter on (optional) */ + /** Secret name to filter on (optional). */ name?: string - /** List of tags to filter on (optional) */ + /** List of tags to filter on (optional). */ tags?: string[] orderBy?: ListSecretsRequestOrderBy page?: number @@ -146,115 +161,151 @@ export type ListSecretsRequest = { } export type DeleteSecretRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string } export type CreateSecretVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** The base64-encoded secret payload of the SecretVersion */ + /** The base64-encoded secret payload of the SecretVersion. */ data: string - /** Description of the SecretVersion */ + /** Description of the SecretVersion. */ description?: string } export type GetSecretVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string } export type GetSecretVersionByNameRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Name of the Secret */ + /** Name of the Secret. */ secretName: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string } export type UpdateSecretVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string - /** Description of the SecretVersion */ + /** Description of the SecretVersion. */ description?: string } export type ListSecretVersionsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string page?: number pageSize?: number - /** Filter results by status */ + /** Filter results by status. */ status?: SecretVersionStatus[] } export type ListSecretVersionsByNameRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Name of the Secret */ + /** Name of the Secret. */ secretName: string page?: number pageSize?: number - /** Filter results by status */ + /** Filter results by status. */ status?: SecretVersionStatus[] } export type DestroySecretVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string } export type EnableSecretVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string } export type DisableSecretVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string } export type AccessSecretVersionRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the Secret */ + /** ID of the Secret. */ secretId: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string } export type AccessSecretVersionByNameRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Name of the Secret */ + /** Name of the Secret. */ secretName: string - /** Revision of the SecretVersion (may be a number or "latest") */ + /** Revision of the SecretVersion (may be a number or "latest"). */ revision: string } diff --git a/packages/clients/src/api/tem/v1alpha1/types.gen.ts b/packages/clients/src/api/tem/v1alpha1/types.gen.ts index 213d3f7a1..7ef8622f2 100644 --- a/packages/clients/src/api/tem/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/tem/v1alpha1/types.gen.ts @@ -21,60 +21,60 @@ export type EmailStatus = | 'failed' | 'canceled' -/** Create email request. address */ +/** Create email request. address. */ export interface CreateEmailRequestAddress { - /** Email address */ + /** Email address. */ email: string - /** Optional display name */ + /** Optional display name. */ name?: string } -/** Create email request. attachment */ +/** Create email request. attachment. */ export interface CreateEmailRequestAttachment { - /** Filename of the attachment */ + /** Filename of the attachment. */ name: string /** * MIME type of the attachment (Currently only allow, text files, pdf and html - * files) + * files). */ type: string - /** Content of the attachment, encoded in base64 */ + /** Content of the attachment, encoded in base64. */ content: string } -/** Create email response */ +/** Create email response. */ export interface CreateEmailResponse { - /** Single page of emails matching the requested criteria */ + /** Single page of emails matching the requested criteria. */ emails: Email[] } -/** Domain */ +/** Domain. */ export interface Domain { - /** ID of the domain */ + /** ID of the domain. */ id: string - /** ID of the organization to which the domain belongs */ + /** ID of the organization to which the domain belongs. */ organizationId: string - /** ID of the project */ + /** ID of the project. */ projectId: string - /** Domain name (example.com) */ + /** Domain name (example.com). */ name: string - /** Status of the domain */ + /** Status of the domain. */ status: DomainStatus - /** Date and time of domain's creation */ + /** Date and time of domain's creation. */ createdAt?: Date - /** Date and time of the next scheduled check */ + /** Date and time of the next scheduled check. */ nextCheckAt?: Date - /** Date and time the domain was last found to be valid */ + /** Date and time the domain was last found to be valid. */ lastValidAt?: Date - /** Date and time of the revocation of the domain */ + /** Date and time of the revocation of the domain. */ revokedAt?: Date - /** Error message if the last check failed */ + /** Error message if the last check failed. */ lastError?: string - /** Snippet of the SPF record that should be registered in the DNS zone */ + /** Snippet of the SPF record that should be registered in the DNS zone. */ spfConfig: string - /** DKIM public key, as should be recorded in the DNS zone */ + /** DKIM public key, as should be recorded in the DNS zone. */ dkimConfig: string - /** Domain's statistics */ + /** Domain's statistics. */ statistics?: DomainStatistics region: Region } @@ -86,39 +86,39 @@ export interface DomainStatistics { canceledCount: number } -/** Email */ +/** Email. */ export interface Email { - /** Technical ID of the email */ + /** Technical ID of the email. */ id: string - /** MessageID of the email */ + /** MessageID of the email. */ messageId: string - /** ID of the project to which the email belongs */ + /** ID of the project to which the email belongs. */ projectId: string - /** Email address of the sender */ + /** Email address of the sender. */ mailFrom: string - /** Email address of the recipient */ + /** Email address of the recipient. */ rcptTo: string - /** Type of the recipient */ + /** Type of the recipient. */ rcptType: EmailRcptType - /** Creation date of the email object */ + /** Creation date of the email object. */ createdAt?: Date - /** Last update time of the email object */ + /** Last update time of the email object. */ updatedAt?: Date - /** Status of the email */ + /** Status of the email. */ status: EmailStatus - /** Additional information on the status */ + /** Additional information on the status. */ statusDetails?: string - /** Total number of attempts to send the email */ + /** Total number of attempts to send the email. */ tryCount: number - /** Informations about the latest three attempts to send the email */ + /** Informations about the latest three attempts to send the email. */ lastTries: EmailTry[] } -/** Email. try */ +/** Email. try. */ export interface EmailTry { - /** Rank number of this attempt to send the email */ + /** Rank number of this attempt to send the email. */ rank: number - /** Date of the attempt */ + /** Date of the attempt. */ triedAt?: Date /** * The SMTP status code received after the attempt. 0 if the attempt did not @@ -132,152 +132,176 @@ export interface EmailTry { message: string } -/** List domains response */ +/** List domains response. */ export interface ListDomainsResponse { - /** Total number of domains matching the request (without pagination) */ + /** Total number of domains matching the request (without pagination). */ totalCount: number domains: Domain[] } -/** List emails response */ +/** List emails response. */ export interface ListEmailsResponse { - /** Count of all emails matching the requested criteria */ + /** Count of all emails matching the requested criteria. */ totalCount: number - /** Single page of emails matching the requested criteria */ + /** Single page of emails matching the requested criteria. */ emails: Email[] } -/** Statistics */ +/** Statistics. */ export interface Statistics { - /** Total number of emails matching the request criteria */ + /** Total number of emails matching the request criteria. */ totalCount: number /** * Number of emails still in the `new` transient state (received from the API, - * not yet processed) + * not yet processed). */ newCount: number /** * Number of emails still in the `sending` transient state (received from the - * API, not yet in their final status) + * API, not yet in their final status). */ sendingCount: number /** * Number of emails in the final `sent` state (have been delivered to the - * target mail system) + * target mail system). */ sentCount: number /** * Number of emails in the final `failed` state (refused by the target mail - * system with a final error status) + * system with a final error status). */ failedCount: number /** * Number of emails in the final `canceled` state (canceled by customer's - * request) + * request). */ canceledCount: number } export type CreateEmailRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Sender information (must be from a checked domain declared in the project) */ + /** Sender information (must be from a checked domain declared in the project). */ from?: CreateEmailRequestAddress - /** Array of recipient information (limited to 1 recipient) */ + /** Array of recipient information (limited to 1 recipient). */ to?: CreateEmailRequestAddress[] - /** Array of recipient information (unimplemented) */ + /** Array of recipient information (unimplemented). */ cc?: CreateEmailRequestAddress[] - /** Array of recipient information (unimplemented) */ + /** Array of recipient information (unimplemented). */ bcc?: CreateEmailRequestAddress[] - /** Message subject */ + /** Message subject. */ subject: string - /** Text content */ + /** Text content. */ text: string - /** HTML content */ + /** HTML content. */ html: string - /** ID of the project in which to create the email */ + /** ID of the project in which to create the email. */ projectId?: string - /** Array of attachments */ + /** Array of attachments. */ attachments?: CreateEmailRequestAttachment[] - /** Maximum date to deliver mail */ + /** Maximum date to deliver mail. */ sendBefore?: Date } export type GetEmailRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the email to retrieve */ + /** ID of the email to retrieve. */ emailId: string } export type ListEmailsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region page?: number pageSize?: number - /** Optional ID of the project in which to list the emails */ + /** Optional ID of the project in which to list the emails. */ projectId?: string - /** Optional ID of the domain for which to list the emails */ + /** Optional ID of the domain for which to list the emails. */ domainId?: string - /** Optional ID of the message for which to list the emails */ + /** Optional ID of the message for which to list the emails. */ messageId?: string - /** Optional, list emails created after this date */ + /** Optional, list emails created after this date. */ since?: Date - /** Optional, list emails created before this date */ + /** Optional, list emails created before this date. */ until?: Date - /** Optional, list emails sent with this `mail_from` sender's address */ + /** Optional, list emails sent with this `mail_from` sender's address. */ mailFrom?: string - /** Optional, list emails sent with this `mail_to` recipient's address */ + /** Optional, list emails sent with this `mail_to` recipient's address. */ mailTo?: string - /** Optional, list emails having any of this status */ + /** Optional, list emails having any of this status. */ statuses?: EmailStatus[] } export type GetStatisticsRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** Optional, count emails for this project */ + /** Optional, count emails for this project. */ projectId?: string /** * Optional, count emails send from this domain (must be coherent with the - * `project_id` and the `organization_id`) + * `project_id` and the `organization_id`). */ domainId?: string - /** Optional, count emails created after this date */ + /** Optional, count emails created after this date. */ since?: Date - /** Optional, count emails created before this date */ + /** Optional, count emails created before this date. */ until?: Date - /** Optional, count emails sent with this `mail_from` sender's address */ + /** Optional, count emails sent with this `mail_from` sender's address. */ mailFrom?: string } export type CancelEmailRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the email to cancel */ + /** ID of the email to cancel. */ emailId: 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?: Region projectId?: string domainName: 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?: Region - /** ID of the domain */ + /** ID of the domain. */ domainId: string } 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?: Region - /** Page number (1 for the first page) */ + /** Page number (1 for the first page). */ page?: number - /** Page size */ + /** Page size. */ pageSize?: number projectId?: string status?: DomainStatus[] @@ -286,15 +310,21 @@ export type ListDomainsRequest = { } export type RevokeDomainRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the domain to revoke */ + /** ID of the domain to revoke. */ domainId: string } export type CheckDomainRequest = { - /** Region to target. If none is passed will use default region from the config */ + /** + * Region to target. If none is passed will use default region from the + * config. + */ region?: Region - /** ID of the domain to check */ + /** ID of the domain to check. */ domainId: string } diff --git a/packages/clients/src/api/test/v1/types.gen.ts b/packages/clients/src/api/test/v1/types.gen.ts index 5c9442d33..538478382 100644 --- a/packages/clients/src/api/test/v1/types.gen.ts +++ b/packages/clients/src/api/test/v1/types.gen.ts @@ -63,7 +63,7 @@ export type ListHumansRequest = { } export type GetHumanRequest = { - /** UUID of the human you want to get */ + /** UUID of the human you want to get. */ humanId: string } @@ -90,7 +90,7 @@ export type CreateHumanRequest = { } export type UpdateHumanRequest = { - /** UUID of the human you want to update */ + /** UUID of the human you want to update. */ humanId: string height?: number shoeSize?: number @@ -104,16 +104,16 @@ export type UpdateHumanRequest = { } export type DeleteHumanRequest = { - /** UUID of the human you want to delete */ + /** UUID of the human you want to delete. */ humanId: string } export type RunHumanRequest = { - /** UUID of the human you want to make run */ + /** UUID of the human you want to make run. */ humanId: string } export type SmokeHumanRequest = { - /** @deprecated UUID of the human you want to make smoking */ + /** @deprecated UUID of the human you want to make smoking. */ humanId?: string } diff --git a/packages/clients/src/api/vpc/v1/types.gen.ts b/packages/clients/src/api/vpc/v1/types.gen.ts index e33fa5a51..ea4b3aff9 100644 --- a/packages/clients/src/api/vpc/v1/types.gen.ts +++ b/packages/clients/src/api/vpc/v1/types.gen.ts @@ -13,85 +13,85 @@ export interface ListPrivateNetworksResponse { totalCount: number } -/** Private network */ +/** Private network. */ export interface PrivateNetwork { - /** The private network ID */ + /** The private network ID. */ id: string - /** The private network name */ + /** The private network name. */ name: string - /** The private network organization */ + /** The private network organization. */ organizationId: string - /** The private network project ID */ + /** The private network project ID. */ projectId: string - /** The zone in which the private network is available */ + /** The zone in which the private network is available. */ zone: Zone - /** The private network tags */ + /** The private network tags. */ tags: string[] - /** The private network creation date */ + /** The private network creation date. */ createdAt?: Date - /** The last private network modification date */ + /** The last private network modification date. */ updatedAt?: Date - /** Private network subnets CIDR */ + /** Private network subnets CIDR. */ subnets: string[] } export type ListPrivateNetworksRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The sort order of the returned private networks */ + /** The sort order of the returned private networks. */ orderBy?: ListPrivateNetworksRequestOrderBy - /** The page number for the returned private networks */ + /** The page number for the returned private networks. */ page?: number - /** The maximum number of private networks per page */ + /** The maximum number of private networks per page. */ pageSize?: number - /** Filter private networks with names containing this string */ + /** Filter private networks with names containing this string. */ name?: string - /** Filter private networks with one or more matching tags */ + /** Filter private networks with one or more matching tags. */ tags?: string[] - /** The organization ID on which to filter the returned private networks */ + /** The organization ID on which to filter the returned private networks. */ organizationId?: string - /** The project ID on which to filter the returned private networks */ + /** The project ID on which to filter the returned private networks. */ projectId?: string - /** The PrivateNetwork IDs on which to filter the returned private networks */ + /** The PrivateNetwork IDs on which to filter the returned private networks. */ privateNetworkIds?: string[] } export type CreatePrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The name of the private network */ + /** The name of the private network. */ name?: string - /** The project ID of the private network */ + /** The project ID of the private network. */ projectId?: string - /** The private networks tags */ + /** The private networks tags. */ tags?: string[] - /** Private network subnets CIDR */ + /** Private network subnets CIDR. */ subnets?: string[] } export type GetPrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The private network id */ + /** The private network id. */ privateNetworkId: string } export type UpdatePrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The private network ID */ + /** The private network ID. */ privateNetworkId: string - /** The name of the private network */ + /** The name of the private network. */ name?: string - /** The private networks tags */ + /** The private networks tags. */ tags?: string[] - /** @deprecated Private network subnets CIDR (deprecated) */ + /** @deprecated Private network subnets CIDR (deprecated). */ subnets?: string[] } export type DeletePrivateNetworkRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** The private network ID */ + /** The private network ID. */ privateNetworkId: string } diff --git a/packages/clients/src/api/vpcgw/v1/types.gen.ts b/packages/clients/src/api/vpcgw/v1/types.gen.ts index e82379153..ded4f03fb 100644 --- a/packages/clients/src/api/vpcgw/v1/types.gen.ts +++ b/packages/clients/src/api/vpcgw/v1/types.gen.ts @@ -71,19 +71,19 @@ export type ListPATRulesRequestOrderBy = export type PATRuleProtocol = 'unknown' | 'both' | 'tcp' | 'udp' -/** Dhcp */ +/** Dhcp. */ 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 - /** Configuration creation date */ + /** Configuration creation date. */ createdAt?: Date - /** Configuration last modification date */ + /** Configuration last modification date. */ updatedAt?: Date - /** Subnet for the DHCP server */ + /** Subnet for the DHCP server. */ subnet: string /** * Address of the DHCP server. This will be the gateway's address in the @@ -92,12 +92,12 @@ export interface DHCP { address: string /** * Low IP (included) of the dynamic address pool. Must be in the config's - * subnet + * subnet. */ poolLow: string /** * High IP (included) of the dynamic address pool. Must be in the config's - * subnet + * subnet. */ poolHigh: string /** @@ -105,7 +105,7 @@ export interface DHCP { * only pre-existing DHCP reservations will be handed out. */ enableDynamic: boolean - /** How long, in seconds, DHCP entries will be valid for */ + /** How long, in seconds, DHCP entries will be valid for. */ validLifetime?: string /** * After how long, in seconds, a renew will be attempted. Must be 30s lower @@ -119,7 +119,7 @@ export interface DHCP { rebindTimer?: string /** * Whether the gateway should push a default route to DHCP clients or only - * hand out IPs + * hand out IPs. */ pushDefaultRoute: boolean /** @@ -129,116 +129,116 @@ export interface DHCP { pushDnsServer: boolean /** * Override the DNS server list pushed to DHCP clients, instead of the gateway - * itself + * itself. */ dnsServersOverride: string[] - /** Add search paths to the pushed DNS configuration */ + /** Add search paths to the pushed DNS configuration. */ dnsSearch: string[] /** * TLD given to hostnames in the Private Network. If an instance with hostname * `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. */ dnsLocalName: string - /** Zone this configuration is available in */ + /** Zone this configuration is available in. */ zone: Zone } -/** Dhcp entry */ +/** Dhcp entry. */ export interface DHCPEntry { - /** Entry ID */ + /** Entry ID. */ id: string - /** Configuration creation date */ + /** Configuration creation date. */ createdAt?: Date - /** Configuration last modification date */ + /** Configuration last modification date. */ updatedAt?: Date - /** Owning GatewayNetwork */ + /** Owning GatewayNetwork. */ gatewayNetworkId: string - /** MAC address of the client machine */ + /** MAC address of the client machine. */ macAddress: string - /** Assigned IP address */ + /** Assigned IP address. */ ipAddress: string - /** Hostname of the client machine */ + /** Hostname of the client machine. */ 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 this entry is available in */ + /** Zone this entry is available in. */ zone: Zone } -/** Gateway */ +/** Gateway. */ 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 */ + /** Gateway type. */ type?: GatewayType - /** Gateway's current status */ + /** Gateway's current status. */ status: GatewayStatus - /** Name of the gateway */ + /** Name of the gateway. */ name: string - /** Tags of the gateway */ + /** Tags of the gateway. */ tags: string[] - /** Public IP of the gateway */ + /** Public IP of the gateway. */ ip?: IP - /** GatewayNetworks attached to the gateway */ + /** GatewayNetworks attached to the gateway. */ gatewayNetworks: GatewayNetwork[] - /** Override the gateway's default recursive DNS servers */ + /** 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 - /** Whether SSH bastion is enabled on the gateway */ + /** Whether SSH bastion is enabled on the gateway. */ bastionEnabled: boolean - /** Port of the SSH bastion */ + /** Port of the SSH bastion. */ bastionPort: number - /** Whether SMTP traffic is allowed to pass through the gateway */ + /** Whether SMTP traffic is allowed to pass through the gateway. */ smtpEnabled: boolean - /** Zone the gateway is available in */ + /** Zone the gateway is available in. */ zone: Zone } -/** Gateway network */ +/** Gateway network. */ export interface GatewayNetwork { - /** ID of the connection */ + /** ID of the 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 gateway */ + /** ID of the connected gateway. */ gatewayId: string - /** ID of the connected private network */ + /** ID of the connected private network. */ privateNetworkId: string /** * MAC address of the gateway in the network (if the gateway is up and - * running) + * running). */ macAddress?: string - /** Whether the gateway masquerades traffic for this network */ + /** Whether the gateway masquerades traffic for this network. */ enableMasquerade: boolean - /** Current status of the gateway network connection */ + /** Current status of the gateway network connection. */ status: GatewayNetworkStatus - /** DHCP configuration for the connected private network */ + /** DHCP configuration for the connected private network. */ dhcp?: DHCP - /** Whether DHCP is enabled on the connected Private Network */ + /** 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 - /** Zone the connection lives in */ + /** Zone the connection lives in. */ zone: Zone } -/** Gateway type */ +/** Gateway type. */ export interface GatewayType { - /** Type name */ + /** Type name. */ name: string /** * Bandwidth, in bps, the gateway has. This is the public bandwidth to the @@ -246,232 +246,232 @@ export interface GatewayType { * Networks. */ bandwidth: number - /** Zone the type is available in */ + /** Zone the type is available in. */ zone: Zone } -/** Ip */ +/** Ip. */ export interface IP { - /** IP ID */ + /** IP ID. */ id: string - /** Owning organization */ + /** Owning organization. */ organizationId: string - /** Owning project */ + /** Owning project. */ projectId: string - /** Configuration creation date */ + /** Configuration creation date. */ createdAt?: Date - /** Configuration last modification date */ + /** Configuration last modification date. */ updatedAt?: Date - /** Tags associated with the IP */ + /** Tags associated with the IP. */ tags: string[] - /** The IP itself */ + /** The IP itself. */ address: string - /** Reverse domain name for the IP address */ + /** Reverse domain name for the IP address. */ reverse?: string - /** Gateway associated to the IP */ + /** Gateway associated to the IP. */ gatewayId?: string - /** Zone this IP is available in */ + /** Zone this IP is available in. */ zone: Zone } -/** List dhcp entries response */ +/** List dhcp entries response. */ export interface ListDHCPEntriesResponse { - /** DHCP entries in this page */ + /** DHCP entries in this page. */ dhcpEntries: DHCPEntry[] - /** Total DHCP entries matching the filter */ + /** Total DHCP entries matching the filter. */ totalCount: number } -/** List dhc ps response */ +/** List dhc ps response. */ export interface ListDHCPsResponse { - /** First page of DHCP configs */ + /** First page of DHCP configs. */ dhcps: DHCP[] - /** Total DHCP configs matching the filter */ + /** Total DHCP configs matching the filter. */ totalCount: number } -/** List gateway networks response */ +/** List gateway networks response. */ export interface ListGatewayNetworksResponse { - /** GatewayNetworks in this page */ + /** GatewayNetworks in this page. */ gatewayNetworks: GatewayNetwork[] - /** Total GatewayNetworks count matching the filter */ + /** Total GatewayNetworks count matching the filter. */ totalCount: number } -/** List gateway types response */ +/** List gateway types response. */ export interface ListGatewayTypesResponse { - /** Available types of gateway */ + /** Available types of gateway. */ types: GatewayType[] } -/** List gateways response */ +/** List gateways response. */ export interface ListGatewaysResponse { - /** Gateways in this page */ + /** Gateways in this page. */ gateways: Gateway[] - /** Total count of gateways matching the filter */ + /** Total count of gateways matching the filter. */ totalCount: number } -/** List i ps response */ +/** List i ps response. */ export interface ListIPsResponse { - /** IPs in this page */ + /** IPs in this page. */ ips: IP[] - /** Total IP count matching the filter */ + /** Total IP count matching the filter. */ totalCount: number } -/** List pat rules response */ +/** List pat rules response. */ export interface ListPATRulesResponse { - /** This page of PAT rules matching the filter */ + /** This page of PAT rules matching the filter. */ patRules: PATRule[] - /** Total PAT rules matching the filter */ + /** Total PAT rules matching the filter. */ totalCount: number } -/** Pat rule */ +/** Pat rule. */ export interface PATRule { - /** Rule ID */ + /** Rule ID. */ id: string - /** Gateway the PAT rule applies to */ + /** Gateway the PAT rule applies to. */ gatewayId: string - /** Rule creation date */ + /** Rule creation date. */ createdAt?: Date - /** Rule last modification date */ + /** Rule last modification date. */ updatedAt?: Date - /** 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 applies to */ + /** Protocol the rule applies to. */ protocol: PATRuleProtocol - /** Zone this rule is available in */ + /** Zone this rule is available in. */ zone: Zone } -/** Set dhcp entries request. entry */ +/** Set dhcp entries request. entry. */ 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. */ macAddress: string - /** IP address to give to the machine */ + /** IP address to give to the machine. */ ipAddress: string } -/** Set dhcp entries response */ +/** Set dhcp entries response. */ export interface SetDHCPEntriesResponse { - /** List of DHCP entries */ + /** List of DHCP entries. */ dhcpEntries: DHCPEntry[] } -/** Set pat rules request. rule */ +/** Set pat rules request. rule. */ export interface SetPATRulesRequestRule { /** * 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 } -/** Set pat rules response */ +/** Set pat rules response. */ export interface SetPATRulesResponse { - /** List of PAT rules */ + /** List of PAT rules. */ patRules: PATRule[] } 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?: Zone - /** Order in which to return results */ + /** Order in which to return results. */ orderBy?: ListGatewaysRequestOrderBy - /** Page number */ + /** Page number. */ 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 gateways including this name */ + /** Filter gateways including this name. */ name?: string - /** Filter gateways with these tags */ + /** Filter gateways with these tags. */ tags?: string[] - /** Filter gateways of this type */ + /** Filter gateways of this type. */ type?: string - /** Filter gateways in this status (unknown for any) */ + /** Filter gateways in this status (unknown for any). */ status?: GatewayStatus - /** Filter gateways attached to this private network */ + /** Filter gateways attached to this private network. */ privateNetworkId?: 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?: Zone - /** ID of the gateway to fetch */ + /** ID of the gateway to fetch. */ gatewayId: 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?: Zone - /** Project to create the gateway into */ + /** Project to create the gateway into. */ projectId?: string - /** Name of the gateway */ + /** Name of the gateway. */ name?: string - /** Tags for the gateway */ + /** Tags for the gateway. */ tags?: string[] - /** Gateway type */ + /** Gateway type. */ type: string /** * Override the gateway's default recursive DNS servers, if DNS features are - * enabled + * enabled. */ upstreamDnsServers?: string[] - /** Attach an existing IP to the gateway */ + /** Attach an existing IP to the gateway. */ ipId?: string - /** Allow SMTP traffic to pass through the gateway */ + /** Allow SMTP traffic to pass through the gateway. */ enableSmtp: boolean - /** Enable SSH bastion on the gateway */ + /** Enable SSH bastion on the gateway. */ enableBastion: boolean - /** Port of the SSH bastion */ + /** Port of the SSH bastion. */ bastionPort?: number } 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?: Zone - /** ID of the gateway to update */ + /** ID of the gateway to update. */ gatewayId: string - /** Name fo the gateway */ + /** Name fo the gateway. */ name?: string - /** Tags for the gateway */ + /** Tags for the gateway. */ tags?: string[] /** * Override the gateway's default recursive DNS servers, if DNS features are - * enabled + * enabled. */ upstreamDnsServers?: string[] - /** Enable SSH bastion on the gateway */ + /** Enable SSH bastion on the gateway. */ enableBastion?: boolean - /** Port of the SSH bastion */ + /** Port of the SSH bastion. */ bastionPort?: number - /** Allow SMTP traffic to pass through the gateway */ + /** Allow SMTP traffic to pass through the gateway. */ enableSmtp?: 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?: Zone - /** ID of the gateway to delete */ + /** ID of the gateway to delete. */ gatewayId: string /** * Whether to cleanup attached DHCP configurations (if any, and if not @@ -481,48 +481,48 @@ export type DeleteGatewayRequest = { } 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?: Zone - /** ID of the gateway to upgrade */ + /** ID of the gateway to upgrade. */ gatewayId: 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?: Zone - /** 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 by gateway */ + /** Filter by gateway. */ gatewayId?: string - /** Filter by private network */ + /** Filter by private network. */ privateNetworkId?: string - /** Filter by masquerade enablement */ + /** Filter by masquerade enablement. */ enableMasquerade?: boolean - /** Filter by DHCP configuration */ + /** Filter by DHCP configuration. */ dhcpId?: string - /** Filter GatewayNetworks by this status (unknown for any) */ + /** Filter GatewayNetworks by this status (unknown for any). */ status?: GatewayNetworkStatus } 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?: Zone - /** ID of the GatewayNetwork to fetch */ + /** ID of the GatewayNetwork to fetch. */ gatewayNetworkId: 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?: Zone - /** Gateway to connect */ + /** Gateway to connect. */ gatewayId: string - /** Private Network to connect */ + /** Private Network to connect. */ privateNetworkId: string - /** Whether to enable masquerade on this network */ + /** Whether to enable masquerade on this network. */ enableMasquerade: boolean /** * Existing configuration. @@ -545,11 +545,11 @@ export type CreateGatewayNetworkRequest = { } 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?: Zone - /** ID of the GatewayNetwork to update */ + /** ID of the GatewayNetwork to update. */ gatewayNetworkId: string - /** New masquerade enablement */ + /** New masquerade enablement. */ enableMasquerade?: boolean /** * New DHCP configuration. @@ -557,7 +557,7 @@ export type UpdateGatewayNetworkRequest = { * One-of ('ipConfig'): at most one of 'dhcpId', 'address' could be set. */ dhcpId?: string - /** Whether to enable DHCP on the connected Private Network */ + /** Whether to enable DHCP on the connected Private Network. */ enableDhcp?: boolean /** * New static IP address. @@ -568,9 +568,9 @@ export type UpdateGatewayNetworkRequest = { } 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?: Zone - /** GatewayNetwork to delete */ + /** GatewayNetwork to delete. */ gatewayNetworkId: string /** * Whether to cleanup the attached DHCP configuration (if any, and if not @@ -580,41 +580,41 @@ export type DeleteGatewayNetworkRequest = { } 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?: Zone - /** 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 DHCPs in this organization */ + /** Include only DHCPs in this organization. */ organizationId?: string - /** Include only DHCPs in this project */ + /** Include only DHCPs in this project. */ projectId?: string - /** Filter on gateway address */ + /** Filter on gateway address. */ address?: string - /** Filter on subnets containing address */ + /** Filter on subnets containing address. */ hasAddress?: 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?: Zone - /** ID of the DHCP config to fetch */ + /** ID of the DHCP config to fetch. */ dhcpId: string } 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?: Zone - /** 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 /** * Address of the DHCP server. This will be the gateway's address in the - * private network. Defaults to the first address of the subnet + * private network. Defaults to the first address of the subnet. */ address?: string /** @@ -650,7 +650,7 @@ export type CreateDHCPRequest = { rebindTimer?: string /** * Whether the gateway should push a default route to DHCP clients or only - * hand out IPs. Defaults to true + * hand out IPs. Defaults to true. */ pushDefaultRoute?: boolean /** @@ -660,10 +660,10 @@ export type CreateDHCPRequest = { pushDnsServer?: boolean /** * Override the DNS server list pushed to DHCP clients, instead of the gateway - * itself + * itself. */ dnsServersOverride?: string[] - /** Additional DNS search paths */ + /** Additional DNS search paths. */ dnsSearch?: string[] /** * TLD given to hostnames in the Private Network. Allowed characters are @@ -674,27 +674,27 @@ export type CreateDHCPRequest = { } 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?: Zone - /** DHCP config to update */ + /** DHCP config to update. */ dhcpId: string - /** Subnet for the DHCP server */ + /** Subnet for the DHCP server. */ subnet?: string /** * Address of the DHCP server. This will be the gateway's address in the - * private network + * private network. */ address?: string - /** Low IP (included) of the dynamic address pool */ + /** Low IP (included) of the dynamic address pool. */ poolLow?: string - /** High IP (included) of the dynamic address pool */ + /** High IP (included) of the dynamic address pool. */ poolHigh?: string /** * Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, * only pre-existing DHCP reservations will be handed out. Defaults to true. */ enableDynamic?: boolean - /** How long, in seconds, DHCP entries will be valid for */ + /** How long, in seconds, DHCP entries will be valid for. */ validLifetime?: string /** * After how long, in seconds, a renew will be attempted. Must be 30s lower @@ -708,7 +708,7 @@ export type UpdateDHCPRequest = { rebindTimer?: string /** * Whether the gateway should push a default route to DHCP clients or only - * hand out IPs + * hand out IPs. */ pushDefaultRoute?: boolean /** @@ -718,10 +718,10 @@ export type UpdateDHCPRequest = { pushDnsServer?: boolean /** * Override the DNS server list pushed to DHCP clients, instead of the gateway - * itself + * itself. */ dnsServersOverride?: string[] - /** Additional DNS search paths */ + /** Additional DNS search paths. */ dnsSearch?: string[] /** * TLD given to hostnames in the Private Network. Allowed characters are @@ -731,211 +731,211 @@ export type UpdateDHCPRequest = { } 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?: Zone - /** DHCP config id to delete */ + /** DHCP config id to delete. */ dhcpId: 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?: Zone - /** 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 entries based on the gateway network they are on */ + /** Filter entries based on the gateway network they are on. */ gatewayNetworkId?: string - /** Filter entries on their MAC address */ + /** Filter entries on their MAC address. */ macAddress?: string - /** Filter entries on their IP address */ + /** Filter entries on their IP address. */ ipAddress?: string - /** Filter entries on their hostname substring */ + /** Filter entries on their hostname substring. */ hostname?: string - /** Filter entries on their type */ + /** Filter entries on their type. */ type?: DHCPEntryType } 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?: Zone - /** ID of the DHCP entry to fetch */ + /** ID of the DHCP entry to fetch. */ dhcpEntryId: 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?: Zone - /** 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 machine */ + /** IP address to give to the machine. */ ipAddress: string } 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?: Zone - /** DHCP entry ID to update */ + /** DHCP entry ID to update. */ dhcpEntryId: string - /** New IP address to give to the machine */ + /** New IP address to give to the machine. */ ipAddress?: 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?: Zone - /** Gateway Network on which to set DHCP reservation list */ + /** Gateway Network on which to set DHCP reservation list. */ gatewayNetworkId: string - /** New list of DHCP reservations */ + /** New list of DHCP reservations. */ dhcpEntries?: SetDHCPEntriesRequestEntry[] } 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?: Zone - /** DHCP entry ID to delete */ + /** DHCP entry ID to delete. */ dhcpEntryId: string } 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?: Zone - /** 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 - /** Fetch rules for this gateway */ + /** Fetch rules for this gateway. */ gatewayId?: string - /** Fetch rules targeting this private ip */ + /** Fetch rules targeting this private ip. */ privateIp?: string - /** Fetch rules for this protocol */ + /** Fetch rules for this protocol. */ protocol?: PATRuleProtocol } 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?: Zone - /** PAT rule to get */ + /** PAT rule to get. */ patRuleId: 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?: Zone - /** Gateway on which to attach the rule to */ + /** Gateway on which to attach the rule to. */ 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 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?: Zone - /** PAT rule to update */ + /** 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 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?: Zone - /** Gateway on which to set the PAT rules */ + /** Gateway on which to set the PAT rules. */ gatewayId: string - /** New list of PAT rules */ + /** New list of PAT rules. */ patRules: SetPATRulesRequestRule[] } 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?: Zone - /** PAT rule to delete */ + /** PAT rule to delete. */ patRuleId: string } 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?: Zone } 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?: Zone - /** Order in which to return results */ + /** Order in which to return results. */ orderBy?: ListIPsRequestOrderBy - /** Page number */ + /** Page number. */ page?: number - /** IPs per page */ + /** IPs per page. */ pageSize?: number - /** Include only IPs in this organization */ + /** Include only IPs in this organization. */ organizationId?: string - /** Include only IPs in this project */ + /** Include only IPs in this project. */ projectId?: string - /** Filter IPs with these tags */ + /** Filter IPs with these tags. */ tags?: string[] - /** Filter by reverse containing this string */ + /** Filter by reverse containing this string. */ reverse?: string - /** Filter whether the IP is attached to a gateway or not */ + /** Filter whether the IP is attached to a gateway or not. */ isFree?: boolean } 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?: Zone - /** ID of the IP to get */ + /** ID of the IP to get. */ ipId: string } 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?: Zone - /** Project to create the IP into */ + /** Project to create the IP into. */ projectId?: string - /** Tags to give to the IP */ + /** Tags to give to the IP. */ tags?: string[] } export type UpdateIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the IP to update */ + /** ID of the IP to update. */ ipId: string - /** Tags to give to the IP */ + /** Tags to give to the IP. */ tags?: string[] - /** Reverse to set on the IP. Empty string to unset */ + /** Reverse to set on the IP. Empty string to unset. */ reverse?: string - /** Gateway to attach the IP to. Empty string to detach */ + /** Gateway to attach the IP to. Empty string to detach. */ gatewayId?: string } export type DeleteIPRequest = { - /** Zone to target. If none is passed will use default zone from the config */ + /** Zone to target. If none is passed will use default zone from the config. */ zone?: Zone - /** ID of the IP to delete */ + /** ID of the IP to delete. */ ipId: 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?: Zone - /** ID of the gateway that needs fresh ssh keys */ + /** ID of the gateway that needs fresh ssh keys. */ gatewayId: string }