Skip to content

CalendarAPI.md

Latest commit

 

History

History
151 lines (98 loc) · 3.94 KB

CalendarAPI.md

File metadata and controls

151 lines (98 loc) · 3.94 KB

\CalendarAPI

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

Method HTTP request Description
GetCalendarById Get /api/v1/calendar/{id}
ListCalendar Get /api/v1/calendar

GetCalendarById

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

Name Type Description Notes

Return type

AlbumResource

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]

ListCalendar

[]AlbumResource ListCalendar(ctx).Start(start).End(end).Unmonitored(unmonitored).IncludeArtist(includeArtist).Tags(tags).Execute()

Example

package main

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

func main() {
	start := time.Now() // time.Time |  (optional)
	end := time.Now() // time.Time |  (optional)
	unmonitored := true // bool |  (optional) (default to false)
	includeArtist := true // bool |  (optional) (default to false)
	tags := "tags_example" // string |  (optional) (default to "")

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.CalendarAPI.ListCalendar(context.Background()).Start(start).End(end).Unmonitored(unmonitored).IncludeArtist(includeArtist).Tags(tags).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CalendarAPI.ListCalendar``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListCalendar`: []AlbumResource
	fmt.Fprintf(os.Stdout, "Response from `CalendarAPI.ListCalendar`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
start time.Time
end time.Time
unmonitored bool [default to false]
includeArtist bool [default to false]
tags string [default to ""]

Return type

[]AlbumResource

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]