Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Domain ¶
type Domain struct {
ID int `json:"id"`
Name string `json:"name"`
Version string `json:"version"`
CreatedAt connection.DateTime `json:"created_at"`
}
Domain represents an Shared Exchange domain +genie:model_response +genie:model_paginated
type DomainNotFoundError ¶
type DomainNotFoundError struct {
ID int
}
DomainNotFoundError indicates a domain was not found
func (*DomainNotFoundError) Error ¶
func (e *DomainNotFoundError) Error() string
type GetDomainResponseBody ¶
type GetDomainResponseBody struct {
connection.APIResponseBody
Data Domain `json:"data"`
}
GetDomainResponseBody represents an API response body containing Domain data
type GetDomainSliceResponseBody ¶
type GetDomainSliceResponseBody struct {
connection.APIResponseBody
Data []Domain `json:"data"`
}
GetDomainSliceResponseBody represents an API response body containing []Domain data
type PaginatedDomain ¶
type PaginatedDomain struct {
*connection.PaginatedBase
Items []Domain
}
PaginatedDomain represents a paginated collection of Domain
func NewPaginatedDomain ¶
func NewPaginatedDomain(getFunc connection.PaginatedGetFunc, parameters connection.APIRequestParameters, pagination connection.APIResponseMetadataPagination, items []Domain) *PaginatedDomain
NewPaginatedDomain returns a pointer to an initialized PaginatedDomain struct
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service implements SharedExchangeService for managing the Shared Exchange service
func NewService ¶
func NewService(connection connection.Connection) *Service
NewService returns a new instance of SharedExchangeService
func (*Service) GetDomains ¶
func (s *Service) GetDomains(parameters connection.APIRequestParameters) ([]Domain, error)
GetDomains retrieves a list of domains
func (*Service) GetDomainsPaginated ¶
func (s *Service) GetDomainsPaginated(parameters connection.APIRequestParameters) (*PaginatedDomain, error)
GetDomainsPaginated retrieves a paginated list of domains
type SharedExchangeService ¶
type SharedExchangeService interface {
}
SharedExchangeService is an interface for managing Shared Exchange
Source Files