\ImportListAPI

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

Method	HTTP request	Description
CreateImportList	Post /api/v1/importlist
CreateImportListActionByName	Post /api/v1/importlist/action/{name}
DeleteImportList	Delete /api/v1/importlist/{id}
DeleteImportListBulk	Delete /api/v1/importlist/bulk
GetImportListById	Get /api/v1/importlist/{id}
ListImportList	Get /api/v1/importlist
ListImportListSchema	Get /api/v1/importlist/schema
PutImportListBulk	Put /api/v1/importlist/bulk
TestImportList	Post /api/v1/importlist/test
TestallImportList	Post /api/v1/importlist/testall
UpdateImportList	Put /api/v1/importlist/{id}

CreateImportList

ImportListResource CreateImportList(ctx).ForceSave(forceSave).ImportListResource(importListResource).Execute()

Example

package main

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

func main() {
	forceSave := true // bool |  (optional) (default to false)
	importListResource := *lidarrClient.NewImportListResource() // ImportListResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.ImportListAPI.CreateImportList(context.Background()).ForceSave(forceSave).ImportListResource(importListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImportListAPI.CreateImportList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateImportList`: ImportListResource
	fmt.Fprintf(os.Stdout, "Response from `ImportListAPI.CreateImportList`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
forceSave	bool		[default to false]
importListResource	ImportListResource

Return type

ImportListResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

CreateImportListActionByName

CreateImportListActionByName(ctx, name).ImportListResource(importListResource).Execute()

Example

package main

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

func main() {
	name := "name_example" // string | 
	importListResource := *lidarrClient.NewImportListResource() // ImportListResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	r, err := apiClient.ImportListAPI.CreateImportListActionByName(context.Background(), name).ImportListResource(importListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImportListAPI.CreateImportListActionByName``: %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.
name	string

Other Parameters

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

Name	Type	Description	Notes

importListResource | ImportListResource | |

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

DeleteImportList

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

DeleteImportListBulk

DeleteImportListBulk(ctx).ImportListBulkResource(importListBulkResource).Execute()

Example

package main

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

func main() {
	importListBulkResource := *lidarrClient.NewImportListBulkResource() // ImportListBulkResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	r, err := apiClient.ImportListAPI.DeleteImportListBulk(context.Background()).ImportListBulkResource(importListBulkResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImportListAPI.DeleteImportListBulk``: %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 apiDeleteImportListBulkRequest struct via the builder pattern

Name	Type	Description	Notes
importListBulkResource	ImportListBulkResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

GetImportListById

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

Name	Type	Description	Notes

Return type

ImportListResource

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]

ListImportList

[]ImportListResource ListImportList(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ImportListResource

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]

ListImportListSchema

[]ImportListResource ListImportListSchema(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ImportListResource

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]

PutImportListBulk

ImportListResource PutImportListBulk(ctx).ImportListBulkResource(importListBulkResource).Execute()

Example

package main

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

func main() {
	importListBulkResource := *lidarrClient.NewImportListBulkResource() // ImportListBulkResource |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
importListBulkResource	ImportListBulkResource

Return type

ImportListResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

TestImportList

TestImportList(ctx).ForceTest(forceTest).ImportListResource(importListResource).Execute()

Example

package main

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

func main() {
	forceTest := true // bool |  (optional) (default to false)
	importListResource := *lidarrClient.NewImportListResource() // ImportListResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	r, err := apiClient.ImportListAPI.TestImportList(context.Background()).ForceTest(forceTest).ImportListResource(importListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImportListAPI.TestImportList``: %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 apiTestImportListRequest struct via the builder pattern

Name	Type	Description	Notes
forceTest	bool		[default to false]
importListResource	ImportListResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

TestallImportList

TestallImportList(ctx).Execute()

Example

package main

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

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

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]

UpdateImportList

ImportListResource UpdateImportList(ctx, id).ForceSave(forceSave).ImportListResource(importListResource).Execute()

Example

package main

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

func main() {
	id := int32(56) // int32 | 
	forceSave := true // bool |  (optional) (default to false)
	importListResource := *lidarrClient.NewImportListResource() // ImportListResource |  (optional)

	configuration := lidarrClient.NewConfiguration()
	apiClient := lidarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.ImportListAPI.UpdateImportList(context.Background(), id).ForceSave(forceSave).ImportListResource(importListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ImportListAPI.UpdateImportList``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateImportList`: ImportListResource
	fmt.Fprintf(os.Stdout, "Response from `ImportListAPI.UpdateImportList`: %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 apiUpdateImportListRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

ImportListResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

Files

ImportListAPI.md

Latest commit

History

ImportListAPI.md

File metadata and controls

\ImportListAPI

CreateImportList

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateImportListActionByName

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteImportList

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteImportListBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetImportListById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListImportList

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListImportListSchema

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutImportListBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestImportList

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

TestallImportList

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateImportList

Example

Path Parameters