Skip to content

Latest commit

 

History

History
208 lines (132 loc) · 5.99 KB

DownloadClientConfigAPI.md

File metadata and controls

208 lines (132 loc) · 5.99 KB
Raw

\DownloadClientConfigAPI

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

Method HTTP request Description
GetDownloadClientConfig Get /api/v1/config/downloadclient
GetDownloadClientConfigById Get /api/v1/config/downloadclient/{id}
UpdateDownloadClientConfig Put /api/v1/config/downloadclient/{id}

GetDownloadClientConfig

DownloadClientConfigResource GetDownloadClientConfig(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

DownloadClientConfigResource

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]

GetDownloadClientConfigById

DownloadClientConfigResource GetDownloadClientConfigById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

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

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

Name Type Description Notes

Return type

DownloadClientConfigResource

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]

UpdateDownloadClientConfig

DownloadClientConfigResource UpdateDownloadClientConfig(ctx, id).DownloadClientConfigResource(downloadClientConfigResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	id := "id_example" // string | 
	downloadClientConfigResource := *readarrClient.NewDownloadClientConfigResource() // DownloadClientConfigResource |  (optional)

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

Name Type Description Notes

downloadClientConfigResource | DownloadClientConfigResource | |

Return type

DownloadClientConfigResource

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]