httplocationos.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package radar

import (
	"context"
	"fmt"
	"net/http"
	"net/url"
	"time"

	"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
	"github.com/cloudflare/cloudflare-go/v2/internal/apiquery"
	"github.com/cloudflare/cloudflare-go/v2/internal/param"
	"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
	"github.com/cloudflare/cloudflare-go/v2/option"
)

// HTTPLocationOSService contains methods and other services that help with
// interacting with the cloudflare API. Note, unlike clients, this service does not
// read variables from the environment automatically. You should not instantiate
// this service directly, and instead use the [NewHTTPLocationOSService] method
// instead.
type HTTPLocationOSService struct {
	Options []option.RequestOption
}

// NewHTTPLocationOSService generates a new service that applies the given options
// to each request. These options are applied after the parent client's options (if
// there is one), and before any request-specific options.
func NewHTTPLocationOSService(opts ...option.RequestOption) (r *HTTPLocationOSService) {
	r = &HTTPLocationOSService{}
	r.Options = opts
	return
}

// Get the top locations, by HTTP traffic, of the requested operating systems.
// Values are a percentage out of the total traffic.
func (r *HTTPLocationOSService) Get(ctx context.Context, os HTTPLocationOSGetParamsOS, query HTTPLocationOSGetParams, opts ...option.RequestOption) (res *HTTPLocationOSGetResponse, err error) {
	opts = append(r.Options[:], opts...)
	var env HTTPLocationOSGetResponseEnvelope
	path := fmt.Sprintf("radar/http/top/locations/os/%v", os)
	err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
	if err != nil {
		return
	}
	res = &env.Result
	return
}

type HTTPLocationOSGetResponse struct {
	Meta HTTPLocationOSGetResponseMeta   `json:"meta,required"`
	Top0 []HTTPLocationOSGetResponseTop0 `json:"top_0,required"`
	JSON httpLocationOSGetResponseJSON   `json:"-"`
}

// httpLocationOSGetResponseJSON contains the JSON metadata for the struct
// [HTTPLocationOSGetResponse]
type httpLocationOSGetResponseJSON struct {
	Meta        apijson.Field
	Top0        apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *HTTPLocationOSGetResponse) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r httpLocationOSGetResponseJSON) RawJSON() string {
	return r.raw
}

type HTTPLocationOSGetResponseMeta struct {
	DateRange      []HTTPLocationOSGetResponseMetaDateRange    `json:"dateRange,required"`
	LastUpdated    string                                      `json:"lastUpdated,required"`
	ConfidenceInfo HTTPLocationOSGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
	JSON           httpLocationOSGetResponseMetaJSON           `json:"-"`
}

// httpLocationOSGetResponseMetaJSON contains the JSON metadata for the struct
// [HTTPLocationOSGetResponseMeta]
type httpLocationOSGetResponseMetaJSON struct {
	DateRange      apijson.Field
	LastUpdated    apijson.Field
	ConfidenceInfo apijson.Field
	raw            string
	ExtraFields    map[string]apijson.Field
}

func (r *HTTPLocationOSGetResponseMeta) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r httpLocationOSGetResponseMetaJSON) RawJSON() string {
	return r.raw
}

type HTTPLocationOSGetResponseMetaDateRange struct {
	// Adjusted end of date range.
	EndTime time.Time `json:"endTime,required" format:"date-time"`
	// Adjusted start of date range.
	StartTime time.Time                                  `json:"startTime,required" format:"date-time"`
	JSON      httpLocationOSGetResponseMetaDateRangeJSON `json:"-"`
}

// httpLocationOSGetResponseMetaDateRangeJSON contains the JSON metadata for the
// struct [HTTPLocationOSGetResponseMetaDateRange]
type httpLocationOSGetResponseMetaDateRangeJSON struct {
	EndTime     apijson.Field
	StartTime   apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *HTTPLocationOSGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r httpLocationOSGetResponseMetaDateRangeJSON) RawJSON() string {
	return r.raw
}

type HTTPLocationOSGetResponseMetaConfidenceInfo struct {
	Annotations []HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
	Level       int64                                                   `json:"level"`
	JSON        httpLocationOSGetResponseMetaConfidenceInfoJSON         `json:"-"`
}

// httpLocationOSGetResponseMetaConfidenceInfoJSON contains the JSON metadata for
// the struct [HTTPLocationOSGetResponseMetaConfidenceInfo]
type httpLocationOSGetResponseMetaConfidenceInfoJSON struct {
	Annotations apijson.Field
	Level       apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *HTTPLocationOSGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r httpLocationOSGetResponseMetaConfidenceInfoJSON) RawJSON() string {
	return r.raw
}

type HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation struct {
	DataSource      string                                                    `json:"dataSource,required"`
	Description     string                                                    `json:"description,required"`
	EventType       string                                                    `json:"eventType,required"`
	IsInstantaneous interface{}                                               `json:"isInstantaneous,required"`
	EndTime         time.Time                                                 `json:"endTime" format:"date-time"`
	LinkedURL       string                                                    `json:"linkedUrl"`
	StartTime       time.Time                                                 `json:"startTime" format:"date-time"`
	JSON            httpLocationOSGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}

// httpLocationOSGetResponseMetaConfidenceInfoAnnotationJSON contains the JSON
// metadata for the struct [HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation]
type httpLocationOSGetResponseMetaConfidenceInfoAnnotationJSON struct {
	DataSource      apijson.Field
	Description     apijson.Field
	EventType       apijson.Field
	IsInstantaneous apijson.Field
	EndTime         apijson.Field
	LinkedURL       apijson.Field
	StartTime       apijson.Field
	raw             string
	ExtraFields     map[string]apijson.Field
}

func (r *HTTPLocationOSGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r httpLocationOSGetResponseMetaConfidenceInfoAnnotationJSON) RawJSON() string {
	return r.raw
}

type HTTPLocationOSGetResponseTop0 struct {
	ClientCountryAlpha2 string                            `json:"clientCountryAlpha2,required"`
	ClientCountryName   string                            `json:"clientCountryName,required"`
	Value               string                            `json:"value,required"`
	JSON                httpLocationOSGetResponseTop0JSON `json:"-"`
}

// httpLocationOSGetResponseTop0JSON contains the JSON metadata for the struct
// [HTTPLocationOSGetResponseTop0]
type httpLocationOSGetResponseTop0JSON struct {
	ClientCountryAlpha2 apijson.Field
	ClientCountryName   apijson.Field
	Value               apijson.Field
	raw                 string
	ExtraFields         map[string]apijson.Field
}

func (r *HTTPLocationOSGetResponseTop0) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r httpLocationOSGetResponseTop0JSON) RawJSON() string {
	return r.raw
}

type HTTPLocationOSGetParams struct {
	// Array of comma separated list of ASNs, start with `-` to exclude from results.
	// For example, `-174, 3356` excludes results from AS174, but includes results from
	// AS3356.
	ASN param.Field[[]string] `query:"asn"`
	// Filter for bot class. Refer to
	// [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
	BotClass param.Field[[]HTTPLocationOSGetParamsBotClass] `query:"botClass"`
	// Array of comma separated list of continents (alpha-2 continent codes). Start
	// with `-` to exclude from results. For example, `-EU,NA` excludes results from
	// Europe, but includes results from North America.
	Continent param.Field[[]string] `query:"continent"`
	// End of the date range (inclusive).
	DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
	// For example, use `7d` and `7dControl` to compare this week with the previous
	// week. Use this parameter or set specific start and end dates (`dateStart` and
	// `dateEnd` parameters).
	DateRange param.Field[[]HTTPLocationOSGetParamsDateRange] `query:"dateRange"`
	// Array of datetimes to filter the start of a series.
	DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
	// Filter for device type.
	DeviceType param.Field[[]HTTPLocationOSGetParamsDeviceType] `query:"deviceType"`
	// Format results are returned in.
	Format param.Field[HTTPLocationOSGetParamsFormat] `query:"format"`
	// Filter for http protocol.
	HTTPProtocol param.Field[[]HTTPLocationOSGetParamsHTTPProtocol] `query:"httpProtocol"`
	// Filter for http version.
	HTTPVersion param.Field[[]HTTPLocationOSGetParamsHTTPVersion] `query:"httpVersion"`
	// Filter for ip version.
	IPVersion param.Field[[]HTTPLocationOSGetParamsIPVersion] `query:"ipVersion"`
	// Limit the number of objects in the response.
	Limit param.Field[int64] `query:"limit"`
	// Array of comma separated list of locations (alpha-2 country codes). Start with
	// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
	// but includes results from PT.
	Location param.Field[[]string] `query:"location"`
	// Array of names that will be used to name the series in responses.
	Name param.Field[[]string] `query:"name"`
	// Filter for tls version.
	TLSVersion param.Field[[]HTTPLocationOSGetParamsTLSVersion] `query:"tlsVersion"`
}

// URLQuery serializes [HTTPLocationOSGetParams]'s query parameters as
// `url.Values`.
func (r HTTPLocationOSGetParams) URLQuery() (v url.Values) {
	return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
		ArrayFormat:  apiquery.ArrayQueryFormatRepeat,
		NestedFormat: apiquery.NestedQueryFormatBrackets,
	})
}

// IP version.
type HTTPLocationOSGetParamsOS string

