diff --git a/packages/clients/src/api/edge_services/v1beta1/api.gen.ts b/packages/clients/src/api/edge_services/v1beta1/api.gen.ts index a456b66a2..d3ea76339 100644 --- a/packages/clients/src/api/edge_services/v1beta1/api.gen.ts +++ b/packages/clients/src/api/edge_services/v1beta1/api.gen.ts @@ -151,7 +151,9 @@ const jsonContentHeaders = { 'Content-Type': 'application/json; charset=utf-8', } -/** Edge Services API. */ +/** + * Edge Services API. + */ export class API extends ParentAPI { protected pageOfListPipelines = ( request: Readonly = {}, @@ -177,10 +179,7 @@ export class API extends ParentAPI { ) /** - * List pipelines. List all pipelines, for a Scaleway Organization or Scaleway - * Project. By default, the pipelines returned in the list are ordered by - * creation date in ascending order, though this can be modified via the - * `order_by` field. + * List pipelines. List all pipelines, for a Scaleway Organization or Scaleway Project. By default, the pipelines returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListPipelinesRequest} * @returns A Promise of ListPipelinesResponse @@ -189,9 +188,7 @@ export class API extends ParentAPI { enrichForPagination('pipelines', this.pageOfListPipelines, request) /** - * Create pipeline. Create a new pipeline. You must specify a `dns_stage_id` - * to form a stage-chain that goes all the way to the backend stage (origin), - * so the HTTP request will be processed according to the stages you created. + * Create pipeline. Create a new pipeline. You must specify a `dns_stage_id` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created. * * @param request - The request {@link CreatePipelineRequest} * @returns A Promise of Pipeline @@ -210,9 +207,7 @@ export class API extends ParentAPI { ) /** - * Get pipeline. Retrieve information about an existing pipeline, specified by - * its `pipeline_id`. Its full details, including errors, are returned in the - * response object. + * Get pipeline. Retrieve information about an existing pipeline, specified by its `pipeline_id`. Its full details, including errors, are returned in the response object. * * @param request - The request {@link GetPipelineRequest} * @returns A Promise of Pipeline @@ -280,9 +275,7 @@ export class API extends ParentAPI { ) /** - * Update pipeline. Update the parameters of an existing pipeline, specified - * by its `pipeline_id`. Parameters which can be updated include the `name`, - * `description` and `dns_stage_id`. + * Update pipeline. Update the parameters of an existing pipeline, specified by its `pipeline_id`. Parameters which can be updated include the `name`, `description` and `dns_stage_id`. * * @param request - The request {@link UpdatePipelineRequest} * @returns A Promise of Pipeline @@ -301,9 +294,7 @@ export class API extends ParentAPI { ) /** - * Delete pipeline. Delete an existing pipeline, specified by its - * `pipeline_id`. Deleting a pipeline is permanent, and cannot be undone. Note - * that all stages linked to the pipeline are also deleted. + * Delete pipeline. Delete an existing pipeline, specified by its `pipeline_id`. Deleting a pipeline is permanent, and cannot be undone. Note that all stages linked to the pipeline are also deleted. * * @param request - The request {@link DeletePipelineRequest} */ @@ -333,12 +324,7 @@ export class API extends ParentAPI { enrichForPagination('headStages', this.pageOfListHeadStages, request) /** - * Configure a entry point to your pipeline. You must specify a `head stage` - * to form a stage-chain that goes all the way to the backend stage (origin), - * so the HTTP request will be processed according to the stages you created.. - * You must specify either a `add_new_head_stage` (to add a new head stage), - * `remove_head_stage` (to remove a head stage) or `swap_head_stage` (to - * replace a head stage). + * Configure a entry point to your pipeline. You must specify a `head stage` to form a stage-chain that goes all the way to the backend stage (origin), so the HTTP request will be processed according to the stages you created.. You must specify either a `add_new_head_stage` (to add a new head stage), `remove_head_stage` (to remove a head stage) or `swap_head_stage` (to replace a head stage). * * @param request - The request {@link SetHeadStageRequest} * @returns A Promise of HeadStageResponse @@ -375,10 +361,7 @@ export class API extends ParentAPI { ) /** - * List DNS stages. List all DNS stages, for a Scaleway Organization or - * Scaleway Project. By default, the DNS stages returned in the list are - * ordered by creation date in ascending order, though this can be modified - * via the `order_by` field. + * List DNS stages. List all DNS stages, for a Scaleway Organization or Scaleway Project. By default, the DNS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListDNSStagesRequest} * @returns A Promise of ListDNSStagesResponse @@ -387,8 +370,7 @@ export class API extends ParentAPI { enrichForPagination('stages', this.pageOfListDNSStages, request) /** - * Create DNS stage. Create a new DNS stage. You must specify the `fqdns` - * field to customize the domain endpoint, using a domain you already own. + * Create DNS stage. Create a new DNS stage. You must specify the `fqdns` field to customize the domain endpoint, using a domain you already own. * * @param request - The request {@link CreateDNSStageRequest} * @returns A Promise of DNSStage @@ -407,9 +389,7 @@ export class API extends ParentAPI { ) /** - * Get DNS stage. Retrieve information about an existing DNS stage, specified - * by its `dns_stage_id`. Its full details, including FQDNs, are returned in - * the response object. + * Get DNS stage. Retrieve information about an existing DNS stage, specified by its `dns_stage_id`. Its full details, including FQDNs, are returned in the response object. * * @param request - The request {@link GetDNSStageRequest} * @returns A Promise of DNSStage @@ -424,8 +404,7 @@ export class API extends ParentAPI { ) /** - * Update DNS stage. Update the parameters of an existing DNS stage, specified - * by its `dns_stage_id`. + * Update DNS stage. Update the parameters of an existing DNS stage, specified by its `dns_stage_id`. * * @param request - The request {@link UpdateDNSStageRequest} * @returns A Promise of DNSStage @@ -444,8 +423,7 @@ export class API extends ParentAPI { ) /** - * Delete DNS stage. Delete an existing DNS stage, specified by its - * `dns_stage_id`. Deleting a DNS stage is permanent, and cannot be undone. + * Delete DNS stage. Delete an existing DNS stage, specified by its `dns_stage_id`. Deleting a DNS stage is permanent, and cannot be undone. * * @param request - The request {@link DeleteDNSStageRequest} */ @@ -475,10 +453,7 @@ export class API extends ParentAPI { ) /** - * List TLS stages. List all TLS stages, for a Scaleway Organization or - * Scaleway Project. By default, the TLS stages returned in the list are - * ordered by creation date in ascending order, though this can be modified - * via the `order_by` field. + * List TLS stages. List all TLS stages, for a Scaleway Organization or Scaleway Project. By default, the TLS stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListTLSStagesRequest} * @returns A Promise of ListTLSStagesResponse @@ -487,12 +462,7 @@ export class API extends ParentAPI { enrichForPagination('stages', this.pageOfListTLSStages, request) /** - * Create TLS stage. Create a new TLS stage. You must specify either the - * `secrets` or `managed_certificate` fields to customize the SSL/TLS - * certificate of your endpoint. Choose `secrets` if you are using a - * pre-existing certificate held in Scaleway Secret Manager, or - * `managed_certificate` to let Scaleway generate and manage a Let's Encrypt - * certificate for your customized endpoint. + * Create TLS stage. Create a new TLS stage. You must specify either the `secrets` or `managed_certificate` fields to customize the SSL/TLS certificate of your endpoint. Choose `secrets` if you are using a pre-existing certificate held in Scaleway Secret Manager, or `managed_certificate` to let Scaleway generate and manage a Let's Encrypt certificate for your customized endpoint. * * @param request - The request {@link CreateTLSStageRequest} * @returns A Promise of TLSStage @@ -511,9 +481,7 @@ export class API extends ParentAPI { ) /** - * Get TLS stage. Retrieve information about an existing TLS stage, specified - * by its `tls_stage_id`. Its full details, including secrets and certificate - * expiration date are returned in the response object. + * Get TLS stage. Retrieve information about an existing TLS stage, specified by its `tls_stage_id`. Its full details, including secrets and certificate expiration date are returned in the response object. * * @param request - The request {@link GetTLSStageRequest} * @returns A Promise of TLSStage @@ -528,9 +496,7 @@ export class API extends ParentAPI { ) /** - * Update TLS stage. Update the parameters of an existing TLS stage, specified - * by its `tls_stage_id`. Both `tls_secrets_config` and `managed_certificate` - * parameters can be updated. + * Update TLS stage. Update the parameters of an existing TLS stage, specified by its `tls_stage_id`. Both `tls_secrets_config` and `managed_certificate` parameters can be updated. * * @param request - The request {@link UpdateTLSStageRequest} * @returns A Promise of TLSStage @@ -549,8 +515,7 @@ export class API extends ParentAPI { ) /** - * Delete TLS stage. Delete an existing TLS stage, specified by its - * `tls_stage_id`. Deleting a TLS stage is permanent, and cannot be undone. + * Delete TLS stage. Delete an existing TLS stage, specified by its `tls_stage_id`. Deleting a TLS stage is permanent, and cannot be undone. * * @param request - The request {@link DeleteTLSStageRequest} */ @@ -580,10 +545,7 @@ export class API extends ParentAPI { ) /** - * List cache stages. List all cache stages, for a Scaleway Organization or - * Scaleway Project. By default, the cache stages returned in the list are - * ordered by creation date in ascending order, though this can be modified - * via the `order_by` field. + * List cache stages. List all cache stages, for a Scaleway Organization or Scaleway Project. By default, the cache stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListCacheStagesRequest} * @returns A Promise of ListCacheStagesResponse @@ -592,8 +554,7 @@ export class API extends ParentAPI { enrichForPagination('stages', this.pageOfListCacheStages, request) /** - * Create cache stage. Create a new cache stage. You must specify the - * `fallback_ttl` field to customize the TTL of the cache. + * Create cache stage. Create a new cache stage. You must specify the `fallback_ttl` field to customize the TTL of the cache. * * @param request - The request {@link CreateCacheStageRequest} * @returns A Promise of CacheStage @@ -612,9 +573,7 @@ export class API extends ParentAPI { ) /** - * Get cache stage. Retrieve information about an existing cache stage, - * specified by its `cache_stage_id`. Its full details, including Time To Live - * (TTL), are returned in the response object. + * Get cache stage. Retrieve information about an existing cache stage, specified by its `cache_stage_id`. Its full details, including Time To Live (TTL), are returned in the response object. * * @param request - The request {@link GetCacheStageRequest} * @returns A Promise of CacheStage @@ -629,9 +588,7 @@ export class API extends ParentAPI { ) /** - * Update cache stage. Update the parameters of an existing cache stage, - * specified by its `cache_stage_id`. Parameters which can be updated include - * the `fallback_ttl` and `backend_stage_id`. + * Update cache stage. Update the parameters of an existing cache stage, specified by its `cache_stage_id`. Parameters which can be updated include the `fallback_ttl` and `backend_stage_id`. * * @param request - The request {@link UpdateCacheStageRequest} * @returns A Promise of CacheStage @@ -650,9 +607,7 @@ export class API extends ParentAPI { ) /** - * Delete cache stage. Delete an existing cache stage, specified by its - * `cache_stage_id`. Deleting a cache stage is permanent, and cannot be - * undone. + * Delete cache stage. Delete an existing cache stage, specified by its `cache_stage_id`. Deleting a cache stage is permanent, and cannot be undone. * * @param request - The request {@link DeleteCacheStageRequest} */ @@ -685,10 +640,7 @@ export class API extends ParentAPI { ) /** - * List backend stages. List all backend stages, for a Scaleway Organization - * or Scaleway Project. By default, the backend stages returned in the list - * are ordered by creation date in ascending order, though this can be - * modified via the `order_by` field. + * List backend stages. List all backend stages, for a Scaleway Organization or Scaleway Project. By default, the backend stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListBackendStagesRequest} * @returns A Promise of ListBackendStagesResponse @@ -697,9 +649,7 @@ export class API extends ParentAPI { enrichForPagination('stages', this.pageOfListBackendStages, request) /** - * Create backend stage. Create a new backend stage. You must specify either a - * `scaleway_s3` (for a Scaleway Object Storage bucket) or `scaleway_lb` (for - * a Scaleway Load Balancer) field to configure the origin. + * Create backend stage. Create a new backend stage. You must specify either a `scaleway_s3` (for a Scaleway Object Storage bucket) or `scaleway_lb` (for a Scaleway Load Balancer) field to configure the origin. * * @param request - The request {@link CreateBackendStageRequest} * @returns A Promise of BackendStage @@ -718,9 +668,7 @@ export class API extends ParentAPI { ) /** - * Get backend stage. Retrieve information about an existing backend stage, - * specified by its `backend_stage_id`. Its full details, including - * `scaleway_s3` or `scaleway_lb`, are returned in the response object. + * Get backend stage. Retrieve information about an existing backend stage, specified by its `backend_stage_id`. Its full details, including `scaleway_s3` or `scaleway_lb`, are returned in the response object. * * @param request - The request {@link GetBackendStageRequest} * @returns A Promise of BackendStage @@ -735,8 +683,7 @@ export class API extends ParentAPI { ) /** - * Update backend stage. Update the parameters of an existing backend stage, - * specified by its `backend_stage_id`. + * Update backend stage. Update the parameters of an existing backend stage, specified by its `backend_stage_id`. * * @param request - The request {@link UpdateBackendStageRequest} * @returns A Promise of BackendStage @@ -755,9 +702,7 @@ export class API extends ParentAPI { ) /** - * Delete backend stage. Delete an existing backend stage, specified by its - * `backend_stage_id`. Deleting a backend stage is permanent, and cannot be - * undone. + * Delete backend stage. Delete an existing backend stage, specified by its `backend_stage_id`. Deleting a backend stage is permanent, and cannot be undone. * * @param request - The request {@link DeleteBackendStageRequest} */ @@ -785,10 +730,7 @@ export class API extends ParentAPI { ) /** - * List WAF stages. List all WAF stages, for a Scaleway Organization or - * Scaleway Project. By default, the WAF stages returned in the list are - * ordered by creation date in ascending order, though this can be modified - * via the `order_by` field. + * List WAF stages. List all WAF stages, for a Scaleway Organization or Scaleway Project. By default, the WAF stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListWafStagesRequest} * @returns A Promise of ListWafStagesResponse @@ -797,8 +739,7 @@ export class API extends ParentAPI { enrichForPagination('stages', this.pageOfListWafStages, request) /** - * Create WAF stage. Create a new WAF stage. You must specify the `mode` and - * `paranoia_level` fields to customize the WAF. + * Create WAF stage. Create a new WAF stage. You must specify the `mode` and `paranoia_level` fields to customize the WAF. * * @param request - The request {@link CreateWafStageRequest} * @returns A Promise of WafStage @@ -817,9 +758,7 @@ export class API extends ParentAPI { ) /** - * Get WAF stage. Retrieve information about an existing WAF stage, specified - * by its `waf_stage_id`. Its full details are returned in the response - * object. + * Get WAF stage. Retrieve information about an existing WAF stage, specified by its `waf_stage_id`. Its full details are returned in the response object. * * @param request - The request {@link GetWafStageRequest} * @returns A Promise of WafStage @@ -834,9 +773,7 @@ export class API extends ParentAPI { ) /** - * Update WAF stage. Update the parameters of an existing WAF stage, specified - * by its `waf_stage_id`. Both `mode` and `paranoia_level` parameters can be - * updated. + * Update WAF stage. Update the parameters of an existing WAF stage, specified by its `waf_stage_id`. Both `mode` and `paranoia_level` parameters can be updated. * * @param request - The request {@link UpdateWafStageRequest} * @returns A Promise of WafStage @@ -855,8 +792,7 @@ export class API extends ParentAPI { ) /** - * Delete WAF stage. Delete an existing WAF stage, specified by its - * `waf_stage_id`. Deleting a WAF stage is permanent, and cannot be undone. + * Delete WAF stage. Delete an existing WAF stage, specified by its `waf_stage_id`. Deleting a WAF stage is permanent, and cannot be undone. * * @param request - The request {@link DeleteWafStageRequest} */ @@ -886,9 +822,7 @@ export class API extends ParentAPI { ) /** - * List route stages. List all route stages, for a given pipeline. By default, - * the route stages returned in the list are ordered by creation date in - * ascending order, though this can be modified via the `order_by` field. + * List route stages. List all route stages, for a given pipeline. By default, the route stages returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListRouteStagesRequest} * @returns A Promise of ListRouteStagesResponse @@ -897,8 +831,7 @@ export class API extends ParentAPI { enrichForPagination('stages', this.pageOfListRouteStages, request) /** - * Create route stage. Create a new route stage. You must specify the - * `waf_stage_id` field to customize the route. + * Create route stage. Create a new route stage. You must specify the `waf_stage_id` field to customize the route. * * @param request - The request {@link CreateRouteStageRequest} * @returns A Promise of RouteStage @@ -917,9 +850,7 @@ export class API extends ParentAPI { ) /** - * Get route stage. Retrieve information about an existing route stage, - * specified by its `route_stage_id`. The summary of the route stage (without - * route rules) is returned in the response object. + * Get route stage. Retrieve information about an existing route stage, specified by its `route_stage_id`. The summary of the route stage (without route rules) is returned in the response object. * * @param request - The request {@link GetRouteStageRequest} * @returns A Promise of RouteStage @@ -934,8 +865,7 @@ export class API extends ParentAPI { ) /** - * Update route stage. Update the parameters of an existing route stage, - * specified by its `route_stage_id`. + * Update route stage. Update the parameters of an existing route stage, specified by its `route_stage_id`. * * @param request - The request {@link UpdateRouteStageRequest} * @returns A Promise of RouteStage @@ -954,9 +884,7 @@ export class API extends ParentAPI { ) /** - * Delete route stage. Delete an existing route stage, specified by its - * `route_stage_id`. Deleting a route stage is permanent, and cannot be - * undone. + * Delete route stage. Delete an existing route stage, specified by its `route_stage_id`. Deleting a route stage is permanent, and cannot be undone. * * @param request - The request {@link DeleteRouteStageRequest} */ @@ -967,8 +895,7 @@ export class API extends ParentAPI { }) /** - * List route rules. List all route rules of an existing route stage, - * specified by its `route_stage_id`. + * List route rules. List all route rules of an existing route stage, specified by its `route_stage_id`. * * @param request - The request {@link ListRouteRulesRequest} * @returns A Promise of ListRouteRulesResponse @@ -983,8 +910,7 @@ export class API extends ParentAPI { ) /** - * Set route rules. Set the rules of an existing route stage, specified by its - * `route_stage_id`. + * Set route rules. Set the rules of an existing route stage, specified by its `route_stage_id`. * * @param request - The request {@link SetRouteRulesRequest} * @returns A Promise of SetRouteRulesResponse @@ -1003,8 +929,7 @@ export class API extends ParentAPI { ) /** - * Add route rules. Add route rules to an existing route stage, specified by - * its `route_stage_id`. + * Add route rules. Add route rules to an existing route stage, specified by its `route_stage_id`. * * @param request - The request {@link AddRouteRulesRequest} * @returns A Promise of AddRouteRulesResponse @@ -1095,11 +1020,7 @@ export class API extends ParentAPI { ) /** - * List purge requests. List all purge requests, for a Scaleway Organization - * or Scaleway Project. This enables you to retrieve a history of all - * previously-made purge requests. By default, the purge requests returned in - * the list are ordered by creation date in ascending order, though this can - * be modified via the `order_by` field. + * List purge requests. List all purge requests, for a Scaleway Organization or Scaleway Project. This enables you to retrieve a history of all previously-made purge requests. By default, the purge requests returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field. * * @param request - The request {@link ListPurgeRequestsRequest} * @returns A Promise of ListPurgeRequestsResponse @@ -1108,9 +1029,7 @@ export class API extends ParentAPI { enrichForPagination('purgeRequests', this.pageOfListPurgeRequests, request) /** - * Create purge request. Create a new purge request. You must specify either - * the `all` field (to purge all content) or a list of `assets` (to define the - * precise assets to purge). + * Create purge request. Create a new purge request. You must specify either the `all` field (to purge all content) or a list of `assets` (to define the precise assets to purge). * * @param request - The request {@link CreatePurgeRequestRequest} * @returns A Promise of PurgeRequest @@ -1129,9 +1048,7 @@ export class API extends ParentAPI { ) /** - * Get purge request. Retrieve information about a purge request, specified by - * its `purge_request_id`. Its full details, including `status` and `target`, - * are returned in the response object. + * Get purge request. Retrieve information about a purge request, specified by its `purge_request_id`. Its full details, including `status` and `target`, are returned in the response object. * * @param request - The request {@link GetPurgeRequestRequest} * @returns A Promise of PurgeRequest @@ -1220,10 +1137,7 @@ export class API extends ParentAPI { }) /** - * Gives information on the currently selected Edge Services subscription - * plan, resource usage and associated billing information for this calendar - * month (including whether consumption falls within or exceeds the currently - * selected subscription plan.). + * Gives information on the currently selected Edge Services subscription plan, resource usage and associated billing information for this calendar month (including whether consumption falls within or exceeds the currently selected subscription plan.). * * @param request - The request {@link GetBillingRequest} * @returns A Promise of GetBillingResponse diff --git a/packages/clients/src/api/edge_services/v1beta1/types.gen.ts b/packages/clients/src/api/edge_services/v1beta1/types.gen.ts index 5ef93fe73..d221b30a6 100644 --- a/packages/clients/src/api/edge_services/v1beta1/types.gen.ts +++ b/packages/clients/src/api/edge_services/v1beta1/types.gen.ts @@ -119,42 +119,58 @@ export type SearchBackendStagesRequestOrderBy = export type WafStageMode = 'unknown_mode' | 'disable' | 'log_only' | 'enable' export interface ScalewayLb { - /** ID of the Load Balancer. */ + /** + * ID of the Load Balancer. + */ id: string - /** Zone of the Load Balancer. */ + /** + * Zone of the Load Balancer. + */ zone: ScwZone - /** ID of the frontend linked to the Load Balancer. */ + /** + * ID of the frontend linked to the Load Balancer. + */ frontendId: string - /** Defines whether the Load Balancer's frontend handles SSL connections. */ + /** + * Defines whether the Load Balancer's frontend handles SSL connections. + */ isSsl?: boolean /** - * Fully Qualified Domain Name (in the format subdomain.example.com) to use in - * HTTP requests sent towards your Load Balancer. + * Fully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer. */ domainName?: string } export interface RuleHttpMatchPathFilter { /** - * Type of filter to match for the HTTP URL path. For now, all path filters - * must be written in regex and use the `regex` type. + * Type of filter to match for the HTTP URL path. For now, all path filters must be written in regex and use the `regex` type. */ pathFilterType: RuleHttpMatchPathFilterPathFilterType - /** Value to be matched for the HTTP URL path. */ + /** + * Value to be matched for the HTTP URL path. + */ value: string } export interface ScalewayLbBackendConfig { - /** Load Balancer information. */ + /** + * Load Balancer information. + */ lbs: ScalewayLb[] } export interface ScalewayS3BackendConfig { - /** Name of the Bucket. */ + /** + * Name of the Bucket. + */ bucketName?: string - /** Region of the Bucket. */ + /** + * Region of the Bucket. + */ bucketRegion?: string - /** Defines whether the bucket website feature is enabled. */ + /** + * Defines whether the bucket website feature is enabled. + */ isWebsite?: boolean } @@ -167,219 +183,283 @@ export interface PipelineError { } export interface TLSSecret { - /** ID of the Secret. */ + /** + * ID of the Secret. + */ secretId: string - /** Region of the Secret. */ + /** + * Region of the Secret. + */ region: ScwRegion } export interface RuleHttpMatch { /** - * HTTP methods to filter for. A request using any of these methods will be - * considered to match the rule. Possible values are `get`, `post`, `put`, - * `patch`, `delete`, `head`, `options`. All methods will match if none is - * provided. + * HTTP methods to filter for. A request using any of these methods will be considered to match the rule. Possible values are `get`, `post`, `put`, `patch`, `delete`, `head`, `options`. All methods will match if none is provided. */ methodFilters: RuleHttpMatchMethodFilter[] /** - * HTTP URL path to filter for. A request whose path matches the given filter - * will be considered to match the rule. All paths will match if none is - * provided. + * HTTP URL path to filter for. A request whose path matches the given filter will be considered to match the rule. All paths will match if none is provided. */ pathFilter?: RuleHttpMatchPathFilter } export interface BackendStage { - /** ID of the backend stage. */ + /** + * ID of the backend stage. + */ id: string - /** Pipeline ID the backend stage belongs to. */ + /** + * Pipeline ID the backend stage belongs to. + */ pipelineId: string - /** Date the backend stage was created. */ + /** + * Date the backend stage was created. + */ createdAt?: Date - /** Date the backend stage was last updated. */ + /** + * Date the backend stage was last updated. + */ updatedAt?: Date /** * Scaleway Object Storage origin bucket (S3) linked to the backend stage. * - * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could - * be set. + * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could be set. */ scalewayS3?: ScalewayS3BackendConfig /** * Scaleway Load Balancer origin linked to the backend stage. * - * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could - * be set. + * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could be set. */ scalewayLb?: ScalewayLbBackendConfig } export interface CacheStage { - /** ID of the cache stage. */ + /** + * ID of the cache stage. + */ id: string - /** Pipeline ID the cache stage belongs to. */ + /** + * Pipeline ID the cache stage belongs to. + */ pipelineId: string - /** Time To Live (TTL) in seconds. Defines how long content is cached. */ + /** + * Time To Live (TTL) in seconds. Defines how long content is cached. + */ fallbackTtl?: string - /** Date the cache stage was created. */ + /** + * Date the cache stage was created. + */ createdAt?: Date - /** Date the cache stage was last updated. */ + /** + * Date the cache stage was last updated. + */ updatedAt?: Date /** * Backend stage ID the cache stage is linked to. * - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ backendStageId?: string /** - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ wafStageId?: string /** - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ routeStageId?: string } export interface DNSStage { - /** ID of the DNS stage. */ + /** + * ID of the DNS stage. + */ id: string - /** List of Fully Qualified Domain Names attached to the stage. */ + /** + * List of Fully Qualified Domain Names attached to the stage. + */ fqdns: string[] - /** Type of the stage. */ + /** + * Type of the stage. + */ type: DNSStageType - /** Pipeline ID the DNS stage belongs to. */ + /** + * Pipeline ID the DNS stage belongs to. + */ pipelineId: string - /** Date the DNS stage was created. */ + /** + * Date the DNS stage was created. + */ createdAt?: Date - /** Date the DNS stage was last updated. */ + /** + * Date the DNS stage was last updated. + */ updatedAt?: Date /** * TLS stage ID the DNS stage is linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ tlsStageId?: string /** * Cache stage ID the DNS stage is linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ cacheStageId?: string /** * Backend stage ID the DNS stage is linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ backendStageId?: string } export interface Pipeline { - /** ID of the pipeline. */ + /** + * ID of the pipeline. + */ id: string - /** Name of the pipeline. */ + /** + * Name of the pipeline. + */ name: string - /** Description of the pipeline. */ + /** + * Description of the pipeline. + */ description: string - /** Status of the pipeline. */ + /** + * Status of the pipeline. + */ status: PipelineStatus - /** Errors of the pipeline. */ + /** + * Errors of the pipeline. + */ errors: PipelineError[] - /** Project ID of the pipeline. */ + /** + * Project ID of the pipeline. + */ projectId: string - /** Organization ID of the pipeline. */ + /** + * Organization ID of the pipeline. + */ organizationId: string - /** Date the pipeline was created. */ + /** + * Date the pipeline was created. + */ createdAt?: Date - /** Date the pipeline was last updated. */ + /** + * Date the pipeline was last updated. + */ updatedAt?: Date } export interface RouteStage { - /** ID of the route stage. */ + /** + * ID of the route stage. + */ id: string - /** Pipeline ID the route stage belongs to. */ + /** + * Pipeline ID the route stage belongs to. + */ pipelineId: string /** - * ID of the WAF stage HTTP requests should be forwarded to when no rules are - * matched. + * ID of the WAF stage HTTP requests should be forwarded to when no rules are matched. * * One-of ('next'): at most one of 'wafStageId' could be set. */ wafStageId?: string - /** Date the route stage was created. */ + /** + * Date the route stage was created. + */ createdAt?: Date - /** Date the route stage was last updated. */ + /** + * Date the route stage was last updated. + */ updatedAt?: Date } export interface TLSStage { - /** ID of the TLS stage. */ + /** + * ID of the TLS stage. + */ id: string - /** Secret (from Scaleway Secret Manager) containing your custom certificate. */ + /** + * Secret (from Scaleway Secret Manager) containing your custom certificate. + */ secrets: TLSSecret[] /** - * True when Scaleway generates and manages a Let's Encrypt certificate for - * the TLS stage/custom endpoint. + * True when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint. */ managedCertificate: boolean - /** Pipeline ID the TLS stage belongs to. */ + /** + * Pipeline ID the TLS stage belongs to. + */ pipelineId: string - /** Expiration date of the certificate. */ + /** + * Expiration date of the certificate. + */ certificateExpiresAt?: Date - /** Date the TLS stage was created. */ + /** + * Date the TLS stage was created. + */ createdAt?: Date - /** Date the TLS stage was last updated. */ + /** + * Date the TLS stage was last updated. + */ updatedAt?: Date /** * Cache stage ID the TLS stage is linked to. * - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'wafStageId', 'routeStageId' could be set. + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ cacheStageId?: string /** * Backend stage ID the TLS stage is linked to. * - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'wafStageId', 'routeStageId' could be set. + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ backendStageId?: string /** - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'wafStageId', 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ wafStageId?: string /** - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'wafStageId', 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ routeStageId?: string } export interface WafStage { - /** ID of the WAF stage. */ + /** + * ID of the WAF stage. + */ id: string - /** Pipeline ID the WAF stage belongs to. */ + /** + * Pipeline ID the WAF stage belongs to. + */ pipelineId: string - /** Mode defining WAF behavior (`disable`/`log_only`/`enable`). */ + /** + * Mode defining WAF behavior (`disable`/`log_only`/`enable`). + */ mode: WafStageMode /** - * Sensitivity level (`1`,`2`,`3`,`4`) to use when classifying requests as - * malicious. With a high level, requests are more likely to be classed as - * malicious, and false positives are expected. With a lower level, requests - * are more likely to be classed as benign. + * Sensitivity level (`1`,`2`,`3`,`4`) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign. */ paranoiaLevel: number - /** Date the WAF stage was created. */ + /** + * Date the WAF stage was created. + */ createdAt?: Date - /** Date the WAF stage was last updated. */ + /** + * Date the WAF stage was last updated. + */ updatedAt?: Date /** * ID of the backend stage to forward requests to after the WAF stage. @@ -391,17 +471,13 @@ export interface WafStage { export interface SetRouteRulesRequestRouteRule { /** - * Rule condition to be matched. Requests matching the condition defined here - * will be directly forwarded to the backend specified by the - * `backend_stage_id` field. Requests that do not match will be checked by the - * next rule's condition. + * Rule condition to be matched. Requests matching the condition defined here will be directly forwarded to the backend specified by the `backend_stage_id` field. Requests that do not match will be checked by the next rule's condition. * * One-of ('match'): at most one of 'ruleHttpMatch' could be set. */ ruleHttpMatch?: RuleHttpMatch /** - * ID of the backend stage that requests matching the rule should be forwarded - * to. + * ID of the backend stage that requests matching the rule should be forwarded to. * * One-of ('next'): at most one of 'backendStageId' could be set. */ @@ -410,27 +486,24 @@ export interface SetRouteRulesRequestRouteRule { export interface RouteRule { /** - * Rule condition to be matched. Requests matching the condition defined here - * will be directly forwarded to the backend specified by the - * `backend_stage_id` field. Requests that do not match will be checked by the - * next rule's condition. + * Rule condition to be matched. Requests matching the condition defined here will be directly forwarded to the backend specified by the `backend_stage_id` field. Requests that do not match will be checked by the next rule's condition. * * One-of ('match'): at most one of 'ruleHttpMatch' could be set. */ ruleHttpMatch?: RuleHttpMatch /** - * ID of the backend stage that requests matching the rule should be forwarded - * to. + * ID of the backend stage that requests matching the rule should be forwarded to. * * One-of ('next'): at most one of 'backendStageId' could be set. */ backendStageId?: string /** - * Position of the rule which determines the order of processing within the - * route stage. + * Position of the rule which determines the order of processing within the route stage. */ position: number - /** Route stage ID the route rule belongs to. */ + /** + * Route stage ID the route rule belongs to. + */ routeStageId: string } @@ -440,31 +513,44 @@ export interface CheckPEMChainRequestSecretChain { } export interface PlanDetails { - /** Subscription plan name. */ + /** + * Subscription plan name. + */ planName: PlanName - /** Amount of egress data from cache included in subscription plan. */ + /** + * Amount of egress data from cache included in subscription plan. + */ packageGb: number - /** Number of pipelines included in subscription plan. */ + /** + * Number of pipelines included in subscription plan. + */ pipelineLimit: number - /** Number of WAF requests included in subscription plan. */ + /** + * Number of WAF requests included in subscription plan. + */ wafRequests: number } export interface PlanUsageDetails { /** - * Cost to date (this month) for the corresponding Edge Services subscription - * plan. + * Cost to date (this month) for the corresponding Edge Services subscription plan. */ planCost?: Money } export interface HeadStageResponseHeadStage { - /** One-of ('head'): at most one of 'dnsStageId' could be set. */ + /** + * + * One-of ('head'): at most one of 'dnsStageId' could be set. + */ dnsStageId?: string } export interface ListHeadStagesResponseHeadStage { - /** One-of ('head'): at most one of 'dnsStageId' could be set. */ + /** + * + * One-of ('head'): at most one of 'dnsStageId' could be set. + */ dnsStageId?: string } @@ -479,11 +565,17 @@ export interface PipelineStages { } export interface PurgeRequest { - /** ID of the purge request. */ + /** + * ID of the purge request. + */ id: string - /** Pipeline ID the purge request belongs to. */ + /** + * Pipeline ID the purge request belongs to. + */ pipelineId: string - /** Status of the purge request. */ + /** + * Status of the purge request. + */ status: PurgeRequestStatus /** * List of asserts to purge. @@ -497,9 +589,13 @@ export interface PurgeRequest { * One-of ('target'): at most one of 'assets', 'all' could be set. */ all?: boolean - /** Date the purge request was created. */ + /** + * Date the purge request was created. + */ createdAt?: Date - /** Date the purge request was last updated. */ + /** + * Date the purge request was last updated. + */ updatedAt?: Date } @@ -517,42 +613,38 @@ export interface SetHeadStageRequestSwapHeadStage { } export interface TLSSecretsConfig { - /** Secret information (from Secret Manager). */ + /** + * Secret information (from Secret Manager). + */ tlsSecrets: TLSSecret[] } export type AddRouteRulesRequest = { - /** ID of the route stage to update. */ + /** + * ID of the route stage to update. + */ routeStageId: string /** - * List of rules to be checked against every HTTP request. The first matching - * rule will forward the request to its specified backend stage. If no rules - * are matched, the request is forwarded to the WAF stage defined by - * `waf_stage_id`. + * List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`. */ routeRules?: SetRouteRulesRequestRouteRule[] /** * Add rules after the given position. * - * One-of ('position'): at most one of 'afterPosition', 'beforePosition' could - * be set. + * One-of ('position'): at most one of 'afterPosition', 'beforePosition' could be set. */ afterPosition?: number /** * Add rules before the given position. * - * One-of ('position'): at most one of 'afterPosition', 'beforePosition' could - * be set. + * One-of ('position'): at most one of 'afterPosition', 'beforePosition' could be set. */ beforePosition?: number } export interface AddRouteRulesResponse { /** - * List of rules to be checked against every HTTP request. The first matching - * rule will forward the request to its specified backend stage. If no rules - * are matched, the request is forwarded to the WAF stage defined by - * `waf_stage_id`. + * List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`. */ routeRules: RouteRule[] } @@ -579,9 +671,15 @@ export interface CheckLbOriginResponse { export type CheckPEMChainRequest = { projectId?: string fqdn: string - /** One-of ('chain'): at most one of 'secret', 'raw' could be set. */ + /** + * + * One-of ('chain'): at most one of 'secret', 'raw' could be set. + */ secret?: CheckPEMChainRequestSecretChain - /** One-of ('chain'): at most one of 'secret', 'raw' could be set. */ + /** + * + * One-of ('chain'): at most one of 'secret', 'raw' could be set. + */ raw?: string } @@ -590,90 +688,99 @@ export interface CheckPEMChainResponse { } export type CreateBackendStageRequest = { - /** Pipeline ID the Backend stage belongs to. */ + /** + * Pipeline ID the Backend stage belongs to. + */ pipelineId: string /** * Scaleway Object Storage origin bucket (S3) linked to the backend stage. * - * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could - * be set. + * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could be set. */ scalewayS3?: ScalewayS3BackendConfig /** * Scaleway Load Balancer origin linked to the backend stage. * - * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could - * be set. + * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could be set. */ scalewayLb?: ScalewayLbBackendConfig } export type CreateCacheStageRequest = { - /** Pipeline ID the Cache stage belongs to. */ + /** + * Pipeline ID the Cache stage belongs to. + */ pipelineId: string - /** Time To Live (TTL) in seconds. Defines how long content is cached. */ + /** + * Time To Live (TTL) in seconds. Defines how long content is cached. + */ fallbackTtl?: string /** * Backend stage ID the cache stage will be linked to. * - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ backendStageId?: string /** - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ wafStageId?: string /** - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ routeStageId?: string } export type CreateDNSStageRequest = { - /** Pipeline ID the DNS stage belongs to. */ + /** + * Pipeline ID the DNS stage belongs to. + */ pipelineId: string /** - * Fully Qualified Domain Name (in the format subdomain.example.com) to attach - * to the stage. + * Fully Qualified Domain Name (in the format subdomain.example.com) to attach to the stage. */ fqdns?: string[] /** * TLS stage ID the DNS stage will be linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ tlsStageId?: string /** * Cache stage ID the DNS stage will be linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ cacheStageId?: string /** * Backend stage ID the DNS stage will be linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ backendStageId?: string } export type CreatePipelineRequest = { - /** Project ID in which the pipeline will be created. */ + /** + * Project ID in which the pipeline will be created. + */ projectId?: string - /** Name of the pipeline. */ + /** + * Name of the pipeline. + */ name: string - /** Description of the pipeline. */ + /** + * Description of the pipeline. + */ description: string } export type CreatePurgeRequestRequest = { - /** Pipeline ID in which the purge request will be created. */ + /** + * Pipeline ID in which the purge request will be created. + */ pipelineId: string /** * List of asserts to purge. @@ -690,11 +797,12 @@ export type CreatePurgeRequestRequest = { } export type CreateRouteStageRequest = { - /** Pipeline ID the route stage belongs to. */ + /** + * Pipeline ID the route stage belongs to. + */ pipelineId: string /** - * ID of the WAF stage HTTP requests should be forwarded to when no rules are - * matched. + * ID of the WAF stage HTTP requests should be forwarded to when no rules are matched. * * One-of ('next'): at most one of 'wafStageId' could be set. */ @@ -702,51 +810,53 @@ export type CreateRouteStageRequest = { } export type CreateTLSStageRequest = { - /** Pipeline ID the TLS stage belongs to. */ + /** + * Pipeline ID the TLS stage belongs to. + */ pipelineId: string - /** Secret (from Scaleway Secret Manager) containing your custom certificate. */ + /** + * Secret (from Scaleway Secret Manager) containing your custom certificate. + */ secrets?: TLSSecret[] /** - * True when Scaleway generates and manages a Let's Encrypt certificate for - * the TLS stage/custom endpoint. + * True when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint. */ managedCertificate?: boolean /** * Cache stage ID the TLS stage will be linked to. * - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ cacheStageId?: string /** * Backend stage ID the TLS stage will be linked to. * - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ backendStageId?: string /** - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ routeStageId?: string /** - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ wafStageId?: string } export type CreateWafStageRequest = { - /** Pipeline ID the WAF stage belongs to. */ + /** + * Pipeline ID the WAF stage belongs to. + */ pipelineId: string - /** Mode defining WAF behavior (`disable`/`log_only`/`enable`). */ + /** + * Mode defining WAF behavior (`disable`/`log_only`/`enable`). + */ mode?: WafStageMode /** - * Sensitivity level (`1`,`2`,`3`,`4`) to use when classifying requests as - * malicious. With a high level, requests are more likely to be classed as - * malicious, and false positives are expected. With a lower level, requests - * are more likely to be classed as benign. + * Sensitivity level (`1`,`2`,`3`,`4`) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign. */ paranoiaLevel: number /** @@ -758,12 +868,16 @@ export type CreateWafStageRequest = { } export type DeleteBackendStageRequest = { - /** ID of the backend stage to delete. */ + /** + * ID of the backend stage to delete. + */ backendStageId: string } export type DeleteCacheStageRequest = { - /** ID of the cache stage to delete. */ + /** + * ID of the cache stage to delete. + */ cacheStageId: string } @@ -772,32 +886,44 @@ export type DeleteCurrentPlanRequest = { } export type DeleteDNSStageRequest = { - /** ID of the DNS stage to delete. */ + /** + * ID of the DNS stage to delete. + */ dnsStageId: string } export type DeletePipelineRequest = { - /** ID of the pipeline to delete. */ + /** + * ID of the pipeline to delete. + */ pipelineId: string } export type DeleteRouteStageRequest = { - /** ID of the route stage to delete. */ + /** + * ID of the route stage to delete. + */ routeStageId: string } export type DeleteTLSStageRequest = { - /** ID of the TLS stage to delete. */ + /** + * ID of the TLS stage to delete. + */ tlsStageId: string } export type DeleteWafStageRequest = { - /** ID of the WAF stage to delete. */ + /** + * ID of the WAF stage to delete. + */ wafStageId: string } export type GetBackendStageRequest = { - /** ID of the requested backend stage. */ + /** + * ID of the requested backend stage. + */ backendStageId: string } @@ -807,73 +933,63 @@ export type GetBillingRequest = { export interface GetBillingResponse { /** - * Information on the currently-selected, active Edge Services subscription - * plan. + * Information on the currently-selected, active Edge Services subscription plan. */ currentPlan?: PlanDetails /** - * Cost to date (this month) for Edge Service subscription plans. This - * comprises the pro-rata cost of the current subscription plan, and any - * previous subscription plans that were active earlier in the month. + * Cost to date (this month) for Edge Service subscription plans. This comprises the pro-rata cost of the current subscription plan, and any previous subscription plans that were active earlier in the month. */ planCost?: Money - /** Total number of pipelines currently configured. */ + /** + * Total number of pipelines currently configured. + */ pipelineNumber: number /** - * Cost to date (this month) of pipelines not included in the subscription - * plans. + * Cost to date (this month) of pipelines not included in the subscription plans. */ extraPipelinesCost?: Money /** - * Total amount of data egressed from the cache in gigabytes from the - * beginning of the month, for the active subscription plan. + * Total amount of data egressed from the cache in gigabytes from the beginning of the month, for the active subscription plan. */ currentPlanCacheUsage: number /** - * Total amount of extra data egressed from cache in gigabytes from the - * beginning of the month, not included in the subscription plans. + * Total amount of extra data egressed from cache in gigabytes from the beginning of the month, not included in the subscription plans. */ extraCacheUsage: number /** - * Cost to date (this month) of the data egressed from the cache that is not - * included in the subscription plans. + * Cost to date (this month) of the data egressed from the cache that is not included in the subscription plans. */ extraCacheCost?: Money /** - * Total number of requests processed by the WAF since the beginning of the - * current month, for the active subscription plan. + * Total number of requests processed by the WAF since the beginning of the current month, for the active subscription plan. */ currentPlanWafUsage: number /** - * Total number of extra requests processed by the WAF from the beginning of - * the month, not included in the subscription plans. + * Total number of extra requests processed by the WAF from the beginning of the month, not included in the subscription plans. */ extraWafUsage: number /** - * Cost to date (this month) of the extra requests processed by the WAF that - * were not included in the subscription plans. + * Cost to date (this month) of the extra requests processed by the WAF that were not included in the subscription plans. */ extraWafCost?: Money /** - * Cost of activating WAF add-on (where subscription plan does not include - * WAF). + * Cost of activating WAF add-on (where subscription plan does not include WAF). */ wafAddOn?: Money /** - * Detailed costs and usage for all Edge Services subscription plans that were - * activated during the month. + * Detailed costs and usage for all Edge Services subscription plans that were activated during the month. */ plansUsageDetails: Record /** - * Total cost to date (this month) of all Edge Services resources including - * active subscription plan, previously active plans, extra pipelines and - * extra egress cache data. + * Total cost to date (this month) of all Edge Services resources including active subscription plan, previously active plans, extra pipelines and extra egress cache data. */ totalCost?: Money } export type GetCacheStageRequest = { - /** ID of the requested cache stage. */ + /** + * ID of the requested cache stage. + */ cacheStageId: string } @@ -882,172 +998,225 @@ export type GetCurrentPlanRequest = { } export type GetDNSStageRequest = { - /** ID of the requested DNS stage. */ + /** + * ID of the requested DNS stage. + */ dnsStageId: string } export type GetPipelineRequest = { - /** ID of the requested pipeline. */ + /** + * ID of the requested pipeline. + */ pipelineId: string } export type GetPurgeRequestRequest = { - /** ID of the requested purge request. */ + /** + * ID of the requested purge request. + */ purgeRequestId: string } export type GetRouteStageRequest = { - /** ID of the requested route stage. */ + /** + * ID of the requested route stage. + */ routeStageId: string } export type GetTLSStageRequest = { - /** ID of the requested TLS stage. */ + /** + * ID of the requested TLS stage. + */ tlsStageId: string } export type GetWafStageRequest = { - /** ID of the requested WAF stage. */ + /** + * ID of the requested WAF stage. + */ wafStageId: string } export interface HeadStageResponse { - /** Modified or created head stage. */ + /** + * Modified or created head stage. + */ headStage?: HeadStageResponseHeadStage } export type ListBackendStagesRequest = { /** - * Pipeline ID to filter for. Only backend stages from this pipeline will be - * returned. + * Pipeline ID to filter for. Only backend stages from this pipeline will be returned. */ pipelineId: string - /** Sort order of backend stages in the response. */ + /** + * Sort order of backend stages in the response. + */ orderBy?: ListBackendStagesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of backend stages to return per page. */ + /** + * Number of backend stages to return per page. + */ pageSize?: number /** - * Bucket name to filter for. Only backend stages from this Bucket will be - * returned. + * Bucket name to filter for. Only backend stages from this Bucket will be returned. */ bucketName?: string /** - * Bucket region to filter for. Only backend stages with buckets in this - * region will be returned. + * Bucket region to filter for. Only backend stages with buckets in this region will be returned. */ bucketRegion?: string /** - * Load Balancer ID to filter for. Only backend stages with this Load Balancer - * will be returned. + * Load Balancer ID to filter for. Only backend stages with this Load Balancer will be returned. */ lbId?: string } export interface ListBackendStagesResponse { - /** Paginated list of backend stages. */ + /** + * Paginated list of backend stages. + */ stages: BackendStage[] - /** Count of all backend stages matching the requested criteria. */ + /** + * Count of all backend stages matching the requested criteria. + */ totalCount: number } export type ListCacheStagesRequest = { /** - * Pipeline ID to filter for. Only cache stages from this pipeline will be - * returned. + * Pipeline ID to filter for. Only cache stages from this pipeline will be returned. */ pipelineId: string - /** Sort order of cache stages in the response. */ + /** + * Sort order of cache stages in the response. + */ orderBy?: ListCacheStagesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of cache stages to return per page. */ + /** + * Number of cache stages to return per page. + */ pageSize?: number } export interface ListCacheStagesResponse { - /** Paginated list of cache stages. */ + /** + * Paginated list of cache stages. + */ stages: CacheStage[] - /** Count of all cache stages matching the requested criteria. */ + /** + * Count of all cache stages matching the requested criteria. + */ totalCount: number } export type ListDNSStagesRequest = { /** - * Pipeline ID to filter for. Only DNS stages from this pipeline will be - * returned. + * Pipeline ID to filter for. Only DNS stages from this pipeline will be returned. */ pipelineId: string - /** Sort order of DNS stages in the response. */ + /** + * Sort order of DNS stages in the response. + */ orderBy?: ListDNSStagesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of DNS stages to return per page. */ + /** + * Number of DNS stages to return per page. + */ pageSize?: number /** - * Fully Qualified Domain Name to filter for (in the format - * subdomain.example.com). Only DNS stages with this FQDN will be returned. + * Fully Qualified Domain Name to filter for (in the format subdomain.example.com). Only DNS stages with this FQDN will be returned. */ fqdn?: string } export interface ListDNSStagesResponse { - /** Paginated list of DNS stages. */ + /** + * Paginated list of DNS stages. + */ stages: DNSStage[] - /** Count of all DNS stages matching the requested criteria. */ + /** + * Count of all DNS stages matching the requested criteria. + */ totalCount: number } export type ListHeadStagesRequest = { - /** ID of the pipeline to update. */ + /** + * ID of the pipeline to update. + */ pipelineId: string - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of head stages to return per page. */ + /** + * Number of head stages to return per page. + */ pageSize?: number } export interface ListHeadStagesResponse { - /** Number of head stages to return per page. */ + /** + * Number of head stages to return per page. + */ headStages: ListHeadStagesResponseHeadStage[] - /** Count of all head stages matching the requested pipeline_id. */ + /** + * Count of all head stages matching the requested pipeline_id. + */ totalCount: number } export type ListPipelinesRequest = { - /** Sort order of pipelines in the response. */ + /** + * Sort order of pipelines in the response. + */ orderBy?: ListPipelinesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of pipelines to return per page. */ + /** + * Number of pipelines to return per page. + */ pageSize?: number /** - * Pipeline name to filter for. Only pipelines with this string within their - * name will be returned. + * Pipeline name to filter for. Only pipelines with this string within their name will be returned. */ name?: string /** - * Organization ID to filter for. Only pipelines from this Organization will - * be returned. + * Organization ID to filter for. Only pipelines from this Organization will be returned. */ organizationId?: string /** - * Project ID to filter for. Only pipelines from this Project will be - * returned. + * Project ID to filter for. Only pipelines from this Project will be returned. */ projectId?: string /** - * Filter on backend stage. Only pipelines with a Load Balancer origin will be - * returned. + * Filter on backend stage. Only pipelines with a Load Balancer origin will be returned. */ hasBackendStageLb?: boolean } export interface ListPipelinesResponse { - /** Paginated list of pipelines. */ + /** + * Paginated list of pipelines. + */ pipelines: Pipeline[] - /** Count of all pipelines matching the requested criteria. */ + /** + * Count of all pipelines matching the requested criteria. + */ totalCount: number } @@ -1071,124 +1240,152 @@ export interface ListPlansResponse { } export type ListPurgeRequestsRequest = { - /** Sort order of purge requests in the response. */ + /** + * Sort order of purge requests in the response. + */ orderBy?: ListPurgeRequestsRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of purge requests to return per page. */ + /** + * Number of purge requests to return per page. + */ pageSize?: number /** - * Organization ID to filter for. Only purge requests from this Project will - * be returned. + * Organization ID to filter for. Only purge requests from this Project will be returned. */ organizationId?: string /** - * Project ID to filter for. Only purge requests from this Project will be - * returned. + * Project ID to filter for. Only purge requests from this Project will be returned. */ projectId?: string /** - * Pipeline ID to filter for. Only purge requests from this pipeline will be - * returned. + * Pipeline ID to filter for. Only purge requests from this pipeline will be returned. */ pipelineId?: string } export interface ListPurgeRequestsResponse { - /** Paginated list of purge requests. */ + /** + * Paginated list of purge requests. + */ purgeRequests: PurgeRequest[] - /** Count of all purge requests matching the requested criteria. */ + /** + * Count of all purge requests matching the requested criteria. + */ totalCount: number } export type ListRouteRulesRequest = { /** - * Route stage ID to filter for. Only route rules from this route stage will - * be returned. + * Route stage ID to filter for. Only route rules from this route stage will be returned. */ routeStageId: string } export interface ListRouteRulesResponse { /** - * List of rules to be checked against every HTTP request. The first matching - * rule will forward the request to its specified backend stage. If no rules - * are matched, the request is forwarded to the WAF stage defined by - * `waf_stage_id`. + * List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`. */ routeRules: RouteRule[] } export type ListRouteStagesRequest = { /** - * Pipeline ID to filter for. Only route stages from this pipeline will be - * returned. + * Pipeline ID to filter for. Only route stages from this pipeline will be returned. */ pipelineId: string - /** Sort order of route stages in the response. */ + /** + * Sort order of route stages in the response. + */ orderBy?: ListRouteStagesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of route stages to return per page. */ + /** + * Number of route stages to return per page. + */ pageSize?: number } export interface ListRouteStagesResponse { - /** Paginated list of summarized route stages. */ + /** + * Paginated list of summarized route stages. + */ stages: RouteStage[] - /** Count of all route stages matching the requested criteria. */ + /** + * Count of all route stages matching the requested criteria. + */ totalCount: number } export type ListTLSStagesRequest = { /** - * Pipeline ID to filter for. Only TLS stages from this pipeline will be - * returned. + * Pipeline ID to filter for. Only TLS stages from this pipeline will be returned. */ pipelineId: string - /** Sort order of TLS stages in the response. */ + /** + * Sort order of TLS stages in the response. + */ orderBy?: ListTLSStagesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of TLS stages to return per page. */ + /** + * Number of TLS stages to return per page. + */ pageSize?: number /** - * Secret ID to filter for. Only TLS stages with this Secret ID will be - * returned. + * Secret ID to filter for. Only TLS stages with this Secret ID will be returned. */ secretId?: string /** - * Secret region to filter for. Only TLS stages with a Secret in this region - * will be returned. + * Secret region to filter for. Only TLS stages with a Secret in this region will be returned. */ secretRegion?: string } export interface ListTLSStagesResponse { - /** Paginated list of TLS stages. */ + /** + * Paginated list of TLS stages. + */ stages: TLSStage[] - /** Count of all TLS stages matching the requested criteria. */ + /** + * Count of all TLS stages matching the requested criteria. + */ totalCount: number } export type ListWafStagesRequest = { /** - * Pipeline ID to filter for. Only WAF stages from this pipeline will be - * returned. + * Pipeline ID to filter for. Only WAF stages from this pipeline will be returned. */ pipelineId: string - /** Sort order of WAF stages in the response. */ + /** + * Sort order of WAF stages in the response. + */ orderBy?: ListWafStagesRequestOrderBy - /** Page number to return, from the paginated results. */ + /** + * Page number to return, from the paginated results. + */ page?: number - /** Number of WAF stages to return per page. */ + /** + * Number of WAF stages to return per page. + */ pageSize?: number } export interface ListWafStagesResponse { - /** Paginated list of WAF stages. */ + /** + * Paginated list of WAF stages. + */ stages: WafStage[] - /** Count of all WAF stages matching the requested criteria. */ + /** + * Count of all WAF stages matching the requested criteria. + */ totalCount: number } @@ -1212,144 +1409,149 @@ export type SelectPlanRequest = { } export type SetHeadStageRequest = { - /** ID of the pipeline to update. */ + /** + * ID of the pipeline to update. + */ pipelineId: string /** * Add a new head stage. * - * One-of ('action'): at most one of 'addNewHeadStage', 'removeHeadStage', - * 'swapHeadStage' could be set. + * One-of ('action'): at most one of 'addNewHeadStage', 'removeHeadStage', 'swapHeadStage' could be set. */ addNewHeadStage?: SetHeadStageRequestAddNewHeadStage /** * Remove a head stage. * - * One-of ('action'): at most one of 'addNewHeadStage', 'removeHeadStage', - * 'swapHeadStage' could be set. + * One-of ('action'): at most one of 'addNewHeadStage', 'removeHeadStage', 'swapHeadStage' could be set. */ removeHeadStage?: SetHeadStageRequestRemoveHeadStage /** * Replace a head stage with a new one. * - * One-of ('action'): at most one of 'addNewHeadStage', 'removeHeadStage', - * 'swapHeadStage' could be set. + * One-of ('action'): at most one of 'addNewHeadStage', 'removeHeadStage', 'swapHeadStage' could be set. */ swapHeadStage?: SetHeadStageRequestSwapHeadStage } export type SetRouteRulesRequest = { - /** ID of the route stage to update. */ + /** + * ID of the route stage to update. + */ routeStageId: string /** - * List of rules to be checked against every HTTP request. The first matching - * rule will forward the request to its specified backend stage. If no rules - * are matched, the request is forwarded to the WAF stage defined by - * `waf_stage_id`. + * List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`. */ routeRules?: SetRouteRulesRequestRouteRule[] } export interface SetRouteRulesResponse { /** - * List of rules to be checked against every HTTP request. The first matching - * rule will forward the request to its specified backend stage. If no rules - * are matched, the request is forwarded to the WAF stage defined by - * `waf_stage_id`. + * List of rules to be checked against every HTTP request. The first matching rule will forward the request to its specified backend stage. If no rules are matched, the request is forwarded to the WAF stage defined by `waf_stage_id`. */ routeRules: RouteRule[] } export type UpdateBackendStageRequest = { - /** ID of the backend stage to update. */ + /** + * ID of the backend stage to update. + */ backendStageId: string /** * Scaleway Object Storage origin bucket (S3) linked to the backend stage. * - * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could - * be set. + * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could be set. */ scalewayS3?: ScalewayS3BackendConfig /** * Scaleway Load Balancer origin linked to the backend stage. * - * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could - * be set. + * One-of ('backendConfig'): at most one of 'scalewayS3', 'scalewayLb' could be set. */ scalewayLb?: ScalewayLbBackendConfig - /** Pipeline ID the Backend stage belongs to. */ + /** + * Pipeline ID the Backend stage belongs to. + */ pipelineId: string } export type UpdateCacheStageRequest = { - /** ID of the cache stage to update. */ + /** + * ID of the cache stage to update. + */ cacheStageId: string - /** Time To Live (TTL) in seconds. Defines how long content is cached. */ + /** + * Time To Live (TTL) in seconds. Defines how long content is cached. + */ fallbackTtl?: string /** * Backend stage ID the cache stage will be linked to. * - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ backendStageId?: string /** - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ wafStageId?: string /** - * One-of ('next'): at most one of 'backendStageId', 'wafStageId', - * 'routeStageId' could be set. + * + * One-of ('next'): at most one of 'backendStageId', 'wafStageId', 'routeStageId' could be set. */ routeStageId?: string } export type UpdateDNSStageRequest = { - /** ID of the DNS stage to update. */ + /** + * ID of the DNS stage to update. + */ dnsStageId: string /** - * Fully Qualified Domain Name (in the format subdomain.example.com) attached - * to the stage. + * Fully Qualified Domain Name (in the format subdomain.example.com) attached to the stage. */ fqdns?: string[] /** * TLS stage ID the DNS stage will be linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ tlsStageId?: string /** * Cache stage ID the DNS stage will be linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ cacheStageId?: string /** * Backend stage ID the DNS stage will be linked to. * - * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', - * 'backendStageId' could be set. + * One-of ('next'): at most one of 'tlsStageId', 'cacheStageId', 'backendStageId' could be set. */ backendStageId?: string } export type UpdatePipelineRequest = { - /** ID of the pipeline to update. */ + /** + * ID of the pipeline to update. + */ pipelineId: string - /** Name of the pipeline. */ + /** + * Name of the pipeline. + */ name?: string - /** Description of the pipeline. */ + /** + * Description of the pipeline. + */ description?: string } export type UpdateRouteStageRequest = { - /** ID of the route stage to update. */ + /** + * ID of the route stage to update. + */ routeStageId: string /** - * ID of the WAF stage HTTP requests should be forwarded to when no rules are - * matched. + * ID of the WAF stage HTTP requests should be forwarded to when no rules are matched. * * One-of ('next'): at most one of 'wafStageId' could be set. */ @@ -1357,51 +1559,53 @@ export type UpdateRouteStageRequest = { } export type UpdateTLSStageRequest = { - /** ID of the TLS stage to update. */ + /** + * ID of the TLS stage to update. + */ tlsStageId: string - /** Secret (from Scaleway Secret-Manager) containing your custom certificate. */ + /** + * Secret (from Scaleway Secret-Manager) containing your custom certificate. + */ tlsSecretsConfig?: TLSSecretsConfig /** - * True when Scaleway generates and manages a Let's Encrypt certificate for - * the TLS stage/custom endpoint. + * True when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint. */ managedCertificate?: boolean /** * Cache stage ID the TLS stage will be linked to. * - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ cacheStageId?: string /** * Backend stage ID the TLS stage will be linked to. * - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ backendStageId?: string /** - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ routeStageId?: string /** - * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', - * 'routeStageId', 'wafStageId' could be set. + * + * One-of ('next'): at most one of 'cacheStageId', 'backendStageId', 'routeStageId', 'wafStageId' could be set. */ wafStageId?: string } export type UpdateWafStageRequest = { - /** ID of the WAF stage to update. */ + /** + * ID of the WAF stage to update. + */ wafStageId: string - /** Mode defining WAF behavior (`disable`/`log_only`/`enable`). */ + /** + * Mode defining WAF behavior (`disable`/`log_only`/`enable`). + */ mode?: WafStageMode /** - * Sensitivity level (`1`,`2`,`3`,`4`) to use when classifying requests as - * malicious. With a high level, requests are more likely to be classed as - * malicious, and false positives are expected. With a lower level, requests - * are more likely to be classed as benign. + * Sensitivity level (`1`,`2`,`3`,`4`) to use when classifying requests as malicious. With a high level, requests are more likely to be classed as malicious, and false positives are expected. With a lower level, requests are more likely to be classed as benign. */ paranoiaLevel?: number /**