nextdns

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 8, 2023 License: MIT Imports: 12 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrEmptyAPIToken = errors.New("api key must not be empty")

Functions

func NewAllowlistService 

func NewAllowlistService(client *Client) *allowlistService

NewAllowlistService returns a new NextDNS allowlist service. nolint: revive

func NewDenylistService 

func NewDenylistService(client *Client) *denylistService

NewDenylistService returns a new NextDNS denylist service. nolint: revive

func NewParentalControlCategoriesService 

func NewParentalControlCategoriesService(client *Client) *parentalControlCategoriesService

NewParentalControlCategoriesService returns a new NextDNS parental control categories service. nolint: revive

func NewParentalControlService 

func NewParentalControlService(client *Client) *parentalControlService

NewParentalControlService returns a new NextDNS parental control service. nolint: revive

func NewParentalControlServicesService 

func NewParentalControlServicesService(client *Client) *parentalControlServicesService

NewParentalControlServicesService returns a new NextDNS parental control services service. nolint: revive

func NewPrivacyBlocklistsService 

func NewPrivacyBlocklistsService(client *Client) *privacyBlocklistsService

NewPrivacyBlocklistsService returns a new NextDNS privacy blocklist service. nolint: revive

func NewPrivacyNativesService 

func NewPrivacyNativesService(client *Client) *privacyNativesService

NewPrivacyNativesService returns a new NextDNS privacy native tracking protection service. nolint: revive

func NewPrivacyService 

func NewPrivacyService(client *Client) *privacyService

NewPrivacyService returns a new NextDNS privacy service. nolint: revive

func NewProfilesService 

func NewProfilesService(client *Client) *profilesService

NewProfilesService returns a new NextDNS profiles service. nolint: revive

func NewRewritesService added in v0.2.0 

func NewRewritesService(client *Client) *rewritesService

NewRewritesService returns a new NextDNS rewrites service. nolint: revive

func NewSecurityService 

func NewSecurityService(client *Client) *securityService

NewSecurityService returns a new NextDNS security service. nolint: revive

func NewSecurityTldsService 

func NewSecurityTldsService(client *Client) *securityTldsService

NewSecurityTldsService returns a new NextDNS security TLDs service. nolint: revive

func NewSettingsBlockPageService 

func NewSettingsBlockPageService(client *Client) *settingsBlockPageService

NewSettingsBlockPageService returns a new NextDNS settings block page service. nolint: revive

func NewSettingsLogsService 

func NewSettingsLogsService(client *Client) *settingsLogsService

NewSettingsLogsService returns a new NextDNS settings logs service. nolint: revive

func NewSettingsPerformanceService 

func NewSettingsPerformanceService(client *Client) *settingsPerformanceService

NewSettingsPerformanceService returns a new NextDNS settings performance service. nolint: revive

func NewSettingsService 

func NewSettingsService(client *Client) *settingsService

NewSettingsService returns a new NextDNS settings service. nolint: revive

func NewSetupLinkedIPService added in v0.5.0 

func NewSetupLinkedIPService(client *Client) *setupLinkedIPService

NewSetupLinkedIPService returns a new NextDNS setup linked ip service. nolint: revive

func NewSetupService added in v0.5.0 

func NewSetupService(client *Client) *setupService

NewSetupService returns a new NextDNS setup service. nolint: revive

Types

type Allowlist 

type Allowlist struct {
	ID     string `json:"id,omitempty"`
	Active bool   `json:"active"`
}

Allowlist represents the allow list of a profile.

type AllowlistService 

type AllowlistService interface {
	Create(context.Context, *CreateAllowlistRequest) error
	List(context.Context, *ListAllowlistRequest) ([]*Allowlist, error)
	Update(context.Context, *UpdateAllowlistRequest) error
}

AllowlistService is an interface for communicating with the NextDNS allowlist API endpoint.

type Client 

