api

type ChiServerOptions struct {
	BaseURL          string
	BaseRouter       chi.Router
	Middlewares      []MiddlewareFunc
	ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error)
}

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

type ClientInterface interface {
	// Healthz request
	Healthz(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListScans request
	ListScans(ctx context.Context, params *ListScansParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateScan request with any body
	CreateScanWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateScan(ctx context.Context, body CreateScanJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveScan request
	RetrieveScan(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// Healthz request
	HealthzWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthzResponse, error)

	// ListScans request
	ListScansWithResponse(ctx context.Context, params *ListScansParams, reqEditors ...RequestEditorFn) (*ListScansResponse, error)

	// CreateScan request with any body
	CreateScanWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateScanResponse, error)

	CreateScanWithResponse(ctx context.Context, body CreateScanJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateScanResponse, error)

	// RetrieveScan request
	RetrieveScanWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*RetrieveScanResponse, error)
}

type CreateScanJSONRequestBody = NewScan

type CreateScanResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *NewScan
	JSONDefault  *Error
}

type Error struct {
	Body *map[string]interface{} `json:"body,omitempty"`

	// Code Error code
	Code int32 `json:"code"`

	// Status Error message
	Status string `json:"status"`
}

type Healthz struct {
	Status  string `json:"status"`
	Version string `json:"version"`
}

type HealthzResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *interface{}
}

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type InvalidParamFormatError struct {
	ParamName string
	Err       error
}

type ListScansParams struct {
	// Page page number for pagination
	Page *PageParam `form:"page,omitempty" json:"page,omitempty"`

	// PageSize page size for pagination. default is 20
	PageSize *PageSizeParam `form:"page_size,omitempty" json:"page_size,omitempty"`

	// Sort sort results by 'asc' or 'desc'. default is 'asc'
	Sort *PageSortParam `form:"sort,omitempty" json:"sort,omitempty"`
}

type ListScansResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Scan
}

type MiddlewareFunc func(http.Handler) http.Handler

type NewScan struct {
	// Description user entered description for easier identification
	Description string   `json:"description"`
	Hosts       []string `json:"hosts"`

	// Ports ports to scan. must be supplied in an array
	Ports []string `json:"ports"`

	// Timeout time in seconds
	Timeout *int `json:"timeout,omitempty"`

	// Type type of scan. must be one of the allowed types
	Type NewScanType `json:"type"`
}

type NewScanType string

type PageParam = string

type PageSizeParam = string

type PageSortParam = string

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type RequiredHeaderError struct {
	ParamName string
	Err       error
}

type RequiredParamError struct {
	ParamName string
}

type RetrieveScanResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Scan
	JSONDefault  *Error
}

type Scan struct {
	// Data The entire response object for a single scan.
	Data        ScanData   `json:"data"`
	Description string     `json:"description"`
	HostsArray  []string   `json:"hosts_array"`
	Id          string     `json:"id"`
	Ports       []string   `json:"ports"`
	ScanType    string     `json:"scan_type"`
	Status      ScanStatus `json:"status"`
	Summary     string     `json:"summary"`

	// Timeout time in seconds
	Timeout *int `json:"timeout,omitempty"`
}

type ScanBody = NewScan

type ScanData struct {
	// Args nmap command equivalent
	Args     *string           `json:"args,omitempty"`
	Hosts    *[]ScanHostsArray `json:"hosts,omitempty"`
	Runstats *struct {
		Finished *struct {
			Elapsed  *float32 `json:"elapsed,omitempty"`
			ErrorMsg *string  `json:"error_msg,omitempty"`
			Exit     *string  `json:"exit,omitempty"`
			Summary  *string  `json:"summary,omitempty"`
			Time     *int64   `json:"time,omitempty"`
			TimeStr  *string  `json:"time_str,omitempty"`
		} `json:"finished,omitempty"`
		Hosts *struct {
			Down  *int `json:"down,omitempty"`
			Total *int `json:"total,omitempty"`
			Up    *int `json:"up,omitempty"`
		} `json:"hosts,omitempty"`
	} `json:"runstats,omitempty"`
	ScanInfo *struct {
		NumServices *int32  `json:"num_services,omitempty"`
		Protocol    *string `json:"protocol,omitempty"`
		ScanFlags   *string `json:"scan_flags,omitempty"`
		Services    *string `json:"services,omitempty"`
		Type        *string `json:"type,omitempty"`
	} `json:"scan_info,omitempty"`
	Scanner *string  `json:"scanner,omitempty"`
	Start   *float32 `json:"start,omitempty"`

	// StartStr scan start time
	StartStr *string `json:"start_str,omitempty"`
	Verbose  *struct {
		Level *int `json:"level,omitempty"`
	} `json:"verbose,omitempty"`

	// Version nmap version on server
	Version *string `json:"version,omitempty"`
}

