edge_services

type API struct {
	// contains filtered or unexported fields
}

type AddRouteRulesRequest struct {
	// RouteStageID: ID of the route stage to update.
	RouteStageID string `json:"-"`

	// RouteRules: 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 `json:"route_rules"`

	// AfterPosition: add rules after the given position.
	// Precisely one of AfterPosition, BeforePosition must be set.
	AfterPosition *uint64 `json:"after_position,omitempty"`

	// BeforePosition: add rules before the given position.
	// Precisely one of AfterPosition, BeforePosition must be set.
	BeforePosition *uint64 `json:"before_position,omitempty"`
}

type AddRouteRulesResponse struct {
	// RouteRules: 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 `json:"route_rules"`
}

type BackendStage struct {
	// ID: ID of the backend stage.
	ID string `json:"id"`

	// PipelineID: pipeline ID the backend stage belongs to.
	PipelineID string `json:"pipeline_id"`

	// CreatedAt: date the backend stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the backend stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// ScalewayS3: scaleway Object Storage origin bucket (S3) linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayS3 *ScalewayS3BackendConfig `json:"scaleway_s3,omitempty"`

	// ScalewayLB: scaleway Load Balancer origin linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayLB *ScalewayLBBackendConfig `json:"scaleway_lb,omitempty"`
}

type CacheStage struct {
	// ID: ID of the cache stage.
	ID string `json:"id"`

	// PipelineID: pipeline ID the cache stage belongs to.
	PipelineID string `json:"pipeline_id"`

	// FallbackTTL: time To Live (TTL) in seconds. Defines how long content is cached.
	FallbackTTL *scw.Duration `json:"fallback_ttl"`

	// IncludeCookies: defines whether responses to requests with cookies must be stored in the cache.
	IncludeCookies bool `json:"include_cookies"`

	// CreatedAt: date the cache stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the cache stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// BackendStageID: backend stage ID the cache stage is linked to.
	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`

	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`

	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	RouteStageID *string `json:"route_stage_id,omitempty"`
}

type CheckDomainRequest struct {
	ProjectID string `json:"project_id"`

	Fqdn string `json:"fqdn"`

	Cname string `json:"cname"`
}

type CheckDomainResponse struct {
	IsValid bool `json:"is_valid"`
}

type CheckLBOriginRequest struct {
	LB *ScalewayLB `json:"lb,omitempty"`
}

type CheckLBOriginResponse struct {
	IsValid bool `json:"is_valid"`

	// ErrorType: default value: unknown
	ErrorType LBOriginError `json:"error_type"`
}

type CheckPEMChainRequest struct {
	ProjectID string `json:"project_id"`

	Fqdn string `json:"fqdn"`

	// Precisely one of Secret, Raw must be set.
	Secret *CheckPEMChainRequestSecretChain `json:"secret,omitempty"`

	// Precisely one of Secret, Raw must be set.
	Raw *string `json:"raw,omitempty"`
}

type CheckPEMChainRequestSecretChain struct {
	SecretID string `json:"secret_id"`

	SecretRegion string `json:"secret_region"`
}

type CheckPEMChainResponse struct {
	IsValid bool `json:"is_valid"`
}

type CreateBackendStageRequest struct {
	// PipelineID: pipeline ID the Backend stage belongs to.
	PipelineID string `json:"-"`

	// ScalewayS3: scaleway Object Storage origin bucket (S3) linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayS3 *ScalewayS3BackendConfig `json:"scaleway_s3,omitempty"`

	// ScalewayLB: scaleway Load Balancer origin linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayLB *ScalewayLBBackendConfig `json:"scaleway_lb,omitempty"`
}

type CreateCacheStageRequest struct {
	// PipelineID: pipeline ID the Cache stage belongs to.
	PipelineID string `json:"-"`

	// FallbackTTL: time To Live (TTL) in seconds. Defines how long content is cached.
	FallbackTTL *scw.Duration `json:"fallback_ttl,omitempty"`

	// IncludeCookies: defines whether responses to requests with cookies must be stored in the cache.
	IncludeCookies *bool `json:"include_cookies,omitempty"`

	// BackendStageID: backend stage ID the cache stage will be linked to.
	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`

	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`

	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	RouteStageID *string `json:"route_stage_id,omitempty"`
}

