// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. package operations import ( "github.com/LukeHagar/plexgo/internal/utils" "github.com/LukeHagar/plexgo/models/components" "net/http" ) type GetFirstCharactersGlobals struct { // Indicates the client accepts the indicated media types Accepts *components.Accepts `default:"application/xml" header:"style=simple,explode=false,name=accepts"` // An opaque identifier unique to the client ClientIdentifier *string `header:"style=simple,explode=false,name=X-Plex-Client-Identifier"` // The name of the client product Product *string `header:"style=simple,explode=false,name=X-Plex-Product"` // The version of the client application Version *string `header:"style=simple,explode=false,name=X-Plex-Version"` // The platform of the client Platform *string `header:"style=simple,explode=false,name=X-Plex-Platform"` // The version of the platform PlatformVersion *string `header:"style=simple,explode=false,name=X-Plex-Platform-Version"` // A relatively friendly name for the client device Device *string `header:"style=simple,explode=false,name=X-Plex-Device"` // A potentially less friendly identifier for the device model Model *string `header:"style=simple,explode=false,name=X-Plex-Model"` // The device vendor DeviceVendor *string `header:"style=simple,explode=false,name=X-Plex-Device-Vendor"` // A friendly name for the client DeviceName *string `header:"style=simple,explode=false,name=X-Plex-Device-Name"` // The marketplace on which the client application is distributed Marketplace *string `header:"style=simple,explode=false,name=X-Plex-Marketplace"` } func (g GetFirstCharactersGlobals) MarshalJSON() ([]byte, error) { return utils.MarshalJSON(g, "", false) } func (g *GetFirstCharactersGlobals) UnmarshalJSON(data []byte) error { if err := utils.UnmarshalJSON(data, &g, "", false, nil); err != nil { return err } return nil } func (g *GetFirstCharactersGlobals) GetAccepts() *components.Accepts { if g == nil { return nil } return g.Accepts } func (g *GetFirstCharactersGlobals) GetClientIdentifier() *string { if g == nil { return nil } return g.ClientIdentifier } func (g *GetFirstCharactersGlobals) GetProduct() *string { if g == nil { return nil } return g.Product } func (g *GetFirstCharactersGlobals) GetVersion() *string { if g == nil { return nil } return g.Version } func (g *GetFirstCharactersGlobals) GetPlatform() *string { if g == nil { return nil } return g.Platform } func (g *GetFirstCharactersGlobals) GetPlatformVersion() *string { if g == nil { return nil } return g.PlatformVersion } func (g *GetFirstCharactersGlobals) GetDevice() *string { if g == nil { return nil } return g.Device } func (g *GetFirstCharactersGlobals) GetModel() *string { if g == nil { return nil } return g.Model } func (g *GetFirstCharactersGlobals) GetDeviceVendor() *string { if g == nil { return nil } return g.DeviceVendor } func (g *GetFirstCharactersGlobals) GetDeviceName() *string { if g == nil { return nil } return g.DeviceName } func (g *GetFirstCharactersGlobals) GetMarketplace() *string { if g == nil { return nil } return g.Marketplace } type GetFirstCharactersRequest struct { // Indicates the client accepts the indicated media types Accepts *components.Accepts `default:"application/xml" header:"style=simple,explode=false,name=accepts"` // An opaque identifier unique to the client ClientIdentifier *string `header:"style=simple,explode=false,name=X-Plex-Client-Identifier"` // The name of the client product Product *string `header:"style=simple,explode=false,name=X-Plex-Product"` // The version of the client application Version *string `header:"style=simple,explode=false,name=X-Plex-Version"` // The platform of the client Platform *string `header:"style=simple,explode=false,name=X-Plex-Platform"` // The version of the platform PlatformVersion *string `header:"style=simple,explode=false,name=X-Plex-Platform-Version"` // A relatively friendly name for the client device Device *string `header:"style=simple,explode=false,name=X-Plex-Device"` // A potentially less friendly identifier for the device model Model *string `header:"style=simple,explode=false,name=X-Plex-Model"` // The device vendor DeviceVendor *string `header:"style=simple,explode=false,name=X-Plex-Device-Vendor"` // A friendly name for the client DeviceName *string `header:"style=simple,explode=false,name=X-Plex-Device-Name"` // The marketplace on which the client application is distributed Marketplace *string `header:"style=simple,explode=false,name=X-Plex-Marketplace"` // Section identifier SectionID int64 `pathParam:"style=simple,explode=false,name=sectionId"` // The metadata type to filter on Type *int64 `queryParam:"style=form,explode=true,name=type"` // The metadata type to filter on Sort *int64 `queryParam:"style=form,explode=true,name=sort"` // A querystring-based filtering language used to select subsets of media. Can be provided as an object with typed properties for type safety, or as a string for complex queries with operators and boolean logic. // // The query supports: // - Fields: integer, boolean, tag, string, date, language // - Operators: =, !=, ==, !==, <=, >=, >>=, <<= (varies by field type) // - Boolean operators: & (AND), , (OR), push/pop (parentheses), or=1 (explicit OR) // - Sorting: sort parameter with :desc, :nullsLast modifiers // - Grouping: group parameter // - Limits: limit parameter // // Examples: // - Object format: `{type: 4, sourceType: 2, title: "24"}` → `type=4&sourceType=2&title=24` // - String format: `type=4&sourceType=2&title==24` - type = 4 AND sourceType = 2 AND title = "24" // - Complex: `push=1&index=1&or=1&rating=2&pop=1&duration=10` - (index = 1 OR rating = 2) AND duration = 10 // // See [API Info section](#section/API-Info/Media-Queries) for detailed information on building media queries. // MediaQuery *components.MediaQuery `queryParam:"style=form,explode=true,name=mediaQuery"` } func (g GetFirstCharactersRequest) MarshalJSON() ([]byte, error) { return utils.MarshalJSON(g, "", false) } func (g *GetFirstCharactersRequest) UnmarshalJSON(data []byte) error { if err := utils.UnmarshalJSON(data, &g, "", false, []string{"sectionId"}); err != nil { return err } return nil } func (g *GetFirstCharactersRequest) GetAccepts() *components.Accepts { if g == nil { return nil } return g.Accepts } func (g *GetFirstCharactersRequest) GetClientIdentifier() *string { if g == nil { return nil } return g.ClientIdentifier } func (g *GetFirstCharactersRequest) GetProduct() *string { if g == nil { return nil } return g.Product } func (g *GetFirstCharactersRequest) GetVersion() *string { if g == nil { return nil } return g.Version } func (g *GetFirstCharactersRequest) GetPlatform() *string { if g == nil { return nil } return g.Platform } func (g *GetFirstCharactersRequest) GetPlatformVersion() *string { if g == nil { return nil } return g.PlatformVersion } func (g *GetFirstCharactersRequest) GetDevice() *string { if g == nil { return nil } return g.Device } func (g *GetFirstCharactersRequest) GetModel() *string { if g == nil { return nil } return g.Model } func (g *GetFirstCharactersRequest) GetDeviceVendor() *string { if g == nil { return nil } return g.DeviceVendor } func (g *GetFirstCharactersRequest) GetDeviceName() *string { if g == nil { return nil } return g.DeviceName } func (g *GetFirstCharactersRequest) GetMarketplace() *string { if g == nil { return nil } return g.Marketplace } func (g *GetFirstCharactersRequest) GetSectionID() int64 { if g == nil { return 0 } return g.SectionID } func (g *GetFirstCharactersRequest) GetType() *int64 { if g == nil { return nil } return g.Type } func (g *GetFirstCharactersRequest) GetSort() *int64 { if g == nil { return nil } return g.Sort } func (g *GetFirstCharactersRequest) GetMediaQuery() *components.MediaQuery { if g == nil { return nil } return g.MediaQuery } type GetFirstCharactersDirectory struct { Key *string `json:"key,omitempty"` // The number of items starting with this character Size *int64 `json:"size,omitempty"` Title *string `json:"title,omitempty"` } func (g *GetFirstCharactersDirectory) GetKey() *string { if g == nil { return nil } return g.Key } func (g *GetFirstCharactersDirectory) GetSize() *int64 { if g == nil { return nil } return g.Size } func (g *GetFirstCharactersDirectory) GetTitle() *string { if g == nil { return nil } return g.Title } // GetFirstCharactersMediaContainer - `MediaContainer` is the root element of most Plex API responses. It serves as a generic container for various types of content (Metadata, Hubs, Directories, etc.) and includes pagination information (offset, size, totalSize) when applicable. // Common attributes: - identifier: Unique identifier for this container - size: Number of items in this response page - totalSize: Total number of items available (for pagination) - offset: Starting index of this page (for pagination) // The container often "hoists" common attributes from its children. For example, if all tracks in a container share the same album title, the `parentTitle` attribute may appear on the MediaContainer rather than being repeated on each track. type GetFirstCharactersMediaContainer struct { Identifier *string `json:"identifier,omitempty"` // The offset of where this container page starts among the total objects available. Also provided in the `X-Plex-Container-Start` header. // Offset *int64 `json:"offset,omitempty"` Size *int64 `json:"size,omitempty"` // The total size of objects available. Also provided in the `X-Plex-Container-Total-Size` header. // TotalSize *int64 `json:"totalSize,omitempty"` Directory []GetFirstCharactersDirectory `json:"Directory,omitempty"` } func (g *GetFirstCharactersMediaContainer) GetIdentifier() *string { if g == nil { return nil } return g.Identifier } func (g *GetFirstCharactersMediaContainer) GetOffset() *int64 { if g == nil { return nil } return g.Offset } func (g *GetFirstCharactersMediaContainer) GetSize() *int64 { if g == nil { return nil } return g.Size } func (g *GetFirstCharactersMediaContainer) GetTotalSize() *int64 { if g == nil { return nil } return g.TotalSize } func (g *GetFirstCharactersMediaContainer) GetDirectory() []GetFirstCharactersDirectory { if g == nil { return nil } return g.Directory } // GetFirstCharactersResponseBody - OK type GetFirstCharactersResponseBody struct { MediaContainer *GetFirstCharactersMediaContainer `json:"MediaContainer,omitempty"` } func (g *GetFirstCharactersResponseBody) GetMediaContainer() *GetFirstCharactersMediaContainer { if g == nil { return nil } return g.MediaContainer } type GetFirstCharactersResponse struct { // HTTP response content type for this operation ContentType string // HTTP response status code for this operation StatusCode int // Raw HTTP response; suitable for custom response parsing RawResponse *http.Response // OK Object *GetFirstCharactersResponseBody } func (g *GetFirstCharactersResponse) GetContentType() string { if g == nil { return "" } return g.ContentType } func (g *GetFirstCharactersResponse) GetStatusCode() int { if g == nil { return 0 } return g.StatusCode } func (g *GetFirstCharactersResponse) GetRawResponse() *http.Response { if g == nil { return nil } return g.RawResponse } func (g *GetFirstCharactersResponse) GetObject() *GetFirstCharactersResponseBody { if g == nil { return nil } return g.Object }