All URIs are relative to http://localhost:7878
| Method | HTTP request | Description |
|---|---|---|
| GetNamingConfig | Get /api/v3/config/naming | |
| GetNamingConfigById | Get /api/v3/config/naming/{id} | |
| GetNamingConfigExamples | Get /api/v3/config/naming/examples | |
| UpdateNamingConfig | Put /api/v3/config/naming/{id} |
NamingConfigResource GetNamingConfig(ctx).Execute()
package main
import (
"context"
"fmt"
"os"
radarrClient "github.com/devopsarr/radarr-go/radarr"
)
func main() {
configuration := radarrClient.NewConfiguration()
apiClient := radarrClient.NewAPIClient(configuration)
resp, r, err := apiClient.NamingConfigAPI.GetNamingConfig(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NamingConfigAPI.GetNamingConfig``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetNamingConfig`: NamingConfigResource
fmt.Fprintf(os.Stdout, "Response from `NamingConfigAPI.GetNamingConfig`: %v\n", resp)
}This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiGetNamingConfigRequest struct via the builder pattern
- 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]
NamingConfigResource GetNamingConfigById(ctx, id).Execute()
package main
import (
"context"
"fmt"
"os"
radarrClient "github.com/devopsarr/radarr-go/radarr"
)
func main() {
id := int32(56) // int32 |
configuration := radarrClient.NewConfiguration()
apiClient := radarrClient.NewAPIClient(configuration)
resp, r, err := apiClient.NamingConfigAPI.GetNamingConfigById(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NamingConfigAPI.GetNamingConfigById``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetNamingConfigById`: NamingConfigResource
fmt.Fprintf(os.Stdout, "Response from `NamingConfigAPI.GetNamingConfigById`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | int32 |
Other parameters are passed through a pointer to a apiGetNamingConfigByIdRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
- 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]
GetNamingConfigExamples(ctx).RenameMovies(renameMovies).ReplaceIllegalCharacters(replaceIllegalCharacters).ColonReplacementFormat(colonReplacementFormat).StandardMovieFormat(standardMovieFormat).MovieFolderFormat(movieFolderFormat).Id(id).ResourceName(resourceName).Execute()
package main
import (
"context"
"fmt"
"os"
radarrClient "github.com/devopsarr/radarr-go/radarr"
)
func main() {
renameMovies := true // bool | (optional)
replaceIllegalCharacters := true // bool | (optional)
colonReplacementFormat := radarrClient.ColonReplacementFormat("delete") // ColonReplacementFormat | (optional)
standardMovieFormat := "standardMovieFormat_example" // string | (optional)
movieFolderFormat := "movieFolderFormat_example" // string | (optional)
id := int32(56) // int32 | (optional)
resourceName := "resourceName_example" // string | (optional)
configuration := radarrClient.NewConfiguration()
apiClient := radarrClient.NewAPIClient(configuration)
r, err := apiClient.NamingConfigAPI.GetNamingConfigExamples(context.Background()).RenameMovies(renameMovies).ReplaceIllegalCharacters(replaceIllegalCharacters).ColonReplacementFormat(colonReplacementFormat).StandardMovieFormat(standardMovieFormat).MovieFolderFormat(movieFolderFormat).Id(id).ResourceName(resourceName).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NamingConfigAPI.GetNamingConfigExamples``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}Other parameters are passed through a pointer to a apiGetNamingConfigExamplesRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|---|---|---|
| renameMovies | bool | ||
| replaceIllegalCharacters | bool | ||
| colonReplacementFormat | ColonReplacementFormat | ||
| standardMovieFormat | string | ||
| movieFolderFormat | string | ||
| id | int32 | ||
| resourceName | string |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamingConfigResource UpdateNamingConfig(ctx, id).NamingConfigResource(namingConfigResource).Execute()
package main
import (
"context"
"fmt"
"os"
radarrClient "github.com/devopsarr/radarr-go/radarr"
)
func main() {
id := "id_example" // string |
namingConfigResource := *radarrClient.NewNamingConfigResource() // NamingConfigResource | (optional)
configuration := radarrClient.NewConfiguration()
apiClient := radarrClient.NewAPIClient(configuration)
resp, r, err := apiClient.NamingConfigAPI.UpdateNamingConfig(context.Background(), id).NamingConfigResource(namingConfigResource).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `NamingConfigAPI.UpdateNamingConfig``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateNamingConfig`: NamingConfigResource
fmt.Fprintf(os.Stdout, "Response from `NamingConfigAPI.UpdateNamingConfig`: %v\n", resp)
}| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string |
Other parameters are passed through a pointer to a apiUpdateNamingConfigRequest struct via the builder pattern
| Name | Type | Description | Notes |
|---|
namingConfigResource | NamingConfigResource | |
- 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]