Skip to content

Latest commit

 

History

History
340 lines (215 loc) · 9.08 KB

QualityProfileAPI.md

File metadata and controls

340 lines (215 loc) · 9.08 KB

\QualityProfileAPI

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

Method HTTP request Description
CreateQualityProfile Post /api/v1/qualityprofile
DeleteQualityProfile Delete /api/v1/qualityprofile/{id}
GetQualityProfileById Get /api/v1/qualityprofile/{id}
ListQualityProfile Get /api/v1/qualityprofile
UpdateQualityProfile Put /api/v1/qualityprofile/{id}

CreateQualityProfile

QualityProfileResource CreateQualityProfile(ctx).QualityProfileResource(qualityProfileResource).Execute()

Example

package main

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

func main() {
	qualityProfileResource := *lidarrClient.NewQualityProfileResource() // QualityProfileResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
qualityProfileResource QualityProfileResource

Return type

QualityProfileResource

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]

DeleteQualityProfile

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

GetQualityProfileById

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

Name Type Description Notes

Return type

QualityProfileResource

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]

ListQualityProfile

[]QualityProfileResource ListQualityProfile(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]QualityProfileResource

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]

UpdateQualityProfile

QualityProfileResource UpdateQualityProfile(ctx, id).QualityProfileResource(qualityProfileResource).Execute()

Example

package main

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

func main() {
	id := "id_example" // string | 
	qualityProfileResource := *lidarrClient.NewQualityProfileResource() // QualityProfileResource |  (optional)

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

Name Type Description Notes

qualityProfileResource | QualityProfileResource | |

Return type

QualityProfileResource

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]