pihole

Nov 22, 2023

Changes in this version

type Client

+ func (c *Client) Login(ctx context.Context) error

Feb 19, 2022

Changes in this version

+ var ErrNotImplementedTokenClient = errors.New("resource is not implemented for the API token client")

type Config

+ APIToken string

Feb 8, 2022

Changes in this version

type Client

+ func (c Client) GetGroupByID(ctx context.Context, id int64) (*Group, error)

Feb 3, 2022

Changes in this version

+ var ErrClientValidationFailed = errors.New("client validation failed")

+ var ErrLoginFailed = errors.New("login failed")

Nov 24, 2021

Changes in this version

+ const DomainOptionsAllow

+ const DomainOptionsDeny

+ const DomainTypeAllowExact

+ const DomainTypeAllowWildcard

+ const DomainTypeDenyExact

+ const DomainTypeDenyWildcard

+ var IntToDomainType = map[int]string

type Client

+ func (c Client) ListDomains(ctx context.Context, opts ListDomainsOptions) (DomainList, error)

+ type Domain struct

+ Comment string

+ DateAdded time.Time

+ DateModified time.Time

+ Domain string

+ Enabled bool

+ GroupIDs []int64

+ ID int64

+ Type string

+ Wildcard bool

+ type DomainList []*Domain

+ type DomainResponse struct

+ Comment string

+ DateAdded int64

+ DateModified int64

+ Domain string

+ Enabled int

+ Groups []int64

+ ID int64

+ Type int

+ func (d DomainResponse) ToDomain() *Domain

+ type DomainResponseList struct

+ Data []*DomainResponse

+ func (l DomainResponseList) ToDomainList() DomainList

+ type ListDomainsOptions struct

+ Type string

Nov 3, 2021

Changes in this version

+ func Bool(b bool) *bool

type Client

+ func (c Client) CreateGroup(ctx context.Context, gr *GroupCreateRequest) (*Group, error)

+ func (c Client) DeleteGroup(ctx context.Context, name string) error

+ func (c Client) GetGroup(ctx context.Context, name string) (*Group, error)

+ func (c Client) UpdateGroup(ctx context.Context, gr *GroupUpdateRequest) (*Group, error)

type Config

+ Client *http.Client

+ type GroupBasicResponse struct

+ Message string

+ Success bool

+ type GroupCreateRequest struct

+ Description string

+ Name string

+ type GroupUpdateRequest struct

+ Description string

+ Enabled *bool

+ Name string

Nov 2, 2021

Changes in this version

type Client

+ func (c Client) ListGroups(ctx context.Context) (GroupList, error)

+ type Group struct

+ DateAdded time.Time

+ DateModified time.Time

+ Description string

+ Enabled bool

+ ID int64

+ Name string

+ type GroupList []*Group

+ type GroupResponse struct

+ DateAdded int64

+ DateModified int64

+ Description string

+ Enabled int

+ ID int64

+ Name string

+ func (gr GroupResponse) ToGroup() *Group

+ type GroupResponseList struct

+ Data []GroupResponse

+ func (grl GroupResponseList) ToGroupList() GroupList

Nov 1, 2021

Changes in this version

type CNAMERecordsListResponse

+ func (rr CNAMERecordsListResponse) ToCNAMERecordList() CNAMERecordList

type Client

+ func (c Client) CreateCNAMERecord(ctx context.Context, record *CNAMERecord) (*CNAMERecord, error)

+ func (c Client) DeleteCNAMERecord(ctx context.Context, domain string) error

+ func (c Client) GetCNAMERecord(ctx context.Context, domain string) (*CNAMERecord, error)

+ func (c Client) UpdateCNAMERecord(ctx context.Context, record *CNAMERecord) (*CNAMERecord, error)

+ type CreateCNAMERecordResponse struct

+ Message string

+ Success bool

+ type NotFoundError struct

+ func NewNotFoundError(message string) *NotFoundError

+ func (e *NotFoundError) Error() string

+ func (e NotFoundError) Is(target error) bool

Nov 1, 2021

Changes in this version

+ type CNAMERecord struct

+ Domain string

+ Target string

+ type CNAMERecordList []CNAMERecord

+ type CNAMERecordsListResponse struct

+ Data [][]string

+ func (rr CNAMERecordsListResponse) ToDNSRecordList() CNAMERecordList

type Client

+ func (c Client) ListCNAMERecords(ctx context.Context) (CNAMERecordList, error)

Nov 1, 2021

Changes in this version

+ type Client struct

+ URL string

+ UserAgent string

+ func New(config *Config) (*Client, error)

+ func (c *Client) Init(ctx context.Context) error

+ func (c *Client) Request(ctx context.Context, method string, path string, data *url.Values) (*http.Request, error)

+ func (c *Client) Validate() error

+ func (c Client) CreateDNSRecord(ctx context.Context, record *DNSRecord) (*DNSRecord, error)

+ func (c Client) DeleteDNSRecord(ctx context.Context, domain string) error

+ func (c Client) GetAdBlockerStatus(ctx context.Context) (*EnableAdBlock, error)

+ func (c Client) GetDNSRecord(ctx context.Context, domain string) (*DNSRecord, error)

+ func (c Client) ListDNSRecords(ctx context.Context) (DNSRecordList, error)

+ func (c Client) RequestWithAuth(ctx context.Context, method string, path string, data *url.Values) (*http.Request, error)

+ func (c Client) RequestWithSession(ctx context.Context, method string, path string, data *url.Values) (*http.Request, error)

+ func (c Client) SetAdBlockEnabled(ctx context.Context, enable bool) (*EnableAdBlock, error)

+ func (c Client) UpdateDNSRecord(ctx context.Context, record *DNSRecord) (*DNSRecord, error)

+ type Config struct

+ Password string

+ URL string

+ UserAgent string

+ type CreateDNSRecordResponse struct

+ Message string

+ Success bool

+ type DNSRecord struct

+ Domain string

+ IP string

+ type DNSRecordList []DNSRecord

+ type DNSRecordsListResponse struct

+ Data [][]string

+ func (rr DNSRecordsListResponse) ToDNSRecordList() DNSRecordList

+ type EnableAdBlock struct

+ Enabled bool

+ type EnableAdBlockResponse struct

+ Status string

+ func (eb EnableAdBlockResponse) ToEnableAdBlock() *EnableAdBlock