nfon

README

go-nfon

A go libary for the NFON-API

Installation

go get github.com/Lukas-Nielsen/go-nfon

Usage

import

import "github.com/Lukas-Nielsen/go-nfon"

perform request

// new client
client := nfon.NewClient(<api key>, <api secret>, <api url>, <debug>)

// new request
req := client.NewRequest()

// add options to request
req.AddLink(<href>, <rel>)
req.AddData(<name>, <value>)

// send request
req.Send(<GET|POST|DELETE|PUT>, <api path>, <pointer to result or nil>)

API Reference

NFON

Authors

• @Lukas-Nielsen

License

MIT

Documentation

Index

• Constants
• type Client
  • func NewClient(key string, secret string, uri string, debug bool) *Client
  • func (c *Client) GetRequestCount() uint
  • func (c *Client) NewRequest() *Request
• type Error
  • func (e Error) Log()
• type Errors
• type Items
• type Request
  • func (r *Request) AddData(name string, value any) *Request
  • func (r *Request) AddLink(rel string, href string) *Request
  • func (r *Request) Send(method method, path string, result *Response) (int, Error)
• type Response

Constants

const (
	POST   method = "POST"
	PUT    method = "PUT"
	DELETE method = "DELETE"
	GET    method = "GET"

	POST_SUCCESS   int = 201
	PUT_SUCCESS    int = 204
	DELETE_SUCCESS int = 204
	GET_SUCCESS    int = 200
)

Types

type Client

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

func NewClient

func NewClient(key string, secret string, uri string, debug bool) *Client

param api key, api secret, api uri, debug the requests

func (*Client) GetRequestCount

func (c *Client) GetRequestCount() uint

func (*Client) NewRequest

func (c *Client) NewRequest() *Request

type Error

type Error struct {
	Detail      string   `json:"detail"`
	Title       string   `json:"title"`
	DescribedBy string   `json:"described_by"`
	Errors      []Errors `json:"errors"`
}

func (Error) Log

func (e Error) Log()

type Errors

type Errors struct {
	Message string `json:"message"`
	Path    string `json:"path"`
	Value   string `json:"value"`
}

type Items

type Items struct {
	Href  string
	Links map[string]string
	Data  map[string]any
}

type Request

type Request struct {
	Links []links `json:"links,omitempty"`
	Data  []data  `json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Request) AddData

func (r *Request) AddData(name string, value any) *Request

func (*Request) AddLink

func (r *Request) AddLink(rel string, href string) *Request

func (*Request) Send

func (r *Request) Send(method method, path string, result *Response) (int, Error)

type Response

type Response struct {
	Href   string
	Offset int
	Total  int
	Size   int
	Links  map[string]string
	Data   map[string]any
	Items  []Items
}