Skip to content

Latest commit

 

History

History
411 lines (261 loc) · 10.8 KB

DelayProfileAPI.md

File metadata and controls

411 lines (261 loc) · 10.8 KB

\DelayProfileAPI

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

Method HTTP request Description
CreateDelayProfile Post /api/v3/delayprofile
DeleteDelayProfile Delete /api/v3/delayprofile/{id}
GetDelayProfileById Get /api/v3/delayprofile/{id}
ListDelayProfile Get /api/v3/delayprofile
UpdateDelayProfile Put /api/v3/delayprofile/{id}
UpdateDelayProfileReorder Put /api/v3/delayprofile/reorder/{id}

CreateDelayProfile

DelayProfileResource CreateDelayProfile(ctx).DelayProfileResource(delayProfileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	delayProfileResource := *radarrClient.NewDelayProfileResource() // DelayProfileResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
delayProfileResource DelayProfileResource

Return type

DelayProfileResource

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]

DeleteDelayProfile

DeleteDelayProfile(ctx, id).Execute()

Example

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

GetDelayProfileById

DelayProfileResource GetDelayProfileById(ctx, id).Execute()

Example

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

Name Type Description Notes

Return type

DelayProfileResource

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]

ListDelayProfile

[]DelayProfileResource ListDelayProfile(ctx).Execute()

Example

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.DelayProfileAPI.ListDelayProfile(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DelayProfileAPI.ListDelayProfile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListDelayProfile`: []DelayProfileResource
	fmt.Fprintf(os.Stdout, "Response from `DelayProfileAPI.ListDelayProfile`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]DelayProfileResource

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]

UpdateDelayProfile

DelayProfileResource UpdateDelayProfile(ctx, id).DelayProfileResource(delayProfileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

func main() {
	id := "id_example" // string | 
	delayProfileResource := *radarrClient.NewDelayProfileResource() // DelayProfileResource |  (optional)

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

Name Type Description Notes

delayProfileResource | DelayProfileResource | |

Return type

DelayProfileResource

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]

UpdateDelayProfileReorder

[]DelayProfileResource UpdateDelayProfileReorder(ctx, id).After(after).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	radarrClient "github.com/devopsarr/radarr-go/radarr"
)

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

	configuration := radarrClient.NewConfiguration()
	apiClient := radarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.DelayProfileAPI.UpdateDelayProfileReorder(context.Background(), id).After(after).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DelayProfileAPI.UpdateDelayProfileReorder``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateDelayProfileReorder`: []DelayProfileResource
	fmt.Fprintf(os.Stdout, "Response from `DelayProfileAPI.UpdateDelayProfileReorder`: %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 apiUpdateDelayProfileReorderRequest struct via the builder pattern

Name Type Description Notes

after | int32 | |

Return type

[]DelayProfileResource

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]