type Client struct {

	// Service for the Profile.
	Profiles ProfilesService

	// Services for the Allowlist and Denylist.
	Allowlist AllowlistService
	Denylist  DenylistService

	// Services for the ParentalControl.
	ParentalControl           ParentalControlService
	ParentalControlServices   ParentalControlServicesService
	ParentalControlCategories ParentalControlCategoriesService

	// Services for the Privacy.
	Privacy           PrivacyService
	PrivacyBlocklists PrivacyBlocklistsService
	PrivacyNatives    PrivacyNativesService

	// Services for the Settings.
	Settings            SettingsService
	SettingsLogs        SettingsLogsService
	SettingsBlockPage   SettingsBlockPageService
	SettingsPerformance SettingsPerformanceService

	// Services for the Security.
	Security     SecurityService
	SecurityTlds SecurityTldsService

	// Services for the Rewrites.
	Rewrites RewritesService

	// Services for the Setup.
	Setup         SetupService
	SetupLinkedIP SetupLinkedIPService

	// Debug mode for the HTTP requests.
	Debug bool
	// contains filtered or unexported fields
}

Client represents a NextDNS client.

func New 

func New(opts ...ClientOption) (*Client, error)

New instantiates a new NextDNS client.

type ClientOption 

type ClientOption func(c *Client) error

ClientOption is a function that can be used to customize the client.

func WithAPIKey 

func WithAPIKey(apiKey string) ClientOption

WithAPIKey sets the API key to be used for requests.

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL sets the base URL of the NextDNS API.

func WithDebug 

func WithDebug() ClientOption

WithDebug enables debug mode.

func WithHTTPClient 

func WithHTTPClient(client *http.Client) ClientOption

WithHTTPClient sets a custom HTTP client that can be used for requests.

type CreateAllowlistRequest 

type CreateAllowlistRequest struct {
	ProfileID string
	Allowlist []*Allowlist
}

CreateAllowlistRequest encapsulates the request for creating an allowlist.

type CreateDenylistRequest 

type CreateDenylistRequest struct {
	ProfileID string
	Denylist  []*Denylist
}

CreateDenylistRequest encapsulates the request for creating a denylist.

type CreateParentalControlCategoriesRequest 

type CreateParentalControlCategoriesRequest struct {
	ProfileID                 string
	ParentalControlCategories []*ParentalControlCategories
}

CreateParentalControlCategoriesRequest encapsulates the request for creating a parental control categories list.

type CreateParentalControlServicesRequest 

type CreateParentalControlServicesRequest struct {
	ProfileID               string
	ParentalControlServices []*ParentalControlServices
}

CreateParentalControlServicesRequest encapsulates the request for creating a parental control services list.

type CreatePrivacyBlocklistsRequest 

type CreatePrivacyBlocklistsRequest struct {
	ProfileID         string
	PrivacyBlocklists []*PrivacyBlocklists
}

CreatePrivacyBlocklistsRequest encapsulates the request for creating a privacy blocklist.

type CreatePrivacyNativesRequest 

type CreatePrivacyNativesRequest struct {
	ProfileID      string
	PrivacyNatives []*PrivacyNatives
}

CreatePrivacyNativesRequest encapsulates the request for creating a privacy native tracking protection list.

type CreateProfileRequest 

type CreateProfileRequest struct {
	Name            string           `json:"name,omitempty"`
	Security        *Security        `json:"security,omitempty"`
	Privacy         *Privacy         `json:"privacy,omitempty"`
	ParentalControl *ParentalControl `json:"parentalControl,omitempty"`
	Denylist        []*Denylist      `json:"denylist,omitempty"`
	Allowlist       []*Allowlist     `json:"allowlist,omitempty"`
	Settings        *Settings        `json:"settings,omitempty"`
	Rewrites        []*Rewrites      `json:"rewrites,omitempty"`
}

CreateProfileRequest encapsulates the request for creating a new profile.

type CreateRewritesRequest added in v0.4.0 

type CreateRewritesRequest struct {
	ProfileID string
	Rewrites  *Rewrites
}

CreateRewritesRequest encapsulates the request for creating a new rewrite.

type CreateSecurityTldsRequest 

type CreateSecurityTldsRequest struct {
	ProfileID    string
	SecurityTlds []*SecurityTlds
}

CreateSecurityTldsRequest encapsulates the request for creating a security TLDs list.

type DeleteProfileRequest 

type DeleteProfileRequest struct {
	ProfileID string
}

DeleteProfileRequest encapsulates the request for deleting a profile.

type DeleteRewritesRequest added in v0.4.0 

type DeleteRewritesRequest struct {
	ProfileID string
	ID        string
}

