Skip to content

BookFileAPI.md

Latest commit

 

History

History
412 lines (261 loc) · 10.5 KB

BookFileAPI.md

File metadata and controls

412 lines (261 loc) · 10.5 KB

\BookFileAPI

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

Method HTTP request Description
DeleteBookFile Delete /api/v1/bookfile/{id}
DeleteBookFileBulk Delete /api/v1/bookfile/bulk
GetBookFileById Get /api/v1/bookfile/{id}
ListBookFile Get /api/v1/bookfile
PutBookFileEditor Put /api/v1/bookfile/editor
UpdateBookFile Put /api/v1/bookfile/{id}

DeleteBookFile

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

DeleteBookFileBulk

DeleteBookFileBulk(ctx).BookFileListResource(bookFileListResource).Execute()

Example

package main

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

func main() {
	bookFileListResource := *readarrClient.NewBookFileListResource() // BookFileListResource |  (optional)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	r, err := apiClient.BookFileAPI.DeleteBookFileBulk(context.Background()).BookFileListResource(bookFileListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BookFileAPI.DeleteBookFileBulk``: %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 apiDeleteBookFileBulkRequest struct via the builder pattern

Name Type Description Notes
bookFileListResource BookFileListResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

GetBookFileById

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

Name Type Description Notes

Return type

BookFileResource

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]

ListBookFile

[]BookFileResource ListBookFile(ctx).AuthorId(authorId).BookFileIds(bookFileIds).BookId(bookId).Unmapped(unmapped).Execute()

Example

package main

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

func main() {
	authorId := int32(56) // int32 |  (optional)
	bookFileIds := []int32{int32(123)} // []int32 |  (optional)
	bookId := []int32{int32(123)} // []int32 |  (optional)
	unmapped := true // bool |  (optional)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.BookFileAPI.ListBookFile(context.Background()).AuthorId(authorId).BookFileIds(bookFileIds).BookId(bookId).Unmapped(unmapped).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BookFileAPI.ListBookFile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListBookFile`: []BookFileResource
	fmt.Fprintf(os.Stdout, "Response from `BookFileAPI.ListBookFile`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
authorId int32
bookFileIds []int32
bookId []int32
unmapped bool

Return type

[]BookFileResource

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]

PutBookFileEditor

PutBookFileEditor(ctx).BookFileListResource(bookFileListResource).Execute()

Example

package main

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

func main() {
	bookFileListResource := *readarrClient.NewBookFileListResource() // BookFileListResource |  (optional)

	configuration := readarrClient.NewConfiguration()
	apiClient := readarrClient.NewAPIClient(configuration)
	r, err := apiClient.BookFileAPI.PutBookFileEditor(context.Background()).BookFileListResource(bookFileListResource).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `BookFileAPI.PutBookFileEditor``: %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 apiPutBookFileEditorRequest struct via the builder pattern

Name Type Description Notes
bookFileListResource BookFileListResource

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

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

UpdateBookFile

BookFileResource UpdateBookFile(ctx, id).BookFileResource(bookFileResource).Execute()

Example

package main

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

func main() {
	id := "id_example" // string | 
	bookFileResource := *readarrClient.NewBookFileResource() // BookFileResource |  (optional)

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

Name Type Description Notes

bookFileResource | BookFileResource | |

Return type

BookFileResource

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]