Skip to content

Latest commit

 

History

History
471 lines (296 loc) · 12.1 KB

EpisodeFileAPI.md

File metadata and controls

471 lines (296 loc) · 12.1 KB

\EpisodeFileAPI

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

Method HTTP request Description
DeleteEpisodeFile Delete /api/v3/episodefile/{id}
DeleteEpisodeFileBulk Delete /api/v3/episodefile/bulk
GetEpisodeFileById Get /api/v3/episodefile/{id}
ListEpisodeFile Get /api/v3/episodefile
PutEpisodeFileBulk Put /api/v3/episodefile/bulk
PutEpisodeFileEditor Put /api/v3/episodefile/editor
UpdateEpisodeFile Put /api/v3/episodefile/{id}

DeleteEpisodeFile

DeleteEpisodeFile(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

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

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.EpisodeFileAPI.DeleteEpisodeFile(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EpisodeFileAPI.DeleteEpisodeFile``: %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 apiDeleteEpisodeFileRequest 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]

DeleteEpisodeFileBulk

DeleteEpisodeFileBulk(ctx).EpisodeFileListResource(episodeFileListResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	episodeFileListResource := *sonarrClient.NewEpisodeFileListResource() // EpisodeFileListResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.EpisodeFileAPI.DeleteEpisodeFileBulk(context.Background()).EpisodeFileListResource(episodeFileListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EpisodeFileAPI.DeleteEpisodeFileBulk``: %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 apiDeleteEpisodeFileBulkRequest struct via the builder pattern

Name Type Description Notes
episodeFileListResource EpisodeFileListResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

GetEpisodeFileById

EpisodeFileResource GetEpisodeFileById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

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

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.EpisodeFileAPI.GetEpisodeFileById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EpisodeFileAPI.GetEpisodeFileById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEpisodeFileById`: EpisodeFileResource
	fmt.Fprintf(os.Stdout, "Response from `EpisodeFileAPI.GetEpisodeFileById`: %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 apiGetEpisodeFileByIdRequest struct via the builder pattern

Name Type Description Notes

Return type

EpisodeFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ListEpisodeFile

[]EpisodeFileResource ListEpisodeFile(ctx).SeriesId(seriesId).EpisodeFileIds(episodeFileIds).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	seriesId := int32(56) // int32 |  (optional)
	episodeFileIds := []int32{int32(123)} // []int32 |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.EpisodeFileAPI.ListEpisodeFile(context.Background()).SeriesId(seriesId).EpisodeFileIds(episodeFileIds).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EpisodeFileAPI.ListEpisodeFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListEpisodeFile`: []EpisodeFileResource
	fmt.Fprintf(os.Stdout, "Response from `EpisodeFileAPI.ListEpisodeFile`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
seriesId int32
episodeFileIds []int32

Return type

[]EpisodeFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

PutEpisodeFileBulk

PutEpisodeFileBulk(ctx).EpisodeFileResource(episodeFileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	episodeFileResource := []sonarrClient.EpisodeFileResource{*sonarrClient.NewEpisodeFileResource()} // []EpisodeFileResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.EpisodeFileAPI.PutEpisodeFileBulk(context.Background()).EpisodeFileResource(episodeFileResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EpisodeFileAPI.PutEpisodeFileBulk``: %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 apiPutEpisodeFileBulkRequest struct via the builder pattern

Name Type Description Notes
episodeFileResource []EpisodeFileResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

PutEpisodeFileEditor

PutEpisodeFileEditor(ctx).EpisodeFileListResource(episodeFileListResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	episodeFileListResource := *sonarrClient.NewEpisodeFileListResource() // EpisodeFileListResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.EpisodeFileAPI.PutEpisodeFileEditor(context.Background()).EpisodeFileListResource(episodeFileListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EpisodeFileAPI.PutEpisodeFileEditor``: %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 apiPutEpisodeFileEditorRequest struct via the builder pattern

Name Type Description Notes
episodeFileListResource EpisodeFileListResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

UpdateEpisodeFile

EpisodeFileResource UpdateEpisodeFile(ctx, id).EpisodeFileResource(episodeFileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	id := "id_example" // string | 
	episodeFileResource := *sonarrClient.NewEpisodeFileResource() // EpisodeFileResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.EpisodeFileAPI.UpdateEpisodeFile(context.Background(), id).EpisodeFileResource(episodeFileResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EpisodeFileAPI.UpdateEpisodeFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateEpisodeFile`: EpisodeFileResource
	fmt.Fprintf(os.Stdout, "Response from `EpisodeFileAPI.UpdateEpisodeFile`: %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 apiUpdateEpisodeFileRequest struct via the builder pattern

Name Type Description Notes

episodeFileResource | EpisodeFileResource | |

Return type

EpisodeFileResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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