account

Documentation

Overview

Code generated by model_paginated_gen. DO NOT EDIT.

Index

• type AccountService
• type Contact
• type ContactNotFoundError
  • func (e *ContactNotFoundError) Error() string
• type ContactType
  • func (t ContactType) String() string
• type Credit
• type Details
• type GetContactResponseBody
• type GetContactsResponseBody
• type GetCreditsResponseBody
• type GetDetailsResponseBody
• type PaginatedContact
  • func NewPaginatedContact(getFunc connection.PaginatedGetFunc, ...) *PaginatedContact
• type Service
  • func NewService(connection connection.Connection) *Service
  • func (s *Service) GetContact(contactID int) (Contact, error)
  • func (s *Service) GetContacts(parameters connection.APIRequestParameters) ([]Contact, error)
  • func (s *Service) GetContactsPaginated(parameters connection.APIRequestParameters) (*PaginatedContact, error)
  • func (s *Service) GetCredits(parameters connection.APIRequestParameters) ([]Credit, error)
  • func (s *Service) GetDetails() (Details, error)

Types

type AccountService

type AccountService interface {
	GetContacts(parameters connection.APIRequestParameters) ([]Contact, error)
	GetContactsPaginated(parameters connection.APIRequestParameters) (*PaginatedContact, error)
	GetContact(contactID int) (Contact, error)

	GetDetails() (Details, error)

	GetCredits(parameters connection.APIRequestParameters) ([]Credit, error)
}

AccountService is an interface for managing account

type Contact

type Contact struct {
	ID        int         `json:"id"`
	Type      ContactType `json:"type"`
	FirstName string      `json:"first_name"`
	LastName  string      `json:"last_name"`
}

Contact represents a UKFast account contact

type ContactNotFoundError

type ContactNotFoundError struct {
	ID int
}

ContactNotFoundError indicates a contact was not found

func (*ContactNotFoundError) Error

func (e *ContactNotFoundError) Error() string

type ContactType

type ContactType string

const (
	ContactTypePrimaryContact ContactType = "Primary Contact"
	ContactTypeAccounts       ContactType = "Accounts"
	ContactTypeTechnical      ContactType = "Technical"
	ContactTypeThirdParty     ContactType = "Third Party"
	ContactTypeOther          ContactType = "Other"
)

func (ContactType) String

func (t ContactType) String() string

type Credit

type Credit struct {
	Type      string `json:"type"`
	Total     int    `json:"total"`
	Remaining int    `json:"remaining"`
}

Credit represents a UKFast account credit

type Details

type Details struct {
	CompanyRegistrationNumber string `json:"company_registration_number"`
	VATIdentificationNumber   string `json:"vat_identification_number"`
	PrimaryContactID          int    `json:"primary_contact_id"`
}

Details represents a UKFast account details

type GetContactResponseBody

type GetContactResponseBody struct {
	connection.APIResponseBody

	Data Contact `json:"data"`
}

GetContactResponseBody represents the API response body from the GetContact resource

type GetContactsResponseBody

type GetContactsResponseBody struct {
	connection.APIResponseBody

	Data []Contact `json:"data"`
}

GetContactsResponseBody represents the API response body from the GetContacts resource

type GetCreditsResponseBody

type GetCreditsResponseBody struct {
	connection.APIResponseBody

	Data []Credit `json:"data"`
}

GetCreditsResponseBody represents the API response body from the GetCredits resource

type GetDetailsResponseBody

type GetDetailsResponseBody struct {
	connection.APIResponseBody

	Data Details `json:"data"`
}

GetDetailsResponseBody represents the API response body from the GetDetails resource

type PaginatedContact

type PaginatedContact struct {
	*connection.PaginatedBase

	Items []Contact
}

PaginatedContact represents a paginated collection of Contact

func NewPaginatedContact

func NewPaginatedContact(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []Contact) *PaginatedContact

NewPaginatedContact returns a pointer to an initialized PaginatedContact struct

type Service

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

Service implements AccountService for managing Account certificates via the UKFast API

func NewService

func NewService(connection connection.Connection) *Service

NewService returns a new instance of AccountService

func (*Service) GetContact

func (s *Service) GetContact(contactID int) (Contact, error)

GetContact retrieves a single contact by id

func (*Service) GetContacts

func (s *Service) GetContacts(parameters connection.APIRequestParameters) ([]Contact, error)

GetContacts retrieves a list of contacts

func (*Service) GetContactsPaginated

func (s *Service) GetContactsPaginated(parameters connection.APIRequestParameters) (*PaginatedContact, error)

GetContactsPaginated retrieves a paginated list of contacts

func (*Service) GetCredits

func (s *Service) GetCredits(parameters connection.APIRequestParameters) ([]Credit, error)

GetCredits retrieves a list of credits

func (*Service) GetDetails

func (s *Service) GetDetails() (Details, error)

GetDetails retrieves account details