nfs

package module

v0.1.0 Latest Latest Go to latest Published: Aug 3, 2019 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/adamdecaf/go-nfs

Links

Open Source Insights

README ¶

go-nfs

A go client library for NearlyFreeSpeech's api.

Api Docs

Getting / Usage

go get github.com/adamdecaf/go-nfs

Building / Testing

You need the following environment variables set:

NFS_ACCOUNT_ID
NFS_API_KEY
NFS_LOGIN

$ go get github.com/adamdecaf/go-nfs
$ cd go-nfs
$ go build .
$ go test -v .

License

Apache License 2.0 See LICENSE for details.

Documentation ¶

Index ¶

func AddBalanceWarning(c *Client, bal float32) error
func GetAccountBalance(c *Client) (float32, error)
func GetAccountBalanceHighest(c *Client) (float32, error)
func GetAccountSites(c *Client) ([]string, error)
func GetAccountStatus(c *Client) (string, error)
func GetDNSRecords(c *Client, domain string, params map[string]string) (string, error)
func GetFriendlyName(c *Client) (string, error)
func GetMemberAccounts(c *Client) ([]string, error)
func GetMemberSites(c *Client) ([]string, error)
func RemoveBalanceWarning(c *Client, bal float32) error
func RemoveDNSRecord(c *Client, domain string, params map[string]string) (string, error)
func SetDNSRecord(c *Client, domain string, params map[string]string) (string, error)
func SetFriendlyName(c *Client, name string) error
type Client
- func NewClient(apiKey, login string) *Client
- func NewClientForAccount(accountId, apiKey, login string) *Client
type Error
- func (e Error) Err() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddBalanceWarning ¶

func AddBalanceWarning(c *Client, bal float32) error

AddBalanceWarning https://members.nearlyfreespeech.net/wiki/API/AccountAddWarning

func GetAccountBalance ¶

func GetAccountBalance(c *Client) (float32, error)

GetAccountBalance https://members.nearlyfreespeech.net/wiki/API/AccountBalance

func GetAccountBalanceHighest ¶

func GetAccountBalanceHighest(c *Client) (float32, error)

GetAccountBalanceHighest https://members.nearlyfreespeech.net/wiki/API/AccountBalanceHigh

func GetAccountSites ¶

func GetAccountSites(c *Client) ([]string, error)

https://members.nearlyfreespeech.net/wiki/API/AccountSites

func GetAccountStatus ¶

func GetAccountStatus(c *Client) (string, error)

func GetDNSRecords ¶

func GetDNSRecords(c *Client, domain string, params map[string]string) (string, error)

GetDNSRecords https://members.nearlyfreespeech.net/wiki/API/

func GetFriendlyName ¶

func GetFriendlyName(c *Client) (string, error)

GetFriendlyName https://members.nearlyfreespeech.net/wiki/API/AccountFriendlyName

func GetMemberAccounts ¶

func GetMemberAccounts(c *Client) ([]string, error)

GetMemberAccounts https://members.nearlyfreespeech.net/wiki/API/MemberAccounts

func GetMemberSites ¶

func GetMemberSites(c *Client) ([]string, error)

GetMemberSites https://members.nearlyfreespeech.net/wiki/API/MemberSites

func RemoveBalanceWarning ¶

func RemoveBalanceWarning(c *Client, bal float32) error

RemoveBalanceWarning https://members.nearlyfreespeech.net/wiki/API/AccountRemoveWarning

func RemoveDNSRecord ¶

func RemoveDNSRecord(c *Client, domain string, params map[string]string) (string, error)

RemoveDNSRecord https://members.nearlyfreespeech.net/wiki/API/DNSRemoveRR

func SetDNSRecord ¶

func SetDNSRecord(c *Client, domain string, params map[string]string) (string, error)

SetDNSRecord https://members.nearlyfreespeech.net/wiki/API/DNSAddRR

func SetFriendlyName ¶

func SetFriendlyName(c *Client, name string) error

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(apiKey, login string) *Client

func NewClientForAccount ¶

func NewClientForAccount(accountId, apiKey, login string) *Client

type Error ¶

type Error struct {
	Debug string `json:"debug"`
	Error string `json:"error"`
}

Error represented by the NFS api

func (Error) Err ¶

func (e Error) Err() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL