Skip to content

AppProfileAPI.md

Latest commit

 

History

History
400 lines (253 loc) · 10 KB

AppProfileAPI.md

File metadata and controls

400 lines (253 loc) · 10 KB

\AppProfileAPI

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

Method HTTP request Description
CreateAppProfile Post /api/v1/appprofile
DeleteAppProfile Delete /api/v1/appprofile/{id}
GetAppProfileById Get /api/v1/appprofile/{id}
GetAppProfileSchema Get /api/v1/appprofile/schema
ListAppProfile Get /api/v1/appprofile
UpdateAppProfile Put /api/v1/appprofile/{id}

CreateAppProfile

AppProfileResource CreateAppProfile(ctx).AppProfileResource(appProfileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	appProfileResource := *prowlarrClient.NewAppProfileResource() // AppProfileResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
appProfileResource AppProfileResource

Return type

AppProfileResource

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]

DeleteAppProfile

DeleteAppProfile(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

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

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

GetAppProfileById

AppProfileResource GetAppProfileById(ctx, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

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

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

Name Type Description Notes

Return type

AppProfileResource

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]

GetAppProfileSchema

AppProfileResource GetAppProfileSchema(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

AppProfileResource

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]

ListAppProfile

[]AppProfileResource ListAppProfile(ctx).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]AppProfileResource

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]

UpdateAppProfile

AppProfileResource UpdateAppProfile(ctx, id).AppProfileResource(appProfileResource).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	prowlarrClient "github.com/devopsarr/prowlarr-go/prowlarr"
)

func main() {
	id := "id_example" // string | 
	appProfileResource := *prowlarrClient.NewAppProfileResource() // AppProfileResource |  (optional)

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

Name Type Description Notes

appProfileResource | AppProfileResource | |

Return type

AppProfileResource

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]