\DownloadClientAPI

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

Method	HTTP request	Description
CreateDownloadClient	Post /api/v3/downloadclient
CreateDownloadClientActionByName	Post /api/v3/downloadclient/action/{name}
DeleteDownloadClient	Delete /api/v3/downloadclient/{id}
DeleteDownloadClientBulk	Delete /api/v3/downloadclient/bulk
GetDownloadClientById	Get /api/v3/downloadclient/{id}
ListDownloadClient	Get /api/v3/downloadclient
ListDownloadClientSchema	Get /api/v3/downloadclient/schema
PutDownloadClientBulk	Put /api/v3/downloadclient/bulk
TestDownloadClient	Post /api/v3/downloadclient/test
TestallDownloadClient	Post /api/v3/downloadclient/testall
UpdateDownloadClient	Put /api/v3/downloadclient/{id}

CreateDownloadClient

DownloadClientResource CreateDownloadClient(ctx).ForceSave(forceSave).DownloadClientResource(downloadClientResource).Execute()

Example

package main

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

func main() {
	forceSave := true // bool |  (optional) (default to false)
	downloadClientResource := *sonarrClient.NewDownloadClientResource() // DownloadClientResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadClientAPI.CreateDownloadClient(context.Background()).ForceSave(forceSave).DownloadClientResource(downloadClientResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadClientAPI.CreateDownloadClient``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateDownloadClient`: DownloadClientResource
	fmt.Fprintf(os.Stdout, "Response from `DownloadClientAPI.CreateDownloadClient`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
forceSave	bool		[default to false]
downloadClientResource	DownloadClientResource

Return type

DownloadClientResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

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

CreateDownloadClientActionByName

CreateDownloadClientActionByName(ctx, name).DownloadClientResource(downloadClientResource).Execute()

Example

package main

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

func main() {
	name := "name_example" // string | 
	downloadClientResource := *sonarrClient.NewDownloadClientResource() // DownloadClientResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.DownloadClientAPI.CreateDownloadClientActionByName(context.Background(), name).DownloadClientResource(downloadClientResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadClientAPI.CreateDownloadClientActionByName``: %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.
name	string

Other Parameters

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

Name	Type	Description	Notes

downloadClientResource | DownloadClientResource | |

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]

DeleteDownloadClient

DeleteDownloadClient(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.DownloadClientAPI.DeleteDownloadClient(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadClientAPI.DeleteDownloadClient``: %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 apiDeleteDownloadClientRequest 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]

DeleteDownloadClientBulk

DeleteDownloadClientBulk(ctx).DownloadClientBulkResource(downloadClientBulkResource).Execute()

Example

package main

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

func main() {
	downloadClientBulkResource := *sonarrClient.NewDownloadClientBulkResource() // DownloadClientBulkResource |  (optional)

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

Name	Type	Description	Notes
downloadClientBulkResource	DownloadClientBulkResource

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]

GetDownloadClientById

DownloadClientResource GetDownloadClientById(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.DownloadClientAPI.GetDownloadClientById(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadClientAPI.GetDownloadClientById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetDownloadClientById`: DownloadClientResource
	fmt.Fprintf(os.Stdout, "Response from `DownloadClientAPI.GetDownloadClientById`: %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 apiGetDownloadClientByIdRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

DownloadClientResource

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]

ListDownloadClient

[]DownloadClientResource ListDownloadClient(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]DownloadClientResource

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]

ListDownloadClientSchema

[]DownloadClientResource ListDownloadClientSchema(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]DownloadClientResource

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]

PutDownloadClientBulk

DownloadClientResource PutDownloadClientBulk(ctx).DownloadClientBulkResource(downloadClientBulkResource).Execute()

Example

package main

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

func main() {
	downloadClientBulkResource := *sonarrClient.NewDownloadClientBulkResource() // DownloadClientBulkResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadClientAPI.PutDownloadClientBulk(context.Background()).DownloadClientBulkResource(downloadClientBulkResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadClientAPI.PutDownloadClientBulk``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PutDownloadClientBulk`: DownloadClientResource
	fmt.Fprintf(os.Stdout, "Response from `DownloadClientAPI.PutDownloadClientBulk`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
downloadClientBulkResource	DownloadClientBulkResource

Return type

DownloadClientResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

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

TestDownloadClient

TestDownloadClient(ctx).ForceTest(forceTest).DownloadClientResource(downloadClientResource).Execute()

Example

package main

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

func main() {
	forceTest := true // bool |  (optional) (default to false)
	downloadClientResource := *sonarrClient.NewDownloadClientResource() // DownloadClientResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.DownloadClientAPI.TestDownloadClient(context.Background()).ForceTest(forceTest).DownloadClientResource(downloadClientResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadClientAPI.TestDownloadClient``: %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 apiTestDownloadClientRequest struct via the builder pattern

Name	Type	Description	Notes
forceTest	bool		[default to false]
downloadClientResource	DownloadClientResource

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]

TestallDownloadClient

TestallDownloadClient(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

UpdateDownloadClient

DownloadClientResource UpdateDownloadClient(ctx, id).ForceSave(forceSave).DownloadClientResource(downloadClientResource).Execute()

Example

package main

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

func main() {
	id := int32(56) // int32 | 
	forceSave := true // bool |  (optional) (default to false)
	downloadClientResource := *sonarrClient.NewDownloadClientResource() // DownloadClientResource |  (optional)

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

Name	Type	Description	Notes

Return type

DownloadClientResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

DownloadClientAPI.md

Latest commit

History

DownloadClientAPI.md

File metadata and controls

\DownloadClientAPI

CreateDownloadClient

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateDownloadClientActionByName

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteDownloadClient

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteDownloadClientBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetDownloadClientById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListDownloadClient

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListDownloadClientSchema

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutDownloadClientBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestDownloadClient

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestallDownloadClient

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateDownloadClient

Example

Path Parameters