Skip to content

OverrideruleAPI.md

Latest commit

 

History

History
274 lines (172 loc) · 6.64 KB

OverrideruleAPI.md

File metadata and controls

274 lines (172 loc) · 6.64 KB

\OverrideruleAPI

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

Method HTTP request Description
CreateOverriderule Post /overrideRule Create override rule
DeleteOverriderule Delete /overrideRule/{ruleId} Delete override rule by ID
ListOverriderule Get /overrideRule Get override rules
UpdateOverriderule Put /overrideRule/{ruleId} Update override rule

CreateOverriderule

[]OverrideRule CreateOverriderule(ctx).Execute()

Create override rule

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]OverrideRule

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]

DeleteOverriderule

OverrideRule DeleteOverriderule(ctx, ruleId).Execute()

Delete override rule by ID

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	ruleId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ruleId float32

Other Parameters

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

Name Type Description Notes

Return type

OverrideRule

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]

ListOverriderule

[]OverrideRule ListOverriderule(ctx).Execute()

Get override rules

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]OverrideRule

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]

UpdateOverriderule

[]OverrideRule UpdateOverriderule(ctx, ruleId).Execute()

Update override rule

Example

package main

import (
	"context"
	"fmt"
	"os"
	seerrClient "github.com/devopsarr/seerr-go/seerr"
)

func main() {
	ruleId := float32(8.14) // float32 | 

	configuration := seerrClient.NewConfiguration()
	apiClient := seerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.OverrideruleAPI.UpdateOverriderule(context.Background(), ruleId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `OverrideruleAPI.UpdateOverriderule``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateOverriderule`: []OverrideRule
	fmt.Fprintf(os.Stdout, "Response from `OverrideruleAPI.UpdateOverriderule`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ruleId float32

Other Parameters

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

Name Type Description Notes

Return type

[]OverrideRule

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]