const (
	HTTPLocationOSGetParamsOSWindows  HTTPLocationOSGetParamsOS = "WINDOWS"
	HTTPLocationOSGetParamsOSMacosx   HTTPLocationOSGetParamsOS = "MACOSX"
	HTTPLocationOSGetParamsOSIos      HTTPLocationOSGetParamsOS = "IOS"
	HTTPLocationOSGetParamsOSAndroid  HTTPLocationOSGetParamsOS = "ANDROID"
	HTTPLocationOSGetParamsOSChromeos HTTPLocationOSGetParamsOS = "CHROMEOS"
	HTTPLocationOSGetParamsOSLinux    HTTPLocationOSGetParamsOS = "LINUX"
	HTTPLocationOSGetParamsOSSmartTv  HTTPLocationOSGetParamsOS = "SMART_TV"
)

func (r HTTPLocationOSGetParamsOS) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsOSWindows, HTTPLocationOSGetParamsOSMacosx, HTTPLocationOSGetParamsOSIos, HTTPLocationOSGetParamsOSAndroid, HTTPLocationOSGetParamsOSChromeos, HTTPLocationOSGetParamsOSLinux, HTTPLocationOSGetParamsOSSmartTv:
		return true
	}
	return false
}

type HTTPLocationOSGetParamsBotClass string

const (
	HTTPLocationOSGetParamsBotClassLikelyAutomated HTTPLocationOSGetParamsBotClass = "LIKELY_AUTOMATED"
	HTTPLocationOSGetParamsBotClassLikelyHuman     HTTPLocationOSGetParamsBotClass = "LIKELY_HUMAN"
)

func (r HTTPLocationOSGetParamsBotClass) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsBotClassLikelyAutomated, HTTPLocationOSGetParamsBotClassLikelyHuman:
		return true
	}
	return false
}

type HTTPLocationOSGetParamsDateRange string

const (
	HTTPLocationOSGetParamsDateRange1d         HTTPLocationOSGetParamsDateRange = "1d"
	HTTPLocationOSGetParamsDateRange2d         HTTPLocationOSGetParamsDateRange = "2d"
	HTTPLocationOSGetParamsDateRange7d         HTTPLocationOSGetParamsDateRange = "7d"
	HTTPLocationOSGetParamsDateRange14d        HTTPLocationOSGetParamsDateRange = "14d"
	HTTPLocationOSGetParamsDateRange28d        HTTPLocationOSGetParamsDateRange = "28d"
	HTTPLocationOSGetParamsDateRange12w        HTTPLocationOSGetParamsDateRange = "12w"
	HTTPLocationOSGetParamsDateRange24w        HTTPLocationOSGetParamsDateRange = "24w"
	HTTPLocationOSGetParamsDateRange52w        HTTPLocationOSGetParamsDateRange = "52w"
	HTTPLocationOSGetParamsDateRange1dControl  HTTPLocationOSGetParamsDateRange = "1dControl"
	HTTPLocationOSGetParamsDateRange2dControl  HTTPLocationOSGetParamsDateRange = "2dControl"
	HTTPLocationOSGetParamsDateRange7dControl  HTTPLocationOSGetParamsDateRange = "7dControl"
	HTTPLocationOSGetParamsDateRange14dControl HTTPLocationOSGetParamsDateRange = "14dControl"
	HTTPLocationOSGetParamsDateRange28dControl HTTPLocationOSGetParamsDateRange = "28dControl"
	HTTPLocationOSGetParamsDateRange12wControl HTTPLocationOSGetParamsDateRange = "12wControl"
	HTTPLocationOSGetParamsDateRange24wControl HTTPLocationOSGetParamsDateRange = "24wControl"
)

func (r HTTPLocationOSGetParamsDateRange) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsDateRange1d, HTTPLocationOSGetParamsDateRange2d, HTTPLocationOSGetParamsDateRange7d, HTTPLocationOSGetParamsDateRange14d, HTTPLocationOSGetParamsDateRange28d, HTTPLocationOSGetParamsDateRange12w, HTTPLocationOSGetParamsDateRange24w, HTTPLocationOSGetParamsDateRange52w, HTTPLocationOSGetParamsDateRange1dControl, HTTPLocationOSGetParamsDateRange2dControl, HTTPLocationOSGetParamsDateRange7dControl, HTTPLocationOSGetParamsDateRange14dControl, HTTPLocationOSGetParamsDateRange28dControl, HTTPLocationOSGetParamsDateRange12wControl, HTTPLocationOSGetParamsDateRange24wControl:
		return true
	}
	return false
}

type HTTPLocationOSGetParamsDeviceType string

const (
	HTTPLocationOSGetParamsDeviceTypeDesktop HTTPLocationOSGetParamsDeviceType = "DESKTOP"
	HTTPLocationOSGetParamsDeviceTypeMobile  HTTPLocationOSGetParamsDeviceType = "MOBILE"
	HTTPLocationOSGetParamsDeviceTypeOther   HTTPLocationOSGetParamsDeviceType = "OTHER"
)

