QueueDetailsAPI.md

\QueueDetailsAPI

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

Method	HTTP request	Description
GetQueueDetailsById	Get /api/v3/queue/details/{id}
ListQueueDetails	Get /api/v3/queue/details

GetQueueDetailsById

QueueResource GetQueueDetailsById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	whisparrClient "github.com/devopsarr/whisparr-go/whisparr"
)

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

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

Name	Type	Description	Notes

Return type

QueueResource

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]

ListQueueDetails

[]QueueResource ListQueueDetails(ctx).MovieId(movieId).IncludeMovie(includeMovie).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	whisparrClient "github.com/devopsarr/whisparr-go/whisparr"
)

func main() {
	movieId := int32(56) // int32 |  (optional)
	includeMovie := true // bool |  (optional) (default to false)

	configuration := whisparrClient.NewConfiguration()
	apiClient := whisparrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.QueueDetailsAPI.ListQueueDetails(context.Background()).MovieId(movieId).IncludeMovie(includeMovie).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `QueueDetailsAPI.ListQueueDetails``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListQueueDetails`: []QueueResource
	fmt.Fprintf(os.Stdout, "Response from `QueueDetailsAPI.ListQueueDetails`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
movieId	int32
includeMovie	bool		[default to false]

Return type

[]QueueResource

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]