Skip to content

Latest commit

 

History

History
1781 lines (1131 loc) · 49.2 KB

UsersAPI.md

File metadata and controls

1781 lines (1131 loc) · 49.2 KB

\UsersAPI

All URIs are relative to http://localhost:5055/api/v1

Method HTTP request Description
CreateAuthResetPassword Post /auth/reset-password Send a reset password email
CreateAuthResetPasswordByGuid Post /auth/reset-password/{guid} Reset the password for a user
CreateUser Post /user Create new user
CreateUserImportFromPlex Post /user/import-from-plex Import all users from Plex
CreateUserRegisterPushSubscription Post /user/registerPushSubscription Register a web push /user/registerPushSubscription
CreateUserSettingsMain Post /user/{userId}/settings/main Update general settings for a user
CreateUserSettingsNotifications Post /user/{userId}/settings/notifications Update notification settings for a user
CreateUserSettingsPassword Post /user/{userId}/settings/password Update password for a user
CreateUserSettingsPermissions Post /user/{userId}/settings/permissions Update permission settings for a user
DeleteUser Delete /user/{userId} Delete user by ID
DeleteUserPushSubscription Delete /user/{userId}/pushSubscription/{endpoint} Delete user push subscription by key
GetUser Get /user Get all users
GetUserByUserId Get /user/{userId} Get user by ID
GetUserPushSubscriptionByEndpoint Get /user/{userId}/pushSubscription/{endpoint} Get web push notification settings for a user
GetUserPushSubscriptions Get /user/{userId}/pushSubscriptions Get all web push notification settings for a user
GetUserQuota Get /user/{userId}/quota Get quotas for a specific user
GetUserRequests Get /user/{userId}/requests Get requests for a specific user
GetUserSettingsMain Get /user/{userId}/settings/main Get general settings for a user
GetUserSettingsNotifications Get /user/{userId}/settings/notifications Get notification settings for a user
GetUserSettingsPassword Get /user/{userId}/settings/password Get password page informatiom
GetUserSettingsPermissions Get /user/{userId}/settings/permissions Get permission settings for a user
GetUserWatchData Get /user/{userId}/watch_data Get watch data
GetUserWatchlist Get /user/{userId}/watchlist Get the Plex watchlist for a specific user
PutUser Put /user Update batch of users
UpdateUser Put /user/{userId} Update a user by user ID

CreateAuthResetPassword

CreateAuthLogout2XXResponse CreateAuthResetPassword(ctx).CreateAuthResetPasswordRequest(createAuthResetPasswordRequest).Execute()

Send a reset password email

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	createAuthResetPasswordRequest := *overseerrClient.NewCreateAuthResetPasswordRequest("Email_example") // CreateAuthResetPasswordRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createAuthResetPasswordRequest CreateAuthResetPasswordRequest

Return type

CreateAuthLogout2XXResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

CreateAuthResetPasswordByGuid

CreateAuthLogout2XXResponse CreateAuthResetPasswordByGuid(ctx, guid).CreateAuthResetPasswordByGuidRequest(createAuthResetPasswordByGuidRequest).Execute()

Reset the password for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	guid := "9afef5a7-ec89-4d5f-9397-261e96970b50" // string | 
	createAuthResetPasswordByGuidRequest := *overseerrClient.NewCreateAuthResetPasswordByGuidRequest("Password_example") // CreateAuthResetPasswordByGuidRequest | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.CreateAuthResetPasswordByGuid(context.Background(), guid).CreateAuthResetPasswordByGuidRequest(createAuthResetPasswordByGuidRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.CreateAuthResetPasswordByGuid``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateAuthResetPasswordByGuid`: CreateAuthLogout2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.CreateAuthResetPasswordByGuid`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
guid string

Other Parameters

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

Name Type Description Notes

createAuthResetPasswordByGuidRequest | CreateAuthResetPasswordByGuidRequest | |

Return type

CreateAuthLogout2XXResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

CreateUser

User CreateUser(ctx).CreateUserRequest(createUserRequest).Execute()

Create new user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	createUserRequest := *overseerrClient.NewCreateUserRequest() // CreateUserRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createUserRequest CreateUserRequest

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

CreateUserImportFromPlex

[]User CreateUserImportFromPlex(ctx).CreateUserImportFromPlexRequest(createUserImportFromPlexRequest).Execute()

