plexgo/docs/sdks/hubs/README.md

Hubs

(Hubs)

Overview

Hubs are a structured two-dimensional container for media, generally represented by multiple horizontal rows.

Available Operations

• GetGlobalHubs - Get Global Hubs
• GetRecentlyAdded - Get Recently Added
• GetLibraryHubs - Get library specific hubs

GetGlobalHubs

Get Global Hubs filtered by the parameters provided.

Example Usage

package main

import(
	"context"
	"github.com/LukeHagar/plexgo"
	"log"
)

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Hubs.GetGlobalHubs(ctx, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
count	*float64	➖	The number of items to return with each hub.
onlyTransient	*operations.OnlyTransient	➖	Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetGlobalHubsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.GetGlobalHubsBadRequest	400	application/json
sdkerrors.GetGlobalHubsUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	*/*

GetRecentlyAdded

This endpoint will return the recently added content.

Example Usage

package main

import(
	"context"
	"github.com/LukeHagar/plexgo"
	"github.com/LukeHagar/plexgo/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Hubs.GetRecentlyAdded(ctx, operations.GetRecentlyAddedRequest{
        ContentDirectoryID: 470161,
        SectionID: plexgo.Int64(2),
        Type: operations.TypeTvShow,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.GetRecentlyAddedRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetRecentlyAddedResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.SDKError	4XX, 5XX	*/*

GetLibraryHubs

This endpoint will return a list of library specific hubs

Example Usage

package main

import(
	"context"
	"github.com/LukeHagar/plexgo"
	"log"
)

func main() {
    ctx := context.Background()

    s := plexgo.New(
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Hubs.GetLibraryHubs(ctx, 6728.76, nil, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
sectionID	float64	✔️	the Id of the library to query
count	*float64	➖	The number of items to return with each hub.
onlyTransient	*operations.QueryParamOnlyTransient	➖	Only return hubs which are "transient", meaning those which are prone to changing after media playback or addition (e.g. On Deck, or Recently Added).
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetLibraryHubsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.GetLibraryHubsBadRequest	400	application/json
sdkerrors.GetLibraryHubsUnauthorized	401	application/json
sdkerrors.SDKError	4XX, 5XX	*/*