mirror of https://github.com/jellyfin/jellyfin-sdk-swift.git synced 2025-02-18 12:50:29 +00:00

jellyfin-bot a524873ad0 Add type-mappings

Update stable OpenAPI client

2021-06-05 07:51:11 +09:00

30 KiB

Raw Blame History

InstantMixAPI

All URIs are relative to http://localhost:8096

Method	HTTP request	Description
getInstantMixFromAlbum	GET /Albums/{id}/InstantMix	Creates an instant playlist based on a given album.
getInstantMixFromArtists	GET /Artists/{id}/InstantMix	Creates an instant playlist based on a given artist.
getInstantMixFromArtists2	GET /Artists/InstantMix	Creates an instant playlist based on a given artist.
getInstantMixFromItem	GET /Items/{id}/InstantMix	Creates an instant playlist based on a given item.
getInstantMixFromMusicGenreById	GET /MusicGenres/{id}/InstantMix	Creates an instant playlist based on a given genre.
getInstantMixFromMusicGenreById2	GET /MusicGenres/InstantMix	Creates an instant playlist based on a given genre.
getInstantMixFromMusicGenreByName	GET /MusicGenres/{name}/InstantMix	Creates an instant playlist based on a given genre.
getInstantMixFromPlaylist	GET /Playlists/{id}/InstantMix	Creates an instant playlist based on a given playlist.
getInstantMixFromSong	GET /Songs/{id}/InstantMix	Creates an instant playlist based on a given song.

getInstantMixFromAlbum

    open class func getInstantMixFromAlbum(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given album.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given album.
InstantMixAPI.getInstantMixFromAlbum(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromArtists

    open class func getInstantMixFromArtists(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given artist.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given artist.
InstantMixAPI.getInstantMixFromArtists(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromArtists2

    open class func getInstantMixFromArtists2(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given artist.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given artist.
InstantMixAPI.getInstantMixFromArtists2(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromItem

    open class func getInstantMixFromItem(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given item.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given item.
InstantMixAPI.getInstantMixFromItem(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromMusicGenreById

    open class func getInstantMixFromMusicGenreById(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given genre.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given genre.
InstantMixAPI.getInstantMixFromMusicGenreById(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromMusicGenreById2

    open class func getInstantMixFromMusicGenreById2(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given genre.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given genre.
InstantMixAPI.getInstantMixFromMusicGenreById2(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromMusicGenreByName

    open class func getInstantMixFromMusicGenreByName(name: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given genre.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let name = "name_example" // String | The genre name.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given genre.
InstantMixAPI.getInstantMixFromMusicGenreByName(name: name, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
name	String	The genre name.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromPlaylist

    open class func getInstantMixFromPlaylist(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given playlist.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given playlist.
InstantMixAPI.getInstantMixFromPlaylist(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInstantMixFromSong

    open class func getInstantMixFromSong(id: String, userId: String? = nil, limit: Int? = nil, fields: [ItemFields]? = nil, enableImages: Bool? = nil, enableUserData: Bool? = nil, imageTypeLimit: Int? = nil, enableImageTypes: [ImageType]? = nil, completion: @escaping (_ data: BaseItemDtoQueryResult?, _ error: Error?) -> Void)

Creates an instant playlist based on a given song.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import JellyfinAPI

let id = "id_example" // String | The item id.
let userId = "userId_example" // String | Optional. Filter by user id, and attach user data. (optional)
let limit = 987 // Int | Optional. The maximum number of records to return. (optional)
let fields = [ItemFields()] // [ItemFields] | Optional. Specify additional fields of information to return in the output. (optional)
let enableImages = true // Bool | Optional. Include image information in output. (optional)
let enableUserData = true // Bool | Optional. Include user data. (optional)
let imageTypeLimit = 987 // Int | Optional. The max number of images to return, per image type. (optional)
let enableImageTypes = [ImageType()] // [ImageType] | Optional. The image types to include in the output. (optional)

// Creates an instant playlist based on a given song.
InstantMixAPI.getInstantMixFromSong(id: id, userId: userId, limit: limit, fields: fields, enableImages: enableImages, enableUserData: enableUserData, imageTypeLimit: imageTypeLimit, enableImageTypes: enableImageTypes) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
id	String	The item id.
userId	String	Optional. Filter by user id, and attach user data.	[optional]
limit	Int	Optional. The maximum number of records to return.	[optional]
fields	[ItemFields]	Optional. Specify additional fields of information to return in the output.	[optional]
enableImages	Bool	Optional. Include image information in output.	[optional]
enableUserData	Bool	Optional. Include user data.	[optional]
imageTypeLimit	Int	Optional. The max number of images to return, per image type.	[optional]
enableImageTypes	[ImageType]	Optional. The image types to include in the output.	[optional]

Return type

BaseItemDtoQueryResult

Authorization

CustomAuthentication

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/json; profile=CamelCase, application/json; profile=PascalCase

[Back to top] [Back to API list] [Back to Model list] [Back to README]

30 KiB Raw Blame History

InstantMixAPI

getInstantMixFromAlbum

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromArtists

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromArtists2

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromItem

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromMusicGenreById

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromMusicGenreById2

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromMusicGenreByName

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromPlaylist

Example

Parameters

Return type

Authorization

HTTP request headers

getInstantMixFromSong

Example

Parameters

Return type

Authorization

HTTP request headers

30 KiB

Raw Blame History