type ScanHostsArray struct {
	Addresses *[]struct {
		Addr     *string `json:"addr,omitempty"`
		AddrType *string `json:"addr_type,omitempty"`
		Vendor   *string `json:"vendor,omitempty"`
	} `json:"addresses,omitempty"`
	Comment  *string `json:"comment,omitempty"`
	Distance *struct {
		Value *int32 `json:"value,omitempty"`
	} `json:"distance,omitempty"`
	EndTime    *int64 `json:"end_time,omitempty"`
	ExtraPorts *[]struct {
		Count   *int32 `json:"count,omitempty"`
		Reasons *[]struct {
			Count  *int32  `json:"count,omitempty"`
			Reason *string `json:"reason,omitempty"`
		} `json:"reasons,omitempty"`
		State *string `json:"state,omitempty"`
	} `json:"extra_ports,omitempty"`
	HostScripts *string `json:"host_scripts,omitempty"`
	Hostnames   *[]struct {
		Name *string `json:"name,omitempty"`
		Type *string `json:"type,omitempty"`
	} `json:"hostnames,omitempty"`
	IpIdSequence *struct {
		Class  *string `json:"class,omitempty"`
		Values *string `json:"values,omitempty"`
	} `json:"ip_id_sequence,omitempty"`
	Os *struct {
		OsFingerprints *string `json:"os_fingerprints,omitempty"`
		OsMatches      *string `json:"os_matches,omitempty"`
		PortsUsed      *string `json:"ports_used,omitempty"`
	} `json:"os,omitempty"`
	Ports *[]struct {
		Id    *int32 `json:"id,omitempty"`
		Owner *struct {
			Name *string `json:"name,omitempty"`
		} `json:"owner,omitempty"`
		Protocol *string `json:"protocol,omitempty"`
		Scripts  *[]struct {
			Id     *string `json:"id,omitempty"`
			Output *string `json:"output,omitempty"`
			Tables *[]struct {
				Elements *[]struct {
					Key   *string `json:"key,omitempty"`
					Value *string `json:"value,omitempty"`
				} `json:"elements,omitempty"`
			} `json:"tables,omitempty"`
		} `json:"scripts,omitempty"`
		Service *struct {
			Confidence  *int32    `json:"confidence,omitempty"`
			Cpes        *[]string `json:"cpes,omitempty"`
			DeviceType  *string   `json:"device_type,omitempty"`
			ExtraInfo   *string   `json:"extra_info,omitempty"`
			HighVersion *string   `json:"high_version,omitempty"`
			Hostname    *string   `json:"hostname,omitempty"`
			LowVersion  *string   `json:"low_version,omitempty"`
			Method      *string   `json:"method,omitempty"`
			Name        *string   `json:"name,omitempty"`
			OsType      *string   `json:"os_type,omitempty"`
			Product     *string   `json:"product,omitempty"`
			Proto       *string   `json:"proto,omitempty"`
			RpcNum      *string   `json:"rpc_num,omitempty"`
			ServiceFp   *string   `json:"service_fp,omitempty"`
			Tunnel      *string   `json:"tunnel,omitempty"`
			Version     *string   `json:"version,omitempty"`
		} `json:"service,omitempty"`
		State *struct {
			Reason    *string `json:"reason,omitempty"`
			ReasonIp  *string `json:"reason_ip,omitempty"`
			ReasonTtl *int32  `json:"reason_ttl,omitempty"`
			State     *string `json:"state,omitempty"`
		} `json:"state,omitempty"`
	} `json:"ports,omitempty"`
	StartTime *int64 `json:"start_time,omitempty"`
	Status    *struct {
		Reason    *string `json:"reason,omitempty"`
		ReasonTtl *int32  `json:"reason_ttl,omitempty"`
		State     *string `json:"state,omitempty"`
	} `json:"status,omitempty"`
	TcpSequence *struct {
		Difficulty *string `json:"difficulty,omitempty"`
		Index      *int32  `json:"index,omitempty"`
		Values     *string `json:"values,omitempty"`
	} `json:"tcp_sequence,omitempty"`
	TcpTsSequence *struct {
		Class  *string `json:"class,omitempty"`
		Values *string `json:"values,omitempty"`
	} `json:"tcp_ts_sequence,omitempty"`
	TimedOut *bool `json:"timed_out,omitempty"`
	Times    *struct {
		Rttv *string `json:"rttv,omitempty"`
		Srtt *string `json:"srtt,omitempty"`
		To   *string `json:"to,omitempty"`
	} `json:"times,omitempty"`
	Trace *struct {
		Hops  *string `json:"hops,omitempty"`
		Port  *int32  `json:"port,omitempty"`
		Proto *string `json:"proto,omitempty"`
	} `json:"trace,omitempty"`
	Uptime *struct {
		LastBoot *string `json:"last_boot,omitempty"`
		Seconds  *int32  `json:"seconds,omitempty"`
	} `json:"uptime,omitempty"`
}

type ScanStatus string

type ServerInterface interface {
	// Healthcheck
	// (GET /healthz)
	Healthz(w http.ResponseWriter, r *http.Request)
	// List Scans
	// (GET /scans)
	ListScans(w http.ResponseWriter, r *http.Request, params ListScansParams)
	// Create Scan
	// (POST /scans)
	CreateScan(w http.ResponseWriter, r *http.Request)
	// Retrieve Scan
	// (GET /scans/{id})
	RetrieveScan(w http.ResponseWriter, r *http.Request, id string)
}

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandlerFunc   func(w http.ResponseWriter, r *http.Request, err error)
}

type TooManyValuesForParamError struct {
	ParamName string
	Count     int
}

type UnescapedCookieParamError struct {
	ParamName string
	Err       error
}

type UnmarshallingParamError struct {
	ParamName string
	Err       error
}