Skip to content

Latest commit

 

History

History
340 lines (215 loc) · 9.19 KB

MetadataProfileAPI.md

File metadata and controls

340 lines (215 loc) · 9.19 KB

\MetadataProfileAPI

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

Method HTTP request Description
CreateMetadataProfile Post /api/v1/metadataprofile
DeleteMetadataProfile Delete /api/v1/metadataprofile/{id}
GetMetadataProfileById Get /api/v1/metadataprofile/{id}
ListMetadataProfile Get /api/v1/metadataprofile
UpdateMetadataProfile Put /api/v1/metadataprofile/{id}

CreateMetadataProfile

MetadataProfileResource CreateMetadataProfile(ctx).MetadataProfileResource(metadataProfileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	metadataProfileResource := *readarrClient.NewMetadataProfileResource() // MetadataProfileResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
metadataProfileResource MetadataProfileResource

Return type

MetadataProfileResource

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]

DeleteMetadataProfile

DeleteMetadataProfile(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

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

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

GetMetadataProfileById

MetadataProfileResource GetMetadataProfileById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

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

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

Name Type Description Notes

Return type

MetadataProfileResource

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]

ListMetadataProfile

[]MetadataProfileResource ListMetadataProfile(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]MetadataProfileResource

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]

UpdateMetadataProfile

MetadataProfileResource UpdateMetadataProfile(ctx, id).MetadataProfileResource(metadataProfileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	readarrClient "github.com/devopsarr/readarr-go/readarr"
)

func main() {
	id := "id_example" // string | 
	metadataProfileResource := *readarrClient.NewMetadataProfileResource() // MetadataProfileResource |  (optional)

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

Name Type Description Notes

metadataProfileResource | MetadataProfileResource | |

Return type

MetadataProfileResource

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]