DeleteRewritesRequest encapsulates the request for deleting a rewrite.

type Denylist 

type Denylist struct {
	ID     string `json:"id,omitempty"`
	Active bool   `json:"active"`
}

Denylist represents the denylist of a profile.

type DenylistService 

type DenylistService interface {
	Create(context.Context, *CreateDenylistRequest) error
	List(context.Context, *ListDenylistRequest) ([]*Denylist, error)
	Update(context.Context, *UpdateDenylistRequest) error
}

DenylistService is an interface for communicating with the NextDNS denylist API endpoint.

type Error 

type Error struct {
	Type    ErrorType
	Message string
	Errors  *ErrorResponse
	Meta    map[string]string
}

Error represents the error from the Client.

func (*Error) Error 

func (e *Error) Error() string

Error returns the string representation of the error. TODO(amalucelli): This is still not the best way to handle multiple errors, make this better at some point.

type ErrorResponse 

type ErrorResponse struct {
	Errors []struct {
		Code   string `json:"code"`
		Detail string `json:"detail,omitempty"`
		Source struct {
			Parameter string `json:"parameter,omitempty"`
		} `json:"source,omitempty"`
	} `json:"errors"`
}

ErrorResponse represents the error response from the NextDNS API.

type ErrorType 

type ErrorType string

ErrorType defines the code of an error. 

const (
	ErrorTypeServiceError   ErrorType = "service_error"  // Internal service error.
	ErrorTypeRequest        ErrorType = "request"        // Regular request error.
	ErrorTypeMalformed      ErrorType = "malformed"      // Response body is malformed.
	ErrorTypeAuthentication ErrorType = "authentication" // Authentication error.
	ErrorTypeNotFound       ErrorType = "not_found"      // Resource not found.
)

type GetParentalControlRequest 

type GetParentalControlRequest struct {
	ProfileID string
}

GetParentalControlRequest encapsulates the request for getting a parental control settings.

type GetPrivacyRequest 

type GetPrivacyRequest struct {
	ProfileID string
}

GetPrivacyRequest encapsulates the request for getting the privacy settings of a profile.

type GetProfileRequest 

type GetProfileRequest struct {
	ProfileID string
}

GetProfileRequest encapsulates the request for getting a profile.

type GetSecurityRequest 

type GetSecurityRequest struct {
	ProfileID string
}

GetSecurityRequest encapsulates the request for getting a security settings.

type GetSettingsBlockPageRequest 

type GetSettingsBlockPageRequest struct {
	ProfileID string
}

GetSettingsBlockPageRequest encapsulates the request for getting the settings block page of a profile.

type GetSettingsLogsRequest 

type GetSettingsLogsRequest struct {
	ProfileID string
}

GetSettingsLogsRequest encapsulates the request for getting the settings logs of a profile.

type GetSettingsPerformanceRequest 

type GetSettingsPerformanceRequest struct {
	ProfileID string
}

GetSettingsPerformanceRequest encapsulates the request for getting the settings performance of a profile.

type GetSettingsRequest 

type GetSettingsRequest struct {
	ProfileID string
}

GetSettingsRequest encapsulates the request for getting the settings of a profile.

type GetSetupLinkedIPRequest added in v0.5.0 

type GetSetupLinkedIPRequest struct {
	ProfileID string
}

GetSetupLinkedIPRequest encapsulates the request for getting the setup linked ip settings of a profile.

type GetSetupRequest added in v0.5.0 

type GetSetupRequest struct {
	ProfileID string
}

GetSetupRequest encapsulates the request for getting the setup settings.

type ListAllowlistRequest added in v0.4.0 

type ListAllowlistRequest struct {
	ProfileID string
}

ListAllowlistRequest encapsulates the request for getting an allowlist.

type ListDenylistRequest added in v0.4.0 

type ListDenylistRequest struct {
	ProfileID string
}

ListDenylistRequest encapsulates the request for getting a denylist.

type ListParentalControlCategoriesRequest added in v0.4.0 

type ListParentalControlCategoriesRequest struct {
	ProfileID string
}

ListParentalControlCategoriesRequest encapsulates the request for getting a parental control categories list.

type ListParentalControlServicesRequest added in v0.4.0 

type ListParentalControlServicesRequest struct {
	ProfileID string
}

GetParentalControlServicesRequest encapsulates the request for getting a parental control services list.

type ListPrivacyBlocklistsRequest added in v0.4.0 

type ListPrivacyBlocklistsRequest struct {
	ProfileID string
}

ListPrivacyBlocklistsRequest encapsulates the request for getting the privacy blocklist.

type ListPrivacyNativesRequest added in v0.4.0 

type ListPrivacyNativesRequest struct {
	ProfileID string
}

ListPrivacyNativesRequest encapsulates the request for getting the privacy native tracking protection list.

type ListProfileRequest 

type ListProfileRequest struct{}

ListProfileRequest encapsulates the request for listing all the profiles.

type ListRewritesRequest added in v0.4.0 

type ListRewritesRequest struct {
	ProfileID string
}

ListRewritesRequest encapsulates the request for getting an rewrites.

type ListSecurityTldsRequest added in v0.4.0 

type ListSecurityTldsRequest struct {
	ProfileID string
}

ListSecurityTldsRequest encapsulates the request for getting a security TLDs list.

type ParentalControl 

type ParentalControl struct {
	Services              []*ParentalControlServices   `json:"services,omitempty"`
	Categories            []*ParentalControlCategories `json:"categories,omitempty"`
	Recreation            *ParentalControlRecreation   `json:"recreation,omitempty"`
	SafeSearch            bool                         `json:"safeSearch"`
	YoutubeRestrictedMode bool                         `json:"youtubeRestrictedMode"`
	BlockBypass           bool                         `json:"blockBypass"`
}

ParentalControl represents the parental control settings of a profile.

type ParentalControlCategories 

type ParentalControlCategories struct {
	ID         string `json:"id,omitempty"`
	Active     bool   `json:"active"`
	Recreation bool   `json:"recreation"`
}

ParentalControlCategories represents the parental control categories of a profile.

type ParentalControlCategoriesService 

type ParentalControlCategoriesService interface {
	Create(context.Context, *CreateParentalControlCategoriesRequest) error
	List(context.Context, *ListParentalControlCategoriesRequest) ([]*ParentalControlCategories, error)
	Update(context.Context, *UpdateParentalControlCategoriesRequest) error
}

ParentalControlCategoriesService is an interface for communicating with the NextDNS parental control categories API endpoint.

type ParentalControlRecreation added in v0.3.0 

type ParentalControlRecreation struct {
	Times    *ParentalControlRecreationTimes `json:"times"`
	Timezone string                          `json:"timezone"`
}

ParentalControlRecreation represents the parental control recreation of a profile.

type ParentalControlRecreationInterval added in v0.3.0 

type ParentalControlRecreationInterval struct {
	Start string `json:"start"`
	End   string `json:"end"`
}

ParentalControlRecreationInterval represents the start and end time of a parental control recreation interval.

type ParentalControlRecreationTimes added in v0.3.0 

type ParentalControlRecreationTimes struct {
	Monday    *ParentalControlRecreationInterval `json:"monday,omitempty"`
	Tuesday   *ParentalControlRecreationInterval `json:"tuesday,omitempty"`
	Wednesday *ParentalControlRecreationInterval `json:"wednesday,omitempty"`
	Thursday  *ParentalControlRecreationInterval `json:"thursday,omitempty"`
	Friday    *ParentalControlRecreationInterval `json:"friday,omitempty"`
	Saturday  *ParentalControlRecreationInterval `json:"saturday,omitempty"`
	Sunday    *ParentalControlRecreationInterval `json:"sunday,omitempty"`
}

ParentalControlRecreationTimes represents the days and times of the week when the parental control is active.

type ParentalControlService 

type ParentalControlService interface {
	Get(context.Context, *GetParentalControlRequest) (*ParentalControl, error)
	Update(context.Context, *UpdateParentalControlRequest) error
}

ParentalControlService is an interface for communicating with the NextDNS parental control API endpoint.

type ParentalControlServices 

type ParentalControlServices struct {
	ID         string `json:"id,omitempty"`
	Active     bool   `json:"active"`
	Recreation bool   `json:"recreation"`
}

ParentalControlServices represents the parental control services of a profile.

type ParentalControlServicesService 

