tsarr 2.6.0 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -3
- package/dist/cli/commands/config.d.ts.map +1 -1
- package/dist/cli/commands/doctor.d.ts.map +1 -1
- package/dist/cli/commands/seerr.d.ts +4 -0
- package/dist/cli/commands/seerr.d.ts.map +1 -0
- package/dist/cli/completions.d.ts.map +1 -1
- package/dist/cli/config.d.ts +1 -1
- package/dist/cli/config.d.ts.map +1 -1
- package/dist/cli/index.js +1164 -56
- package/dist/clients/seerr-types.d.ts +2 -0
- package/dist/clients/seerr-types.d.ts.map +1 -0
- package/dist/clients/seerr.d.ts +158 -0
- package/dist/clients/seerr.d.ts.map +1 -0
- package/dist/clients/seerr.js +1009 -0
- package/dist/generated/seerr/client/client.gen.d.ts +3 -0
- package/dist/generated/seerr/client/client.gen.d.ts.map +1 -0
- package/dist/generated/seerr/client/index.d.ts +9 -0
- package/dist/generated/seerr/client/index.d.ts.map +1 -0
- package/dist/generated/seerr/client/types.gen.d.ts +118 -0
- package/dist/generated/seerr/client/types.gen.d.ts.map +1 -0
- package/dist/generated/seerr/client/utils.gen.d.ts +34 -0
- package/dist/generated/seerr/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/seerr/client.gen.d.ts +13 -0
- package/dist/generated/seerr/client.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/auth.gen.d.ts +19 -0
- package/dist/generated/seerr/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/bodySerializer.gen.d.ts +26 -0
- package/dist/generated/seerr/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/params.gen.d.ts +44 -0
- package/dist/generated/seerr/core/params.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated/seerr/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/generated/seerr/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated/seerr/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/types.gen.d.ts +79 -0
- package/dist/generated/seerr/core/types.gen.d.ts.map +1 -0
- package/dist/generated/seerr/core/utils.gen.d.ts +20 -0
- package/dist/generated/seerr/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/seerr/index.d.ts +3 -0
- package/dist/generated/seerr/index.d.ts.map +1 -0
- package/dist/generated/seerr/sdk.gen.d.ts +1309 -0
- package/dist/generated/seerr/sdk.gen.d.ts.map +1 -0
- package/dist/generated/seerr/types.gen.d.ts +4867 -0
- package/dist/generated/seerr/types.gen.d.ts.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +41 -36
- package/dist/tsarr-2.7.0.tgz +0 -0
- package/package.json +12 -2
- package/dist/tsarr-2.6.0.tgz +0 -0
|
@@ -0,0 +1,1309 @@
|
|
|
1
|
+
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
+
import type { DeleteBlacklistByTmdbIdData, DeleteBlacklistByTmdbIdResponses, DeleteBlocklistByTmdbIdData, DeleteBlocklistByTmdbIdResponses, DeleteIssueByIssueIdData, DeleteIssueByIssueIdResponses, DeleteIssueCommentByCommentIdData, DeleteIssueCommentByCommentIdResponses, DeleteMediaByMediaIdData, DeleteMediaByMediaIdFileData, DeleteMediaByMediaIdFileResponses, DeleteMediaByMediaIdResponses, DeleteOverrideRuleByRuleIdData, DeleteOverrideRuleByRuleIdResponses, DeleteRequestByRequestIdData, DeleteRequestByRequestIdResponses, DeleteSettingsDiscoverBySliderIdData, DeleteSettingsDiscoverBySliderIdResponses, DeleteSettingsRadarrByRadarrIdData, DeleteSettingsRadarrByRadarrIdResponses, DeleteSettingsSonarrBySonarrIdData, DeleteSettingsSonarrBySonarrIdResponses, DeleteUserByUserIdData, DeleteUserByUserIdPushSubscriptionByEndpointData, DeleteUserByUserIdPushSubscriptionByEndpointResponses, DeleteUserByUserIdResponses, DeleteUserByUserIdSettingsLinkedAccountsJellyfinData, DeleteUserByUserIdSettingsLinkedAccountsJellyfinErrors, DeleteUserByUserIdSettingsLinkedAccountsJellyfinResponses, DeleteUserByUserIdSettingsLinkedAccountsPlexData, DeleteUserByUserIdSettingsLinkedAccountsPlexErrors, DeleteUserByUserIdSettingsLinkedAccountsPlexResponses, DeleteWatchlistByTmdbIdData, DeleteWatchlistByTmdbIdResponses, GetAuthMeData, GetAuthMeResponses, GetBackdropsData, GetBackdropsResponses, GetBlacklistByTmdbIdData, GetBlacklistByTmdbIdResponses, GetBlacklistData, GetBlacklistResponses, GetBlocklistByTmdbIdData, GetBlocklistByTmdbIdResponses, GetBlocklistData, GetBlocklistResponses, GetCertificationsMovieData, GetCertificationsMovieErrors, GetCertificationsMovieResponses, GetCertificationsTvData, GetCertificationsTvErrors, GetCertificationsTvResponses, GetCollectionByCollectionIdData, GetCollectionByCollectionIdResponses, GetDiscoverGenresliderMovieData, GetDiscoverGenresliderMovieResponses, GetDiscoverGenresliderTvData, GetDiscoverGenresliderTvResponses, GetDiscoverKeywordByKeywordIdMoviesData, GetDiscoverKeywordByKeywordIdMoviesResponses, GetDiscoverMoviesData, GetDiscoverMoviesGenreByGenreIdData, GetDiscoverMoviesGenreByGenreIdResponses, GetDiscoverMoviesLanguageByLanguageData, GetDiscoverMoviesLanguageByLanguageResponses, GetDiscoverMoviesResponses, GetDiscoverMoviesStudioByStudioIdData, GetDiscoverMoviesStudioByStudioIdResponses, GetDiscoverMoviesUpcomingData, GetDiscoverMoviesUpcomingResponses, GetDiscoverTrendingData, GetDiscoverTrendingResponses, GetDiscoverTvData, GetDiscoverTvGenreByGenreIdData, GetDiscoverTvGenreByGenreIdResponses, GetDiscoverTvLanguageByLanguageData, GetDiscoverTvLanguageByLanguageResponses, GetDiscoverTvNetworkByNetworkIdData, GetDiscoverTvNetworkByNetworkIdResponses, GetDiscoverTvResponses, GetDiscoverTvUpcomingData, GetDiscoverTvUpcomingResponses, GetDiscoverWatchlistData, GetDiscoverWatchlistResponses, GetGenresMovieData, GetGenresMovieResponses, GetGenresTvData, GetGenresTvResponses, GetIssueByIssueIdData, GetIssueByIssueIdResponses, GetIssueCommentByCommentIdData, GetIssueCommentByCommentIdResponses, GetIssueCountData, GetIssueCountResponses, GetIssueData, GetIssueResponses, GetKeywordByKeywordIdData, GetKeywordByKeywordIdErrors, GetKeywordByKeywordIdResponses, GetLanguagesData, GetLanguagesResponses, GetMediaByMediaIdWatchDataData, GetMediaByMediaIdWatchDataResponses, GetMediaData, GetMediaResponses, GetMovieByMovieIdData, GetMovieByMovieIdRatingscombinedData, GetMovieByMovieIdRatingscombinedResponses, GetMovieByMovieIdRatingsData, GetMovieByMovieIdRatingsResponses, GetMovieByMovieIdRecommendationsData, GetMovieByMovieIdRecommendationsResponses, GetMovieByMovieIdResponses, GetMovieByMovieIdSimilarData, GetMovieByMovieIdSimilarResponses, GetNetworkByNetworkIdData, GetNetworkByNetworkIdResponses, GetOverrideRuleData, GetOverrideRuleResponses, GetPersonByPersonIdCombinedCreditsData, GetPersonByPersonIdCombinedCreditsResponses, GetPersonByPersonIdData, GetPersonByPersonIdResponses, GetRegionsData, GetRegionsResponses, GetRequestByRequestIdData, GetRequestByRequestIdResponses, GetRequestCountData, GetRequestCountResponses, GetRequestData, GetRequestResponses, GetSearchCompanyData, GetSearchCompanyResponses, GetSearchData, GetSearchKeywordData, GetSearchKeywordResponses, GetSearchResponses, GetServiceRadarrByRadarrIdData, GetServiceRadarrByRadarrIdResponses, GetServiceRadarrData, GetServiceRadarrResponses, GetServiceSonarrBySonarrIdData, GetServiceSonarrBySonarrIdResponses, GetServiceSonarrData, GetServiceSonarrLookupByTmdbIdData, GetServiceSonarrLookupByTmdbIdResponses, GetServiceSonarrResponses, GetSettingsAboutData, GetSettingsAboutResponses, GetSettingsCacheData, GetSettingsCacheResponses, GetSettingsDiscoverData, GetSettingsDiscoverResetData, GetSettingsDiscoverResetResponses, GetSettingsDiscoverResponses, GetSettingsJellyfinData, GetSettingsJellyfinLibraryData, GetSettingsJellyfinLibraryResponses, GetSettingsJellyfinResponses, GetSettingsJellyfinSyncData, GetSettingsJellyfinSyncResponses, GetSettingsJellyfinUsersData, GetSettingsJellyfinUsersResponses, GetSettingsJobsData, GetSettingsJobsResponses, GetSettingsLogsData, GetSettingsLogsResponses, GetSettingsMainData, GetSettingsMainResponses, GetSettingsMetadatasData, GetSettingsMetadatasResponses, GetSettingsNetworkData, GetSettingsNetworkResponses, GetSettingsNotificationsDiscordData, GetSettingsNotificationsDiscordResponses, GetSettingsNotificationsEmailData, GetSettingsNotificationsEmailResponses, GetSettingsNotificationsGotifyData, GetSettingsNotificationsGotifyResponses, GetSettingsNotificationsNtfyData, GetSettingsNotificationsNtfyResponses, GetSettingsNotificationsPushbulletData, GetSettingsNotificationsPushbulletResponses, GetSettingsNotificationsPushoverData, GetSettingsNotificationsPushoverResponses, GetSettingsNotificationsPushoverSoundsData, GetSettingsNotificationsPushoverSoundsResponses, GetSettingsNotificationsSlackData, GetSettingsNotificationsSlackResponses, GetSettingsNotificationsTelegramData, GetSettingsNotificationsTelegramResponses, GetSettingsNotificationsWebhookData, GetSettingsNotificationsWebhookResponses, GetSettingsNotificationsWebpushData, GetSettingsNotificationsWebpushResponses, GetSettingsPlexData, GetSettingsPlexDevicesServersData, GetSettingsPlexDevicesServersResponses, GetSettingsPlexLibraryData, GetSettingsPlexLibraryResponses, GetSettingsPlexResponses, GetSettingsPlexSyncData, GetSettingsPlexSyncResponses, GetSettingsPlexUsersData, GetSettingsPlexUsersResponses, GetSettingsPublicData, GetSettingsPublicResponses, GetSettingsRadarrByRadarrIdProfilesData, GetSettingsRadarrByRadarrIdProfilesResponses, GetSettingsRadarrData, GetSettingsRadarrResponses, GetSettingsSonarrData, GetSettingsSonarrResponses, GetSettingsTautulliData, GetSettingsTautulliResponses, GetStatusAppdataData, GetStatusAppdataResponses, GetStatusData, GetStatusResponses, GetStudioByStudioIdData, GetStudioByStudioIdResponses, GetTvByTvIdData, GetTvByTvIdRatingsData, GetTvByTvIdRatingsResponses, GetTvByTvIdRecommendationsData, GetTvByTvIdRecommendationsResponses, GetTvByTvIdResponses, GetTvByTvIdSeasonBySeasonNumberData, GetTvByTvIdSeasonBySeasonNumberResponses, GetTvByTvIdSimilarData, GetTvByTvIdSimilarResponses, GetUserByUserIdData, GetUserByUserIdPushSubscriptionByEndpointData, GetUserByUserIdPushSubscriptionByEndpointResponses, GetUserByUserIdPushSubscriptionsData, GetUserByUserIdPushSubscriptionsResponses, GetUserByUserIdQuotaData, GetUserByUserIdQuotaResponses, GetUserByUserIdRequestsData, GetUserByUserIdRequestsResponses, GetUserByUserIdResponses, GetUserByUserIdSettingsMainData, GetUserByUserIdSettingsMainResponses, GetUserByUserIdSettingsNotificationsData, GetUserByUserIdSettingsNotificationsResponses, GetUserByUserIdSettingsPasswordData, GetUserByUserIdSettingsPasswordResponses, GetUserByUserIdSettingsPermissionsData, GetUserByUserIdSettingsPermissionsResponses, GetUserByUserIdWatchDataData, GetUserByUserIdWatchDataResponses, GetUserByUserIdWatchlistData, GetUserByUserIdWatchlistResponses, GetUserData, GetUserResponses, GetWatchprovidersMoviesData, GetWatchprovidersMoviesResponses, GetWatchprovidersRegionsData, GetWatchprovidersRegionsResponses, GetWatchprovidersTvData, GetWatchprovidersTvResponses, PostAuthJellyfinData, PostAuthJellyfinResponses, PostAuthLocalData, PostAuthLocalResponses, PostAuthLogoutData, PostAuthLogoutResponses, PostAuthPlexData, PostAuthPlexResponses, PostAuthResetPasswordByGuidData, PostAuthResetPasswordByGuidResponses, PostAuthResetPasswordData, PostAuthResetPasswordResponses, PostBlacklistData, PostBlacklistErrors, PostBlacklistResponses, PostBlocklistData, PostBlocklistErrors, PostBlocklistResponses, PostIssueByIssueIdByStatusData, PostIssueByIssueIdByStatusResponses, PostIssueByIssueIdCommentData, PostIssueByIssueIdCommentResponses, PostIssueData, PostIssueResponses, PostMediaByMediaIdByStatusData, PostMediaByMediaIdByStatusResponses, PostOverrideRuleData, PostOverrideRuleResponses, PostRequestByRequestIdByStatusData, PostRequestByRequestIdByStatusResponses, PostRequestByRequestIdRetryData, PostRequestByRequestIdRetryResponses, PostRequestData, PostRequestResponses, PostSettingsCacheByCacheIdFlushData, PostSettingsCacheByCacheIdFlushResponses, PostSettingsCacheDnsByDnsEntryFlushData, PostSettingsCacheDnsByDnsEntryFlushResponses, PostSettingsDiscoverAddData, PostSettingsDiscoverAddResponses, PostSettingsDiscoverData, PostSettingsDiscoverResponses, PostSettingsInitializeData, PostSettingsInitializeResponses, PostSettingsJellyfinData, PostSettingsJellyfinResponses, PostSettingsJellyfinSyncData, PostSettingsJellyfinSyncResponses, PostSettingsJobsByJobIdCancelData, PostSettingsJobsByJobIdCancelResponses, PostSettingsJobsByJobIdRunData, PostSettingsJobsByJobIdRunResponses, PostSettingsJobsByJobIdScheduleData, PostSettingsJobsByJobIdScheduleResponses, PostSettingsMainData, PostSettingsMainRegenerateData, PostSettingsMainRegenerateResponses, PostSettingsMainResponses, PostSettingsMetadatasTestData, PostSettingsMetadatasTestResponses, PostSettingsNetworkData, PostSettingsNetworkResponses, PostSettingsNotificationsDiscordData, PostSettingsNotificationsDiscordResponses, PostSettingsNotificationsDiscordTestData, PostSettingsNotificationsDiscordTestResponses, PostSettingsNotificationsEmailData, PostSettingsNotificationsEmailResponses, PostSettingsNotificationsEmailTestData, PostSettingsNotificationsEmailTestResponses, PostSettingsNotificationsGotifyData, PostSettingsNotificationsGotifyResponses, PostSettingsNotificationsGotifyTestData, PostSettingsNotificationsGotifyTestResponses, PostSettingsNotificationsNtfyData, PostSettingsNotificationsNtfyResponses, PostSettingsNotificationsNtfyTestData, PostSettingsNotificationsNtfyTestResponses, PostSettingsNotificationsPushbulletData, PostSettingsNotificationsPushbulletResponses, PostSettingsNotificationsPushbulletTestData, PostSettingsNotificationsPushbulletTestResponses, PostSettingsNotificationsPushoverData, PostSettingsNotificationsPushoverResponses, PostSettingsNotificationsPushoverTestData, PostSettingsNotificationsPushoverTestResponses, PostSettingsNotificationsSlackData, PostSettingsNotificationsSlackResponses, PostSettingsNotificationsSlackTestData, PostSettingsNotificationsSlackTestResponses, PostSettingsNotificationsTelegramData, PostSettingsNotificationsTelegramResponses, PostSettingsNotificationsTelegramTestData, PostSettingsNotificationsTelegramTestResponses, PostSettingsNotificationsWebhookData, PostSettingsNotificationsWebhookResponses, PostSettingsNotificationsWebhookTestData, PostSettingsNotificationsWebhookTestResponses, PostSettingsNotificationsWebpushData, PostSettingsNotificationsWebpushResponses, PostSettingsNotificationsWebpushTestData, PostSettingsNotificationsWebpushTestResponses, PostSettingsPlexData, PostSettingsPlexResponses, PostSettingsPlexSyncData, PostSettingsPlexSyncResponses, PostSettingsRadarrData, PostSettingsRadarrResponses, PostSettingsRadarrTestData, PostSettingsRadarrTestResponses, PostSettingsSonarrData, PostSettingsSonarrResponses, PostSettingsSonarrTestData, PostSettingsSonarrTestResponses, PostSettingsTautulliData, PostSettingsTautulliResponses, PostUserByUserIdSettingsLinkedAccountsJellyfinData, PostUserByUserIdSettingsLinkedAccountsJellyfinErrors, PostUserByUserIdSettingsLinkedAccountsJellyfinResponses, PostUserByUserIdSettingsLinkedAccountsPlexData, PostUserByUserIdSettingsLinkedAccountsPlexErrors, PostUserByUserIdSettingsLinkedAccountsPlexResponses, PostUserByUserIdSettingsMainData, PostUserByUserIdSettingsMainResponses, PostUserByUserIdSettingsNotificationsData, PostUserByUserIdSettingsNotificationsResponses, PostUserByUserIdSettingsPasswordData, PostUserByUserIdSettingsPasswordResponses, PostUserByUserIdSettingsPermissionsData, PostUserByUserIdSettingsPermissionsResponses, PostUserData, PostUserImportFromJellyfinData, PostUserImportFromJellyfinResponses, PostUserImportFromPlexData, PostUserImportFromPlexResponses, PostUserRegisterPushSubscriptionData, PostUserRegisterPushSubscriptionResponses, PostUserResponses, PostWatchlistData, PostWatchlistResponses, PutIssueCommentByCommentIdData, PutIssueCommentByCommentIdResponses, PutOverrideRuleByRuleIdData, PutOverrideRuleByRuleIdResponses, PutRequestByRequestIdData, PutRequestByRequestIdResponses, PutSettingsDiscoverBySliderIdData, PutSettingsDiscoverBySliderIdResponses, PutSettingsMetadatasData, PutSettingsMetadatasResponses, PutSettingsRadarrByRadarrIdData, PutSettingsRadarrByRadarrIdResponses, PutSettingsSonarrBySonarrIdData, PutSettingsSonarrBySonarrIdResponses, PutUserByUserIdData, PutUserByUserIdResponses, PutUserData, PutUserResponses } from './types.gen';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Get Seerr status
|
|
18
|
+
*
|
|
19
|
+
* Returns the current Seerr status in a JSON object.
|
|
20
|
+
*/
|
|
21
|
+
export declare const getStatus: <ThrowOnError extends boolean = false>(options?: Options<GetStatusData, ThrowOnError>) => import("./client").RequestResult<GetStatusResponses, unknown, ThrowOnError, "fields">;
|
|
22
|
+
/**
|
|
23
|
+
* Get application data volume status
|
|
24
|
+
*
|
|
25
|
+
* For Docker installs, returns whether or not the volume mount was configured properly. Always returns true for non-Docker installs.
|
|
26
|
+
*/
|
|
27
|
+
export declare const getStatusAppdata: <ThrowOnError extends boolean = false>(options?: Options<GetStatusAppdataData, ThrowOnError>) => import("./client").RequestResult<GetStatusAppdataResponses, unknown, ThrowOnError, "fields">;
|
|
28
|
+
/**
|
|
29
|
+
* Get main settings
|
|
30
|
+
*
|
|
31
|
+
* Retrieves all main settings in a JSON object.
|
|
32
|
+
*/
|
|
33
|
+
export declare const getSettingsMain: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsMainData, ThrowOnError>) => import("./client").RequestResult<GetSettingsMainResponses, unknown, ThrowOnError, "fields">;
|
|
34
|
+
/**
|
|
35
|
+
* Update main settings
|
|
36
|
+
*
|
|
37
|
+
* Updates main settings with the provided values.
|
|
38
|
+
*/
|
|
39
|
+
export declare const postSettingsMain: <ThrowOnError extends boolean = false>(options: Options<PostSettingsMainData, ThrowOnError>) => import("./client").RequestResult<PostSettingsMainResponses, unknown, ThrowOnError, "fields">;
|
|
40
|
+
/**
|
|
41
|
+
* Get network settings
|
|
42
|
+
*
|
|
43
|
+
* Retrieves all network settings in a JSON object.
|
|
44
|
+
*/
|
|
45
|
+
export declare const getSettingsNetwork: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNetworkData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNetworkResponses, unknown, ThrowOnError, "fields">;
|
|
46
|
+
/**
|
|
47
|
+
* Update network settings
|
|
48
|
+
*
|
|
49
|
+
* Updates network settings with the provided values.
|
|
50
|
+
*/
|
|
51
|
+
export declare const postSettingsNetwork: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNetworkData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNetworkResponses, unknown, ThrowOnError, "fields">;
|
|
52
|
+
/**
|
|
53
|
+
* Get main settings with newly-generated API key
|
|
54
|
+
*
|
|
55
|
+
* Returns main settings in a JSON object, using the new API key.
|
|
56
|
+
*/
|
|
57
|
+
export declare const postSettingsMainRegenerate: <ThrowOnError extends boolean = false>(options?: Options<PostSettingsMainRegenerateData, ThrowOnError>) => import("./client").RequestResult<PostSettingsMainRegenerateResponses, unknown, ThrowOnError, "fields">;
|
|
58
|
+
/**
|
|
59
|
+
* Get Jellyfin settings
|
|
60
|
+
*
|
|
61
|
+
* Retrieves current Jellyfin settings.
|
|
62
|
+
*/
|
|
63
|
+
export declare const getSettingsJellyfin: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsJellyfinData, ThrowOnError>) => import("./client").RequestResult<GetSettingsJellyfinResponses, unknown, ThrowOnError, "fields">;
|
|
64
|
+
/**
|
|
65
|
+
* Update Jellyfin settings
|
|
66
|
+
*
|
|
67
|
+
* Updates Jellyfin settings with the provided values.
|
|
68
|
+
*/
|
|
69
|
+
export declare const postSettingsJellyfin: <ThrowOnError extends boolean = false>(options: Options<PostSettingsJellyfinData, ThrowOnError>) => import("./client").RequestResult<PostSettingsJellyfinResponses, unknown, ThrowOnError, "fields">;
|
|
70
|
+
/**
|
|
71
|
+
* Get Jellyfin libraries
|
|
72
|
+
*
|
|
73
|
+
* Returns a list of Jellyfin libraries in a JSON array.
|
|
74
|
+
*/
|
|
75
|
+
export declare const getSettingsJellyfinLibrary: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsJellyfinLibraryData, ThrowOnError>) => import("./client").RequestResult<GetSettingsJellyfinLibraryResponses, unknown, ThrowOnError, "fields">;
|
|
76
|
+
/**
|
|
77
|
+
* Get Jellyfin Users
|
|
78
|
+
*
|
|
79
|
+
* Returns a list of Jellyfin Users in a JSON array.
|
|
80
|
+
*/
|
|
81
|
+
export declare const getSettingsJellyfinUsers: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsJellyfinUsersData, ThrowOnError>) => import("./client").RequestResult<GetSettingsJellyfinUsersResponses, unknown, ThrowOnError, "fields">;
|
|
82
|
+
/**
|
|
83
|
+
* Get status of full Jellyfin library sync
|
|
84
|
+
*
|
|
85
|
+
* Returns sync progress in a JSON array.
|
|
86
|
+
*/
|
|
87
|
+
export declare const getSettingsJellyfinSync: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsJellyfinSyncData, ThrowOnError>) => import("./client").RequestResult<GetSettingsJellyfinSyncResponses, unknown, ThrowOnError, "fields">;
|
|
88
|
+
/**
|
|
89
|
+
* Start full Jellyfin library sync
|
|
90
|
+
*
|
|
91
|
+
* Runs a full Jellyfin library sync and returns the progress in a JSON array.
|
|
92
|
+
*/
|
|
93
|
+
export declare const postSettingsJellyfinSync: <ThrowOnError extends boolean = false>(options?: Options<PostSettingsJellyfinSyncData, ThrowOnError>) => import("./client").RequestResult<PostSettingsJellyfinSyncResponses, unknown, ThrowOnError, "fields">;
|
|
94
|
+
/**
|
|
95
|
+
* Get Plex settings
|
|
96
|
+
*
|
|
97
|
+
* Retrieves current Plex settings.
|
|
98
|
+
*/
|
|
99
|
+
export declare const getSettingsPlex: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsPlexData, ThrowOnError>) => import("./client").RequestResult<GetSettingsPlexResponses, unknown, ThrowOnError, "fields">;
|
|
100
|
+
/**
|
|
101
|
+
* Update Plex settings
|
|
102
|
+
*
|
|
103
|
+
* Updates Plex settings with the provided values.
|
|
104
|
+
*/
|
|
105
|
+
export declare const postSettingsPlex: <ThrowOnError extends boolean = false>(options: Options<PostSettingsPlexData, ThrowOnError>) => import("./client").RequestResult<PostSettingsPlexResponses, unknown, ThrowOnError, "fields">;
|
|
106
|
+
/**
|
|
107
|
+
* Get Plex libraries
|
|
108
|
+
*
|
|
109
|
+
* Returns a list of Plex libraries in a JSON array.
|
|
110
|
+
*/
|
|
111
|
+
export declare const getSettingsPlexLibrary: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsPlexLibraryData, ThrowOnError>) => import("./client").RequestResult<GetSettingsPlexLibraryResponses, unknown, ThrowOnError, "fields">;
|
|
112
|
+
/**
|
|
113
|
+
* Get status of full Plex library scan
|
|
114
|
+
*
|
|
115
|
+
* Returns scan progress in a JSON array.
|
|
116
|
+
*/
|
|
117
|
+
export declare const getSettingsPlexSync: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsPlexSyncData, ThrowOnError>) => import("./client").RequestResult<GetSettingsPlexSyncResponses, unknown, ThrowOnError, "fields">;
|
|
118
|
+
/**
|
|
119
|
+
* Start full Plex library scan
|
|
120
|
+
*
|
|
121
|
+
* Runs a full Plex library scan and returns the progress in a JSON array.
|
|
122
|
+
*/
|
|
123
|
+
export declare const postSettingsPlexSync: <ThrowOnError extends boolean = false>(options?: Options<PostSettingsPlexSyncData, ThrowOnError>) => import("./client").RequestResult<PostSettingsPlexSyncResponses, unknown, ThrowOnError, "fields">;
|
|
124
|
+
/**
|
|
125
|
+
* Gets the user's available Plex servers
|
|
126
|
+
*
|
|
127
|
+
* Returns a list of available Plex servers and their connectivity state
|
|
128
|
+
*/
|
|
129
|
+
export declare const getSettingsPlexDevicesServers: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsPlexDevicesServersData, ThrowOnError>) => import("./client").RequestResult<GetSettingsPlexDevicesServersResponses, unknown, ThrowOnError, "fields">;
|
|
130
|
+
/**
|
|
131
|
+
* Get Plex users
|
|
132
|
+
*
|
|
133
|
+
* Returns a list of Plex users in a JSON array.
|
|
134
|
+
*
|
|
135
|
+
* Requires the `MANAGE_USERS` permission.
|
|
136
|
+
*
|
|
137
|
+
*/
|
|
138
|
+
export declare const getSettingsPlexUsers: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsPlexUsersData, ThrowOnError>) => import("./client").RequestResult<GetSettingsPlexUsersResponses, unknown, ThrowOnError, "fields">;
|
|
139
|
+
/**
|
|
140
|
+
* Get Metadata settings
|
|
141
|
+
*
|
|
142
|
+
* Retrieves current Metadata settings.
|
|
143
|
+
*/
|
|
144
|
+
export declare const getSettingsMetadatas: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsMetadatasData, ThrowOnError>) => import("./client").RequestResult<GetSettingsMetadatasResponses, unknown, ThrowOnError, "fields">;
|
|
145
|
+
/**
|
|
146
|
+
* Update Metadata settings
|
|
147
|
+
*
|
|
148
|
+
* Updates Metadata settings with the provided values.
|
|
149
|
+
*/
|
|
150
|
+
export declare const putSettingsMetadatas: <ThrowOnError extends boolean = false>(options: Options<PutSettingsMetadatasData, ThrowOnError>) => import("./client").RequestResult<PutSettingsMetadatasResponses, unknown, ThrowOnError, "fields">;
|
|
151
|
+
/**
|
|
152
|
+
* Test Provider configuration
|
|
153
|
+
*
|
|
154
|
+
* Tests if the TVDB configuration is valid. Returns a list of available languages on success.
|
|
155
|
+
*/
|
|
156
|
+
export declare const postSettingsMetadatasTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsMetadatasTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsMetadatasTestResponses, unknown, ThrowOnError, "fields">;
|
|
157
|
+
/**
|
|
158
|
+
* Get Tautulli settings
|
|
159
|
+
*
|
|
160
|
+
* Retrieves current Tautulli settings.
|
|
161
|
+
*/
|
|
162
|
+
export declare const getSettingsTautulli: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsTautulliData, ThrowOnError>) => import("./client").RequestResult<GetSettingsTautulliResponses, unknown, ThrowOnError, "fields">;
|
|
163
|
+
/**
|
|
164
|
+
* Update Tautulli settings
|
|
165
|
+
*
|
|
166
|
+
* Updates Tautulli settings with the provided values.
|
|
167
|
+
*/
|
|
168
|
+
export declare const postSettingsTautulli: <ThrowOnError extends boolean = false>(options: Options<PostSettingsTautulliData, ThrowOnError>) => import("./client").RequestResult<PostSettingsTautulliResponses, unknown, ThrowOnError, "fields">;
|
|
169
|
+
/**
|
|
170
|
+
* Get Radarr settings
|
|
171
|
+
*
|
|
172
|
+
* Returns all Radarr settings in a JSON array.
|
|
173
|
+
*/
|
|
174
|
+
export declare const getSettingsRadarr: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsRadarrData, ThrowOnError>) => import("./client").RequestResult<GetSettingsRadarrResponses, unknown, ThrowOnError, "fields">;
|
|
175
|
+
/**
|
|
176
|
+
* Create Radarr instance
|
|
177
|
+
*
|
|
178
|
+
* Creates a new Radarr instance from the request body.
|
|
179
|
+
*/
|
|
180
|
+
export declare const postSettingsRadarr: <ThrowOnError extends boolean = false>(options: Options<PostSettingsRadarrData, ThrowOnError>) => import("./client").RequestResult<PostSettingsRadarrResponses, unknown, ThrowOnError, "fields">;
|
|
181
|
+
/**
|
|
182
|
+
* Test Radarr configuration
|
|
183
|
+
*
|
|
184
|
+
* Tests if the Radarr configuration is valid. Returns profiles and root folders on success.
|
|
185
|
+
*/
|
|
186
|
+
export declare const postSettingsRadarrTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsRadarrTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsRadarrTestResponses, unknown, ThrowOnError, "fields">;
|
|
187
|
+
/**
|
|
188
|
+
* Delete Radarr instance
|
|
189
|
+
*
|
|
190
|
+
* Deletes an existing Radarr instance based on the radarrId parameter.
|
|
191
|
+
*/
|
|
192
|
+
export declare const deleteSettingsRadarrByRadarrId: <ThrowOnError extends boolean = false>(options: Options<DeleteSettingsRadarrByRadarrIdData, ThrowOnError>) => import("./client").RequestResult<DeleteSettingsRadarrByRadarrIdResponses, unknown, ThrowOnError, "fields">;
|
|
193
|
+
/**
|
|
194
|
+
* Update Radarr instance
|
|
195
|
+
*
|
|
196
|
+
* Updates an existing Radarr instance with the provided values.
|
|
197
|
+
*/
|
|
198
|
+
export declare const putSettingsRadarrByRadarrId: <ThrowOnError extends boolean = false>(options: Options<PutSettingsRadarrByRadarrIdData, ThrowOnError>) => import("./client").RequestResult<PutSettingsRadarrByRadarrIdResponses, unknown, ThrowOnError, "fields">;
|
|
199
|
+
/**
|
|
200
|
+
* Get available Radarr profiles
|
|
201
|
+
*
|
|
202
|
+
* Returns a list of profiles available on the Radarr server instance in a JSON array.
|
|
203
|
+
*/
|
|
204
|
+
export declare const getSettingsRadarrByRadarrIdProfiles: <ThrowOnError extends boolean = false>(options: Options<GetSettingsRadarrByRadarrIdProfilesData, ThrowOnError>) => import("./client").RequestResult<GetSettingsRadarrByRadarrIdProfilesResponses, unknown, ThrowOnError, "fields">;
|
|
205
|
+
/**
|
|
206
|
+
* Get Sonarr settings
|
|
207
|
+
*
|
|
208
|
+
* Returns all Sonarr settings in a JSON array.
|
|
209
|
+
*/
|
|
210
|
+
export declare const getSettingsSonarr: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsSonarrData, ThrowOnError>) => import("./client").RequestResult<GetSettingsSonarrResponses, unknown, ThrowOnError, "fields">;
|
|
211
|
+
/**
|
|
212
|
+
* Create Sonarr instance
|
|
213
|
+
*
|
|
214
|
+
* Creates a new Sonarr instance from the request body.
|
|
215
|
+
*/
|
|
216
|
+
export declare const postSettingsSonarr: <ThrowOnError extends boolean = false>(options: Options<PostSettingsSonarrData, ThrowOnError>) => import("./client").RequestResult<PostSettingsSonarrResponses, unknown, ThrowOnError, "fields">;
|
|
217
|
+
/**
|
|
218
|
+
* Test Sonarr configuration
|
|
219
|
+
*
|
|
220
|
+
* Tests if the Sonarr configuration is valid. Returns profiles and root folders on success.
|
|
221
|
+
*/
|
|
222
|
+
export declare const postSettingsSonarrTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsSonarrTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsSonarrTestResponses, unknown, ThrowOnError, "fields">;
|
|
223
|
+
/**
|
|
224
|
+
* Delete Sonarr instance
|
|
225
|
+
*
|
|
226
|
+
* Deletes an existing Sonarr instance based on the sonarrId parameter.
|
|
227
|
+
*/
|
|
228
|
+
export declare const deleteSettingsSonarrBySonarrId: <ThrowOnError extends boolean = false>(options: Options<DeleteSettingsSonarrBySonarrIdData, ThrowOnError>) => import("./client").RequestResult<DeleteSettingsSonarrBySonarrIdResponses, unknown, ThrowOnError, "fields">;
|
|
229
|
+
/**
|
|
230
|
+
* Update Sonarr instance
|
|
231
|
+
*
|
|
232
|
+
* Updates an existing Sonarr instance with the provided values.
|
|
233
|
+
*/
|
|
234
|
+
export declare const putSettingsSonarrBySonarrId: <ThrowOnError extends boolean = false>(options: Options<PutSettingsSonarrBySonarrIdData, ThrowOnError>) => import("./client").RequestResult<PutSettingsSonarrBySonarrIdResponses, unknown, ThrowOnError, "fields">;
|
|
235
|
+
/**
|
|
236
|
+
* Get public settings
|
|
237
|
+
*
|
|
238
|
+
* Returns settings that are not protected or sensitive. Mainly used to determine if the application has been configured for the first time.
|
|
239
|
+
*/
|
|
240
|
+
export declare const getSettingsPublic: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsPublicData, ThrowOnError>) => import("./client").RequestResult<GetSettingsPublicResponses, unknown, ThrowOnError, "fields">;
|
|
241
|
+
/**
|
|
242
|
+
* Initialize application
|
|
243
|
+
*
|
|
244
|
+
* Sets the app as initialized, allowing the user to navigate to pages other than the setup page.
|
|
245
|
+
*/
|
|
246
|
+
export declare const postSettingsInitialize: <ThrowOnError extends boolean = false>(options?: Options<PostSettingsInitializeData, ThrowOnError>) => import("./client").RequestResult<PostSettingsInitializeResponses, unknown, ThrowOnError, "fields">;
|
|
247
|
+
/**
|
|
248
|
+
* Get scheduled jobs
|
|
249
|
+
*
|
|
250
|
+
* Returns list of all scheduled jobs and details about their next execution time in a JSON array.
|
|
251
|
+
*/
|
|
252
|
+
export declare const getSettingsJobs: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsJobsData, ThrowOnError>) => import("./client").RequestResult<GetSettingsJobsResponses, unknown, ThrowOnError, "fields">;
|
|
253
|
+
/**
|
|
254
|
+
* Invoke a specific job
|
|
255
|
+
*
|
|
256
|
+
* Invokes a specific job to run. Will return the new job status in JSON format.
|
|
257
|
+
*/
|
|
258
|
+
export declare const postSettingsJobsByJobIdRun: <ThrowOnError extends boolean = false>(options: Options<PostSettingsJobsByJobIdRunData, ThrowOnError>) => import("./client").RequestResult<PostSettingsJobsByJobIdRunResponses, unknown, ThrowOnError, "fields">;
|
|
259
|
+
/**
|
|
260
|
+
* Cancel a specific job
|
|
261
|
+
*
|
|
262
|
+
* Cancels a specific job. Will return the new job status in JSON format.
|
|
263
|
+
*/
|
|
264
|
+
export declare const postSettingsJobsByJobIdCancel: <ThrowOnError extends boolean = false>(options: Options<PostSettingsJobsByJobIdCancelData, ThrowOnError>) => import("./client").RequestResult<PostSettingsJobsByJobIdCancelResponses, unknown, ThrowOnError, "fields">;
|
|
265
|
+
/**
|
|
266
|
+
* Modify job schedule
|
|
267
|
+
*
|
|
268
|
+
* Re-registers the job with the schedule specified. Will return the job in JSON format.
|
|
269
|
+
*/
|
|
270
|
+
export declare const postSettingsJobsByJobIdSchedule: <ThrowOnError extends boolean = false>(options: Options<PostSettingsJobsByJobIdScheduleData, ThrowOnError>) => import("./client").RequestResult<PostSettingsJobsByJobIdScheduleResponses, unknown, ThrowOnError, "fields">;
|
|
271
|
+
/**
|
|
272
|
+
* Get a list of active caches
|
|
273
|
+
*
|
|
274
|
+
* Retrieves a list of all active caches and their current stats.
|
|
275
|
+
*/
|
|
276
|
+
export declare const getSettingsCache: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsCacheData, ThrowOnError>) => import("./client").RequestResult<GetSettingsCacheResponses, unknown, ThrowOnError, "fields">;
|
|
277
|
+
/**
|
|
278
|
+
* Flush a specific cache
|
|
279
|
+
*
|
|
280
|
+
* Flushes all data from the cache ID provided
|
|
281
|
+
*/
|
|
282
|
+
export declare const postSettingsCacheByCacheIdFlush: <ThrowOnError extends boolean = false>(options: Options<PostSettingsCacheByCacheIdFlushData, ThrowOnError>) => import("./client").RequestResult<PostSettingsCacheByCacheIdFlushResponses, unknown, ThrowOnError, "fields">;
|
|
283
|
+
/**
|
|
284
|
+
* Flush a specific DNS cache entry
|
|
285
|
+
*
|
|
286
|
+
* Flushes a specific DNS cache entry
|
|
287
|
+
*/
|
|
288
|
+
export declare const postSettingsCacheDnsByDnsEntryFlush: <ThrowOnError extends boolean = false>(options: Options<PostSettingsCacheDnsByDnsEntryFlushData, ThrowOnError>) => import("./client").RequestResult<PostSettingsCacheDnsByDnsEntryFlushResponses, unknown, ThrowOnError, "fields">;
|
|
289
|
+
/**
|
|
290
|
+
* Returns logs
|
|
291
|
+
*
|
|
292
|
+
* Returns list of all log items and details
|
|
293
|
+
*/
|
|
294
|
+
export declare const getSettingsLogs: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsLogsData, ThrowOnError>) => import("./client").RequestResult<GetSettingsLogsResponses, unknown, ThrowOnError, "fields">;
|
|
295
|
+
/**
|
|
296
|
+
* Get email notification settings
|
|
297
|
+
*
|
|
298
|
+
* Returns current email notification settings in a JSON object.
|
|
299
|
+
*/
|
|
300
|
+
export declare const getSettingsNotificationsEmail: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsEmailData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsEmailResponses, unknown, ThrowOnError, "fields">;
|
|
301
|
+
/**
|
|
302
|
+
* Update email notification settings
|
|
303
|
+
*
|
|
304
|
+
* Updates email notification settings with provided values
|
|
305
|
+
*/
|
|
306
|
+
export declare const postSettingsNotificationsEmail: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsEmailData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsEmailResponses, unknown, ThrowOnError, "fields">;
|
|
307
|
+
/**
|
|
308
|
+
* Test email settings
|
|
309
|
+
*
|
|
310
|
+
* Sends a test notification to the email agent.
|
|
311
|
+
*/
|
|
312
|
+
export declare const postSettingsNotificationsEmailTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsEmailTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsEmailTestResponses, unknown, ThrowOnError, "fields">;
|
|
313
|
+
/**
|
|
314
|
+
* Get Discord notification settings
|
|
315
|
+
*
|
|
316
|
+
* Returns current Discord notification settings in a JSON object.
|
|
317
|
+
*/
|
|
318
|
+
export declare const getSettingsNotificationsDiscord: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsDiscordData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsDiscordResponses, unknown, ThrowOnError, "fields">;
|
|
319
|
+
/**
|
|
320
|
+
* Update Discord notification settings
|
|
321
|
+
*
|
|
322
|
+
* Updates Discord notification settings with the provided values.
|
|
323
|
+
*/
|
|
324
|
+
export declare const postSettingsNotificationsDiscord: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsDiscordData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsDiscordResponses, unknown, ThrowOnError, "fields">;
|
|
325
|
+
/**
|
|
326
|
+
* Test Discord settings
|
|
327
|
+
*
|
|
328
|
+
* Sends a test notification to the Discord agent.
|
|
329
|
+
*/
|
|
330
|
+
export declare const postSettingsNotificationsDiscordTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsDiscordTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsDiscordTestResponses, unknown, ThrowOnError, "fields">;
|
|
331
|
+
/**
|
|
332
|
+
* Get Pushbullet notification settings
|
|
333
|
+
*
|
|
334
|
+
* Returns current Pushbullet notification settings in a JSON object.
|
|
335
|
+
*/
|
|
336
|
+
export declare const getSettingsNotificationsPushbullet: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsPushbulletData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsPushbulletResponses, unknown, ThrowOnError, "fields">;
|
|
337
|
+
/**
|
|
338
|
+
* Update Pushbullet notification settings
|
|
339
|
+
*
|
|
340
|
+
* Update Pushbullet notification settings with the provided values.
|
|
341
|
+
*/
|
|
342
|
+
export declare const postSettingsNotificationsPushbullet: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsPushbulletData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsPushbulletResponses, unknown, ThrowOnError, "fields">;
|
|
343
|
+
/**
|
|
344
|
+
* Test Pushbullet settings
|
|
345
|
+
*
|
|
346
|
+
* Sends a test notification to the Pushbullet agent.
|
|
347
|
+
*/
|
|
348
|
+
export declare const postSettingsNotificationsPushbulletTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsPushbulletTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsPushbulletTestResponses, unknown, ThrowOnError, "fields">;
|
|
349
|
+
/**
|
|
350
|
+
* Get Pushover notification settings
|
|
351
|
+
*
|
|
352
|
+
* Returns current Pushover notification settings in a JSON object.
|
|
353
|
+
*/
|
|
354
|
+
export declare const getSettingsNotificationsPushover: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsPushoverData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsPushoverResponses, unknown, ThrowOnError, "fields">;
|
|
355
|
+
/**
|
|
356
|
+
* Update Pushover notification settings
|
|
357
|
+
*
|
|
358
|
+
* Update Pushover notification settings with the provided values.
|
|
359
|
+
*/
|
|
360
|
+
export declare const postSettingsNotificationsPushover: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsPushoverData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsPushoverResponses, unknown, ThrowOnError, "fields">;
|
|
361
|
+
/**
|
|
362
|
+
* Test Pushover settings
|
|
363
|
+
*
|
|
364
|
+
* Sends a test notification to the Pushover agent.
|
|
365
|
+
*/
|
|
366
|
+
export declare const postSettingsNotificationsPushoverTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsPushoverTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsPushoverTestResponses, unknown, ThrowOnError, "fields">;
|
|
367
|
+
/**
|
|
368
|
+
* Get Pushover sounds
|
|
369
|
+
*
|
|
370
|
+
* Returns valid Pushover sound options in a JSON array.
|
|
371
|
+
*/
|
|
372
|
+
export declare const getSettingsNotificationsPushoverSounds: <ThrowOnError extends boolean = false>(options: Options<GetSettingsNotificationsPushoverSoundsData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsPushoverSoundsResponses, unknown, ThrowOnError, "fields">;
|
|
373
|
+
/**
|
|
374
|
+
* Get Gotify notification settings
|
|
375
|
+
*
|
|
376
|
+
* Returns current Gotify notification settings in a JSON object.
|
|
377
|
+
*/
|
|
378
|
+
export declare const getSettingsNotificationsGotify: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsGotifyData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsGotifyResponses, unknown, ThrowOnError, "fields">;
|
|
379
|
+
/**
|
|
380
|
+
* Update Gotify notification settings
|
|
381
|
+
*
|
|
382
|
+
* Update Gotify notification settings with the provided values.
|
|
383
|
+
*/
|
|
384
|
+
export declare const postSettingsNotificationsGotify: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsGotifyData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsGotifyResponses, unknown, ThrowOnError, "fields">;
|
|
385
|
+
/**
|
|
386
|
+
* Test Gotify settings
|
|
387
|
+
*
|
|
388
|
+
* Sends a test notification to the Gotify agent.
|
|
389
|
+
*/
|
|
390
|
+
export declare const postSettingsNotificationsGotifyTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsGotifyTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsGotifyTestResponses, unknown, ThrowOnError, "fields">;
|
|
391
|
+
/**
|
|
392
|
+
* Get ntfy.sh notification settings
|
|
393
|
+
*
|
|
394
|
+
* Returns current ntfy.sh notification settings in a JSON object.
|
|
395
|
+
*/
|
|
396
|
+
export declare const getSettingsNotificationsNtfy: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsNtfyData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsNtfyResponses, unknown, ThrowOnError, "fields">;
|
|
397
|
+
/**
|
|
398
|
+
* Update ntfy.sh notification settings
|
|
399
|
+
*
|
|
400
|
+
* Update ntfy.sh notification settings with the provided values.
|
|
401
|
+
*/
|
|
402
|
+
export declare const postSettingsNotificationsNtfy: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsNtfyData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsNtfyResponses, unknown, ThrowOnError, "fields">;
|
|
403
|
+
/**
|
|
404
|
+
* Test ntfy.sh settings
|
|
405
|
+
*
|
|
406
|
+
* Sends a test notification to the ntfy.sh agent.
|
|
407
|
+
*/
|
|
408
|
+
export declare const postSettingsNotificationsNtfyTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsNtfyTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsNtfyTestResponses, unknown, ThrowOnError, "fields">;
|
|
409
|
+
/**
|
|
410
|
+
* Get Slack notification settings
|
|
411
|
+
*
|
|
412
|
+
* Returns current Slack notification settings in a JSON object.
|
|
413
|
+
*/
|
|
414
|
+
export declare const getSettingsNotificationsSlack: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsSlackData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsSlackResponses, unknown, ThrowOnError, "fields">;
|
|
415
|
+
/**
|
|
416
|
+
* Update Slack notification settings
|
|
417
|
+
*
|
|
418
|
+
* Updates Slack notification settings with the provided values.
|
|
419
|
+
*/
|
|
420
|
+
export declare const postSettingsNotificationsSlack: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsSlackData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsSlackResponses, unknown, ThrowOnError, "fields">;
|
|
421
|
+
/**
|
|
422
|
+
* Test Slack settings
|
|
423
|
+
*
|
|
424
|
+
* Sends a test notification to the Slack agent.
|
|
425
|
+
*/
|
|
426
|
+
export declare const postSettingsNotificationsSlackTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsSlackTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsSlackTestResponses, unknown, ThrowOnError, "fields">;
|
|
427
|
+
/**
|
|
428
|
+
* Get Telegram notification settings
|
|
429
|
+
*
|
|
430
|
+
* Returns current Telegram notification settings in a JSON object.
|
|
431
|
+
*/
|
|
432
|
+
export declare const getSettingsNotificationsTelegram: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsTelegramData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsTelegramResponses, unknown, ThrowOnError, "fields">;
|
|
433
|
+
/**
|
|
434
|
+
* Update Telegram notification settings
|
|
435
|
+
*
|
|
436
|
+
* Update Telegram notification settings with the provided values.
|
|
437
|
+
*/
|
|
438
|
+
export declare const postSettingsNotificationsTelegram: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsTelegramData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsTelegramResponses, unknown, ThrowOnError, "fields">;
|
|
439
|
+
/**
|
|
440
|
+
* Test Telegram settings
|
|
441
|
+
*
|
|
442
|
+
* Sends a test notification to the Telegram agent.
|
|
443
|
+
*/
|
|
444
|
+
export declare const postSettingsNotificationsTelegramTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsTelegramTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsTelegramTestResponses, unknown, ThrowOnError, "fields">;
|
|
445
|
+
/**
|
|
446
|
+
* Get Web Push notification settings
|
|
447
|
+
*
|
|
448
|
+
* Returns current Web Push notification settings in a JSON object.
|
|
449
|
+
*/
|
|
450
|
+
export declare const getSettingsNotificationsWebpush: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsWebpushData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsWebpushResponses, unknown, ThrowOnError, "fields">;
|
|
451
|
+
/**
|
|
452
|
+
* Update Web Push notification settings
|
|
453
|
+
*
|
|
454
|
+
* Updates Web Push notification settings with the provided values.
|
|
455
|
+
*/
|
|
456
|
+
export declare const postSettingsNotificationsWebpush: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsWebpushData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsWebpushResponses, unknown, ThrowOnError, "fields">;
|
|
457
|
+
/**
|
|
458
|
+
* Test Web Push settings
|
|
459
|
+
*
|
|
460
|
+
* Sends a test notification to the Web Push agent.
|
|
461
|
+
*/
|
|
462
|
+
export declare const postSettingsNotificationsWebpushTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsWebpushTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsWebpushTestResponses, unknown, ThrowOnError, "fields">;
|
|
463
|
+
/**
|
|
464
|
+
* Get webhook notification settings
|
|
465
|
+
*
|
|
466
|
+
* Returns current webhook notification settings in a JSON object.
|
|
467
|
+
*/
|
|
468
|
+
export declare const getSettingsNotificationsWebhook: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsNotificationsWebhookData, ThrowOnError>) => import("./client").RequestResult<GetSettingsNotificationsWebhookResponses, unknown, ThrowOnError, "fields">;
|
|
469
|
+
/**
|
|
470
|
+
* Update webhook notification settings
|
|
471
|
+
*
|
|
472
|
+
* Updates webhook notification settings with the provided values.
|
|
473
|
+
*/
|
|
474
|
+
export declare const postSettingsNotificationsWebhook: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsWebhookData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsWebhookResponses, unknown, ThrowOnError, "fields">;
|
|
475
|
+
/**
|
|
476
|
+
* Test webhook settings
|
|
477
|
+
*
|
|
478
|
+
* Sends a test notification to the webhook agent.
|
|
479
|
+
*/
|
|
480
|
+
export declare const postSettingsNotificationsWebhookTest: <ThrowOnError extends boolean = false>(options: Options<PostSettingsNotificationsWebhookTestData, ThrowOnError>) => import("./client").RequestResult<PostSettingsNotificationsWebhookTestResponses, unknown, ThrowOnError, "fields">;
|
|
481
|
+
/**
|
|
482
|
+
* Get all discover sliders
|
|
483
|
+
*
|
|
484
|
+
* Returns all discovery sliders. Built-in and custom made.
|
|
485
|
+
*/
|
|
486
|
+
export declare const getSettingsDiscover: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsDiscoverData, ThrowOnError>) => import("./client").RequestResult<GetSettingsDiscoverResponses, unknown, ThrowOnError, "fields">;
|
|
487
|
+
/**
|
|
488
|
+
* Batch update all sliders.
|
|
489
|
+
*
|
|
490
|
+
* Batch update all sliders at once. Should also be used for creation. Will only update sliders provided
|
|
491
|
+
* and will not delete any sliders not present in the request. If a slider is missing a required field,
|
|
492
|
+
* it will be ignored. Requires the `ADMIN` permission.
|
|
493
|
+
*
|
|
494
|
+
*/
|
|
495
|
+
export declare const postSettingsDiscover: <ThrowOnError extends boolean = false>(options: Options<PostSettingsDiscoverData, ThrowOnError>) => import("./client").RequestResult<PostSettingsDiscoverResponses, unknown, ThrowOnError, "fields">;
|
|
496
|
+
/**
|
|
497
|
+
* Delete slider by ID
|
|
498
|
+
*
|
|
499
|
+
* Deletes the slider with the provided sliderId. Requires the `ADMIN` permission.
|
|
500
|
+
*/
|
|
501
|
+
export declare const deleteSettingsDiscoverBySliderId: <ThrowOnError extends boolean = false>(options: Options<DeleteSettingsDiscoverBySliderIdData, ThrowOnError>) => import("./client").RequestResult<DeleteSettingsDiscoverBySliderIdResponses, unknown, ThrowOnError, "fields">;
|
|
502
|
+
/**
|
|
503
|
+
* Update a single slider
|
|
504
|
+
*
|
|
505
|
+
* Updates a single slider and return the newly updated slider. Requires the `ADMIN` permission.
|
|
506
|
+
*
|
|
507
|
+
*/
|
|
508
|
+
export declare const putSettingsDiscoverBySliderId: <ThrowOnError extends boolean = false>(options: Options<PutSettingsDiscoverBySliderIdData, ThrowOnError>) => import("./client").RequestResult<PutSettingsDiscoverBySliderIdResponses, unknown, ThrowOnError, "fields">;
|
|
509
|
+
/**
|
|
510
|
+
* Add a new slider
|
|
511
|
+
*
|
|
512
|
+
* Add a single slider and return the newly created slider. Requires the `ADMIN` permission.
|
|
513
|
+
*
|
|
514
|
+
*/
|
|
515
|
+
export declare const postSettingsDiscoverAdd: <ThrowOnError extends boolean = false>(options: Options<PostSettingsDiscoverAddData, ThrowOnError>) => import("./client").RequestResult<PostSettingsDiscoverAddResponses, unknown, ThrowOnError, "fields">;
|
|
516
|
+
/**
|
|
517
|
+
* Reset all discover sliders
|
|
518
|
+
*
|
|
519
|
+
* Resets all discovery sliders to the default values. Requires the `ADMIN` permission.
|
|
520
|
+
*/
|
|
521
|
+
export declare const getSettingsDiscoverReset: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsDiscoverResetData, ThrowOnError>) => import("./client").RequestResult<GetSettingsDiscoverResetResponses, unknown, ThrowOnError, "fields">;
|
|
522
|
+
/**
|
|
523
|
+
* Get server stats
|
|
524
|
+
*
|
|
525
|
+
* Returns current server stats in a JSON object.
|
|
526
|
+
*/
|
|
527
|
+
export declare const getSettingsAbout: <ThrowOnError extends boolean = false>(options?: Options<GetSettingsAboutData, ThrowOnError>) => import("./client").RequestResult<GetSettingsAboutResponses, unknown, ThrowOnError, "fields">;
|
|
528
|
+
/**
|
|
529
|
+
* Get logged-in user
|
|
530
|
+
*
|
|
531
|
+
* Returns the currently logged-in user.
|
|
532
|
+
*/
|
|
533
|
+
export declare const getAuthMe: <ThrowOnError extends boolean = false>(options?: Options<GetAuthMeData, ThrowOnError>) => import("./client").RequestResult<GetAuthMeResponses, unknown, ThrowOnError, "fields">;
|
|
534
|
+
/**
|
|
535
|
+
* Sign in using a Plex token
|
|
536
|
+
*
|
|
537
|
+
* Takes an `authToken` (Plex token) to log the user in. Generates a session cookie for use in further requests. If the user does not exist, and there are no other users, then a user will be created with full admin privileges. If a user logs in with access to the main Plex server, they will also have an account created, but without any permissions.
|
|
538
|
+
*/
|
|
539
|
+
export declare const postAuthPlex: <ThrowOnError extends boolean = false>(options: Options<PostAuthPlexData, ThrowOnError>) => import("./client").RequestResult<PostAuthPlexResponses, unknown, ThrowOnError, "fields">;
|
|
540
|
+
/**
|
|
541
|
+
* Sign in using a Jellyfin username and password
|
|
542
|
+
*
|
|
543
|
+
* Takes the user's username and password to log the user in. Generates a session cookie for use in further requests. If the user does not exist, and there are no other users, then a user will be created with full admin privileges. If a user logs in with access to the Jellyfin server, they will also have an account created, but without any permissions.
|
|
544
|
+
*/
|
|
545
|
+
export declare const postAuthJellyfin: <ThrowOnError extends boolean = false>(options: Options<PostAuthJellyfinData, ThrowOnError>) => import("./client").RequestResult<PostAuthJellyfinResponses, unknown, ThrowOnError, "fields">;
|
|
546
|
+
/**
|
|
547
|
+
* Sign in using a local account
|
|
548
|
+
*
|
|
549
|
+
* Takes an `email` and a `password` to log the user in. Generates a session cookie for use in further requests.
|
|
550
|
+
*/
|
|
551
|
+
export declare const postAuthLocal: <ThrowOnError extends boolean = false>(options: Options<PostAuthLocalData, ThrowOnError>) => import("./client").RequestResult<PostAuthLocalResponses, unknown, ThrowOnError, "fields">;
|
|
552
|
+
/**
|
|
553
|
+
* Sign out and clear session cookie
|
|
554
|
+
*
|
|
555
|
+
* Completely clear the session cookie and associated values, effectively signing the user out.
|
|
556
|
+
*/
|
|
557
|
+
export declare const postAuthLogout: <ThrowOnError extends boolean = false>(options?: Options<PostAuthLogoutData, ThrowOnError>) => import("./client").RequestResult<PostAuthLogoutResponses, unknown, ThrowOnError, "fields">;
|
|
558
|
+
/**
|
|
559
|
+
* Send a reset password email
|
|
560
|
+
*
|
|
561
|
+
* Sends a reset password email to the email if the user exists
|
|
562
|
+
*/
|
|
563
|
+
export declare const postAuthResetPassword: <ThrowOnError extends boolean = false>(options: Options<PostAuthResetPasswordData, ThrowOnError>) => import("./client").RequestResult<PostAuthResetPasswordResponses, unknown, ThrowOnError, "fields">;
|
|
564
|
+
/**
|
|
565
|
+
* Reset the password for a user
|
|
566
|
+
*
|
|
567
|
+
* Resets the password for a user if the given guid is connected to a user
|
|
568
|
+
*/
|
|
569
|
+
export declare const postAuthResetPasswordByGuid: <ThrowOnError extends boolean = false>(options: Options<PostAuthResetPasswordByGuidData, ThrowOnError>) => import("./client").RequestResult<PostAuthResetPasswordByGuidResponses, unknown, ThrowOnError, "fields">;
|
|
570
|
+
/**
|
|
571
|
+
* Get all users
|
|
572
|
+
*
|
|
573
|
+
* Returns all users in a JSON object.
|
|
574
|
+
*/
|
|
575
|
+
export declare const getUser: <ThrowOnError extends boolean = false>(options?: Options<GetUserData, ThrowOnError>) => import("./client").RequestResult<GetUserResponses, unknown, ThrowOnError, "fields">;
|
|
576
|
+
/**
|
|
577
|
+
* Create new user
|
|
578
|
+
*
|
|
579
|
+
* Creates a new user. Requires the `MANAGE_USERS` permission.
|
|
580
|
+
*
|
|
581
|
+
*/
|
|
582
|
+
export declare const postUser: <ThrowOnError extends boolean = false>(options: Options<PostUserData, ThrowOnError>) => import("./client").RequestResult<PostUserResponses, unknown, ThrowOnError, "fields">;
|
|
583
|
+
/**
|
|
584
|
+
* Update batch of users
|
|
585
|
+
*
|
|
586
|
+
* Update users with given IDs with provided values in request `body.settings`. You cannot update users' Plex tokens through this request.
|
|
587
|
+
*
|
|
588
|
+
* Requires the `MANAGE_USERS` permission.
|
|
589
|
+
*
|
|
590
|
+
*/
|
|
591
|
+
export declare const putUser: <ThrowOnError extends boolean = false>(options: Options<PutUserData, ThrowOnError>) => import("./client").RequestResult<PutUserResponses, unknown, ThrowOnError, "fields">;
|
|
592
|
+
/**
|
|
593
|
+
* Import all users from Plex
|
|
594
|
+
*
|
|
595
|
+
* Fetches and imports users from the Plex server. If a list of Plex IDs is provided in the request body, only the specified users will be imported. Otherwise, all users will be imported.
|
|
596
|
+
*
|
|
597
|
+
* Requires the `MANAGE_USERS` permission.
|
|
598
|
+
*
|
|
599
|
+
*/
|
|
600
|
+
export declare const postUserImportFromPlex: <ThrowOnError extends boolean = false>(options?: Options<PostUserImportFromPlexData, ThrowOnError>) => import("./client").RequestResult<PostUserImportFromPlexResponses, unknown, ThrowOnError, "fields">;
|
|
601
|
+
/**
|
|
602
|
+
* Import all users from Jellyfin
|
|
603
|
+
*
|
|
604
|
+
* Fetches and imports users from the Jellyfin server.
|
|
605
|
+
*
|
|
606
|
+
* Requires the `MANAGE_USERS` permission.
|
|
607
|
+
*
|
|
608
|
+
*/
|
|
609
|
+
export declare const postUserImportFromJellyfin: <ThrowOnError extends boolean = false>(options?: Options<PostUserImportFromJellyfinData, ThrowOnError>) => import("./client").RequestResult<PostUserImportFromJellyfinResponses, unknown, ThrowOnError, "fields">;
|
|
610
|
+
/**
|
|
611
|
+
* Register a web push /user/registerPushSubscription
|
|
612
|
+
*
|
|
613
|
+
* Registers a web push subscription for the logged-in user
|
|
614
|
+
*/
|
|
615
|
+
export declare const postUserRegisterPushSubscription: <ThrowOnError extends boolean = false>(options: Options<PostUserRegisterPushSubscriptionData, ThrowOnError>) => import("./client").RequestResult<PostUserRegisterPushSubscriptionResponses, unknown, ThrowOnError, "fields">;
|
|
616
|
+
/**
|
|
617
|
+
* Get all web push notification settings for a user
|
|
618
|
+
*
|
|
619
|
+
* Returns all web push notification settings for a user in a JSON object.
|
|
620
|
+
*
|
|
621
|
+
*/
|
|
622
|
+
export declare const getUserByUserIdPushSubscriptions: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdPushSubscriptionsData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdPushSubscriptionsResponses, unknown, ThrowOnError, "fields">;
|
|
623
|
+
/**
|
|
624
|
+
* Delete user push subscription by key
|
|
625
|
+
*
|
|
626
|
+
* Deletes the user push subscription with the provided key.
|
|
627
|
+
*/
|
|
628
|
+
export declare const deleteUserByUserIdPushSubscriptionByEndpoint: <ThrowOnError extends boolean = false>(options: Options<DeleteUserByUserIdPushSubscriptionByEndpointData, ThrowOnError>) => import("./client").RequestResult<DeleteUserByUserIdPushSubscriptionByEndpointResponses, unknown, ThrowOnError, "fields">;
|
|
629
|
+
/**
|
|
630
|
+
* Get web push notification settings for a user
|
|
631
|
+
*
|
|
632
|
+
* Returns web push notification settings for a user in a JSON object.
|
|
633
|
+
*
|
|
634
|
+
*/
|
|
635
|
+
export declare const getUserByUserIdPushSubscriptionByEndpoint: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdPushSubscriptionByEndpointData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdPushSubscriptionByEndpointResponses, unknown, ThrowOnError, "fields">;
|
|
636
|
+
/**
|
|
637
|
+
* Delete user by ID
|
|
638
|
+
*
|
|
639
|
+
* Deletes the user with the provided userId. Requires the `MANAGE_USERS` permission.
|
|
640
|
+
*/
|
|
641
|
+
export declare const deleteUserByUserId: <ThrowOnError extends boolean = false>(options: Options<DeleteUserByUserIdData, ThrowOnError>) => import("./client").RequestResult<DeleteUserByUserIdResponses, unknown, ThrowOnError, "fields">;
|
|
642
|
+
/**
|
|
643
|
+
* Get user by ID
|
|
644
|
+
*
|
|
645
|
+
* Retrieves user details in a JSON object. Requires the `MANAGE_USERS` permission.
|
|
646
|
+
*
|
|
647
|
+
*/
|
|
648
|
+
export declare const getUserByUserId: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdResponses, unknown, ThrowOnError, "fields">;
|
|
649
|
+
/**
|
|
650
|
+
* Update a user by user ID
|
|
651
|
+
*
|
|
652
|
+
* Update a user with the provided values. You cannot update a user's Plex token through this request.
|
|
653
|
+
*
|
|
654
|
+
* Requires the `MANAGE_USERS` permission.
|
|
655
|
+
*
|
|
656
|
+
*/
|
|
657
|
+
export declare const putUserByUserId: <ThrowOnError extends boolean = false>(options: Options<PutUserByUserIdData, ThrowOnError>) => import("./client").RequestResult<PutUserByUserIdResponses, unknown, ThrowOnError, "fields">;
|
|
658
|
+
/**
|
|
659
|
+
* Get requests for a specific user
|
|
660
|
+
*
|
|
661
|
+
* Retrieves a user's requests in a JSON object.
|
|
662
|
+
*
|
|
663
|
+
*/
|
|
664
|
+
export declare const getUserByUserIdRequests: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdRequestsData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdRequestsResponses, unknown, ThrowOnError, "fields">;
|
|
665
|
+
/**
|
|
666
|
+
* Get quotas for a specific user
|
|
667
|
+
*
|
|
668
|
+
* Returns quota details for a user in a JSON object. Requires `MANAGE_USERS` permission if viewing other users.
|
|
669
|
+
*
|
|
670
|
+
*/
|
|
671
|
+
export declare const getUserByUserIdQuota: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdQuotaData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdQuotaResponses, unknown, ThrowOnError, "fields">;
|
|
672
|
+
/**
|
|
673
|
+
* Returns blocklisted items
|
|
674
|
+
*
|
|
675
|
+
* Returns list of all blocklisted media
|
|
676
|
+
*/
|
|
677
|
+
export declare const getBlocklist: <ThrowOnError extends boolean = false>(options?: Options<GetBlocklistData, ThrowOnError>) => import("./client").RequestResult<GetBlocklistResponses, unknown, ThrowOnError, "fields">;
|
|
678
|
+
/**
|
|
679
|
+
* Add media to blocklist
|
|
680
|
+
*/
|
|
681
|
+
export declare const postBlocklist: <ThrowOnError extends boolean = false>(options: Options<PostBlocklistData, ThrowOnError>) => import("./client").RequestResult<PostBlocklistResponses, PostBlocklistErrors, ThrowOnError, "fields">;
|
|
682
|
+
/**
|
|
683
|
+
* Remove media from blocklist
|
|
684
|
+
*/
|
|
685
|
+
export declare const deleteBlocklistByTmdbId: <ThrowOnError extends boolean = false>(options: Options<DeleteBlocklistByTmdbIdData, ThrowOnError>) => import("./client").RequestResult<DeleteBlocklistByTmdbIdResponses, unknown, ThrowOnError, "fields">;
|
|
686
|
+
/**
|
|
687
|
+
* Get media from blocklist
|
|
688
|
+
*/
|
|
689
|
+
export declare const getBlocklistByTmdbId: <ThrowOnError extends boolean = false>(options: Options<GetBlocklistByTmdbIdData, ThrowOnError>) => import("./client").RequestResult<GetBlocklistByTmdbIdResponses, unknown, ThrowOnError, "fields">;
|
|
690
|
+
/**
|
|
691
|
+
* Returns blocklisted items
|
|
692
|
+
*
|
|
693
|
+
* **DEPRECATED**: Use `/blocklist` instead. This endpoint will be deprecated soon.
|
|
694
|
+
*
|
|
695
|
+
*
|
|
696
|
+
* @deprecated
|
|
697
|
+
*/
|
|
698
|
+
export declare const getBlacklist: <ThrowOnError extends boolean = false>(options?: Options<GetBlacklistData, ThrowOnError>) => import("./client").RequestResult<GetBlacklistResponses, unknown, ThrowOnError, "fields">;
|
|
699
|
+
/**
|
|
700
|
+
* Add media to blocklist
|
|
701
|
+
*
|
|
702
|
+
* **DEPRECATED**: Use `/blocklist` instead. This endpoint will be deprecated soon.
|
|
703
|
+
*
|
|
704
|
+
*
|
|
705
|
+
* @deprecated
|
|
706
|
+
*/
|
|
707
|
+
export declare const postBlacklist: <ThrowOnError extends boolean = false>(options: Options<PostBlacklistData, ThrowOnError>) => import("./client").RequestResult<PostBlacklistResponses, PostBlacklistErrors, ThrowOnError, "fields">;
|
|
708
|
+
/**
|
|
709
|
+
* Remove media from blocklist
|
|
710
|
+
*
|
|
711
|
+
* **DEPRECATED**: Use `/blocklist/{tmdbId}` instead. This endpoint will be deprecated soon.
|
|
712
|
+
*
|
|
713
|
+
*
|
|
714
|
+
* @deprecated
|
|
715
|
+
*/
|
|
716
|
+
export declare const deleteBlacklistByTmdbId: <ThrowOnError extends boolean = false>(options: Options<DeleteBlacklistByTmdbIdData, ThrowOnError>) => import("./client").RequestResult<DeleteBlacklistByTmdbIdResponses, unknown, ThrowOnError, "fields">;
|
|
717
|
+
/**
|
|
718
|
+
* Get media from blocklist
|
|
719
|
+
*
|
|
720
|
+
* **DEPRECATED**: Use `/blocklist/{tmdbId}` instead. This endpoint will be deprecated soon.
|
|
721
|
+
*
|
|
722
|
+
*
|
|
723
|
+
* @deprecated
|
|
724
|
+
*/
|
|
725
|
+
export declare const getBlacklistByTmdbId: <ThrowOnError extends boolean = false>(options: Options<GetBlacklistByTmdbIdData, ThrowOnError>) => import("./client").RequestResult<GetBlacklistByTmdbIdResponses, unknown, ThrowOnError, "fields">;
|
|
726
|
+
/**
|
|
727
|
+
* Add media to watchlist
|
|
728
|
+
*/
|
|
729
|
+
export declare const postWatchlist: <ThrowOnError extends boolean = false>(options: Options<PostWatchlistData, ThrowOnError>) => import("./client").RequestResult<PostWatchlistResponses, unknown, ThrowOnError, "fields">;
|
|
730
|
+
/**
|
|
731
|
+
* Delete watchlist item
|
|
732
|
+
*
|
|
733
|
+
* Removes a watchlist item.
|
|
734
|
+
*/
|
|
735
|
+
export declare const deleteWatchlistByTmdbId: <ThrowOnError extends boolean = false>(options: Options<DeleteWatchlistByTmdbIdData, ThrowOnError>) => import("./client").RequestResult<DeleteWatchlistByTmdbIdResponses, unknown, ThrowOnError, "fields">;
|
|
736
|
+
/**
|
|
737
|
+
* Get the Plex watchlist for a specific user
|
|
738
|
+
*
|
|
739
|
+
* Retrieves a user's Plex Watchlist in a JSON object.
|
|
740
|
+
*
|
|
741
|
+
*/
|
|
742
|
+
export declare const getUserByUserIdWatchlist: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdWatchlistData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdWatchlistResponses, unknown, ThrowOnError, "fields">;
|
|
743
|
+
/**
|
|
744
|
+
* Get general settings for a user
|
|
745
|
+
*
|
|
746
|
+
* Returns general settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users.
|
|
747
|
+
*/
|
|
748
|
+
export declare const getUserByUserIdSettingsMain: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdSettingsMainData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdSettingsMainResponses, unknown, ThrowOnError, "fields">;
|
|
749
|
+
/**
|
|
750
|
+
* Update general settings for a user
|
|
751
|
+
*
|
|
752
|
+
* Updates and returns general settings for a specific user. Requires `MANAGE_USERS` permission if editing other users.
|
|
753
|
+
*/
|
|
754
|
+
export declare const postUserByUserIdSettingsMain: <ThrowOnError extends boolean = false>(options: Options<PostUserByUserIdSettingsMainData, ThrowOnError>) => import("./client").RequestResult<PostUserByUserIdSettingsMainResponses, unknown, ThrowOnError, "fields">;
|
|
755
|
+
/**
|
|
756
|
+
* Get password page informatiom
|
|
757
|
+
*
|
|
758
|
+
* Returns important data for the password page to function correctly. Requires `MANAGE_USERS` permission if viewing other users.
|
|
759
|
+
*/
|
|
760
|
+
export declare const getUserByUserIdSettingsPassword: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdSettingsPasswordData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdSettingsPasswordResponses, unknown, ThrowOnError, "fields">;
|
|
761
|
+
/**
|
|
762
|
+
* Update password for a user
|
|
763
|
+
*
|
|
764
|
+
* Updates a user's password. Requires `MANAGE_USERS` permission if editing other users.
|
|
765
|
+
*/
|
|
766
|
+
export declare const postUserByUserIdSettingsPassword: <ThrowOnError extends boolean = false>(options: Options<PostUserByUserIdSettingsPasswordData, ThrowOnError>) => import("./client").RequestResult<PostUserByUserIdSettingsPasswordResponses, unknown, ThrowOnError, "fields">;
|
|
767
|
+
/**
|
|
768
|
+
* Remove the linked Plex account for a user
|
|
769
|
+
*
|
|
770
|
+
* Removes the linked Plex account for a specific user. Requires `MANAGE_USERS` permission if editing other users.
|
|
771
|
+
*/
|
|
772
|
+
export declare const deleteUserByUserIdSettingsLinkedAccountsPlex: <ThrowOnError extends boolean = false>(options: Options<DeleteUserByUserIdSettingsLinkedAccountsPlexData, ThrowOnError>) => import("./client").RequestResult<DeleteUserByUserIdSettingsLinkedAccountsPlexResponses, DeleteUserByUserIdSettingsLinkedAccountsPlexErrors, ThrowOnError, "fields">;
|
|
773
|
+
/**
|
|
774
|
+
* Link the provided Plex account to the current user
|
|
775
|
+
*
|
|
776
|
+
* Logs in to Plex with the provided auth token, then links the associated Plex account with the user's account. Users can only link external accounts to their own account.
|
|
777
|
+
*/
|
|
778
|
+
export declare const postUserByUserIdSettingsLinkedAccountsPlex: <ThrowOnError extends boolean = false>(options: Options<PostUserByUserIdSettingsLinkedAccountsPlexData, ThrowOnError>) => import("./client").RequestResult<PostUserByUserIdSettingsLinkedAccountsPlexResponses, PostUserByUserIdSettingsLinkedAccountsPlexErrors, ThrowOnError, "fields">;
|
|
779
|
+
/**
|
|
780
|
+
* Remove the linked Jellyfin account for a user
|
|
781
|
+
*
|
|
782
|
+
* Removes the linked Jellyfin account for a specific user. Requires `MANAGE_USERS` permission if editing other users.
|
|
783
|
+
*/
|
|
784
|
+
export declare const deleteUserByUserIdSettingsLinkedAccountsJellyfin: <ThrowOnError extends boolean = false>(options: Options<DeleteUserByUserIdSettingsLinkedAccountsJellyfinData, ThrowOnError>) => import("./client").RequestResult<DeleteUserByUserIdSettingsLinkedAccountsJellyfinResponses, DeleteUserByUserIdSettingsLinkedAccountsJellyfinErrors, ThrowOnError, "fields">;
|
|
785
|
+
/**
|
|
786
|
+
* Link the provided Jellyfin account to the current user
|
|
787
|
+
*
|
|
788
|
+
* Logs in to Jellyfin with the provided credentials, then links the associated Jellyfin account with the user's account. Users can only link external accounts to their own account.
|
|
789
|
+
*/
|
|
790
|
+
export declare const postUserByUserIdSettingsLinkedAccountsJellyfin: <ThrowOnError extends boolean = false>(options: Options<PostUserByUserIdSettingsLinkedAccountsJellyfinData, ThrowOnError>) => import("./client").RequestResult<PostUserByUserIdSettingsLinkedAccountsJellyfinResponses, PostUserByUserIdSettingsLinkedAccountsJellyfinErrors, ThrowOnError, "fields">;
|
|
791
|
+
/**
|
|
792
|
+
* Get notification settings for a user
|
|
793
|
+
*
|
|
794
|
+
* Returns notification settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users.
|
|
795
|
+
*/
|
|
796
|
+
export declare const getUserByUserIdSettingsNotifications: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdSettingsNotificationsData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdSettingsNotificationsResponses, unknown, ThrowOnError, "fields">;
|
|
797
|
+
/**
|
|
798
|
+
* Update notification settings for a user
|
|
799
|
+
*
|
|
800
|
+
* Updates and returns notification settings for a specific user. Requires `MANAGE_USERS` permission if editing other users.
|
|
801
|
+
*/
|
|
802
|
+
export declare const postUserByUserIdSettingsNotifications: <ThrowOnError extends boolean = false>(options: Options<PostUserByUserIdSettingsNotificationsData, ThrowOnError>) => import("./client").RequestResult<PostUserByUserIdSettingsNotificationsResponses, unknown, ThrowOnError, "fields">;
|
|
803
|
+
/**
|
|
804
|
+
* Get permission settings for a user
|
|
805
|
+
*
|
|
806
|
+
* Returns permission settings for a specific user. Requires `MANAGE_USERS` permission if viewing other users.
|
|
807
|
+
*/
|
|
808
|
+
export declare const getUserByUserIdSettingsPermissions: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdSettingsPermissionsData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdSettingsPermissionsResponses, unknown, ThrowOnError, "fields">;
|
|
809
|
+
/**
|
|
810
|
+
* Update permission settings for a user
|
|
811
|
+
*
|
|
812
|
+
* Updates and returns permission settings for a specific user. Requires `MANAGE_USERS` permission if editing other users.
|
|
813
|
+
*/
|
|
814
|
+
export declare const postUserByUserIdSettingsPermissions: <ThrowOnError extends boolean = false>(options: Options<PostUserByUserIdSettingsPermissionsData, ThrowOnError>) => import("./client").RequestResult<PostUserByUserIdSettingsPermissionsResponses, unknown, ThrowOnError, "fields">;
|
|
815
|
+
/**
|
|
816
|
+
* Get watch data
|
|
817
|
+
*
|
|
818
|
+
* Returns play count, play duration, and recently watched media.
|
|
819
|
+
*
|
|
820
|
+
* Requires the `ADMIN` permission to fetch results for other users.
|
|
821
|
+
*
|
|
822
|
+
*/
|
|
823
|
+
export declare const getUserByUserIdWatchData: <ThrowOnError extends boolean = false>(options: Options<GetUserByUserIdWatchDataData, ThrowOnError>) => import("./client").RequestResult<GetUserByUserIdWatchDataResponses, unknown, ThrowOnError, "fields">;
|
|
824
|
+
/**
|
|
825
|
+
* Search for movies, TV shows, or people
|
|
826
|
+
*
|
|
827
|
+
* Returns a list of movies, TV shows, or people a JSON object.
|
|
828
|
+
*/
|
|
829
|
+
export declare const getSearch: <ThrowOnError extends boolean = false>(options: Options<GetSearchData, ThrowOnError>) => import("./client").RequestResult<GetSearchResponses, unknown, ThrowOnError, "fields">;
|
|
830
|
+
/**
|
|
831
|
+
* Search for keywords
|
|
832
|
+
*
|
|
833
|
+
* Returns a list of TMDB keywords matching the search query
|
|
834
|
+
*/
|
|
835
|
+
export declare const getSearchKeyword: <ThrowOnError extends boolean = false>(options: Options<GetSearchKeywordData, ThrowOnError>) => import("./client").RequestResult<GetSearchKeywordResponses, unknown, ThrowOnError, "fields">;
|
|
836
|
+
/**
|
|
837
|
+
* Search for companies
|
|
838
|
+
*
|
|
839
|
+
* Returns a list of TMDB companies matching the search query. (Will not return origin country)
|
|
840
|
+
*/
|
|
841
|
+
export declare const getSearchCompany: <ThrowOnError extends boolean = false>(options: Options<GetSearchCompanyData, ThrowOnError>) => import("./client").RequestResult<GetSearchCompanyResponses, unknown, ThrowOnError, "fields">;
|
|
842
|
+
/**
|
|
843
|
+
* Discover movies
|
|
844
|
+
*
|
|
845
|
+
* Returns a list of movies in a JSON object.
|
|
846
|
+
*/
|
|
847
|
+
export declare const getDiscoverMovies: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverMoviesData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverMoviesResponses, unknown, ThrowOnError, "fields">;
|
|
848
|
+
/**
|
|
849
|
+
* Discover movies by genre
|
|
850
|
+
*
|
|
851
|
+
* Returns a list of movies based on the provided genre ID in a JSON object.
|
|
852
|
+
*/
|
|
853
|
+
export declare const getDiscoverMoviesGenreByGenreId: <ThrowOnError extends boolean = false>(options: Options<GetDiscoverMoviesGenreByGenreIdData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverMoviesGenreByGenreIdResponses, unknown, ThrowOnError, "fields">;
|
|
854
|
+
/**
|
|
855
|
+
* Discover movies by original language
|
|
856
|
+
*
|
|
857
|
+
* Returns a list of movies based on the provided ISO 639-1 language code in a JSON object.
|
|
858
|
+
*/
|
|
859
|
+
export declare const getDiscoverMoviesLanguageByLanguage: <ThrowOnError extends boolean = false>(options: Options<GetDiscoverMoviesLanguageByLanguageData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverMoviesLanguageByLanguageResponses, unknown, ThrowOnError, "fields">;
|
|
860
|
+
/**
|
|
861
|
+
* Discover movies by studio
|
|
862
|
+
*
|
|
863
|
+
* Returns a list of movies based on the provided studio ID in a JSON object.
|
|
864
|
+
*/
|
|
865
|
+
export declare const getDiscoverMoviesStudioByStudioId: <ThrowOnError extends boolean = false>(options: Options<GetDiscoverMoviesStudioByStudioIdData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverMoviesStudioByStudioIdResponses, unknown, ThrowOnError, "fields">;
|
|
866
|
+
/**
|
|
867
|
+
* Upcoming movies
|
|
868
|
+
*
|
|
869
|
+
* Returns a list of movies in a JSON object.
|
|
870
|
+
*/
|
|
871
|
+
export declare const getDiscoverMoviesUpcoming: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverMoviesUpcomingData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverMoviesUpcomingResponses, unknown, ThrowOnError, "fields">;
|
|
872
|
+
/**
|
|
873
|
+
* Discover TV shows
|
|
874
|
+
*
|
|
875
|
+
* Returns a list of TV shows in a JSON object.
|
|
876
|
+
*/
|
|
877
|
+
export declare const getDiscoverTv: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverTvData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverTvResponses, unknown, ThrowOnError, "fields">;
|
|
878
|
+
/**
|
|
879
|
+
* Discover TV shows by original language
|
|
880
|
+
*
|
|
881
|
+
* Returns a list of TV shows based on the provided ISO 639-1 language code in a JSON object.
|
|
882
|
+
*/
|
|
883
|
+
export declare const getDiscoverTvLanguageByLanguage: <ThrowOnError extends boolean = false>(options: Options<GetDiscoverTvLanguageByLanguageData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverTvLanguageByLanguageResponses, unknown, ThrowOnError, "fields">;
|
|
884
|
+
/**
|
|
885
|
+
* Discover TV shows by genre
|
|
886
|
+
*
|
|
887
|
+
* Returns a list of TV shows based on the provided genre ID in a JSON object.
|
|
888
|
+
*/
|
|
889
|
+
export declare const getDiscoverTvGenreByGenreId: <ThrowOnError extends boolean = false>(options: Options<GetDiscoverTvGenreByGenreIdData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverTvGenreByGenreIdResponses, unknown, ThrowOnError, "fields">;
|
|
890
|
+
/**
|
|
891
|
+
* Discover TV shows by network
|
|
892
|
+
*
|
|
893
|
+
* Returns a list of TV shows based on the provided network ID in a JSON object.
|
|
894
|
+
*/
|
|
895
|
+
export declare const getDiscoverTvNetworkByNetworkId: <ThrowOnError extends boolean = false>(options: Options<GetDiscoverTvNetworkByNetworkIdData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverTvNetworkByNetworkIdResponses, unknown, ThrowOnError, "fields">;
|
|
896
|
+
/**
|
|
897
|
+
* Discover Upcoming TV shows
|
|
898
|
+
*
|
|
899
|
+
* Returns a list of upcoming TV shows in a JSON object.
|
|
900
|
+
*/
|
|
901
|
+
export declare const getDiscoverTvUpcoming: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverTvUpcomingData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverTvUpcomingResponses, unknown, ThrowOnError, "fields">;
|
|
902
|
+
/**
|
|
903
|
+
* Trending movies and TV
|
|
904
|
+
*
|
|
905
|
+
* Returns a list of movies and TV shows in a JSON object.
|
|
906
|
+
*/
|
|
907
|
+
export declare const getDiscoverTrending: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverTrendingData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverTrendingResponses, unknown, ThrowOnError, "fields">;
|
|
908
|
+
/**
|
|
909
|
+
* Get movies from keyword
|
|
910
|
+
*
|
|
911
|
+
* Returns list of movies based on the provided keyword ID a JSON object.
|
|
912
|
+
*/
|
|
913
|
+
export declare const getDiscoverKeywordByKeywordIdMovies: <ThrowOnError extends boolean = false>(options: Options<GetDiscoverKeywordByKeywordIdMoviesData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverKeywordByKeywordIdMoviesResponses, unknown, ThrowOnError, "fields">;
|
|
914
|
+
/**
|
|
915
|
+
* Get genre slider data for movies
|
|
916
|
+
*
|
|
917
|
+
* Returns a list of genres with backdrops attached
|
|
918
|
+
*/
|
|
919
|
+
export declare const getDiscoverGenresliderMovie: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverGenresliderMovieData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverGenresliderMovieResponses, unknown, ThrowOnError, "fields">;
|
|
920
|
+
/**
|
|
921
|
+
* Get genre slider data for TV series
|
|
922
|
+
*
|
|
923
|
+
* Returns a list of genres with backdrops attached
|
|
924
|
+
*/
|
|
925
|
+
export declare const getDiscoverGenresliderTv: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverGenresliderTvData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverGenresliderTvResponses, unknown, ThrowOnError, "fields">;
|
|
926
|
+
/**
|
|
927
|
+
* Get the Plex watchlist.
|
|
928
|
+
*/
|
|
929
|
+
export declare const getDiscoverWatchlist: <ThrowOnError extends boolean = false>(options?: Options<GetDiscoverWatchlistData, ThrowOnError>) => import("./client").RequestResult<GetDiscoverWatchlistResponses, unknown, ThrowOnError, "fields">;
|
|
930
|
+
/**
|
|
931
|
+
* Get all requests
|
|
932
|
+
*
|
|
933
|
+
* Returns all requests if the user has the `ADMIN` or `MANAGE_REQUESTS` permissions. Otherwise, only the logged-in user's requests are returned.
|
|
934
|
+
*
|
|
935
|
+
* If the `requestedBy` parameter is specified, only requests from that particular user ID will be returned.
|
|
936
|
+
*
|
|
937
|
+
*/
|
|
938
|
+
export declare const getRequest: <ThrowOnError extends boolean = false>(options?: Options<GetRequestData, ThrowOnError>) => import("./client").RequestResult<GetRequestResponses, unknown, ThrowOnError, "fields">;
|
|
939
|
+
/**
|
|
940
|
+
* Create new request
|
|
941
|
+
*
|
|
942
|
+
* Creates a new request with the provided media ID and type. The `REQUEST` permission is required.
|
|
943
|
+
*
|
|
944
|
+
* If the user has the `ADMIN` or `AUTO_APPROVE` permissions, their request will be auomatically approved.
|
|
945
|
+
*
|
|
946
|
+
*/
|
|
947
|
+
export declare const postRequest: <ThrowOnError extends boolean = false>(options: Options<PostRequestData, ThrowOnError>) => import("./client").RequestResult<PostRequestResponses, unknown, ThrowOnError, "fields">;
|
|
948
|
+
/**
|
|
949
|
+
* Gets request counts
|
|
950
|
+
*
|
|
951
|
+
* Returns the number of requests by status including pending, approved, available, and completed requests.
|
|
952
|
+
*
|
|
953
|
+
*/
|
|
954
|
+
export declare const getRequestCount: <ThrowOnError extends boolean = false>(options?: Options<GetRequestCountData, ThrowOnError>) => import("./client").RequestResult<GetRequestCountResponses, unknown, ThrowOnError, "fields">;
|
|
955
|
+
/**
|
|
956
|
+
* Delete request
|
|
957
|
+
*
|
|
958
|
+
* Removes a request. If the user has the `MANAGE_REQUESTS` permission, any request can be removed. Otherwise, only pending requests can be removed.
|
|
959
|
+
*/
|
|
960
|
+
export declare const deleteRequestByRequestId: <ThrowOnError extends boolean = false>(options: Options<DeleteRequestByRequestIdData, ThrowOnError>) => import("./client").RequestResult<DeleteRequestByRequestIdResponses, unknown, ThrowOnError, "fields">;
|
|
961
|
+
/**
|
|
962
|
+
* Get MediaRequest
|
|
963
|
+
*
|
|
964
|
+
* Returns a specific MediaRequest in a JSON object.
|
|
965
|
+
*/
|
|
966
|
+
export declare const getRequestByRequestId: <ThrowOnError extends boolean = false>(options: Options<GetRequestByRequestIdData, ThrowOnError>) => import("./client").RequestResult<GetRequestByRequestIdResponses, unknown, ThrowOnError, "fields">;
|
|
967
|
+
/**
|
|
968
|
+
* Update MediaRequest
|
|
969
|
+
*
|
|
970
|
+
* Updates a specific media request and returns the request in a JSON object. Requires the `MANAGE_REQUESTS` permission.
|
|
971
|
+
*/
|
|
972
|
+
export declare const putRequestByRequestId: <ThrowOnError extends boolean = false>(options: Options<PutRequestByRequestIdData, ThrowOnError>) => import("./client").RequestResult<PutRequestByRequestIdResponses, unknown, ThrowOnError, "fields">;
|
|
973
|
+
/**
|
|
974
|
+
* Retry failed request
|
|
975
|
+
*
|
|
976
|
+
* Retries a request by resending requests to Sonarr or Radarr.
|
|
977
|
+
*
|
|
978
|
+
* Requires the `MANAGE_REQUESTS` permission or `ADMIN`.
|
|
979
|
+
*
|
|
980
|
+
*/
|
|
981
|
+
export declare const postRequestByRequestIdRetry: <ThrowOnError extends boolean = false>(options: Options<PostRequestByRequestIdRetryData, ThrowOnError>) => import("./client").RequestResult<PostRequestByRequestIdRetryResponses, unknown, ThrowOnError, "fields">;
|
|
982
|
+
/**
|
|
983
|
+
* Update a request's status
|
|
984
|
+
*
|
|
985
|
+
* Updates a request's status to approved or declined. Also returns the request in a JSON object.
|
|
986
|
+
*
|
|
987
|
+
* Requires the `MANAGE_REQUESTS` permission or `ADMIN`.
|
|
988
|
+
*
|
|
989
|
+
*/
|
|
990
|
+
export declare const postRequestByRequestIdByStatus: <ThrowOnError extends boolean = false>(options: Options<PostRequestByRequestIdByStatusData, ThrowOnError>) => import("./client").RequestResult<PostRequestByRequestIdByStatusResponses, unknown, ThrowOnError, "fields">;
|
|
991
|
+
/**
|
|
992
|
+
* Get movie details
|
|
993
|
+
*
|
|
994
|
+
* Returns full movie details in a JSON object.
|
|
995
|
+
*/
|
|
996
|
+
export declare const getMovieByMovieId: <ThrowOnError extends boolean = false>(options: Options<GetMovieByMovieIdData, ThrowOnError>) => import("./client").RequestResult<GetMovieByMovieIdResponses, unknown, ThrowOnError, "fields">;
|
|
997
|
+
/**
|
|
998
|
+
* Get recommended movies
|
|
999
|
+
*
|
|
1000
|
+
* Returns list of recommended movies based on provided movie ID in a JSON object.
|
|
1001
|
+
*/
|
|
1002
|
+
export declare const getMovieByMovieIdRecommendations: <ThrowOnError extends boolean = false>(options: Options<GetMovieByMovieIdRecommendationsData, ThrowOnError>) => import("./client").RequestResult<GetMovieByMovieIdRecommendationsResponses, unknown, ThrowOnError, "fields">;
|
|
1003
|
+
/**
|
|
1004
|
+
* Get similar movies
|
|
1005
|
+
*
|
|
1006
|
+
* Returns list of similar movies based on the provided movieId in a JSON object.
|
|
1007
|
+
*/
|
|
1008
|
+
export declare const getMovieByMovieIdSimilar: <ThrowOnError extends boolean = false>(options: Options<GetMovieByMovieIdSimilarData, ThrowOnError>) => import("./client").RequestResult<GetMovieByMovieIdSimilarResponses, unknown, ThrowOnError, "fields">;
|
|
1009
|
+
/**
|
|
1010
|
+
* Get movie ratings
|
|
1011
|
+
*
|
|
1012
|
+
* Returns ratings based on the provided movieId in a JSON object.
|
|
1013
|
+
*/
|
|
1014
|
+
export declare const getMovieByMovieIdRatings: <ThrowOnError extends boolean = false>(options: Options<GetMovieByMovieIdRatingsData, ThrowOnError>) => import("./client").RequestResult<GetMovieByMovieIdRatingsResponses, unknown, ThrowOnError, "fields">;
|
|
1015
|
+
/**
|
|
1016
|
+
* Get RT and IMDB movie ratings combined
|
|
1017
|
+
*
|
|
1018
|
+
* Returns ratings from RottenTomatoes and IMDB based on the provided movieId in a JSON object.
|
|
1019
|
+
*/
|
|
1020
|
+
export declare const getMovieByMovieIdRatingscombined: <ThrowOnError extends boolean = false>(options: Options<GetMovieByMovieIdRatingscombinedData, ThrowOnError>) => import("./client").RequestResult<GetMovieByMovieIdRatingscombinedResponses, unknown, ThrowOnError, "fields">;
|
|
1021
|
+
/**
|
|
1022
|
+
* Get TV details
|
|
1023
|
+
*
|
|
1024
|
+
* Returns full TV details in a JSON object.
|
|
1025
|
+
*/
|
|
1026
|
+
export declare const getTvByTvId: <ThrowOnError extends boolean = false>(options: Options<GetTvByTvIdData, ThrowOnError>) => import("./client").RequestResult<GetTvByTvIdResponses, unknown, ThrowOnError, "fields">;
|
|
1027
|
+
/**
|
|
1028
|
+
* Get season details and episode list
|
|
1029
|
+
*
|
|
1030
|
+
* Returns season details with a list of episodes in a JSON object.
|
|
1031
|
+
*/
|
|
1032
|
+
export declare const getTvByTvIdSeasonBySeasonNumber: <ThrowOnError extends boolean = false>(options: Options<GetTvByTvIdSeasonBySeasonNumberData, ThrowOnError>) => import("./client").RequestResult<GetTvByTvIdSeasonBySeasonNumberResponses, unknown, ThrowOnError, "fields">;
|
|
1033
|
+
/**
|
|
1034
|
+
* Get recommended TV series
|
|
1035
|
+
*
|
|
1036
|
+
* Returns list of recommended TV series based on the provided tvId in a JSON object.
|
|
1037
|
+
*/
|
|
1038
|
+
export declare const getTvByTvIdRecommendations: <ThrowOnError extends boolean = false>(options: Options<GetTvByTvIdRecommendationsData, ThrowOnError>) => import("./client").RequestResult<GetTvByTvIdRecommendationsResponses, unknown, ThrowOnError, "fields">;
|
|
1039
|
+
/**
|
|
1040
|
+
* Get similar TV series
|
|
1041
|
+
*
|
|
1042
|
+
* Returns list of similar TV series based on the provided tvId in a JSON object.
|
|
1043
|
+
*/
|
|
1044
|
+
export declare const getTvByTvIdSimilar: <ThrowOnError extends boolean = false>(options: Options<GetTvByTvIdSimilarData, ThrowOnError>) => import("./client").RequestResult<GetTvByTvIdSimilarResponses, unknown, ThrowOnError, "fields">;
|
|
1045
|
+
/**
|
|
1046
|
+
* Get TV ratings
|
|
1047
|
+
*
|
|
1048
|
+
* Returns ratings based on provided tvId in a JSON object.
|
|
1049
|
+
*/
|
|
1050
|
+
export declare const getTvByTvIdRatings: <ThrowOnError extends boolean = false>(options: Options<GetTvByTvIdRatingsData, ThrowOnError>) => import("./client").RequestResult<GetTvByTvIdRatingsResponses, unknown, ThrowOnError, "fields">;
|
|
1051
|
+
/**
|
|
1052
|
+
* Get person details
|
|
1053
|
+
*
|
|
1054
|
+
* Returns person details based on provided personId in a JSON object.
|
|
1055
|
+
*/
|
|
1056
|
+
export declare const getPersonByPersonId: <ThrowOnError extends boolean = false>(options: Options<GetPersonByPersonIdData, ThrowOnError>) => import("./client").RequestResult<GetPersonByPersonIdResponses, unknown, ThrowOnError, "fields">;
|
|
1057
|
+
/**
|
|
1058
|
+
* Get combined credits
|
|
1059
|
+
*
|
|
1060
|
+
* Returns the person's combined credits based on the provided personId in a JSON object.
|
|
1061
|
+
*/
|
|
1062
|
+
export declare const getPersonByPersonIdCombinedCredits: <ThrowOnError extends boolean = false>(options: Options<GetPersonByPersonIdCombinedCreditsData, ThrowOnError>) => import("./client").RequestResult<GetPersonByPersonIdCombinedCreditsResponses, unknown, ThrowOnError, "fields">;
|
|
1063
|
+
/**
|
|
1064
|
+
* Get media
|
|
1065
|
+
*
|
|
1066
|
+
* Returns all media (can be filtered and limited) in a JSON object.
|
|
1067
|
+
*/
|
|
1068
|
+
export declare const getMedia: <ThrowOnError extends boolean = false>(options?: Options<GetMediaData, ThrowOnError>) => import("./client").RequestResult<GetMediaResponses, unknown, ThrowOnError, "fields">;
|
|
1069
|
+
/**
|
|
1070
|
+
* Delete media item
|
|
1071
|
+
*
|
|
1072
|
+
* Removes a media item. The `MANAGE_REQUESTS` permission is required to perform this action.
|
|
1073
|
+
*/
|
|
1074
|
+
export declare const deleteMediaByMediaId: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaByMediaIdData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaByMediaIdResponses, unknown, ThrowOnError, "fields">;
|
|
1075
|
+
/**
|
|
1076
|
+
* Delete media file
|
|
1077
|
+
*
|
|
1078
|
+
* Removes a media file from radarr/sonarr. The `ADMIN` permission is required to perform this action.
|
|
1079
|
+
*/
|
|
1080
|
+
export declare const deleteMediaByMediaIdFile: <ThrowOnError extends boolean = false>(options: Options<DeleteMediaByMediaIdFileData, ThrowOnError>) => import("./client").RequestResult<DeleteMediaByMediaIdFileResponses, unknown, ThrowOnError, "fields">;
|
|
1081
|
+
/**
|
|
1082
|
+
* Update media status
|
|
1083
|
+
*
|
|
1084
|
+
* Updates a media item's status and returns the media in JSON format
|
|
1085
|
+
*/
|
|
1086
|
+
export declare const postMediaByMediaIdByStatus: <ThrowOnError extends boolean = false>(options: Options<PostMediaByMediaIdByStatusData, ThrowOnError>) => import("./client").RequestResult<PostMediaByMediaIdByStatusResponses, unknown, ThrowOnError, "fields">;
|
|
1087
|
+
/**
|
|
1088
|
+
* Get watch data
|
|
1089
|
+
*
|
|
1090
|
+
* Returns play count, play duration, and users who have watched the media.
|
|
1091
|
+
*
|
|
1092
|
+
* Requires the `ADMIN` permission.
|
|
1093
|
+
*
|
|
1094
|
+
*/
|
|
1095
|
+
export declare const getMediaByMediaIdWatchData: <ThrowOnError extends boolean = false>(options: Options<GetMediaByMediaIdWatchDataData, ThrowOnError>) => import("./client").RequestResult<GetMediaByMediaIdWatchDataResponses, unknown, ThrowOnError, "fields">;
|
|
1096
|
+
/**
|
|
1097
|
+
* Get collection details
|
|
1098
|
+
*
|
|
1099
|
+
* Returns full collection details in a JSON object.
|
|
1100
|
+
*/
|
|
1101
|
+
export declare const getCollectionByCollectionId: <ThrowOnError extends boolean = false>(options: Options<GetCollectionByCollectionIdData, ThrowOnError>) => import("./client").RequestResult<GetCollectionByCollectionIdResponses, unknown, ThrowOnError, "fields">;
|
|
1102
|
+
/**
|
|
1103
|
+
* Get non-sensitive Radarr server list
|
|
1104
|
+
*
|
|
1105
|
+
* Returns a list of Radarr server IDs and names in a JSON object.
|
|
1106
|
+
*/
|
|
1107
|
+
export declare const getServiceRadarr: <ThrowOnError extends boolean = false>(options?: Options<GetServiceRadarrData, ThrowOnError>) => import("./client").RequestResult<GetServiceRadarrResponses, unknown, ThrowOnError, "fields">;
|
|
1108
|
+
/**
|
|
1109
|
+
* Get Radarr server quality profiles and root folders
|
|
1110
|
+
*
|
|
1111
|
+
* Returns a Radarr server's quality profile and root folder details in a JSON object.
|
|
1112
|
+
*/
|
|
1113
|
+
export declare const getServiceRadarrByRadarrId: <ThrowOnError extends boolean = false>(options: Options<GetServiceRadarrByRadarrIdData, ThrowOnError>) => import("./client").RequestResult<GetServiceRadarrByRadarrIdResponses, unknown, ThrowOnError, "fields">;
|
|
1114
|
+
/**
|
|
1115
|
+
* Get non-sensitive Sonarr server list
|
|
1116
|
+
*
|
|
1117
|
+
* Returns a list of Sonarr server IDs and names in a JSON object.
|
|
1118
|
+
*/
|
|
1119
|
+
export declare const getServiceSonarr: <ThrowOnError extends boolean = false>(options?: Options<GetServiceSonarrData, ThrowOnError>) => import("./client").RequestResult<GetServiceSonarrResponses, unknown, ThrowOnError, "fields">;
|
|
1120
|
+
/**
|
|
1121
|
+
* Get Sonarr server quality profiles and root folders
|
|
1122
|
+
*
|
|
1123
|
+
* Returns a Sonarr server's quality profile and root folder details in a JSON object.
|
|
1124
|
+
*/
|
|
1125
|
+
export declare const getServiceSonarrBySonarrId: <ThrowOnError extends boolean = false>(options: Options<GetServiceSonarrBySonarrIdData, ThrowOnError>) => import("./client").RequestResult<GetServiceSonarrBySonarrIdResponses, unknown, ThrowOnError, "fields">;
|
|
1126
|
+
/**
|
|
1127
|
+
* Get series from Sonarr
|
|
1128
|
+
*
|
|
1129
|
+
* Returns a list of series returned by searching for the name in Sonarr.
|
|
1130
|
+
*/
|
|
1131
|
+
export declare const getServiceSonarrLookupByTmdbId: <ThrowOnError extends boolean = false>(options: Options<GetServiceSonarrLookupByTmdbIdData, ThrowOnError>) => import("./client").RequestResult<GetServiceSonarrLookupByTmdbIdResponses, unknown, ThrowOnError, "fields">;
|
|
1132
|
+
/**
|
|
1133
|
+
* Regions supported by TMDB
|
|
1134
|
+
*
|
|
1135
|
+
* Returns a list of regions in a JSON object.
|
|
1136
|
+
*/
|
|
1137
|
+
export declare const getRegions: <ThrowOnError extends boolean = false>(options?: Options<GetRegionsData, ThrowOnError>) => import("./client").RequestResult<GetRegionsResponses, unknown, ThrowOnError, "fields">;
|
|
1138
|
+
/**
|
|
1139
|
+
* Languages supported by TMDB
|
|
1140
|
+
*
|
|
1141
|
+
* Returns a list of languages in a JSON object.
|
|
1142
|
+
*/
|
|
1143
|
+
export declare const getLanguages: <ThrowOnError extends boolean = false>(options?: Options<GetLanguagesData, ThrowOnError>) => import("./client").RequestResult<GetLanguagesResponses, unknown, ThrowOnError, "fields">;
|
|
1144
|
+
/**
|
|
1145
|
+
* Get movie studio details
|
|
1146
|
+
*
|
|
1147
|
+
* Returns movie studio details in a JSON object.
|
|
1148
|
+
*/
|
|
1149
|
+
export declare const getStudioByStudioId: <ThrowOnError extends boolean = false>(options: Options<GetStudioByStudioIdData, ThrowOnError>) => import("./client").RequestResult<GetStudioByStudioIdResponses, unknown, ThrowOnError, "fields">;
|
|
1150
|
+
/**
|
|
1151
|
+
* Get TV network details
|
|
1152
|
+
*
|
|
1153
|
+
* Returns TV network details in a JSON object.
|
|
1154
|
+
*/
|
|
1155
|
+
export declare const getNetworkByNetworkId: <ThrowOnError extends boolean = false>(options: Options<GetNetworkByNetworkIdData, ThrowOnError>) => import("./client").RequestResult<GetNetworkByNetworkIdResponses, unknown, ThrowOnError, "fields">;
|
|
1156
|
+
/**
|
|
1157
|
+
* Get list of official TMDB movie genres
|
|
1158
|
+
*
|
|
1159
|
+
* Returns a list of genres in a JSON array.
|
|
1160
|
+
*/
|
|
1161
|
+
export declare const getGenresMovie: <ThrowOnError extends boolean = false>(options?: Options<GetGenresMovieData, ThrowOnError>) => import("./client").RequestResult<GetGenresMovieResponses, unknown, ThrowOnError, "fields">;
|
|
1162
|
+
/**
|
|
1163
|
+
* Get list of official TMDB movie genres
|
|
1164
|
+
*
|
|
1165
|
+
* Returns a list of genres in a JSON array.
|
|
1166
|
+
*/
|
|
1167
|
+
export declare const getGenresTv: <ThrowOnError extends boolean = false>(options?: Options<GetGenresTvData, ThrowOnError>) => import("./client").RequestResult<GetGenresTvResponses, unknown, ThrowOnError, "fields">;
|
|
1168
|
+
/**
|
|
1169
|
+
* Get backdrops of trending items
|
|
1170
|
+
*
|
|
1171
|
+
* Returns a list of backdrop image paths in a JSON array.
|
|
1172
|
+
*/
|
|
1173
|
+
export declare const getBackdrops: <ThrowOnError extends boolean = false>(options?: Options<GetBackdropsData, ThrowOnError>) => import("./client").RequestResult<GetBackdropsResponses, unknown, ThrowOnError, "fields">;
|
|
1174
|
+
/**
|
|
1175
|
+
* Get all issues
|
|
1176
|
+
*
|
|
1177
|
+
* Returns a list of issues in JSON format.
|
|
1178
|
+
*
|
|
1179
|
+
*/
|
|
1180
|
+
export declare const getIssue: <ThrowOnError extends boolean = false>(options?: Options<GetIssueData, ThrowOnError>) => import("./client").RequestResult<GetIssueResponses, unknown, ThrowOnError, "fields">;
|
|
1181
|
+
/**
|
|
1182
|
+
* Create new issue
|
|
1183
|
+
*
|
|
1184
|
+
* Creates a new issue
|
|
1185
|
+
*
|
|
1186
|
+
*/
|
|
1187
|
+
export declare const postIssue: <ThrowOnError extends boolean = false>(options: Options<PostIssueData, ThrowOnError>) => import("./client").RequestResult<PostIssueResponses, unknown, ThrowOnError, "fields">;
|
|
1188
|
+
/**
|
|
1189
|
+
* Gets issue counts
|
|
1190
|
+
*
|
|
1191
|
+
* Returns the number of open and closed issues, as well as the number of issues of each type.
|
|
1192
|
+
*
|
|
1193
|
+
*/
|
|
1194
|
+
export declare const getIssueCount: <ThrowOnError extends boolean = false>(options?: Options<GetIssueCountData, ThrowOnError>) => import("./client").RequestResult<GetIssueCountResponses, unknown, ThrowOnError, "fields">;
|
|
1195
|
+
/**
|
|
1196
|
+
* Delete issue
|
|
1197
|
+
*
|
|
1198
|
+
* Removes an issue. If the user has the `MANAGE_ISSUES` permission, any issue can be removed. Otherwise, only a users own issues can be removed.
|
|
1199
|
+
*/
|
|
1200
|
+
export declare const deleteIssueByIssueId: <ThrowOnError extends boolean = false>(options: Options<DeleteIssueByIssueIdData, ThrowOnError>) => import("./client").RequestResult<DeleteIssueByIssueIdResponses, unknown, ThrowOnError, "fields">;
|
|
1201
|
+
/**
|
|
1202
|
+
* Get issue
|
|
1203
|
+
*
|
|
1204
|
+
* Returns a single issue in JSON format.
|
|
1205
|
+
*
|
|
1206
|
+
*/
|
|
1207
|
+
export declare const getIssueByIssueId: <ThrowOnError extends boolean = false>(options: Options<GetIssueByIssueIdData, ThrowOnError>) => import("./client").RequestResult<GetIssueByIssueIdResponses, unknown, ThrowOnError, "fields">;
|
|
1208
|
+
/**
|
|
1209
|
+
* Create a comment
|
|
1210
|
+
*
|
|
1211
|
+
* Creates a comment and returns associated issue in JSON format.
|
|
1212
|
+
*
|
|
1213
|
+
*/
|
|
1214
|
+
export declare const postIssueByIssueIdComment: <ThrowOnError extends boolean = false>(options: Options<PostIssueByIssueIdCommentData, ThrowOnError>) => import("./client").RequestResult<PostIssueByIssueIdCommentResponses, unknown, ThrowOnError, "fields">;
|
|
1215
|
+
/**
|
|
1216
|
+
* Delete issue comment
|
|
1217
|
+
*
|
|
1218
|
+
* Deletes an issue comment. Only users with `MANAGE_ISSUES` or the user who created the comment can perform this action.
|
|
1219
|
+
*
|
|
1220
|
+
*/
|
|
1221
|
+
export declare const deleteIssueCommentByCommentId: <ThrowOnError extends boolean = false>(options: Options<DeleteIssueCommentByCommentIdData, ThrowOnError>) => import("./client").RequestResult<DeleteIssueCommentByCommentIdResponses, unknown, ThrowOnError, "fields">;
|
|
1222
|
+
/**
|
|
1223
|
+
* Get issue comment
|
|
1224
|
+
*
|
|
1225
|
+
* Returns a single issue comment in JSON format.
|
|
1226
|
+
*
|
|
1227
|
+
*/
|
|
1228
|
+
export declare const getIssueCommentByCommentId: <ThrowOnError extends boolean = false>(options: Options<GetIssueCommentByCommentIdData, ThrowOnError>) => import("./client").RequestResult<GetIssueCommentByCommentIdResponses, unknown, ThrowOnError, "fields">;
|
|
1229
|
+
/**
|
|
1230
|
+
* Update issue comment
|
|
1231
|
+
*
|
|
1232
|
+
* Updates and returns a single issue comment in JSON format.
|
|
1233
|
+
*
|
|
1234
|
+
*/
|
|
1235
|
+
export declare const putIssueCommentByCommentId: <ThrowOnError extends boolean = false>(options: Options<PutIssueCommentByCommentIdData, ThrowOnError>) => import("./client").RequestResult<PutIssueCommentByCommentIdResponses, unknown, ThrowOnError, "fields">;
|
|
1236
|
+
/**
|
|
1237
|
+
* Update an issue's status
|
|
1238
|
+
*
|
|
1239
|
+
* Updates an issue's status to approved or declined. Also returns the issue in a JSON object.
|
|
1240
|
+
*
|
|
1241
|
+
* Requires the `MANAGE_ISSUES` permission or `ADMIN`.
|
|
1242
|
+
*
|
|
1243
|
+
*/
|
|
1244
|
+
export declare const postIssueByIssueIdByStatus: <ThrowOnError extends boolean = false>(options: Options<PostIssueByIssueIdByStatusData, ThrowOnError>) => import("./client").RequestResult<PostIssueByIssueIdByStatusResponses, unknown, ThrowOnError, "fields">;
|
|
1245
|
+
/**
|
|
1246
|
+
* Get keyword
|
|
1247
|
+
*
|
|
1248
|
+
* Returns a single keyword in JSON format.
|
|
1249
|
+
*
|
|
1250
|
+
*/
|
|
1251
|
+
export declare const getKeywordByKeywordId: <ThrowOnError extends boolean = false>(options: Options<GetKeywordByKeywordIdData, ThrowOnError>) => import("./client").RequestResult<GetKeywordByKeywordIdResponses, GetKeywordByKeywordIdErrors, ThrowOnError, "fields">;
|
|
1252
|
+
/**
|
|
1253
|
+
* Get watch provider regions
|
|
1254
|
+
*
|
|
1255
|
+
* Returns a list of all available watch provider regions.
|
|
1256
|
+
*
|
|
1257
|
+
*/
|
|
1258
|
+
export declare const getWatchprovidersRegions: <ThrowOnError extends boolean = false>(options?: Options<GetWatchprovidersRegionsData, ThrowOnError>) => import("./client").RequestResult<GetWatchprovidersRegionsResponses, unknown, ThrowOnError, "fields">;
|
|
1259
|
+
/**
|
|
1260
|
+
* Get watch provider movies
|
|
1261
|
+
*
|
|
1262
|
+
* Returns a list of all available watch providers for movies.
|
|
1263
|
+
*
|
|
1264
|
+
*/
|
|
1265
|
+
export declare const getWatchprovidersMovies: <ThrowOnError extends boolean = false>(options: Options<GetWatchprovidersMoviesData, ThrowOnError>) => import("./client").RequestResult<GetWatchprovidersMoviesResponses, unknown, ThrowOnError, "fields">;
|
|
1266
|
+
/**
|
|
1267
|
+
* Get watch provider series
|
|
1268
|
+
*
|
|
1269
|
+
* Returns a list of all available watch providers for series.
|
|
1270
|
+
*
|
|
1271
|
+
*/
|
|
1272
|
+
export declare const getWatchprovidersTv: <ThrowOnError extends boolean = false>(options: Options<GetWatchprovidersTvData, ThrowOnError>) => import("./client").RequestResult<GetWatchprovidersTvResponses, unknown, ThrowOnError, "fields">;
|
|
1273
|
+
/**
|
|
1274
|
+
* Get movie certifications
|
|
1275
|
+
*
|
|
1276
|
+
* Returns list of movie certifications from TMDB.
|
|
1277
|
+
*/
|
|
1278
|
+
export declare const getCertificationsMovie: <ThrowOnError extends boolean = false>(options?: Options<GetCertificationsMovieData, ThrowOnError>) => import("./client").RequestResult<GetCertificationsMovieResponses, GetCertificationsMovieErrors, ThrowOnError, "fields">;
|
|
1279
|
+
/**
|
|
1280
|
+
* Get TV certifications
|
|
1281
|
+
*
|
|
1282
|
+
* Returns list of TV show certifications from TMDB.
|
|
1283
|
+
*/
|
|
1284
|
+
export declare const getCertificationsTv: <ThrowOnError extends boolean = false>(options?: Options<GetCertificationsTvData, ThrowOnError>) => import("./client").RequestResult<GetCertificationsTvResponses, GetCertificationsTvErrors, ThrowOnError, "fields">;
|
|
1285
|
+
/**
|
|
1286
|
+
* Get override rules
|
|
1287
|
+
*
|
|
1288
|
+
* Returns a list of all override rules with their conditions and settings
|
|
1289
|
+
*/
|
|
1290
|
+
export declare const getOverrideRule: <ThrowOnError extends boolean = false>(options?: Options<GetOverrideRuleData, ThrowOnError>) => import("./client").RequestResult<GetOverrideRuleResponses, unknown, ThrowOnError, "fields">;
|
|
1291
|
+
/**
|
|
1292
|
+
* Create override rule
|
|
1293
|
+
*
|
|
1294
|
+
* Creates a new Override Rule from the request body.
|
|
1295
|
+
*/
|
|
1296
|
+
export declare const postOverrideRule: <ThrowOnError extends boolean = false>(options?: Options<PostOverrideRuleData, ThrowOnError>) => import("./client").RequestResult<PostOverrideRuleResponses, unknown, ThrowOnError, "fields">;
|
|
1297
|
+
/**
|
|
1298
|
+
* Delete override rule by ID
|
|
1299
|
+
*
|
|
1300
|
+
* Deletes the override rule with the provided ruleId.
|
|
1301
|
+
*/
|
|
1302
|
+
export declare const deleteOverrideRuleByRuleId: <ThrowOnError extends boolean = false>(options: Options<DeleteOverrideRuleByRuleIdData, ThrowOnError>) => import("./client").RequestResult<DeleteOverrideRuleByRuleIdResponses, unknown, ThrowOnError, "fields">;
|
|
1303
|
+
/**
|
|
1304
|
+
* Update override rule
|
|
1305
|
+
*
|
|
1306
|
+
* Updates an Override Rule from the request body.
|
|
1307
|
+
*/
|
|
1308
|
+
export declare const putOverrideRuleByRuleId: <ThrowOnError extends boolean = false>(options: Options<PutOverrideRuleByRuleIdData, ThrowOnError>) => import("./client").RequestResult<PutOverrideRuleByRuleIdResponses, unknown, ThrowOnError, "fields">;
|
|
1309
|
+
//# sourceMappingURL=sdk.gen.d.ts.map
|