\CustomFormatAPI

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

Method	HTTP request	Description
CreateCustomFormat	Post /api/v3/customformat
DeleteCustomFormat	Delete /api/v3/customformat/{id}
DeleteCustomFormatBulk	Delete /api/v3/customformat/bulk
GetCustomFormatById	Get /api/v3/customformat/{id}
ListCustomFormat	Get /api/v3/customformat
ListCustomFormatSchema	Get /api/v3/customformat/schema
PutCustomFormatBulk	Put /api/v3/customformat/bulk
UpdateCustomFormat	Put /api/v3/customformat/{id}

CreateCustomFormat

CustomFormatResource CreateCustomFormat(ctx).CustomFormatResource(customFormatResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	customFormatResource := *sonarrClient.NewCustomFormatResource() // CustomFormatResource |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
customFormatResource	CustomFormatResource

Return type

CustomFormatResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: text/plain, application/json, text/json

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

DeleteCustomFormat

DeleteCustomFormat(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	id := int32(56) // int32 | 

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.CustomFormatAPI.DeleteCustomFormat(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CustomFormatAPI.DeleteCustomFormat``: %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 apiDeleteCustomFormatRequest 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]

DeleteCustomFormatBulk

DeleteCustomFormatBulk(ctx).CustomFormatBulkResource(customFormatBulkResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	customFormatBulkResource := *sonarrClient.NewCustomFormatBulkResource() // CustomFormatBulkResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	r, err := apiClient.CustomFormatAPI.DeleteCustomFormatBulk(context.Background()).CustomFormatBulkResource(customFormatBulkResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CustomFormatAPI.DeleteCustomFormatBulk``: %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 apiDeleteCustomFormatBulkRequest struct via the builder pattern

Name	Type	Description	Notes
customFormatBulkResource	CustomFormatBulkResource

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]

GetCustomFormatById

CustomFormatResource GetCustomFormatById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	id := int32(56) // int32 | 

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

Name	Type	Description	Notes

Return type

CustomFormatResource

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]

ListCustomFormat

[]CustomFormatResource ListCustomFormat(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]CustomFormatResource

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]

ListCustomFormatSchema

[]CustomFormatSpecificationSchema ListCustomFormatSchema(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]CustomFormatSpecificationSchema

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]

PutCustomFormatBulk

CustomFormatResource PutCustomFormatBulk(ctx).CustomFormatBulkResource(customFormatBulkResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	customFormatBulkResource := *sonarrClient.NewCustomFormatBulkResource() // CustomFormatBulkResource |  (optional)

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

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
customFormatBulkResource	CustomFormatBulkResource

Return type

CustomFormatResource

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]

UpdateCustomFormat

CustomFormatResource UpdateCustomFormat(ctx, id).CustomFormatResource(customFormatResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	sonarrClient "github.com/devopsarr/sonarr-go/sonarr"
)

func main() {
	id := "id_example" // string | 
	customFormatResource := *sonarrClient.NewCustomFormatResource() // CustomFormatResource |  (optional)

	configuration := sonarrClient.NewConfiguration()
	apiClient := sonarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.CustomFormatAPI.UpdateCustomFormat(context.Background(), id).CustomFormatResource(customFormatResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `CustomFormatAPI.UpdateCustomFormat``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateCustomFormat`: CustomFormatResource
	fmt.Fprintf(os.Stdout, "Response from `CustomFormatAPI.UpdateCustomFormat`: %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 apiUpdateCustomFormatRequest struct via the builder pattern

Name	Type	Description	Notes

customFormatResource | CustomFormatResource | |

Return type

CustomFormatResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: text/plain, application/json, text/json

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

Files

CustomFormatAPI.md

Latest commit

History

CustomFormatAPI.md

File metadata and controls

\CustomFormatAPI

CreateCustomFormat

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteCustomFormat

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteCustomFormatBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetCustomFormatById

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListCustomFormat

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListCustomFormatSchema

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PutCustomFormatBulk

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

UpdateCustomFormat

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers