Skip to content

Latest commit

 

History

History
412 lines (261 loc) · 10.6 KB

TrackFileAPI.md

File metadata and controls

412 lines (261 loc) · 10.6 KB

\TrackFileAPI

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

Method HTTP request Description
DeleteTrackFile Delete /api/v1/trackfile/{id}
DeleteTrackFileBulk Delete /api/v1/trackfile/bulk
GetTrackFileById Get /api/v1/trackfile/{id}
ListTrackFile Get /api/v1/trackfile
PutTrackFileEditor Put /api/v1/trackfile/editor
UpdateTrackFile Put /api/v1/trackfile/{id}

DeleteTrackFile

DeleteTrackFile(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)

func main() {
	id := int32(56) // int32 | 

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	r, err := apiClient.TrackFileAPI.DeleteTrackFile(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackFileAPI.DeleteTrackFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiDeleteTrackFileRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteTrackFileBulk

DeleteTrackFileBulk(ctx).TrackFileListResource(trackFileListResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)

func main() {
	trackFileListResource := *lidarrClient.NewTrackFileListResource() // TrackFileListResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	r, err := apiClient.TrackFileAPI.DeleteTrackFileBulk(context.Background()).TrackFileListResource(trackFileListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackFileAPI.DeleteTrackFileBulk``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiDeleteTrackFileBulkRequest struct via the builder pattern

Name Type Description Notes
trackFileListResource TrackFileListResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

GetTrackFileById

TrackFileResource GetTrackFileById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)

func main() {
	id := int32(56) // int32 | 

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackFileAPI.GetTrackFileById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackFileAPI.GetTrackFileById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetTrackFileById`: TrackFileResource
	fmt.Fprintf(os.Stdout, "Response from `TrackFileAPI.GetTrackFileById`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id int32

Other Parameters

Other parameters are passed through a pointer to a apiGetTrackFileByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

TrackFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

ListTrackFile

[]TrackFileResource ListTrackFile(ctx).ArtistId(artistId).TrackFileIds(trackFileIds).AlbumId(albumId).Unmapped(unmapped).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)

func main() {
	artistId := int32(56) // int32 |  (optional)
	trackFileIds := []int32{int32(123)} // []int32 |  (optional)
	albumId := []int32{int32(123)} // []int32 |  (optional)
	unmapped := true // bool |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackFileAPI.ListTrackFile(context.Background()).ArtistId(artistId).TrackFileIds(trackFileIds).AlbumId(albumId).Unmapped(unmapped).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackFileAPI.ListTrackFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListTrackFile`: []TrackFileResource
	fmt.Fprintf(os.Stdout, "Response from `TrackFileAPI.ListTrackFile`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListTrackFileRequest struct via the builder pattern

Name Type Description Notes
artistId int32
trackFileIds []int32
albumId []int32
unmapped bool

Return type

[]TrackFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

PutTrackFileEditor

PutTrackFileEditor(ctx).TrackFileListResource(trackFileListResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)

func main() {
	trackFileListResource := *lidarrClient.NewTrackFileListResource() // TrackFileListResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	r, err := apiClient.TrackFileAPI.PutTrackFileEditor(context.Background()).TrackFileListResource(trackFileListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackFileAPI.PutTrackFileEditor``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPutTrackFileEditorRequest struct via the builder pattern

Name Type Description Notes
trackFileListResource TrackFileListResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

UpdateTrackFile

TrackFileResource UpdateTrackFile(ctx, id).TrackFileResource(trackFileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	lidarrClient "github.com/devopsarr/lidarr-go/lidarr"
)

func main() {
	id := "id_example" // string | 
	trackFileResource := *lidarrClient.NewTrackFileResource() // TrackFileResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.TrackFileAPI.UpdateTrackFile(context.Background(), id).TrackFileResource(trackFileResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `TrackFileAPI.UpdateTrackFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateTrackFile`: TrackFileResource
	fmt.Fprintf(os.Stdout, "Response from `TrackFileAPI.UpdateTrackFile`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiUpdateTrackFileRequest struct via the builder pattern

Name Type Description Notes

trackFileResource | TrackFileResource | |

Return type

TrackFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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