Import all users from Plex

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	createUserImportFromPlexRequest := *overseerrClient.NewCreateUserImportFromPlexRequest() // CreateUserImportFromPlexRequest |  (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
createUserImportFromPlexRequest CreateUserImportFromPlexRequest

Return type

[]User

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

CreateUserRegisterPushSubscription

CreateUserRegisterPushSubscription(ctx).CreateUserRegisterPushSubscriptionRequest(createUserRegisterPushSubscriptionRequest).Execute()

Register a web push /user/registerPushSubscription

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	createUserRegisterPushSubscriptionRequest := *overseerrClient.NewCreateUserRegisterPushSubscriptionRequest("Endpoint_example", "Auth_example", "P256dh_example") // CreateUserRegisterPushSubscriptionRequest | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	r, err := apiClient.UsersAPI.CreateUserRegisterPushSubscription(context.Background()).CreateUserRegisterPushSubscriptionRequest(createUserRegisterPushSubscriptionRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.CreateUserRegisterPushSubscription``: %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 apiCreateUserRegisterPushSubscriptionRequest struct via the builder pattern

Name Type Description Notes
createUserRegisterPushSubscriptionRequest CreateUserRegisterPushSubscriptionRequest

Return type

(empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

CreateUserSettingsMain

GetUserSettingsMain2XXResponse CreateUserSettingsMain(ctx, userId).CreateUserSettingsMainRequest(createUserSettingsMainRequest).Execute()

Update general settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	createUserSettingsMainRequest := *overseerrClient.NewCreateUserSettingsMainRequest() // CreateUserSettingsMainRequest | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.CreateUserSettingsMain(context.Background(), userId).CreateUserSettingsMainRequest(createUserSettingsMainRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.CreateUserSettingsMain``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateUserSettingsMain`: GetUserSettingsMain2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.CreateUserSettingsMain`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

createUserSettingsMainRequest | CreateUserSettingsMainRequest | |

Return type

GetUserSettingsMain2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

CreateUserSettingsNotifications

UserSettingsNotifications CreateUserSettingsNotifications(ctx, userId).UserSettingsNotifications(userSettingsNotifications).Execute()

Update notification settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	userSettingsNotifications := *overseerrClient.NewUserSettingsNotifications() // UserSettingsNotifications | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

userSettingsNotifications | UserSettingsNotifications | |

Return type

UserSettingsNotifications

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

CreateUserSettingsPassword

CreateUserSettingsPassword(ctx, userId).CreateUserSettingsPasswordRequest(createUserSettingsPasswordRequest).Execute()

Update password for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	createUserSettingsPasswordRequest := *overseerrClient.NewCreateUserSettingsPasswordRequest("NewPassword_example") // CreateUserSettingsPasswordRequest | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	r, err := apiClient.UsersAPI.CreateUserSettingsPassword(context.Background(), userId).CreateUserSettingsPasswordRequest(createUserSettingsPasswordRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.CreateUserSettingsPassword``: %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.
userId float32

Other Parameters

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

Name Type Description Notes

createUserSettingsPasswordRequest | CreateUserSettingsPasswordRequest | |

Return type

(empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

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

CreateUserSettingsPermissions

GetUserSettingsPermissions2XXResponse CreateUserSettingsPermissions(ctx, userId).CreateUserSettingsPermissionsRequest(createUserSettingsPermissionsRequest).Execute()

Update permission settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	createUserSettingsPermissionsRequest := *overseerrClient.NewCreateUserSettingsPermissionsRequest(float32(123)) // CreateUserSettingsPermissionsRequest | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.CreateUserSettingsPermissions(context.Background(), userId).CreateUserSettingsPermissionsRequest(createUserSettingsPermissionsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.CreateUserSettingsPermissions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateUserSettingsPermissions`: GetUserSettingsPermissions2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.CreateUserSettingsPermissions`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

createUserSettingsPermissionsRequest | CreateUserSettingsPermissionsRequest | |

Return type

GetUserSettingsPermissions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

DeleteUser

User DeleteUser(ctx, userId).Execute()

Delete user by ID

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DeleteUserPushSubscription

DeleteUserPushSubscription(ctx, userId, endpoint).Execute()

Delete user push subscription by key

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	endpoint := "endpoint_example" // string | 

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	r, err := apiClient.UsersAPI.DeleteUserPushSubscription(context.Background(), userId, endpoint).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.DeleteUserPushSubscription``: %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.
userId float32
endpoint string

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetUser

GetUser2XXResponse GetUser(ctx).Take(take).Skip(skip).Sort(sort).Execute()

Get all users

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	take := float32(20) // float32 |  (optional)
	skip := float32(0) // float32 |  (optional)
	sort := "sort_example" // string |  (optional) (default to "created")

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUser(context.Background()).Take(take).Skip(skip).Sort(sort).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUser``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUser`: GetUser2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUser`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
take float32
skip float32
sort string [default to "created"]

Return type

GetUser2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserByUserId

User GetUserByUserId(ctx, userId).Execute()

Get user by ID

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserPushSubscriptionByEndpoint

GetUserPushSubscriptions2XXResponse GetUserPushSubscriptionByEndpoint(ctx, userId, endpoint).Execute()

Get web push notification settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	endpoint := "endpoint_example" // string | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32
endpoint string

Other Parameters

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

Name Type Description Notes

Return type

GetUserPushSubscriptions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserPushSubscriptions

GetUserPushSubscriptions2XXResponse GetUserPushSubscriptions(ctx, userId).Execute()

Get all web push notification settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

GetUserPushSubscriptions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserQuota

GetUserQuota2XXResponse GetUserQuota(ctx, userId).Execute()

Get quotas for a specific user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

GetUserQuota2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserRequests

GetUserRequests2XXResponse GetUserRequests(ctx, userId).Take(take).Skip(skip).Execute()

Get requests for a specific user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	take := float32(20) // float32 |  (optional)
	skip := float32(0) // float32 |  (optional)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUserRequests(context.Background(), userId).Take(take).Skip(skip).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUserRequests``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUserRequests`: GetUserRequests2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUserRequests`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

take | float32 | | skip | float32 | |

Return type

GetUserRequests2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserSettingsMain

GetUserSettingsMain2XXResponse GetUserSettingsMain(ctx, userId).Execute()

Get general settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

GetUserSettingsMain2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserSettingsNotifications

UserSettingsNotifications GetUserSettingsNotifications(ctx, userId).Execute()

Get notification settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

UserSettingsNotifications

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserSettingsPassword

GetUserSettingsPassword2XXResponse GetUserSettingsPassword(ctx, userId).Execute()

Get password page informatiom

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

GetUserSettingsPassword2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserSettingsPermissions

GetUserSettingsPermissions2XXResponse GetUserSettingsPermissions(ctx, userId).Execute()

Get permission settings for a user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

GetUserSettingsPermissions2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserWatchData

GetUserWatchData2XXResponse GetUserWatchData(ctx, userId).Execute()

Get watch data

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

Return type

GetUserWatchData2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetUserWatchlist

GetUserWatchlist2XXResponse GetUserWatchlist(ctx, userId).Page(page).Execute()

Get the Plex watchlist for a specific user

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	page := float32(1) // float32 |  (optional) (default to 1)

	configuration := overseerrClient.NewConfiguration()
	apiClient := overseerrClient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUserWatchlist(context.Background(), userId).Page(page).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUserWatchlist``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUserWatchlist`: GetUserWatchlist2XXResponse
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUserWatchlist`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

page | float32 | | [default to 1]

Return type

GetUserWatchlist2XXResponse

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

PutUser

[]User PutUser(ctx).PutUserRequest(putUserRequest).Execute()

Update batch of users

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	putUserRequest := *overseerrClient.NewPutUserRequest() // PutUserRequest | 

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

Path Parameters

Other Parameters

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

Name Type Description Notes
putUserRequest PutUserRequest

Return type

[]User

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

UpdateUser

User UpdateUser(ctx, userId).User(user).Execute()

Update a user by user ID

Example

package main

import (
	"context"
	"fmt"
	"os"
	overseerrClient "github.com/devopsarr/overseerr-go/overseerr"
)

func main() {
	userId := float32(8.14) // float32 | 
	user := *overseerrClient.NewUser(int32(1), "hey@itsme.com", "2020-09-02T05:02:23.000Z", "2020-09-02T05:02:23.000Z") // User | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId float32

Other Parameters

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

Name Type Description Notes

user | User | |

Return type

User

Authorization

apiKey, cookieAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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