Skip to content

Latest commit

 

History

History
340 lines (215 loc) · 9.14 KB

ReleaseProfileAPI.md

File metadata and controls

340 lines (215 loc) · 9.14 KB
Raw

\ReleaseProfileAPI

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

Method HTTP request Description
CreateReleaseProfile Post /api/v3/releaseprofile
DeleteReleaseProfile Delete /api/v3/releaseprofile/{id}
GetReleaseProfileById Get /api/v3/releaseprofile/{id}
ListReleaseProfile Get /api/v3/releaseprofile
UpdateReleaseProfile Put /api/v3/releaseprofile/{id}

CreateReleaseProfile

ReleaseProfileResource CreateReleaseProfile(ctx).ReleaseProfileResource(releaseProfileResource).Execute()

Example

package main

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

func main() {
	releaseProfileResource := *whisparrClient.NewReleaseProfileResource() // ReleaseProfileResource |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
releaseProfileResource ReleaseProfileResource

Return type

ReleaseProfileResource

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]

DeleteReleaseProfile

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

GetReleaseProfileById

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

Name Type Description Notes

Return type

ReleaseProfileResource

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]

ListReleaseProfile

[]ReleaseProfileResource ListReleaseProfile(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.ReleaseProfileAPI.ListReleaseProfile(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ReleaseProfileAPI.ListReleaseProfile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListReleaseProfile`: []ReleaseProfileResource
	fmt.Fprintf(os.Stdout, "Response from `ReleaseProfileAPI.ListReleaseProfile`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ReleaseProfileResource

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]

UpdateReleaseProfile

ReleaseProfileResource UpdateReleaseProfile(ctx, id).ReleaseProfileResource(releaseProfileResource).Execute()

Example

package main

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

func main() {
	id := "id_example" // string | 
	releaseProfileResource := *whisparrClient.NewReleaseProfileResource() // ReleaseProfileResource |  (optional)

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

Name Type Description Notes

releaseProfileResource | ReleaseProfileResource | |

Return type

ReleaseProfileResource

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]