type ParentalControlServicesService interface {
	Create(context.Context, *CreateParentalControlServicesRequest) error
	List(context.Context, *ListParentalControlServicesRequest) ([]*ParentalControlServices, error)
	Update(context.Context, *UpdateParentalControlServicesRequest) error
}

ParentalControlServicesService is an interface for communicating with the NextDNS parental control services API endpoint.

type Privacy 

type Privacy struct {
	Blocklists        []*PrivacyBlocklists `json:"blocklists,omitempty"`
	Natives           []*PrivacyNatives    `json:"natives,omitempty"`
	DisguisedTrackers bool                 `json:"disguisedTrackers"`
	AllowAffiliate    bool                 `json:"allowAffiliate"`
}

Privacy represents the privacy settings of a profile.

type PrivacyBlocklists 

type PrivacyBlocklists struct {
	ID        string     `json:"id"`
	Name      string     `json:"name,omitempty"`
	Website   string     `json:"website,omitempty"`
	Entries   int        `json:"entries,omitempty"`
	UpdatedOn *time.Time `json:"updatedOn,omitempty"`
}

PrivacyBlocklists represents a privacy blocklist of a profile.

type PrivacyBlocklistsService 

type PrivacyBlocklistsService interface {
	Create(context.Context, *CreatePrivacyBlocklistsRequest) error
	List(context.Context, *ListPrivacyBlocklistsRequest) ([]*PrivacyBlocklists, error)
}

PrivacyBlocklistsService is an interface for communicating with the NextDNS privacy blocklist API endpoint.

type PrivacyNatives 

type PrivacyNatives struct {
	ID string `json:"id"`
}

PrivacyNatives represents a privacy native tracking protection of a profile.

type PrivacyNativesService 

type PrivacyNativesService interface {
	Create(context.Context, *CreatePrivacyNativesRequest) error
	List(context.Context, *ListPrivacyNativesRequest) ([]*PrivacyNatives, error)
}

PrivacyNativesService is an interface for communicating with the NextDNS privacy native tracking protection API endpoint.

type PrivacyService 

type PrivacyService interface {
	Get(context.Context, *GetPrivacyRequest) (*Privacy, error)
	Update(context.Context, *UpdatePrivacyRequest) error
}

PrivacyService is an interface for communicating with the NextDNS privacy settings API endpoint.

type Profile 

type Profile struct {
	Name            string           `json:"name,omitempty"`
	Security        *Security        `json:"security,omitempty"`
	Privacy         *Privacy         `json:"privacy,omitempty"`
	ParentalControl *ParentalControl `json:"parentalControl,omitempty"`
	Denylist        []*Denylist      `json:"denylist,omitempty"`
	Allowlist       []*Allowlist     `json:"allowlist,omitempty"`
	Settings        *Settings        `json:"settings,omitempty"`
	Rewrites        []*Rewrites      `json:"rewrites,omitempty"`
	Setup           *Setup           `json:"setup,omitempty"`
}

Profile represents a NextDNS profile.

type Profiles 

type Profiles struct {
	ID          string `json:"id"`
	Fingerprint string `json:"fingerprint"`
	Name        string `json:"name"`
}

Profiles represents a list of NextDNS profiles.

type ProfilesService 

type ProfilesService interface {
	Create(context.Context, *CreateProfileRequest) (string, error)
	Get(context.Context, *GetProfileRequest) (*Profile, error)
	Update(context.Context, *UpdateProfileRequest) error
	List(context.Context, *ListProfileRequest) ([]*Profiles, error)
	Delete(context.Context, *DeleteProfileRequest) error
}

ProfilesService is an interface for communicating with the NextDNS API.

type Rewrites added in v0.2.0 

type Rewrites struct {
	ID      string `json:"id,omitempty"`
	Name    string `json:"name"`
	Type    string `json:"type,omitempty"`
	Content string `json:"content"`
}

Rewrites represents the rewrite list of a profile.

type RewritesService added in v0.2.0 

type RewritesService interface {
	Create(context.Context, *CreateRewritesRequest) (string, error)
	List(context.Context, *ListRewritesRequest) ([]*Rewrites, error)
	Delete(context.Context, *DeleteRewritesRequest) error
}

RewritesService is an interface for communicating with the NextDNS rewrites API endpoint.

