PlexGO

package main

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

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

    s := plexgo.New(
        plexgo.WithAccepts(components.AcceptsApplicationXML),
        plexgo.WithClientIdentifier("abc123"),
        plexgo.WithProduct("Plex for Roku"),
        plexgo.WithVersion("2.4.1"),
        plexgo.WithPlatform("Roku"),
        plexgo.WithPlatformVersion("4.3 build 1057"),
        plexgo.WithDevice("Roku 3"),
        plexgo.WithModel("4200X"),
        plexgo.WithDeviceVendor("Roku"),
        plexgo.WithDeviceName("Living Room TV"),
        plexgo.WithMarketplace("googlePlay"),
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Library.UpdateItems(ctx, operations.UpdateItemsRequest{
        SectionID: "<id>",
        FieldLocked: components.BoolIntTrue.ToPointer(),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Library

Set the fields of the filtered items

This endpoint takes an large possible set of values. Here are some examples.

Parameters, extra documentation
- artist.title.value
  - When used with track, both artist.title.value and album.title.value need to be specified
- title.value usage
  - Summary
    - Tracks always rename and never merge
    - Albums and Artists
      - if single item and item without title does not exist, it is renamed.
      - if single item and item with title does exist they are merged.
      - if multiple they are always merged.
  - Tracks
    - Works as expected will update the track’s title
    - Single track: /library/sections/{id}/all?type=10&id=42&title.value=NewName
    - Multiple tracks: /library/sections/{id}/all?type=10&id=42,43,44&title.value=NewName
    - All tracks: /library/sections/{id}/all?type=10&title.value=NewName
  - Albums
    - Functionality changes depending on the existence of an album with the same title
    - Album exists
      - Single album: /library/sections/{id}/all?type=9&id=42&title.value=Album 2
        
        Album with id 42 is merged into album titled “Album 2”
      - Multiple/All albums: /library/sections/{id}/all?type=9&title.value=Moo Album
        
        All albums are merged into the existing album titled “Moo Album”
    - Album does not exist
      - Single album: /library/sections/{id}/all?type=9&id=42&title.value=NewAlbumTitle
        
        Album with id 42 has title modified to “NewAlbumTitle”
      - Multiple/All albums: /library/sections/{id}/all?type=9&title.value=NewAlbumTitle
        
        All albums are merged into a new album with title=“NewAlbumTitle”
  - Artists
    - Functionaly changes depending on the existence of an artist with the same title.
    - Artist exists
      - Single artist: /library/sections/{id}/all?type=8&id=42&title.value=Artist 2
        
        Artist with id 42 is merged into existing artist titled “Artist 2”
      - Multiple/All artists: /library/sections/{id}/all?type=8&title.value=Artist 3
        
        All artists are merged into the existing artist titled “Artist 3”
    - Artist does not exist
      - Single artist: /library/sections/{id}/all?type=8&id=42&title.value=NewArtistTitle
        
        Artist with id 42 has title modified to “NewArtistTitle”
      - Multiple/All artists: /library/sections/{id}/all?type=8&title.value=NewArtistTitle
        
        All artists are merged into a new artist with title=“NewArtistTitle”
Notes
- Technically square brackets are not allowed in an URI except the Internet Protocol Literal Address
- RFC3513: A host identified by an Internet Protocol literal address, version 6 [RFC3513] or later, is distinguished by enclosing the IP literal within square brackets (”[” and ”]”). This is the only place where square bracket characters are allowed in the URI syntax.
- Escaped square brackets are allowed, but don’t render well

PUT

library

sections

{sectionId}

all

PlexGO

package main

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

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

    s := plexgo.New(
        plexgo.WithAccepts(components.AcceptsApplicationXML),
        plexgo.WithClientIdentifier("abc123"),
        plexgo.WithProduct("Plex for Roku"),
        plexgo.WithVersion("2.4.1"),
        plexgo.WithPlatform("Roku"),
        plexgo.WithPlatformVersion("4.3 build 1057"),
        plexgo.WithDevice("Roku 3"),
        plexgo.WithModel("4200X"),
        plexgo.WithDeviceVendor("Roku"),
        plexgo.WithDeviceName("Living Room TV"),
        plexgo.WithMarketplace("googlePlay"),
        plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Library.UpdateItems(ctx, operations.UpdateItemsRequest{
        SectionID: "<id>",
        FieldLocked: components.BoolIntTrue.ToPointer(),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Authorizations

X-Plex-Token

string

header

required

The token which identifies the user accessing the PMS. This can be either:

A traditional access token obtained from plex.tv
A JWT token obtained through the JWT authentication flow

JWT tokens provide better security with:

Short-lived tokens (7 days expiration)
Public-key cryptography (ED25519)
Better clock synchronization
Individual device revocation capability

Headers

accepts

enum<string>

default:application/xml

Indicates the client accepts the indicated media types

Available options:

application/json,

application/xml

X-Plex-Client-Identifier

string

required

An opaque identifier unique to the client

Example:

"abc123"

X-Plex-Product

string

The name of the client product

Example:

"Plex for Roku"

X-Plex-Version

string

The version of the client application

Example:

"2.4.1"

X-Plex-Platform

string

The platform of the client

Example:

"Roku"

X-Plex-Platform-Version

string

The version of the platform

Example:

"4.3 build 1057"

X-Plex-Device

string

A relatively friendly name for the client device

Example:

"Roku 3"

X-Plex-Model

string

A potentially less friendly identifier for the device model

Example:

"4200X"

X-Plex-Device-Vendor

string

The device vendor

Example:

"Roku"

X-Plex-Device-Name

string

A friendly name for the client

Example:

"Living Room TV"

X-Plex-Marketplace

string

The marketplace on which the client application is distributed

Example:

"googlePlay"

Path Parameters

sectionId

string

required

The id of the section

Query Parameters

type

string

filters

string

The filters to apply to determine which items should be modified

field.value

string

Set the specified field to a new value

field.locked

enum<integer>

default:0

Set the specified field to locked (or unlocked if set to 0)

Available options:

0,

1

Example:

1

title.value

string

This field is treated specially by albums or artists and may be used for implicit reparenting.

artist.title.value

string

Reparents set of Tracks or Albums - used with album.title.* in the case of tracks

artist.title.id

string

Reparents set of Tracks or Albums - used with album.title.* in the case of tracks

album.title.value

string

Reparents set of Tracks - Must be used in conjunction with artist.title.value or id

album.title.id

string

Reparents set of Tracks - Must be used in conjunction with artist.title.value or id

tagtype[idx].tag.tag

string

Creates tag and associates it with each item in the set. - [idx] links this and the next parameters together

tagtype[idx].tagging.object

string

Here object may be text/thumb/art/theme - Optionally used in conjunction with tag.tag, to update association info across the set.

tagtype[].tag.tag-

string

Remove comma separated tags from the set of items

tagtype[].tag

string

Remove associations of this type (e.g. genre) from the set of items

Response

Delete a library section Analyze a section

Documentation Index

Authorizations

Headers

Path Parameters

Query Parameters

Response