func (r HTTPLocationOSGetParamsDeviceType) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsDeviceTypeDesktop, HTTPLocationOSGetParamsDeviceTypeMobile, HTTPLocationOSGetParamsDeviceTypeOther:
		return true
	}
	return false
}

// Format results are returned in.
type HTTPLocationOSGetParamsFormat string

const (
	HTTPLocationOSGetParamsFormatJson HTTPLocationOSGetParamsFormat = "JSON"
	HTTPLocationOSGetParamsFormatCsv  HTTPLocationOSGetParamsFormat = "CSV"
)

func (r HTTPLocationOSGetParamsFormat) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsFormatJson, HTTPLocationOSGetParamsFormatCsv:
		return true
	}
	return false
}

type HTTPLocationOSGetParamsHTTPProtocol string

const (
	HTTPLocationOSGetParamsHTTPProtocolHTTP  HTTPLocationOSGetParamsHTTPProtocol = "HTTP"
	HTTPLocationOSGetParamsHTTPProtocolHTTPS HTTPLocationOSGetParamsHTTPProtocol = "HTTPS"
)

func (r HTTPLocationOSGetParamsHTTPProtocol) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsHTTPProtocolHTTP, HTTPLocationOSGetParamsHTTPProtocolHTTPS:
		return true
	}
	return false
}

type HTTPLocationOSGetParamsHTTPVersion string

const (
	HTTPLocationOSGetParamsHTTPVersionHttPv1 HTTPLocationOSGetParamsHTTPVersion = "HTTPv1"
	HTTPLocationOSGetParamsHTTPVersionHttPv2 HTTPLocationOSGetParamsHTTPVersion = "HTTPv2"
	HTTPLocationOSGetParamsHTTPVersionHttPv3 HTTPLocationOSGetParamsHTTPVersion = "HTTPv3"
)

func (r HTTPLocationOSGetParamsHTTPVersion) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsHTTPVersionHttPv1, HTTPLocationOSGetParamsHTTPVersionHttPv2, HTTPLocationOSGetParamsHTTPVersionHttPv3:
		return true
	}
	return false
}

type HTTPLocationOSGetParamsIPVersion string

const (
	HTTPLocationOSGetParamsIPVersionIPv4 HTTPLocationOSGetParamsIPVersion = "IPv4"
	HTTPLocationOSGetParamsIPVersionIPv6 HTTPLocationOSGetParamsIPVersion = "IPv6"
)

func (r HTTPLocationOSGetParamsIPVersion) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsIPVersionIPv4, HTTPLocationOSGetParamsIPVersionIPv6:
		return true
	}
	return false
}

type HTTPLocationOSGetParamsTLSVersion string

const (
	HTTPLocationOSGetParamsTLSVersionTlSv1_0  HTTPLocationOSGetParamsTLSVersion = "TLSv1_0"
	HTTPLocationOSGetParamsTLSVersionTlSv1_1  HTTPLocationOSGetParamsTLSVersion = "TLSv1_1"
	HTTPLocationOSGetParamsTLSVersionTlSv1_2  HTTPLocationOSGetParamsTLSVersion = "TLSv1_2"
	HTTPLocationOSGetParamsTLSVersionTlSv1_3  HTTPLocationOSGetParamsTLSVersion = "TLSv1_3"
	HTTPLocationOSGetParamsTLSVersionTlSvQuic HTTPLocationOSGetParamsTLSVersion = "TLSvQUIC"
)

func (r HTTPLocationOSGetParamsTLSVersion) IsKnown() bool {
	switch r {
	case HTTPLocationOSGetParamsTLSVersionTlSv1_0, HTTPLocationOSGetParamsTLSVersionTlSv1_1, HTTPLocationOSGetParamsTLSVersionTlSv1_2, HTTPLocationOSGetParamsTLSVersionTlSv1_3, HTTPLocationOSGetParamsTLSVersionTlSvQuic:
		return true
	}
	return false
}

type HTTPLocationOSGetResponseEnvelope struct {
	Result  HTTPLocationOSGetResponse             `json:"result,required"`
	Success bool                                  `json:"success,required"`
	JSON    httpLocationOSGetResponseEnvelopeJSON `json:"-"`
}

// httpLocationOSGetResponseEnvelopeJSON contains the JSON metadata for the struct
// [HTTPLocationOSGetResponseEnvelope]
type httpLocationOSGetResponseEnvelopeJSON struct {
	Result      apijson.Field
	Success     apijson.Field
	raw         string
	ExtraFields map[string]apijson.Field
}

func (r *HTTPLocationOSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
	return apijson.UnmarshalRoot(data, r)
}

func (r httpLocationOSGetResponseEnvelopeJSON) RawJSON() string {
	return r.raw
}