type Security 

type Security struct {
	ThreatIntelligenceFeeds bool            `json:"threatIntelligenceFeeds"`
	AiThreatDetection       bool            `json:"aiThreatDetection"`
	GoogleSafeBrowsing      bool            `json:"googleSafeBrowsing"`
	Cryptojacking           bool            `json:"cryptojacking"`
	DNSRebinding            bool            `json:"dnsRebinding"`
	IdnHomographs           bool            `json:"idnHomographs"`
	Typosquatting           bool            `json:"typosquatting"`
	Dga                     bool            `json:"dga"`
	Nrd                     bool            `json:"nrd"`
	DDNS                    bool            `json:"ddns"`
	Parking                 bool            `json:"parking"`
	Csam                    bool            `json:"csam"`
	Tlds                    []*SecurityTlds `json:"tlds,omitempty"`
}

Security represents the security settings of a profile.

type SecurityService 

type SecurityService interface {
	Get(context.Context, *GetSecurityRequest) (*Security, error)
	Update(context.Context, *UpdateSecurityRequest) error
}

SecurityService is an interface for communicating with the NextDNS security API endpoint.

type SecurityTlds 

type SecurityTlds struct {
	ID string `json:"id"`
}

Allowlist represents the security TLDs of a profile.

type SecurityTldsService 

type SecurityTldsService interface {
	Create(context.Context, *CreateSecurityTldsRequest) error
	List(context.Context, *ListSecurityTldsRequest) ([]*SecurityTlds, error)
}

SecurityTldsService is an interface for communicating with the NextDNS security TLDs API endpoint.

type Settings 

type Settings struct {
	Logs        *SettingsLogs        `json:"logs,omitempty"`
	BlockPage   *SettingsBlockPage   `json:"blockPage,omitempty"`
	Performance *SettingsPerformance `json:"performance,omitempty"`
	Web3        bool                 `json:"web3"`
}

Settings represents the settings of a profile.

type SettingsBlockPage 

type SettingsBlockPage struct {
	Enabled bool `json:"enabled"`
}

SettingsBlockPage represents the settings block page of a profile.

type SettingsBlockPageService 

type SettingsBlockPageService interface {
	Get(context.Context, *GetSettingsBlockPageRequest) (*SettingsBlockPage, error)
	Update(context.Context, *UpdateSettingsBlockPageRequest) error
}

SettingsBlockPageService is an interface for communicating with the NextDNS settings block page API endpoint.

type SettingsLogs 

type SettingsLogs struct {
	Enabled   bool              `json:"enabled"`
	Drop      *SettingsLogsDrop `json:"drop,omitempty"`
	Retention int               `json:"retention,omitempty"`
	Location  string            `json:"location,omitempty"`
}

SettingsLogs represents the settings logs of a profile.

type SettingsLogsDrop 

type SettingsLogsDrop struct {
	IP     bool `json:"ip"`
	Domain bool `json:"domain"`
}

SettingsLogsDrop represents the settings logs privacy adjustments of a profile.

type SettingsLogsService 

type SettingsLogsService interface {
	Get(context.Context, *GetSettingsLogsRequest) (*SettingsLogs, error)
	Update(context.Context, *UpdateSettingsLogsRequest) error
}

SettingsLogsService is an interface for communicating with the NextDNS settings logs API endpoint.

type SettingsPerformance 

type SettingsPerformance struct {
	Ecs             bool `json:"ecs"`
	CacheBoost      bool `json:"cacheBoost"`
	CnameFlattening bool `json:"cnameFlattening"`
}

SettingsPerformance represents the settings performance of a profile.

type SettingsPerformanceService 

type SettingsPerformanceService interface {
	Get(context.Context, *GetSettingsPerformanceRequest) (*SettingsPerformance, error)
	Update(context.Context, *UpdateSettingsPerformanceRequest) error
}

SettingsPerformanceService is an interface for communicating with the NextDNS settings performance API endpoint.

type SettingsService 

type SettingsService interface {
	Get(context.Context, *GetSettingsRequest) (*Settings, error)
	Update(context.Context, *UpdateSettingsRequest) error
}

SettingsService is an interface for communicating with the NextDNS settings API endpoint.

type Setup added in v0.5.0 

