// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. package plexgo import ( "bytes" "context" "fmt" "github.com/LukeHagar/plexgo/internal/config" "github.com/LukeHagar/plexgo/internal/hooks" "github.com/LukeHagar/plexgo/internal/utils" "github.com/LukeHagar/plexgo/models/operations" "github.com/LukeHagar/plexgo/models/sdkerrors" "github.com/LukeHagar/plexgo/retry" "net/http" "net/url" ) // Log - Submit logs to the Log Handler for Plex Media Server type Log struct { rootSDK *PlexAPI sdkConfiguration config.SDKConfiguration hooks *hooks.Hooks } func newLog(rootSDK *PlexAPI, sdkConfig config.SDKConfiguration, hooks *hooks.Hooks) *Log { return &Log{ rootSDK: rootSDK, sdkConfiguration: sdkConfig, hooks: hooks, } } // LogLine - Logging a single line message. // This endpoint will write a single-line log message, including a level and source to the main Plex Media Server log. func (s *Log) LogLine(ctx context.Context, level operations.Level, message string, source string, opts ...operations.Option) (*operations.LogLineResponse, error) { request := operations.LogLineRequest{ Level: level, Message: message, Source: source, } o := operations.Options{} supportedOptions := []string{ operations.SupportedOptionRetries, operations.SupportedOptionTimeout, } for _, opt := range opts { if err := opt(&o, supportedOptions...); err != nil { return nil, fmt.Errorf("error applying option: %w", err) } } var baseURL string if o.ServerURL == nil { baseURL = utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails()) } else { baseURL = *o.ServerURL } opURL, err := url.JoinPath(baseURL, "/log") if err != nil { return nil, fmt.Errorf("error generating URL: %w", err) } hookCtx := hooks.HookContext{ SDK: s.rootSDK, SDKConfiguration: s.sdkConfiguration, BaseURL: baseURL, Context: ctx, OperationID: "logLine", OAuth2Scopes: []string{}, SecuritySource: s.sdkConfiguration.Security, } timeout := o.Timeout if timeout == nil { timeout = s.sdkConfiguration.Timeout } if timeout != nil { var cancel context.CancelFunc ctx, cancel = context.WithTimeout(ctx, *timeout) defer cancel() } req, err := http.NewRequestWithContext(ctx, "GET", opURL, nil) if err != nil { return nil, fmt.Errorf("error creating request: %w", err) } req.Header.Set("Accept", "application/json") req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent) if err := utils.PopulateQueryParams(ctx, req, request, nil); err != nil { return nil, fmt.Errorf("error populating query params: %w", err) } if err := utils.PopulateSecurity(ctx, req, s.sdkConfiguration.Security); err != nil { return nil, err } for k, v := range o.SetHeaders { req.Header.Set(k, v) } globalRetryConfig := s.sdkConfiguration.RetryConfig retryConfig := o.Retries if retryConfig == nil { if globalRetryConfig != nil { retryConfig = globalRetryConfig } } var httpRes *http.Response if retryConfig != nil { httpRes, err = utils.Retry(ctx, utils.Retries{ Config: retryConfig, StatusCodes: []string{ "429", "500", "502", "503", "504", }, }, func() (*http.Response, error) { if req.Body != nil && req.Body != http.NoBody && req.GetBody != nil { copyBody, err := req.GetBody() if err != nil { return nil, err } req.Body = copyBody } req, err = s.hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req) if err != nil { if retry.IsPermanentError(err) || retry.IsTemporaryError(err) { return nil, err } return nil, retry.Permanent(err) } httpRes, err := s.sdkConfiguration.Client.Do(req) if err != nil || httpRes == nil { if err != nil { err = fmt.Errorf("error sending request: %w", err) } else { err = fmt.Errorf("error sending request: no response") } _, err = s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err) } return httpRes, err }) if err != nil { return nil, err } else { httpRes, err = s.hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes) if err != nil { return nil, err } } } else { req, err = s.hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req) if err != nil { return nil, err } httpRes, err = s.sdkConfiguration.Client.Do(req) if err != nil || httpRes == nil { if err != nil { err = fmt.Errorf("error sending request: %w", err) } else { err = fmt.Errorf("error sending request: no response") } _, err = s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err) return nil, err } else if utils.MatchStatusCodes([]string{"400", "401", "4XX", "5XX"}, httpRes.StatusCode) { _httpRes, err := s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, httpRes, nil) if err != nil { return nil, err } else if _httpRes != nil { httpRes = _httpRes } } else { httpRes, err = s.hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes) if err != nil { return nil, err } } } res := &operations.LogLineResponse{ StatusCode: httpRes.StatusCode, ContentType: httpRes.Header.Get("Content-Type"), RawResponse: httpRes, } switch { case httpRes.StatusCode == 200: case httpRes.StatusCode == 400: switch { case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`): rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } var out sdkerrors.LogLineBadRequest if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil { return nil, err } out.RawResponse = httpRes return nil, &out default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes) } case httpRes.StatusCode == 401: switch { case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`): rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } var out sdkerrors.LogLineUnauthorized if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil { return nil, err } out.RawResponse = httpRes return nil, &out default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes) } case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes) case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes) default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes) } return res, nil } // LogMultiLine - Logging a multi-line message // This endpoint allows for the batch addition of log entries to the main Plex Media Server log. // It accepts a text/plain request body, where each line represents a distinct log entry. // Each log entry consists of URL-encoded key-value pairs, specifying log attributes such as 'level', 'message', and 'source'. // // Log entries are separated by a newline character (`\n`). // Each entry's parameters should be URL-encoded to ensure accurate parsing and handling of special characters. // This method is efficient for logging multiple entries in a single API call, reducing the overhead of multiple individual requests. // // The 'level' parameter specifies the log entry's severity or importance, with the following integer values: // - `0`: Error - Critical issues that require immediate attention. // - `1`: Warning - Important events that are not critical but may indicate potential issues. // - `2`: Info - General informational messages about system operation. // - `3`: Debug - Detailed information useful for debugging purposes. // - `4`: Verbose - Highly detailed diagnostic information for in-depth analysis. // // The 'message' parameter contains the log text, and 'source' identifies the log message's origin (e.g., an application name or module). // // Example of a single log entry format: // `level=4&message=Sample%20log%20entry&source=applicationName` // // Ensure each parameter is properly URL-encoded to avoid interpretation issues. func (s *Log) LogMultiLine(ctx context.Context, request string, opts ...operations.Option) (*operations.LogMultiLineResponse, error) { o := operations.Options{} supportedOptions := []string{ operations.SupportedOptionRetries, operations.SupportedOptionTimeout, } for _, opt := range opts { if err := opt(&o, supportedOptions...); err != nil { return nil, fmt.Errorf("error applying option: %w", err) } } var baseURL string if o.ServerURL == nil { baseURL = utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails()) } else { baseURL = *o.ServerURL } opURL, err := url.JoinPath(baseURL, "/log") if err != nil { return nil, fmt.Errorf("error generating URL: %w", err) } hookCtx := hooks.HookContext{ SDK: s.rootSDK, SDKConfiguration: s.sdkConfiguration, BaseURL: baseURL, Context: ctx, OperationID: "logMultiLine", OAuth2Scopes: []string{}, SecuritySource: s.sdkConfiguration.Security, } bodyReader, reqContentType, err := utils.SerializeRequestBody(ctx, request, false, false, "Request", "string", `request:"mediaType=text/plain"`) if err != nil { return nil, err } timeout := o.Timeout if timeout == nil { timeout = s.sdkConfiguration.Timeout } if timeout != nil { var cancel context.CancelFunc ctx, cancel = context.WithTimeout(ctx, *timeout) defer cancel() } req, err := http.NewRequestWithContext(ctx, "POST", opURL, bodyReader) if err != nil { return nil, fmt.Errorf("error creating request: %w", err) } req.Header.Set("Accept", "application/json") req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent) if reqContentType != "" { req.Header.Set("Content-Type", reqContentType) } if err := utils.PopulateSecurity(ctx, req, s.sdkConfiguration.Security); err != nil { return nil, err } for k, v := range o.SetHeaders { req.Header.Set(k, v) } globalRetryConfig := s.sdkConfiguration.RetryConfig retryConfig := o.Retries if retryConfig == nil { if globalRetryConfig != nil { retryConfig = globalRetryConfig } } var httpRes *http.Response if retryConfig != nil { httpRes, err = utils.Retry(ctx, utils.Retries{ Config: retryConfig, StatusCodes: []string{ "429", "500", "502", "503", "504", }, }, func() (*http.Response, error) { if req.Body != nil && req.Body != http.NoBody && req.GetBody != nil { copyBody, err := req.GetBody() if err != nil { return nil, err } req.Body = copyBody } req, err = s.hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req) if err != nil { if retry.IsPermanentError(err) || retry.IsTemporaryError(err) { return nil, err } return nil, retry.Permanent(err) } httpRes, err := s.sdkConfiguration.Client.Do(req) if err != nil || httpRes == nil { if err != nil { err = fmt.Errorf("error sending request: %w", err) } else { err = fmt.Errorf("error sending request: no response") } _, err = s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err) } return httpRes, err }) if err != nil { return nil, err } else { httpRes, err = s.hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes) if err != nil { return nil, err } } } else { req, err = s.hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req) if err != nil { return nil, err } httpRes, err = s.sdkConfiguration.Client.Do(req) if err != nil || httpRes == nil { if err != nil { err = fmt.Errorf("error sending request: %w", err) } else { err = fmt.Errorf("error sending request: no response") } _, err = s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err) return nil, err } else if utils.MatchStatusCodes([]string{"400", "401", "4XX", "5XX"}, httpRes.StatusCode) { _httpRes, err := s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, httpRes, nil) if err != nil { return nil, err } else if _httpRes != nil { httpRes = _httpRes } } else { httpRes, err = s.hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes) if err != nil { return nil, err } } } res := &operations.LogMultiLineResponse{ StatusCode: httpRes.StatusCode, ContentType: httpRes.Header.Get("Content-Type"), RawResponse: httpRes, } switch { case httpRes.StatusCode == 200: case httpRes.StatusCode == 400: switch { case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`): rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } var out sdkerrors.LogMultiLineBadRequest if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil { return nil, err } out.RawResponse = httpRes return nil, &out default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes) } case httpRes.StatusCode == 401: switch { case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`): rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } var out sdkerrors.LogMultiLineUnauthorized if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil { return nil, err } out.RawResponse = httpRes return nil, &out default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes) } case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes) case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes) default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes) } return res, nil } // EnablePaperTrail - Enabling Papertrail // This endpoint will enable all Plex Media Serverlogs to be sent to the Papertrail networked logging site for a period of time. func (s *Log) EnablePaperTrail(ctx context.Context, opts ...operations.Option) (*operations.EnablePaperTrailResponse, error) { o := operations.Options{} supportedOptions := []string{ operations.SupportedOptionRetries, operations.SupportedOptionTimeout, } for _, opt := range opts { if err := opt(&o, supportedOptions...); err != nil { return nil, fmt.Errorf("error applying option: %w", err) } } var baseURL string if o.ServerURL == nil { baseURL = utils.ReplaceParameters(s.sdkConfiguration.GetServerDetails()) } else { baseURL = *o.ServerURL } opURL, err := url.JoinPath(baseURL, "/log/networked") if err != nil { return nil, fmt.Errorf("error generating URL: %w", err) } hookCtx := hooks.HookContext{ SDK: s.rootSDK, SDKConfiguration: s.sdkConfiguration, BaseURL: baseURL, Context: ctx, OperationID: "enablePaperTrail", OAuth2Scopes: []string{}, SecuritySource: s.sdkConfiguration.Security, } timeout := o.Timeout if timeout == nil { timeout = s.sdkConfiguration.Timeout } if timeout != nil { var cancel context.CancelFunc ctx, cancel = context.WithTimeout(ctx, *timeout) defer cancel() } req, err := http.NewRequestWithContext(ctx, "GET", opURL, nil) if err != nil { return nil, fmt.Errorf("error creating request: %w", err) } req.Header.Set("Accept", "application/json") req.Header.Set("User-Agent", s.sdkConfiguration.UserAgent) if err := utils.PopulateSecurity(ctx, req, s.sdkConfiguration.Security); err != nil { return nil, err } for k, v := range o.SetHeaders { req.Header.Set(k, v) } globalRetryConfig := s.sdkConfiguration.RetryConfig retryConfig := o.Retries if retryConfig == nil { if globalRetryConfig != nil { retryConfig = globalRetryConfig } } var httpRes *http.Response if retryConfig != nil { httpRes, err = utils.Retry(ctx, utils.Retries{ Config: retryConfig, StatusCodes: []string{ "429", "500", "502", "503", "504", }, }, func() (*http.Response, error) { if req.Body != nil && req.Body != http.NoBody && req.GetBody != nil { copyBody, err := req.GetBody() if err != nil { return nil, err } req.Body = copyBody } req, err = s.hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req) if err != nil { if retry.IsPermanentError(err) || retry.IsTemporaryError(err) { return nil, err } return nil, retry.Permanent(err) } httpRes, err := s.sdkConfiguration.Client.Do(req) if err != nil || httpRes == nil { if err != nil { err = fmt.Errorf("error sending request: %w", err) } else { err = fmt.Errorf("error sending request: no response") } _, err = s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err) } return httpRes, err }) if err != nil { return nil, err } else { httpRes, err = s.hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes) if err != nil { return nil, err } } } else { req, err = s.hooks.BeforeRequest(hooks.BeforeRequestContext{HookContext: hookCtx}, req) if err != nil { return nil, err } httpRes, err = s.sdkConfiguration.Client.Do(req) if err != nil || httpRes == nil { if err != nil { err = fmt.Errorf("error sending request: %w", err) } else { err = fmt.Errorf("error sending request: no response") } _, err = s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, nil, err) return nil, err } else if utils.MatchStatusCodes([]string{"400", "401", "403", "4XX", "5XX"}, httpRes.StatusCode) { _httpRes, err := s.hooks.AfterError(hooks.AfterErrorContext{HookContext: hookCtx}, httpRes, nil) if err != nil { return nil, err } else if _httpRes != nil { httpRes = _httpRes } } else { httpRes, err = s.hooks.AfterSuccess(hooks.AfterSuccessContext{HookContext: hookCtx}, httpRes) if err != nil { return nil, err } } } res := &operations.EnablePaperTrailResponse{ StatusCode: httpRes.StatusCode, ContentType: httpRes.Header.Get("Content-Type"), RawResponse: httpRes, } switch { case httpRes.StatusCode == 200: case httpRes.StatusCode == 400: switch { case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`): rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } var out sdkerrors.EnablePaperTrailBadRequest if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil { return nil, err } out.RawResponse = httpRes return nil, &out default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes) } case httpRes.StatusCode == 401: switch { case utils.MatchContentType(httpRes.Header.Get("Content-Type"), `application/json`): rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } var out sdkerrors.EnablePaperTrailUnauthorized if err := utils.UnmarshalJsonFromResponseBody(bytes.NewBuffer(rawBody), &out, ""); err != nil { return nil, err } out.RawResponse = httpRes return nil, &out default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError(fmt.Sprintf("unknown content-type received: %s", httpRes.Header.Get("Content-Type")), httpRes.StatusCode, string(rawBody), httpRes) } case httpRes.StatusCode == 403: fallthrough case httpRes.StatusCode >= 400 && httpRes.StatusCode < 500: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes) case httpRes.StatusCode >= 500 && httpRes.StatusCode < 600: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("API error occurred", httpRes.StatusCode, string(rawBody), httpRes) default: rawBody, err := utils.ConsumeRawBody(httpRes) if err != nil { return nil, err } return nil, sdkerrors.NewSDKError("unknown status code returned", httpRes.StatusCode, string(rawBody), httpRes) } return res, nil }