Skip to content

HistoryAPI.md

Latest commit

 

History

History
224 lines (148 loc) · 6.36 KB

HistoryAPI.md

File metadata and controls

224 lines (148 loc) · 6.36 KB

\HistoryAPI

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

Method HTTP request Description
GetHistory Get /api/v1/history
ListHistoryIndexer Get /api/v1/history/indexer
ListHistorySince Get /api/v1/history/since

GetHistory

HistoryResourcePagingResource GetHistory(ctx).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).EventType(eventType).Successful(successful).DownloadId(downloadId).IndexerIds(indexerIds).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	page := int32(56) // int32 |  (optional) (default to 1)
	pageSize := int32(56) // int32 |  (optional) (default to 10)
	sortKey := "sortKey_example" // string |  (optional)
	sortDirection := prowlarrClient.SortDirection("default") // SortDirection |  (optional)
	eventType := []int32{int32(123)} // []int32 |  (optional)
	successful := true // bool |  (optional)
	downloadId := "downloadId_example" // string |  (optional)
	indexerIds := []int32{int32(123)} // []int32 |  (optional)

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.HistoryAPI.GetHistory(context.Background()).Page(page).PageSize(pageSize).SortKey(sortKey).SortDirection(sortDirection).EventType(eventType).Successful(successful).DownloadId(downloadId).IndexerIds(indexerIds).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HistoryAPI.GetHistory``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetHistory`: HistoryResourcePagingResource
	fmt.Fprintf(os.Stdout, "Response from `HistoryAPI.GetHistory`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
page int32 [default to 1]
pageSize int32 [default to 10]
sortKey string
sortDirection SortDirection
eventType []int32
successful bool
downloadId string
indexerIds []int32

Return type

HistoryResourcePagingResource

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]

ListHistoryIndexer

[]HistoryResource ListHistoryIndexer(ctx).IndexerId(indexerId).EventType(eventType).Limit(limit).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	indexerId := int32(56) // int32 |  (optional)
	eventType := prowlarrClient.HistoryEventType("unknown") // HistoryEventType |  (optional)
	limit := int32(56) // int32 |  (optional)

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.HistoryAPI.ListHistoryIndexer(context.Background()).IndexerId(indexerId).EventType(eventType).Limit(limit).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HistoryAPI.ListHistoryIndexer``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListHistoryIndexer`: []HistoryResource
	fmt.Fprintf(os.Stdout, "Response from `HistoryAPI.ListHistoryIndexer`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
indexerId int32
eventType HistoryEventType
limit int32

Return type

[]HistoryResource

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]

ListHistorySince

[]HistoryResource ListHistorySince(ctx).Date(date).EventType(eventType).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	date := time.Now() // time.Time |  (optional)
	eventType := prowlarrClient.HistoryEventType("unknown") // HistoryEventType |  (optional)

	configuration := prowlarrClient.NewConfiguration()
	apiClient := prowlarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.HistoryAPI.ListHistorySince(context.Background()).Date(date).EventType(eventType).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HistoryAPI.ListHistorySince``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListHistorySince`: []HistoryResource
	fmt.Fprintf(os.Stdout, "Response from `HistoryAPI.ListHistorySince`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
date time.Time
eventType HistoryEventType

Return type

[]HistoryResource

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]