type Setup struct {
	Ipv4     []string       `json:"ipv4"`
	Ipv6     []string       `json:"ipv6"`
	LinkedIP *SetupLinkedIP `json:"linkedIp"`
	Dnscrypt string         `json:"dnscrypt"`
}

Setup represents the setup settings.

type SetupLinkedIP added in v0.5.0 

type SetupLinkedIP struct {
	Servers     []string `json:"servers"`
	IP          string   `json:"ip"`
	Ddns        string   `json:"ddns"`
	UpdateToken string   `json:"updateToken"`
}

type SetupLinkedIPService added in v0.5.0 

type SetupLinkedIPService interface {
	Get(context.Context, *GetSetupLinkedIPRequest) (*SetupLinkedIP, error)
	Update(context.Context, *UpdateSetupLinkedIPRequest) error
}

SetupLinkedIPService is an interface for communicating with the NextDNS setup linked ip API endpoint.

type SetupService added in v0.5.0 

type SetupService interface {
	Get(context.Context, *GetSetupRequest) (*Setup, error)
}

SetupService is an interface for communicating with the NextDNS setup API endpoint.

type UpdateAllowlistRequest 

type UpdateAllowlistRequest struct {
	ProfileID string
	ID        string
	Allowlist *Allowlist
}

UpdateAllowlistRequest encapsulates the request for updating an allowlist.

type UpdateDenylistRequest 

type UpdateDenylistRequest struct {
	ProfileID string
	ID        string
	Denylist  *Denylist
}

UpdateDenylistRequest encapsulates the request for updating a denylist.

type UpdateParentalControlCategoriesRequest 

type UpdateParentalControlCategoriesRequest struct {
	ProfileID                 string
	ID                        string
	ParentalControlCategories *ParentalControlCategories
}

UpdateParentalControlCategoriesRequest encapsulates the request for updating a parental control categories list.

type UpdateParentalControlRequest 

type UpdateParentalControlRequest struct {
	ProfileID       string
	ParentalControl *ParentalControl
}

UpdateParentalControlRequest encapsulates the request for updating a parental control settings.

type UpdateParentalControlServicesRequest 

type UpdateParentalControlServicesRequest struct {
	ProfileID               string
	ID                      string
	ParentalControlServices *ParentalControlServices
}

UpdateParentalControlServicesRequest encapsulates the request for updating a parental control services list.

type UpdatePrivacyRequest 

type UpdatePrivacyRequest struct {
	ProfileID string
	Privacy   *Privacy
}

UpdatePrivacyRequest encapsulates the request for updating the privacy settings of a profile.

type UpdateProfileRequest 

type UpdateProfileRequest struct {
	ProfileID string
	Profile   *Profile
}

UpdateProfileRequest encapsulates the request for setting custom profile settings.

type UpdateSecurityRequest 

type UpdateSecurityRequest struct {
	ProfileID string
	Security  *Security
}

UpdateSecurityRequest encapsulates the request for updating security settings.

type UpdateSettingsBlockPageRequest 

type UpdateSettingsBlockPageRequest struct {
	ProfileID         string
	SettingsBlockPage *SettingsBlockPage
}

UpdateSettingsBlockPageRequest encapsulates the request for updating the settings block page of a profile.

type UpdateSettingsLogsRequest 

type UpdateSettingsLogsRequest struct {
	ProfileID    string
	SettingsLogs *SettingsLogs
}

UpdateSettingsLogsRequest encapsulates the request for updating the settings logs of a profile.

type UpdateSettingsPerformanceRequest 

type UpdateSettingsPerformanceRequest struct {
	ProfileID           string
	SettingsPerformance *SettingsPerformance
}

UpdateSettingsPerformanceRequest encapsulates the request for updating the settings performance of a profile.

type UpdateSettingsRequest 

type UpdateSettingsRequest struct {
	ProfileID string
	Settings  *Settings
}

UpdateSettingsRequest encapsulates the request for updating the settings of a profile.

type UpdateSetupLinkedIPRequest added in v0.5.0 

type UpdateSetupLinkedIPRequest struct {
	ProfileID     string
	SetupLinkedIP *SetupLinkedIP
}

UpdateSetupLinkedIPRequest encapsulates the request for updating the setup linked ip of a profile.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.