Skip to content

ImportExclusionsAPI.md

Latest commit

 

History

History
403 lines (254 loc) · 10.8 KB

ImportExclusionsAPI.md

File metadata and controls

403 lines (254 loc) · 10.8 KB

\ImportExclusionsAPI

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

Method HTTP request Description
CreateExclusions Post /api/v3/exclusions
CreateExclusionsBulk Post /api/v3/exclusions/bulk
DeleteExclusions Delete /api/v3/exclusions/{id}
GetExclusionsById Get /api/v3/exclusions/{id}
ListExclusions Get /api/v3/exclusions
UpdateExclusions Put /api/v3/exclusions/{id}

CreateExclusions

ImportExclusionsResource CreateExclusions(ctx).ImportExclusionsResource(importExclusionsResource).Execute()

Example

package main

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

func main() {
	importExclusionsResource := *whisparrClient.NewImportExclusionsResource() // ImportExclusionsResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
importExclusionsResource ImportExclusionsResource

Return type

ImportExclusionsResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

CreateExclusionsBulk

CreateExclusionsBulk(ctx).ImportExclusionsResource(importExclusionsResource).Execute()

Example

package main

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

func main() {
	importExclusionsResource := []whisparrClient.ImportExclusionsResource{*whisparrClient.NewImportExclusionsResource()} // []ImportExclusionsResource |  (optional)

	configuration := whisparrClient.NewConfiguration()
	apiClient := whisparrClient.NewAPIClient(configuration)
	r, err := apiClient.ImportExclusionsAPI.CreateExclusionsBulk(context.Background()).ImportExclusionsResource(importExclusionsResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImportExclusionsAPI.CreateExclusionsBulk``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

Other Parameters

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

Name Type Description Notes
importExclusionsResource []ImportExclusionsResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

DeleteExclusions

DeleteExclusions(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)
	r, err := apiClient.ImportExclusionsAPI.DeleteExclusions(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImportExclusionsAPI.DeleteExclusions``: %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.
id int32

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

GetExclusionsById

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

Name Type Description Notes

Return type

ImportExclusionsResource

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]

ListExclusions

[]ImportExclusionsResource ListExclusions(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ImportExclusionsResource

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]

UpdateExclusions

ImportExclusionsResource UpdateExclusions(ctx, id).ImportExclusionsResource(importExclusionsResource).Execute()

Example

package main

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

func main() {
	id := "id_example" // string | 
	importExclusionsResource := *whisparrClient.NewImportExclusionsResource() // ImportExclusionsResource |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

importExclusionsResource | ImportExclusionsResource | |

Return type

ImportExclusionsResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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