censys

type AccountManagementClient interface {
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/accountmanagement#getorganizationcredits
	GetOrganizationCreditDetails(
		ctx context.Context,
		orgID string,
	) (Result[components.OrganizationCredits], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/accountmanagement#getusercredits
	GetUserCreditDetails(
		ctx context.Context,
	) (Result[components.UserCredits], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/accountmanagement#getorganizationdetails
	GetOrganizationDetails(
		ctx context.Context,
		orgID string,
	) (Result[components.OrganizationDetails], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/accountmanagement#listorganizationmembers
	ListOrganizationMembers(
		ctx context.Context,
		orgID string,
		pageSize mo.Option[int],
		pageToken mo.Option[string],
	) (Result[components.OrganizationMembersList], ClientError)
}

type Client interface {
	GlobalDataClient
	CollectionsClient
	ThreatHuntingClient
	AccountManagementClient
	HasOrgID() bool
}

type ClientError interface {
	cenclierrors.CencliError
	Status() string
	StatusCode() mo.Option[int64]
}

type ClientGenericError interface {
	ClientError
}

type ClientNotConfiguredError interface {
	cenclierrors.CencliError
}

type ClientStructuredError interface {
	ClientError
}

type ClientUnauthorizedError interface {
	ClientError
}

type CollectionsClient interface {
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/collections#search
	SearchCollection(
		ctx context.Context,
		collectionID string,
		orgID mo.Option[string],
		query string,
		fields []string,
		pageSize mo.Option[int64],
		pageToken mo.Option[string],
	) (Result[components.SearchQueryResponse], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/collections#aggregate
	AggregateCollection(
		ctx context.Context,
		collectionID string,
		orgID mo.Option[string],
		query string,
		field string,
		numBuckets int64,
		countByLevel mo.Option[string],
		filterByQuery mo.Option[bool],
	) (Result[components.SearchAggregateResponse], ClientError)
}

type GlobalDataClient interface {
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/globaldata#gethosts
	GetHosts(
		ctx context.Context,
		orgID mo.Option[string],
		hostIDs []string,
		atTime mo.Option[time.Time],
	) (Result[[]components.Host], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/globaldata#getcertificates
	GetCertificates(
		ctx context.Context,
		orgID mo.Option[string],
		certificateIDs []string,
	) (Result[[]components.Certificate], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/globaldata#getwebproperties
	GetWebProperties(
		ctx context.Context,
		orgID mo.Option[string],
		webPropertyIDs []string,
		atTime mo.Option[time.Time],
	) (Result[[]components.Webproperty], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/globaldata#search
	Search(
		ctx context.Context,
		orgID mo.Option[string],
		query string,
		fields []string,
		pageSize mo.Option[int64],
		pageToken mo.Option[string],
	) (Result[components.SearchQueryResponse], ClientError)
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/globaldata#aggregate
	Aggregate(
		ctx context.Context,
		orgID mo.Option[string],
		query string,
		field string,
		numBuckets int64,
		countByLevel mo.Option[string],
		filterByQuery mo.Option[bool],
	) (Result[components.SearchAggregateResponse], ClientError)
	// https://github.com/censys/censys-sdk-go/blob/v0.22.2/models/operations/v3globaldataassethosttimeline.go
	// Note: the SDK client has the parameters backwards; fromTime is the end time and toTime is the start time. This is a mistake, but we need to keep it to not break existing API usage, so we abstract this miscommunication through this function's parameters.
	HostTimeline(
		ctx context.Context,
		orgID mo.Option[string],
		hostID string,
		fromTime time.Time,
		toTime time.Time,
	) (Result[components.HostTimeline], ClientError)
}

type Metadata struct {
	Request  *http.Request
	Response *http.Response
	Latency  time.Duration
	Attempts uint64
}

type Result[T any] struct {
	Metadata Metadata
	Data     *T
}

type ThreatHuntingClient interface {
	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/threathunting#gethostobservationswithcertificate
	GetHostObservationsWithCertificate(
		ctx context.Context,
		orgID mo.Option[string],
		certificateID string,
		startTime mo.Option[time.Time],
		endTime mo.Option[time.Time],
		port mo.Option[int],
		protocol mo.Option[string],
		pageSize mo.Option[int64],
		pageToken mo.Option[string],
	) (Result[components.HostObservationResponse], ClientError)

	// https://github.com/censys/censys-sdk-go/tree/main/docs/sdks/threathunting#valuecounts
	GetValueCounts(
		ctx context.Context,
		orgID mo.Option[string],
		query mo.Option[string],
		andCountConditions []components.CountCondition,
	) (Result[components.ValueCountsResponse], ClientError)
}