Skip to content

Latest commit

 

History

History
570 lines (362 loc) · 14.7 KB

RequestAPI.md

File metadata and controls

570 lines (362 loc) · 14.7 KB

\RequestAPI

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
CreateRequest Post /request Create new request
CreateRequestByStatus Post /request/{requestId}/{status} Update a request's status
CreateRequestRetry Post /request/{requestId}/retry Retry failed request
DeleteRequest Delete /request/{requestId} Delete request
GetRequest Get /request Get all requests
GetRequestByRequestId Get /request/{requestId} Get MediaRequest
GetRequestCount Get /request/count Gets request counts
UpdateRequest Put /request/{requestId} Update MediaRequest

CreateRequest

MediaRequest CreateRequest(ctx).CreateRequestRequest(createRequestRequest).Execute()

Create new request

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	createRequestRequest := *overseerrClient.NewCreateRequestRequest("movie", float32(123)) // CreateRequestRequest | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.RequestAPI.CreateRequest(context.Background()).CreateRequestRequest(createRequestRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RequestAPI.CreateRequest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateRequest`: MediaRequest
	fmt.Fprintf(os.Stdout, "Response from `RequestAPI.CreateRequest`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
createRequestRequest CreateRequestRequest

Return type

MediaRequest

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateRequestByStatus

MediaRequest CreateRequestByStatus(ctx, requestId, status).Execute()

Update a request's status

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	requestId := "1" // string | Request ID
	status := "status_example" // string | New status

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.RequestAPI.CreateRequestByStatus(context.Background(), requestId, status).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RequestAPI.CreateRequestByStatus``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateRequestByStatus`: MediaRequest
	fmt.Fprintf(os.Stdout, "Response from `RequestAPI.CreateRequestByStatus`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
requestId string Request ID
status string New status

Other Parameters

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

Name Type Description Notes

Return type

MediaRequest

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateRequestRetry

MediaRequest CreateRequestRetry(ctx, requestId).Execute()

Retry failed request

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	requestId := "1" // string | Request ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
requestId string Request ID

Other Parameters

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

Name Type Description Notes

Return type

MediaRequest

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRequest

DeleteRequest(ctx, requestId).Execute()

Delete request

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	requestId := "1" // string | Request ID

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	r, err := apiClient.RequestAPI.DeleteRequest(context.Background(), requestId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RequestAPI.DeleteRequest``: %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.
requestId string Request ID

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRequest

GetUserRequests2XXResponse GetRequest(ctx).Take(take).Skip(skip).Filter(filter).Sort(sort).RequestedBy(requestedBy).Execute()

Get all requests

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	take := float32(20) // float32 |  (optional)
	skip := float32(0) // float32 |  (optional)
	filter := "filter_example" // string |  (optional)
	sort := "sort_example" // string |  (optional) (default to "added")
	requestedBy := float32(1) // float32 |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.RequestAPI.GetRequest(context.Background()).Take(take).Skip(skip).Filter(filter).Sort(sort).RequestedBy(requestedBy).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RequestAPI.GetRequest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetRequest`: GetUserRequests2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `RequestAPI.GetRequest`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
take float32
skip float32
filter string
sort string [default to "added"]
requestedBy float32

Return type

GetUserRequests2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRequestByRequestId

MediaRequest GetRequestByRequestId(ctx, requestId).Execute()

Get MediaRequest

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	requestId := "1" // string | Request ID

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
requestId string Request ID

Other Parameters

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

Name Type Description Notes

Return type

MediaRequest

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRequestCount

GetRequestCount2XXResponse GetRequestCount(ctx).Execute()

Gets request counts

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

GetRequestCount2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateRequest

MediaRequest UpdateRequest(ctx, requestId).UpdateRequestRequest(updateRequestRequest).Execute()

Update MediaRequest

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	requestId := "1" // string | Request ID
	updateRequestRequest := *overseerrClient.NewUpdateRequestRequest("MediaType_example") // UpdateRequestRequest | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.RequestAPI.UpdateRequest(context.Background(), requestId).UpdateRequestRequest(updateRequestRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RequestAPI.UpdateRequest``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateRequest`: MediaRequest
	fmt.Fprintf(os.Stdout, "Response from `RequestAPI.UpdateRequest`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
requestId string Request ID

Other Parameters

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

Name Type Description Notes

updateRequestRequest | UpdateRequestRequest | |

Return type

MediaRequest

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]