api

package

v0.10.13 Latest Latest Go to latest Published: Jun 5, 2019 License: Apache-2.0 Imports: 24 Imported by: 2

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/indiereign/shift72-kibble

Links

Open Source Insights

Documentation ¶

Index ¶

func AppendAllFilms(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error
func AppendAllTVShows(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error
func AppendFilms(cfg *models.Config, site *models.Site, slugs []string, ...) error
func AppendTVSeasons(cfg *models.Config, site *models.Site, slugs []string, ...) error
func CheckAdminCredentials(cfg *models.Config)
func Get(cfg *models.Config, url string) ([]byte, error)
func IsAdmin(cfg *models.Config) (bool, error)
func LoadAllBundles(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error
func LoadAllCollections(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error
func LoadAllPlans(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error
func LoadBios(cfg *models.Config, serviceConfig models.ServiceConfig, ...) (models.Pages, models.Navigation, error)
func LoadConfig(cfg *models.Config) (models.ServiceConfig, error)
func LoadFeatureToggles(cfg *models.Config) (models.FeatureToggles, error)
func LoadSite(cfg *models.Config) (*models.Site, error)
func Upload(cfg *models.Config, url string, params map[string]string, target string) error
type BundleV1
type CollectionV4
type PlansV1

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AppendAllFilms ¶

func AppendAllFilms(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error

AppendAllFilms -

func AppendAllTVShows ¶

func AppendAllTVShows(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error

AppendAllTVShows -

func AppendFilms ¶

func AppendFilms(cfg *models.Config, site *models.Site, slugs []string, itemIndex models.ItemIndex) error

AppendFilms - load a list of films

func AppendTVSeasons ¶

func AppendTVSeasons(cfg *models.Config, site *models.Site, slugs []string, itemIndex models.ItemIndex) error

AppendTVSeasons - load a list of tv seasons

func CheckAdminCredentials ¶

func CheckAdminCredentials(cfg *models.Config)

CheckAdminCredentials - check that the admin credentials are valid

func Get ¶

func Get(cfg *models.Config, url string) ([]byte, error)

Get - make an http request and read the response

func IsAdmin ¶

func IsAdmin(cfg *models.Config) (bool, error)

IsAdmin - check auth token is valid

func LoadAllBundles ¶

func LoadAllBundles(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error

LoadAllBundles - load all bundles

func LoadAllCollections ¶

func LoadAllCollections(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error

LoadAllCollections - load all collections

func LoadAllPlans ¶

func LoadAllPlans(cfg *models.Config, site *models.Site, itemIndex models.ItemIndex) error

LoadAllPlans - loads all active plans

func LoadBios ¶

func LoadBios(cfg *models.Config, serviceConfig models.ServiceConfig, itemIndex models.ItemIndex) (models.Pages, models.Navigation, error)

LoadBios - load the bios request

func LoadConfig ¶

func LoadConfig(cfg *models.Config) (models.ServiceConfig, error)

LoadConfig - load all and merge

func LoadFeatureToggles ¶

func LoadFeatureToggles(cfg *models.Config) (models.FeatureToggles, error)

LoadFeatureToggles - load all and merge

func LoadSite ¶

func LoadSite(cfg *models.Config) (*models.Site, error)

LoadSite - load the complete site

func Upload ¶

func Upload(cfg *models.Config, url string, params map[string]string, target string) error

Upload a file

Types ¶

type BundleV1 ¶

type BundleV1 struct {
	ID             int       `json:"id"`
	Title          string    `json:"title"`
	Tagline        string    `json:"tagline"`
	Description    string    `json:"description"`
	Status         string    `json:"status"`
	PublishedDate  time.Time `json:"published_date"`
	SeoTitle       string    `json:"seo_title"`
	SeoKeywords    string    `json:"seo_keywords"`
	SeoDescription string    `json:"seo_description"`
	PortraitImage  string    `json:"portrait_image"`
	LandscapeImage string    `json:"landscape_image"`
	CarouselImage  string    `json:"carousel_image"`
	CreatedAt      time.Time `json:"created_at"`
	UpdatedAt      time.Time `json:"updated_at"`
	BgImage        string    `json:"bg_image"`
	PromoURL       string    `json:"promo_url"`
	ExternalID     string    `json:"external_id"`
	Items          []string  `json:"items"`
}

BundleV1 - model

type CollectionV4 ¶

type CollectionV4 struct {
	CarouselImage  string   `json:"carousel_image"`
	CreatedAt      string   `json:"created_at"`
	Description    string   `json:"description"`
	DisplayName    string   `json:"display_name"`
	HeaderImage    string   `json:"header_image"`
	ID             int      `json:"id"`
	ItemLayout     string   `json:"item_layout"`
	Items          []string `json:"items"`
	ItemsPerRow    int      `json:"items_per_row"`
	LandscapeImage string   `json:"landscape_image"`
	PortraitImage  string   `json:"portrait_image"`
	SearchQuery    string   `json:"search_query"`
	SeoDescription string   `json:"seo_description"`
	SeoKeywords    string   `json:"seo_keywords"`
	SeoTitle       string   `json:"seo_title"`
	Title          string   `json:"title"`
	TitleSlug      string   `json:"title_slug"`
	UpdatedAt      string   `json:"updated_at"`
}

CollectionV4 - mapped from the v4 api

type PlansV1 ¶

type PlansV1 struct {
	ID              int       `json:"id"`
	Name            string    `json:"name"`
	Description     string    `json:"description"`
	Status          string    `json:"status"`
	CreatedAt       time.Time `json:"created_at"`
	UpdatedAt       time.Time `json:"updated_at"`
	PageID          int       `json:"page_id"`
	Interval        *string   `json:"interval"`
	IntervalCount   *int      `json:"interval_count"`
	TrialPeriodDays *int      `json:"trial_period_days"`
	PortraitImage   string    `json:"portrait_image"`
}

PlansV1 - model

Source Files ¶

View all Source files

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