type CreateDNSStageRequest struct {
	// PipelineID: pipeline ID the DNS stage belongs to.
	PipelineID string `json:"-"`

	// Fqdns: fully Qualified Domain Name (in the format subdomain.example.com) to attach to the stage.
	Fqdns *[]string `json:"fqdns,omitempty"`

	// TLSStageID: TLS stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	TLSStageID *string `json:"tls_stage_id,omitempty"`

	// CacheStageID: cache stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

type CreatePipelineRequest struct {
	// ProjectID: project ID in which the pipeline will be created.
	ProjectID string `json:"project_id"`

	// Name: name of the pipeline.
	Name string `json:"name"`

	// Description: description of the pipeline.
	Description string `json:"description"`
}

type CreatePurgeRequestRequest struct {
	// PipelineID: pipeline ID in which the purge request will be created.
	PipelineID string `json:"pipeline_id"`

	// Assets: list of asserts to purge.
	// Precisely one of Assets, All must be set.
	Assets *[]string `json:"assets,omitempty"`

	// All: defines whether to purge all content.
	// Precisely one of Assets, All must be set.
	All *bool `json:"all,omitempty"`
}

type CreateRouteStageRequest struct {
	// PipelineID: pipeline ID the route stage belongs to.
	PipelineID string `json:"-"`

	// WafStageID: ID of the WAF stage HTTP requests should be forwarded to when no rules are matched.
	// Precisely one of WafStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`
}

type CreateTLSStageRequest struct {
	// PipelineID: pipeline ID the TLS stage belongs to.
	PipelineID string `json:"-"`

	// Secrets: secret (from Scaleway Secret Manager) containing your custom certificate.
	Secrets []*TLSSecret `json:"secrets"`

	// ManagedCertificate: true when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.
	ManagedCertificate *bool `json:"managed_certificate,omitempty"`

	// CacheStageID: cache stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`

	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	RouteStageID *string `json:"route_stage_id,omitempty"`

	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`
}

type CreateWafStageRequest struct {
	// PipelineID: pipeline ID the WAF stage belongs to.
	PipelineID string `json:"-"`

	// Mode: mode defining WAF behavior (`disable`/`log_only`/`enable`).
	// Default value: unknown_mode
	Mode WafStageMode `json:"mode"`

	// ParanoiaLevel: 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 uint32 `json:"paranoia_level"`

	// BackendStageID: ID of the backend stage to forward requests to after the WAF stage.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

type DNSStage struct {
	// ID: ID of the DNS stage.
	ID string `json:"id"`

	// Fqdns: list of Fully Qualified Domain Names attached to the stage.
	Fqdns []string `json:"fqdns"`

	// Type: type of the stage.
	// Default value: unknown_type
	Type DNSStageType `json:"type"`

	// PipelineID: pipeline ID the DNS stage belongs to.
	PipelineID string `json:"pipeline_id"`

	// CreatedAt: date the DNS stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the DNS stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// TLSStageID: TLS stage ID the DNS stage is linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	TLSStageID *string `json:"tls_stage_id,omitempty"`

	// CacheStageID: cache stage ID the DNS stage is linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the DNS stage is linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

type DNSStageType string

type DeleteBackendStageRequest struct {
	// BackendStageID: ID of the backend stage to delete.
	BackendStageID string `json:"-"`
}

type DeleteCacheStageRequest struct {
	// CacheStageID: ID of the cache stage to delete.
	CacheStageID string `json:"-"`
}

type DeleteCurrentPlanRequest struct {
	ProjectID string `json:"-"`
}

type DeleteDNSStageRequest struct {
	// DNSStageID: ID of the DNS stage to delete.
	DNSStageID string `json:"-"`
}

type DeletePipelineRequest struct {
	// PipelineID: ID of the pipeline to delete.
	PipelineID string `json:"-"`
}

type DeleteRouteStageRequest struct {
	// RouteStageID: ID of the route stage to delete.
	RouteStageID string `json:"-"`
}

type DeleteTLSStageRequest struct {
	// TLSStageID: ID of the TLS stage to delete.
	TLSStageID string `json:"-"`
}

type DeleteWafStageRequest struct {
	// WafStageID: ID of the WAF stage to delete.
	WafStageID string `json:"-"`
}

type GetBackendStageRequest struct {
	// BackendStageID: ID of the requested backend stage.
	BackendStageID string `json:"-"`
}

type GetBillingRequest struct {
	ProjectID string `json:"-"`
}

type GetBillingResponse struct {
	// CurrentPlan: information on the currently-selected, active Edge Services subscription plan.
	CurrentPlan *PlanDetails `json:"current_plan"`

	// PlanCost: 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 *scw.Money `json:"plan_cost"`

	// PipelineNumber: total number of pipelines currently configured.
	PipelineNumber uint32 `json:"pipeline_number"`

	// ExtraPipelinesCost: cost to date (this month) of pipelines not included in the subscription plans.
	ExtraPipelinesCost *scw.Money `json:"extra_pipelines_cost"`

	// CurrentPlanCacheUsage: total amount of data egressed from the cache in gigabytes from the beginning of the month, for the active subscription plan.
	CurrentPlanCacheUsage uint64 `json:"current_plan_cache_usage"`

	// ExtraCacheUsage: total amount of extra data egressed from cache in gigabytes from the beginning of the month, not included in the subscription plans.
	ExtraCacheUsage uint64 `json:"extra_cache_usage"`

	// ExtraCacheCost: cost to date (this month) of the data egressed from the cache that is not included in the subscription plans.
	ExtraCacheCost *scw.Money `json:"extra_cache_cost"`

	// CurrentPlanWafUsage: total number of requests processed by the WAF since the beginning of the current month, for the active subscription plan.
	CurrentPlanWafUsage uint64 `json:"current_plan_waf_usage"`

	// ExtraWafUsage: total number of extra requests processed by the WAF from the beginning of the month, not included in the subscription plans.
	ExtraWafUsage uint64 `json:"extra_waf_usage"`

	// ExtraWafCost: cost to date (this month) of the extra requests processed by the WAF that were not included in the subscription plans.
	ExtraWafCost *scw.Money `json:"extra_waf_cost"`

	// WafAddOn: cost of activating WAF add-on (where subscription plan does not include WAF).
	WafAddOn *scw.Money `json:"waf_add_on"`

	// PlansUsageDetails: detailed costs and usage for all Edge Services subscription plans that were activated during the month.
	PlansUsageDetails map[string]*PlanUsageDetails `json:"plans_usage_details"`

	// TotalCost: 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 *scw.Money `json:"total_cost"`
}

type GetCacheStageRequest struct {
	// CacheStageID: ID of the requested cache stage.
	CacheStageID string `json:"-"`
}

type GetCurrentPlanRequest struct {
	ProjectID string `json:"-"`
}

type GetDNSStageRequest struct {
	// DNSStageID: ID of the requested DNS stage.
	DNSStageID string `json:"-"`
}

type GetPipelineRequest struct {
	// PipelineID: ID of the requested pipeline.
	PipelineID string `json:"-"`
}

type GetPurgeRequestRequest struct {
	// PurgeRequestID: ID of the requested purge request.
	PurgeRequestID string `json:"-"`
}

type GetRouteStageRequest struct {
	// RouteStageID: ID of the requested route stage.
	RouteStageID string `json:"-"`
}

type GetTLSStageRequest struct {
	// TLSStageID: ID of the requested TLS stage.
	TLSStageID string `json:"-"`
}

type GetWafStageRequest struct {
	// WafStageID: ID of the requested WAF stage.
	WafStageID string `json:"-"`
}

type HeadStageResponse struct {
	// HeadStage: modified or created head stage.
	HeadStage *HeadStageResponseHeadStage `json:"head_stage"`
}

type HeadStageResponseHeadStage struct {
	// Precisely one of DNSStageID must be set.
	DNSStageID *string `json:"dns_stage_id,omitempty"`
}

type LBOriginError string

type ListBackendStagesRequest struct {
	// PipelineID: pipeline ID to filter for. Only backend stages from this pipeline will be returned.
	PipelineID string `json:"-"`

	// OrderBy: sort order of backend stages in the response.
	// Default value: created_at_asc
	OrderBy ListBackendStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of backend stages to return per page.
	PageSize *uint32 `json:"-"`

	// BucketName: bucket name to filter for. Only backend stages from this Bucket will be returned.
	BucketName *string `json:"-"`

	// BucketRegion: bucket region to filter for. Only backend stages with buckets in this region will be returned.
	BucketRegion *string `json:"-"`

	// LBID: load Balancer ID to filter for. Only backend stages with this Load Balancer will be returned.
	LBID *string `json:"-"`
}

type ListBackendStagesRequestOrderBy string

type ListBackendStagesResponse struct {
	// Stages: paginated list of backend stages.
	Stages []*BackendStage `json:"stages"`

	// TotalCount: count of all backend stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListCacheStagesRequest struct {
	// PipelineID: pipeline ID to filter for. Only cache stages from this pipeline will be returned.
	PipelineID string `json:"-"`

	// OrderBy: sort order of cache stages in the response.
	// Default value: created_at_asc
	OrderBy ListCacheStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of cache stages to return per page.
	PageSize *uint32 `json:"-"`
}

type ListCacheStagesRequestOrderBy string

type ListCacheStagesResponse struct {
	// Stages: paginated list of cache stages.
	Stages []*CacheStage `json:"stages"`

	// TotalCount: count of all cache stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListDNSStagesRequest struct {
	// PipelineID: pipeline ID to filter for. Only DNS stages from this pipeline will be returned.
	PipelineID string `json:"-"`

	// OrderBy: sort order of DNS stages in the response.
	// Default value: created_at_asc
	OrderBy ListDNSStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of DNS stages to return per page.
	PageSize *uint32 `json:"-"`

	// Fqdn: fully Qualified Domain Name to filter for (in the format subdomain.example.com). Only DNS stages with this FQDN will be returned.
	Fqdn *string `json:"-"`
}

type ListDNSStagesRequestOrderBy string

type ListDNSStagesResponse struct {
	// Stages: paginated list of DNS stages.
	Stages []*DNSStage `json:"stages"`

	// TotalCount: count of all DNS stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListHeadStagesRequest struct {
	// PipelineID: ID of the pipeline to update.
	PipelineID string `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of head stages to return per page.
	PageSize *uint32 `json:"-"`
}

type ListHeadStagesResponse struct {
	// HeadStages: number of head stages to return per page.
	HeadStages []*ListHeadStagesResponseHeadStage `json:"head_stages"`

	// TotalCount: count of all head stages matching the requested pipeline_id.
	TotalCount uint64 `json:"total_count"`
}

type ListHeadStagesResponseHeadStage struct {
	// Precisely one of DNSStageID must be set.
	DNSStageID *string `json:"dns_stage_id,omitempty"`
}

type ListPipelinesRequest struct {
	// OrderBy: sort order of pipelines in the response.
	// Default value: created_at_asc
	OrderBy ListPipelinesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of pipelines to return per page.
	PageSize *uint32 `json:"-"`

	// Name: pipeline name to filter for. Only pipelines with this string within their name will be returned.
	Name *string `json:"-"`

	// OrganizationID: organization ID to filter for. Only pipelines from this Organization will be returned.
	OrganizationID *string `json:"-"`

	// ProjectID: project ID to filter for. Only pipelines from this Project will be returned.
	ProjectID *string `json:"-"`

	// HasBackendStageLB: filter on backend stage. Only pipelines with a Load Balancer origin will be returned.
	HasBackendStageLB *bool `json:"-"`
}

type ListPipelinesRequestOrderBy string

type ListPipelinesResponse struct {
	// Pipelines: paginated list of pipelines.
	Pipelines []*Pipeline `json:"pipelines"`

	// TotalCount: count of all pipelines matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListPipelinesWithStagesRequest struct {
	// OrderBy: default value: created_at_asc
	OrderBy ListPipelinesWithStagesRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	Name *string `json:"-"`

	OrganizationID *string `json:"-"`

	ProjectID *string `json:"-"`
}

type ListPipelinesWithStagesRequestOrderBy string

type ListPipelinesWithStagesResponse struct {
	Pipelines []*PipelineStages `json:"pipelines"`

	TotalCount uint64 `json:"total_count"`
}

type ListPlansResponse struct {
	TotalCount uint64 `json:"total_count"`

	Plans []*PlanDetails `json:"plans"`
}

type ListPurgeRequestsRequest struct {
	// OrderBy: sort order of purge requests in the response.
	// Default value: created_at_asc
	OrderBy ListPurgeRequestsRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of purge requests to return per page.
	PageSize *uint32 `json:"-"`

	// OrganizationID: organization ID to filter for. Only purge requests from this Project will be returned.
	OrganizationID *string `json:"-"`

	// ProjectID: project ID to filter for. Only purge requests from this Project will be returned.
	ProjectID *string `json:"-"`

	// PipelineID: pipeline ID to filter for. Only purge requests from this pipeline will be returned.
	PipelineID *string `json:"-"`
}

type ListPurgeRequestsRequestOrderBy string

type ListPurgeRequestsResponse struct {
	// PurgeRequests: paginated list of purge requests.
	PurgeRequests []*PurgeRequest `json:"purge_requests"`

	// TotalCount: count of all purge requests matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListRouteRulesRequest struct {
	// RouteStageID: route stage ID to filter for. Only route rules from this route stage will be returned.
	RouteStageID string `json:"-"`
}

type ListRouteRulesResponse struct {
	// RouteRules: 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 `json:"route_rules"`

	// TotalCount: count of all route rules matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListRouteStagesRequest struct {
	// PipelineID: pipeline ID to filter for. Only route stages from this pipeline will be returned.
	PipelineID string `json:"-"`

	// OrderBy: sort order of route stages in the response.
	// Default value: created_at_asc
	OrderBy ListRouteStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of route stages to return per page.
	PageSize *uint32 `json:"-"`
}

type ListRouteStagesRequestOrderBy string

type ListRouteStagesResponse struct {
	// Stages: paginated list of summarized route stages.
	Stages []*RouteStage `json:"stages"`

	// TotalCount: count of all route stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListTLSStagesRequest struct {
	// PipelineID: pipeline ID to filter for. Only TLS stages from this pipeline will be returned.
	PipelineID string `json:"-"`

	// OrderBy: sort order of TLS stages in the response.
	// Default value: created_at_asc
	OrderBy ListTLSStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of TLS stages to return per page.
	PageSize *uint32 `json:"-"`

	// SecretID: secret ID to filter for. Only TLS stages with this Secret ID will be returned.
	SecretID *string `json:"-"`

	// SecretRegion: secret region to filter for. Only TLS stages with a Secret in this region will be returned.
	SecretRegion *string `json:"-"`
}

type ListTLSStagesRequestOrderBy string

type ListTLSStagesResponse struct {
	// Stages: paginated list of TLS stages.
	Stages []*TLSStage `json:"stages"`

	// TotalCount: count of all TLS stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListWafStagesRequest struct {
	// PipelineID: pipeline ID to filter for. Only WAF stages from this pipeline will be returned.
	PipelineID string `json:"-"`

	// OrderBy: sort order of WAF stages in the response.
	// Default value: created_at_asc
	OrderBy ListWafStagesRequestOrderBy `json:"-"`

	// Page: page number to return, from the paginated results.
	Page *int32 `json:"-"`

	// PageSize: number of WAF stages to return per page.
	PageSize *uint32 `json:"-"`
}

type ListWafStagesRequestOrderBy string

type ListWafStagesResponse struct {
	// Stages: paginated list of WAF stages.
	Stages []*WafStage `json:"stages"`

	// TotalCount: count of all WAF stages matching the requested criteria.
	TotalCount uint64 `json:"total_count"`
}

type Pipeline struct {
	// ID: ID of the pipeline.
	ID string `json:"id"`

	// Name: name of the pipeline.
	Name string `json:"name"`

	// Description: description of the pipeline.
	Description string `json:"description"`

	// Status: status of the pipeline.
	// Default value: unknown_status
	Status PipelineStatus `json:"status"`

	// Errors: errors of the pipeline.
	Errors []*PipelineError `json:"errors"`

	// ProjectID: project ID of the pipeline.
	ProjectID string `json:"project_id"`

	// OrganizationID: organization ID of the pipeline.
	OrganizationID string `json:"organization_id"`

	// CreatedAt: date the pipeline was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the pipeline was last updated.
	UpdatedAt *time.Time `json:"updated_at"`
}

type PipelineError struct {
	// Stage: default value: unknown_stage
	Stage PipelineErrorStage `json:"stage"`

	// Code: default value: unknown_code
	Code PipelineErrorCode `json:"code"`

	// Severity: default value: unknown_severity
	Severity PipelineErrorSeverity `json:"severity"`

	Message string `json:"message"`

	// Type: default value: unknown_type
	Type PipelineErrorType `json:"type"`
}

type PipelineErrorCode string

type PipelineErrorSeverity string

type PipelineErrorStage string

type PipelineErrorType string

type PipelineStages struct {
	Pipeline *Pipeline `json:"pipeline"`

	DNSStages []*DNSStage `json:"dns_stages"`

	TLSStages []*TLSStage `json:"tls_stages"`

	CacheStages []*CacheStage `json:"cache_stages"`

	BackendStages []*BackendStage `json:"backend_stages"`

	WafStages []*WafStage `json:"waf_stages"`

	RouteStages []*RouteStage `json:"route_stages"`
}

type PipelineStatus string

type Plan struct {
	// PlanName: default value: unknown_name
	PlanName PlanName `json:"plan_name"`
}

type PlanDetails struct {
	// PlanName: subscription plan name.
	// Default value: unknown_name
	PlanName PlanName `json:"plan_name"`

	// PackageGb: amount of egress data from cache included in subscription plan.
	PackageGb uint64 `json:"package_gb"`

	// PipelineLimit: number of pipelines included in subscription plan.
	PipelineLimit uint32 `json:"pipeline_limit"`

	// WafRequests: number of WAF requests included in subscription plan.
	WafRequests uint64 `json:"waf_requests"`
}

type PlanName string

type PlanUsageDetails struct {
	// PlanCost: cost to date (this month) for the corresponding Edge Services subscription plan.
	PlanCost *scw.Money `json:"plan_cost"`
}

type PurgeRequest struct {
	// ID: ID of the purge request.
	ID string `json:"id"`

	// PipelineID: pipeline ID the purge request belongs to.
	PipelineID string `json:"pipeline_id"`

	// Status: status of the purge request.
	// Default value: unknown_status
	Status PurgeRequestStatus `json:"status"`

	// Assets: list of asserts to purge.
	// Precisely one of Assets, All must be set.
	Assets *[]string `json:"assets,omitempty"`

	// All: defines whether to purge all content.
	// Precisely one of Assets, All must be set.
	All *bool `json:"all,omitempty"`

	// CreatedAt: date the purge request was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the purge request was last updated.
	UpdatedAt *time.Time `json:"updated_at"`
}

type PurgeRequestStatus string

type RouteRule struct {
	// RuleHTTPMatch: 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.
	// Precisely one of RuleHTTPMatch must be set.
	RuleHTTPMatch *RuleHTTPMatch `json:"rule_http_match,omitempty"`

	// BackendStageID: ID of the backend stage that requests matching the rule should be forwarded to.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`

	// Position: position of the rule which determines the order of processing within the route stage.
	Position int32 `json:"position"`

	// RouteStageID: route stage ID the route rule belongs to.
	RouteStageID string `json:"route_stage_id"`
}

type RouteStage struct {
	// ID: ID of the route stage.
	ID string `json:"id"`

	// PipelineID: pipeline ID the route stage belongs to.
	PipelineID string `json:"pipeline_id"`

	// WafStageID: ID of the WAF stage HTTP requests should be forwarded to when no rules are matched.
	// Precisely one of WafStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`

	// CreatedAt: date the route stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the route stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`
}

type RuleHTTPMatch struct {
	// MethodFilters: 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 `json:"method_filters"`

	// PathFilter: 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 `json:"path_filter"`
}

type RuleHTTPMatchMethodFilter string

type RuleHTTPMatchPathFilter struct {
	// PathFilterType: 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.
	// Default value: unknown_path_filter
	PathFilterType RuleHTTPMatchPathFilterPathFilterType `json:"path_filter_type"`

	// Value: value to be matched for the HTTP URL path.
	Value string `json:"value"`
}

type RuleHTTPMatchPathFilterPathFilterType string

type ScalewayLB struct {
	// ID: ID of the Load Balancer.
	ID string `json:"id"`

	// Zone: zone of the Load Balancer.
	Zone scw.Zone `json:"zone"`

	// FrontendID: ID of the frontend linked to the Load Balancer.
	FrontendID string `json:"frontend_id"`

	// IsSsl: defines whether the Load Balancer's frontend handles SSL connections.
	IsSsl *bool `json:"is_ssl"`

	// DomainName: fully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer.
	DomainName *string `json:"domain_name"`
}

type ScalewayLBBackendConfig struct {
	// LBs: load Balancer information.
	LBs []*ScalewayLB `json:"lbs"`
}

type ScalewayS3BackendConfig struct {
	// BucketName: name of the Bucket.
	BucketName *string `json:"bucket_name"`

	// BucketRegion: region of the Bucket.
	BucketRegion *string `json:"bucket_region"`

	// IsWebsite: defines whether the bucket website feature is enabled.
	IsWebsite *bool `json:"is_website"`
}

type SearchBackendStagesRequest struct {
	// OrderBy: default value: created_at_asc
	OrderBy SearchBackendStagesRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	ProjectID string `json:"-"`

	BucketName *string `json:"-"`

	BucketRegion *string `json:"-"`

	LBID *string `json:"-"`
}

type SearchBackendStagesRequestOrderBy string

type SearchRouteRulesRequest struct {
	// OrderBy: default value: created_at_asc
	OrderBy SearchRouteRulesRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	OrganizationID *string `json:"-"`

	ProjectID *string `json:"-"`
}

type SearchRouteRulesRequestOrderBy string

type SearchWafStagesRequest struct {
	// OrderBy: default value: created_at_asc
	OrderBy SearchWafStagesRequestOrderBy `json:"-"`

	Page *int32 `json:"-"`

	PageSize *uint32 `json:"-"`

	ProjectID string `json:"-"`
}

type SearchWafStagesRequestOrderBy string

type SelectPlanRequest struct {
	ProjectID string `json:"project_id"`

	// PlanName: default value: unknown_name
	PlanName PlanName `json:"plan_name"`
}

type SetHeadStageRequest struct {
	// PipelineID: ID of the pipeline to update.
	PipelineID string `json:"-"`

	// AddNewHeadStage: add a new head stage.
	// Precisely one of AddNewHeadStage, RemoveHeadStage, SwapHeadStage must be set.
	AddNewHeadStage *SetHeadStageRequestAddNewHeadStage `json:"add_new_head_stage,omitempty"`

	// RemoveHeadStage: remove a head stage.
	// Precisely one of AddNewHeadStage, RemoveHeadStage, SwapHeadStage must be set.
	RemoveHeadStage *SetHeadStageRequestRemoveHeadStage `json:"remove_head_stage,omitempty"`

	// SwapHeadStage: replace a head stage with a new one.
	// Precisely one of AddNewHeadStage, RemoveHeadStage, SwapHeadStage must be set.
	SwapHeadStage *SetHeadStageRequestSwapHeadStage `json:"swap_head_stage,omitempty"`
}

type SetHeadStageRequestAddNewHeadStage struct {
	NewStageID string `json:"new_stage_id"`
}

type SetHeadStageRequestRemoveHeadStage struct {
	RemoveStageID string `json:"remove_stage_id"`
}

type SetHeadStageRequestSwapHeadStage struct {
	NewStageID string `json:"new_stage_id"`

	CurrentStageID string `json:"current_stage_id"`
}

type SetRouteRulesRequest struct {
	// RouteStageID: ID of the route stage to update.
	RouteStageID string `json:"-"`

	// RouteRules: 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 `json:"route_rules"`
}

type SetRouteRulesRequestRouteRule struct {
	// RuleHTTPMatch: 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.
	// Precisely one of RuleHTTPMatch must be set.
	RuleHTTPMatch *RuleHTTPMatch `json:"rule_http_match,omitempty"`

	// BackendStageID: ID of the backend stage that requests matching the rule should be forwarded to.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

type SetRouteRulesResponse struct {
	// RouteRules: 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 `json:"route_rules"`
}

type TLSSecret struct {
	// SecretID: ID of the Secret.
	SecretID string `json:"secret_id"`

	// Region: region of the Secret.
	Region scw.Region `json:"region"`
}

type TLSSecretsConfig struct {
	// TLSSecrets: secret information (from Secret Manager).
	TLSSecrets []*TLSSecret `json:"tls_secrets"`
}

type TLSStage struct {
	// ID: ID of the TLS stage.
	ID string `json:"id"`

	// Secrets: secret (from Scaleway Secret Manager) containing your custom certificate.
	Secrets []*TLSSecret `json:"secrets"`

	// ManagedCertificate: true when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.
	ManagedCertificate bool `json:"managed_certificate"`

	// PipelineID: pipeline ID the TLS stage belongs to.
	PipelineID string `json:"pipeline_id"`

	// CertificateExpiresAt: expiration date of the certificate.
	CertificateExpiresAt *time.Time `json:"certificate_expires_at"`

	// CreatedAt: date the TLS stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the TLS stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// CacheStageID: cache stage ID the TLS stage is linked to.
	// Precisely one of CacheStageID, BackendStageID, WafStageID, RouteStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the TLS stage is linked to.
	// Precisely one of CacheStageID, BackendStageID, WafStageID, RouteStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`

	// Precisely one of CacheStageID, BackendStageID, WafStageID, RouteStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`

	// Precisely one of CacheStageID, BackendStageID, WafStageID, RouteStageID must be set.
	RouteStageID *string `json:"route_stage_id,omitempty"`
}

type UpdateBackendStageRequest struct {
	// BackendStageID: ID of the backend stage to update.
	BackendStageID string `json:"-"`

	// ScalewayS3: scaleway Object Storage origin bucket (S3) linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayS3 *ScalewayS3BackendConfig `json:"scaleway_s3,omitempty"`

	// ScalewayLB: scaleway Load Balancer origin linked to the backend stage.
	// Precisely one of ScalewayS3, ScalewayLB must be set.
	ScalewayLB *ScalewayLBBackendConfig `json:"scaleway_lb,omitempty"`

	// PipelineID: pipeline ID the Backend stage belongs to.
	PipelineID string `json:"pipeline_id"`
}

type UpdateCacheStageRequest struct {
	// CacheStageID: ID of the cache stage to update.
	CacheStageID string `json:"-"`

	// FallbackTTL: time To Live (TTL) in seconds. Defines how long content is cached.
	FallbackTTL *scw.Duration `json:"fallback_ttl,omitempty"`

	// IncludeCookies: defines whether responses to requests with cookies must be stored in the cache.
	IncludeCookies *bool `json:"include_cookies,omitempty"`

	// BackendStageID: backend stage ID the cache stage will be linked to.
	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`

	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`

	// Precisely one of BackendStageID, WafStageID, RouteStageID must be set.
	RouteStageID *string `json:"route_stage_id,omitempty"`
}

type UpdateDNSStageRequest struct {
	// DNSStageID: ID of the DNS stage to update.
	DNSStageID string `json:"-"`

	// Fqdns: fully Qualified Domain Name (in the format subdomain.example.com) attached to the stage.
	Fqdns *[]string `json:"fqdns,omitempty"`

	// TLSStageID: TLS stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	TLSStageID *string `json:"tls_stage_id,omitempty"`

	// CacheStageID: cache stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the DNS stage will be linked to.
	// Precisely one of TLSStageID, CacheStageID, BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

type UpdatePipelineRequest struct {
	// PipelineID: ID of the pipeline to update.
	PipelineID string `json:"-"`

	// Name: name of the pipeline.
	Name *string `json:"name,omitempty"`

	// Description: description of the pipeline.
	Description *string `json:"description,omitempty"`
}

type UpdateRouteStageRequest struct {
	// RouteStageID: ID of the route stage to update.
	RouteStageID string `json:"-"`

	// WafStageID: ID of the WAF stage HTTP requests should be forwarded to when no rules are matched.
	// Precisely one of WafStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`
}

type UpdateTLSStageRequest struct {
	// TLSStageID: ID of the TLS stage to update.
	TLSStageID string `json:"-"`

	// TLSSecretsConfig: secret (from Scaleway Secret-Manager) containing your custom certificate.
	TLSSecretsConfig *TLSSecretsConfig `json:"tls_secrets_config,omitempty"`

	// ManagedCertificate: true when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.
	ManagedCertificate *bool `json:"managed_certificate,omitempty"`

	// CacheStageID: cache stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	CacheStageID *string `json:"cache_stage_id,omitempty"`

	// BackendStageID: backend stage ID the TLS stage will be linked to.
	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`

	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	RouteStageID *string `json:"route_stage_id,omitempty"`

	// Precisely one of CacheStageID, BackendStageID, RouteStageID, WafStageID must be set.
	WafStageID *string `json:"waf_stage_id,omitempty"`
}

type UpdateWafStageRequest struct {
	// WafStageID: ID of the WAF stage to update.
	WafStageID string `json:"-"`

	// Mode: mode defining WAF behavior (`disable`/`log_only`/`enable`).
	// Default value: unknown_mode
	Mode WafStageMode `json:"mode"`

	// ParanoiaLevel: 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 *uint32 `json:"paranoia_level,omitempty"`

	// BackendStageID: ID of the backend stage to forward requests to after the WAF stage.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

type WafStage struct {
	// ID: ID of the WAF stage.
	ID string `json:"id"`

	// PipelineID: pipeline ID the WAF stage belongs to.
	PipelineID string `json:"pipeline_id"`

	// Mode: mode defining WAF behavior (`disable`/`log_only`/`enable`).
	// Default value: unknown_mode
	Mode WafStageMode `json:"mode"`

	// ParanoiaLevel: 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 uint32 `json:"paranoia_level"`

	// CreatedAt: date the WAF stage was created.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: date the WAF stage was last updated.
	UpdatedAt *time.Time `json:"updated_at"`

	// BackendStageID: ID of the backend stage to forward requests to after the WAF stage.
	// Precisely one of BackendStageID must be set.
	BackendStageID *string `json:"backend_stage_id,omitempty"`
}

type WafStageMode string

type WaitForPipelineRequest struct {
	PipelineID    string
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

type WaitForPurgeRequestRequest struct {
	PurgeRequestID string
	Timeout        *time.Duration
	RetryInterval  *time.Duration
}