LukeParke/plexjs
1
0
Fork 0
mirror of https://github.com/LukeHagar/plexjs.git synced 2025-12-06 12:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Automated build 'Merge branch 'main' of https://github.com/LukeHagar/plex-api-spec' typescript-axios sdk: 4695449944

Browse Source
This commit is contained in:
GitHub Action Bot
2023-04-14 01:37:25 +00:00
parent 747686ef12
commit b57c6be086
4 changed files with 175 additions and 217 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
dist/sdk-output/api.d.ts vendored
View File

@@ -4546,7 +4546,7 @@ export declare const SecurityApiAxiosParamCreator: (configuration?: Configuratio
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation: (source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
getSourceConnectionInformation: (source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* This endpoint provides the caller with a temporary token with the same access level as the caller\'s token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
* @summary Get a Transient Token.
@@ -4583,7 +4583,7 @@ export declare const SecurityApiFp: (configuration?: Configuration) => {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
getSourceConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* This endpoint provides the caller with a temporary token with the same access level as the caller\'s token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
* @summary Get a Transient Token.
@@ -4620,7 +4620,7 @@ export declare const SecurityApiFactory: (configuration?: Configuration, basePat
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void>;
getSourceConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void>;
/**
* This endpoint provides the caller with a temporary token with the same access level as the caller\'s token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
* @summary Get a Transient Token.
@@ -4639,57 +4639,57 @@ export declare const SecurityApiFactory: (configuration?: Configuration, basePat
getTransientToken(type: any, scope: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void>;
};
/**
* Request parameters for getConnectionInformation operation in SecurityApi.
* Request parameters for getSourceConnectionInformation operation in SecurityApi.
* @export
* @interface SecurityApiGetConnectionInformationRequest
* @interface SecurityApiGetSourceConnectionInformationRequest
*/
export interface SecurityApiGetConnectionInformationRequest {
export interface SecurityApiGetSourceConnectionInformationRequest {
/**
* The source identifier with an included prefix.
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly source: any;
/**
* Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexDeviceName?: any;
/**
* The type of device your application is running on Device name and or model number, eg &#x60;iPhone3,2&#x60;, &#x60;Motorola XOOM™&#x60;, &#x60;LG5200TV&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexDevice?: any;
/**
* Operating system version, eg &#x60;4.3.1&#x60;, &#x60;10.6.7&#x60;, &#x60;3.2&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexPlatformVersion?: any;
/**
* Platform name, eg &#x60;Web&#x60;, &#x60;iOS&#x60;, &#x60;MacOSX&#x60;, &#x60;Android&#x60;, &#x60;LG&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexPlatform?: any;
/**
* Plex application name, eg &#x60;Laika&#x60;, &#x60;Plex Media Server&#x60;, &#x60;Media Link&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexProduct?: any;
/**
* One or more of &#x60;[player, controller, server]&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexProvides?: any;
/**
* Your application version number
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexVersion?: any;
}
@@ -4764,12 +4764,12 @@ export declare class SecurityApi extends BaseAPI {
/**
* If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. Note: requires Plex Media Server >= 1.15.4.
* @summary Get Source Connection Information
* @param {SecurityApiGetConnectionInformationRequest} requestParameters Request parameters.
* @param {SecurityApiGetSourceConnectionInformationRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
* @memberof SecurityApi
*/
getConnectionInformation(requestParameters: SecurityApiGetConnectionInformationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
getSourceConnectionInformation(requestParameters: SecurityApiGetSourceConnectionInformationRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
* This endpoint provides the caller with a temporary token with the same access level as the caller\'s token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
* @summary Get a Transient Token.
@@ -5239,7 +5239,7 @@ export declare class SessionsApi extends BaseAPI {
export declare const UpdaterApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -5290,7 +5290,7 @@ export declare const UpdaterApiAxiosParamCreator: (configuration?: Configuration
export declare const UpdaterApiFp: (configuration?: Configuration) => {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -5341,7 +5341,7 @@ export declare const UpdaterApiFp: (configuration?: Configuration) => {
export declare const UpdaterApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -5559,7 +5559,7 @@ export interface UpdaterApiQueryUpdateStatusRequest {
export declare class UpdaterApi extends BaseAPI {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {UpdaterApiApplyUpdatesRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
@@ -5603,7 +5603,7 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails: (xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
getUserDetails: (xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* UserApi - functional programming interface
@@ -5623,7 +5623,7 @@ export declare const UserApiFp: (configuration?: Configuration) => {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
getUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* UserApi - factory interface
@@ -5643,54 +5643,54 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void>;
getUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void>;
};
/**
* Request parameters for getCurrentUserDetails operation in UserApi.
* Request parameters for getUserDetails operation in UserApi.
* @export
* @interface UserApiGetCurrentUserDetailsRequest
* @interface UserApiGetUserDetailsRequest
*/
export interface UserApiGetCurrentUserDetailsRequest {
export interface UserApiGetUserDetailsRequest {
/**
* Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexDeviceName?: any;
/**
* The type of device your application is running on Device name and or model number, eg &#x60;iPhone3,2&#x60;, &#x60;Motorola XOOM™&#x60;, &#x60;LG5200TV&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexDevice?: any;
/**
* Operating system version, eg &#x60;4.3.1&#x60;, &#x60;10.6.7&#x60;, &#x60;3.2&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexPlatformVersion?: any;
/**
* Platform name, eg &#x60;Web&#x60;, &#x60;iOS&#x60;, &#x60;MacOSX&#x60;, &#x60;Android&#x60;, &#x60;LG&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexPlatform?: any;
/**
* Plex application name, eg &#x60;Laika&#x60;, &#x60;Plex Media Server&#x60;, &#x60;Media Link&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexProduct?: any;
/**
* One or more of &#x60;[player, controller, server]&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexProvides?: any;
/**
* Your application version number
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexVersion?: any;
}
@@ -5704,10 +5704,10 @@ export declare class UserApi extends BaseAPI {
/**
* Get Logged in User
* @summary Get Logged in User
* @param {UserApiGetCurrentUserDetailsRequest} requestParameters Request parameters.
* @param {UserApiGetUserDetailsRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
* @memberof UserApi
*/
getCurrentUserDetails(requestParameters?: UserApiGetCurrentUserDetailsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
getUserDetails(requestParameters?: UserApiGetUserDetailsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}

224
dist/sdk-output/api.js vendored
View File

@@ -412,60 +412,45 @@ var AuthenticationApiAxiosParamCreator = function (configuration) {
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/pins";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication PlexClientIdentifier required
return [4 /*yield*/, (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Plex-Client-Identifier", configuration)
// authentication PlexToken required
];
case 1:
// authentication PlexClientIdentifier required
_a.sent();
// authentication PlexToken required
return [4 /*yield*/, (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Plex-Token", configuration)];
case 2:
// authentication PlexToken required
_a.sent();
if (strong !== undefined) {
localVarQueryParameter['strong'] = strong;
}
if (xPlexDeviceName !== undefined && xPlexDeviceName !== null) {
localVarHeaderParameter['X-Plex-Device-Name'] = String(JSON.stringify(xPlexDeviceName));
}
if (xPlexDevice !== undefined && xPlexDevice !== null) {
localVarHeaderParameter['X-Plex-Device'] = String(JSON.stringify(xPlexDevice));
}
if (xPlexPlatformVersion !== undefined && xPlexPlatformVersion !== null) {
localVarHeaderParameter['X-Plex-Platform-Version'] = String(JSON.stringify(xPlexPlatformVersion));
}
if (xPlexPlatform !== undefined && xPlexPlatform !== null) {
localVarHeaderParameter['X-Plex-Platform'] = String(JSON.stringify(xPlexPlatform));
}
if (xPlexProduct !== undefined && xPlexProduct !== null) {
localVarHeaderParameter['X-Plex-Product'] = String(JSON.stringify(xPlexProduct));
}
if (xPlexProvides !== undefined && xPlexProvides !== null) {
localVarHeaderParameter['X-Plex-Provides'] = String(JSON.stringify(xPlexProvides));
}
if (xPlexVersion !== undefined && xPlexVersion !== null) {
localVarHeaderParameter['X-Plex-Version'] = String(JSON.stringify(xPlexVersion));
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
return [2 /*return*/, {
url: (0, common_1.toPathString)(localVarUrlObj),
axiosOptions: localVarRequestOptions,
}];
localVarPath = "/pins";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), axiosOptions);
localVarHeaderParameter = {};
localVarQueryParameter = {};
if (strong !== undefined) {
localVarQueryParameter['strong'] = strong;
}
if (xPlexDeviceName !== undefined && xPlexDeviceName !== null) {
localVarHeaderParameter['X-Plex-Device-Name'] = String(JSON.stringify(xPlexDeviceName));
}
if (xPlexDevice !== undefined && xPlexDevice !== null) {
localVarHeaderParameter['X-Plex-Device'] = String(JSON.stringify(xPlexDevice));
}
if (xPlexPlatformVersion !== undefined && xPlexPlatformVersion !== null) {
localVarHeaderParameter['X-Plex-Platform-Version'] = String(JSON.stringify(xPlexPlatformVersion));
}
if (xPlexPlatform !== undefined && xPlexPlatform !== null) {
localVarHeaderParameter['X-Plex-Platform'] = String(JSON.stringify(xPlexPlatform));
}
if (xPlexProduct !== undefined && xPlexProduct !== null) {
localVarHeaderParameter['X-Plex-Product'] = String(JSON.stringify(xPlexProduct));
}
if (xPlexProvides !== undefined && xPlexProvides !== null) {
localVarHeaderParameter['X-Plex-Provides'] = String(JSON.stringify(xPlexProvides));
}
if (xPlexVersion !== undefined && xPlexVersion !== null) {
localVarHeaderParameter['X-Plex-Version'] = String(JSON.stringify(xPlexVersion));
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
return [2 /*return*/, {
url: (0, common_1.toPathString)(localVarUrlObj),
axiosOptions: localVarRequestOptions,
}];
});
});
},
@@ -488,60 +473,45 @@ var AuthenticationApiAxiosParamCreator = function (configuration) {
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'pinID' is not null or undefined
(0, common_1.assertParamExists)('getToken', 'pinID', pinID);
localVarPath = "/pins/{pinID}"
.replace("{".concat("pinID", "}"), encodeURIComponent(String(pinID)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication PlexClientIdentifier required
return [4 /*yield*/, (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Plex-Client-Identifier", configuration)
// authentication PlexToken required
];
case 1:
// authentication PlexClientIdentifier required
_a.sent();
// authentication PlexToken required
return [4 /*yield*/, (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Plex-Token", configuration)];
case 2:
// authentication PlexToken required
_a.sent();
if (xPlexDeviceName !== undefined && xPlexDeviceName !== null) {
localVarHeaderParameter['X-Plex-Device-Name'] = String(JSON.stringify(xPlexDeviceName));
}
if (xPlexDevice !== undefined && xPlexDevice !== null) {
localVarHeaderParameter['X-Plex-Device'] = String(JSON.stringify(xPlexDevice));
}
if (xPlexPlatformVersion !== undefined && xPlexPlatformVersion !== null) {
localVarHeaderParameter['X-Plex-Platform-Version'] = String(JSON.stringify(xPlexPlatformVersion));
}
if (xPlexPlatform !== undefined && xPlexPlatform !== null) {
localVarHeaderParameter['X-Plex-Platform'] = String(JSON.stringify(xPlexPlatform));
}
if (xPlexProduct !== undefined && xPlexProduct !== null) {
localVarHeaderParameter['X-Plex-Product'] = String(JSON.stringify(xPlexProduct));
}
if (xPlexProvides !== undefined && xPlexProvides !== null) {
localVarHeaderParameter['X-Plex-Provides'] = String(JSON.stringify(xPlexProvides));
}
if (xPlexVersion !== undefined && xPlexVersion !== null) {
localVarHeaderParameter['X-Plex-Version'] = String(JSON.stringify(xPlexVersion));
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
return [2 /*return*/, {
url: (0, common_1.toPathString)(localVarUrlObj),
axiosOptions: localVarRequestOptions,
}];
// verify required parameter 'pinID' is not null or undefined
(0, common_1.assertParamExists)('getToken', 'pinID', pinID);
localVarPath = "/pins/{pinID}"
.replace("{".concat("pinID", "}"), encodeURIComponent(String(pinID)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), axiosOptions);
localVarHeaderParameter = {};
localVarQueryParameter = {};
if (xPlexDeviceName !== undefined && xPlexDeviceName !== null) {
localVarHeaderParameter['X-Plex-Device-Name'] = String(JSON.stringify(xPlexDeviceName));
}
if (xPlexDevice !== undefined && xPlexDevice !== null) {
localVarHeaderParameter['X-Plex-Device'] = String(JSON.stringify(xPlexDevice));
}
if (xPlexPlatformVersion !== undefined && xPlexPlatformVersion !== null) {
localVarHeaderParameter['X-Plex-Platform-Version'] = String(JSON.stringify(xPlexPlatformVersion));
}
if (xPlexPlatform !== undefined && xPlexPlatform !== null) {
localVarHeaderParameter['X-Plex-Platform'] = String(JSON.stringify(xPlexPlatform));
}
if (xPlexProduct !== undefined && xPlexProduct !== null) {
localVarHeaderParameter['X-Plex-Product'] = String(JSON.stringify(xPlexProduct));
}
if (xPlexProvides !== undefined && xPlexProvides !== null) {
localVarHeaderParameter['X-Plex-Provides'] = String(JSON.stringify(xPlexProvides));
}
if (xPlexVersion !== undefined && xPlexVersion !== null) {
localVarHeaderParameter['X-Plex-Version'] = String(JSON.stringify(xPlexVersion));
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), axiosOptions.headers);
return [2 /*return*/, {
url: (0, common_1.toPathString)(localVarUrlObj),
axiosOptions: localVarRequestOptions,
}];
});
});
},
@@ -5092,7 +5062,7 @@ var SecurityApiAxiosParamCreator = function (configuration) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation: function (source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
getSourceConnectionInformation: function (source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
if (axiosOptions === void 0) { axiosOptions = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -5100,7 +5070,7 @@ var SecurityApiAxiosParamCreator = function (configuration) {
switch (_a.label) {
case 0:
// verify required parameter 'source' is not null or undefined
(0, common_1.assertParamExists)('getConnectionInformation', 'source', source);
(0, common_1.assertParamExists)('getSourceConnectionInformation', 'source', source);
localVarPath = "/security/resources";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
@@ -5264,12 +5234,12 @@ var SecurityApiFp = function (configuration) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation: function (source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
getSourceConnectionInformation: function (source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions)];
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSourceConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -5329,8 +5299,8 @@ var SecurityApiFactory = function (configuration, basePath, axios) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation: function (source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
return localVarFp.getConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then(function (request) { return request(axios, basePath); });
getSourceConnectionInformation: function (source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
return localVarFp.getSourceConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then(function (request) { return request(axios, basePath); });
},
/**
* This endpoint provides the caller with a temporary token with the same access level as the caller\'s token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
@@ -5367,14 +5337,14 @@ var SecurityApi = /** @class */ (function (_super) {
/**
* If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. Note: requires Plex Media Server >= 1.15.4.
* @summary Get Source Connection Information
* @param {SecurityApiGetConnectionInformationRequest} requestParameters Request parameters.
* @param {SecurityApiGetSourceConnectionInformationRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
* @memberof SecurityApi
*/
SecurityApi.prototype.getConnectionInformation = function (requestParameters, axiosOptions) {
SecurityApi.prototype.getSourceConnectionInformation = function (requestParameters, axiosOptions) {
var _this = this;
return (0, exports.SecurityApiFp)(this.configuration).getConnectionInformation(requestParameters.source, requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
return (0, exports.SecurityApiFp)(this.configuration).getSourceConnectionInformation(requestParameters.source, requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* This endpoint provides the caller with a temporary token with the same access level as the caller\'s token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
@@ -5996,7 +5966,7 @@ var UpdaterApiAxiosParamCreator = function (configuration) {
return {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -6234,7 +6204,7 @@ var UpdaterApiFp = function (configuration) {
return {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -6325,7 +6295,7 @@ var UpdaterApiFactory = function (configuration, basePath, axios) {
return {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -6390,7 +6360,7 @@ var UpdaterApi = /** @class */ (function (_super) {
}
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {UpdaterApiApplyUpdatesRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
@@ -6450,7 +6420,7 @@ var UserApiAxiosParamCreator = function (configuration) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails: function (xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
getUserDetails: function (xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
if (axiosOptions === void 0) { axiosOptions = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -6532,12 +6502,12 @@ var UserApiFp = function (configuration) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails: function (xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
getUserDetails: function (xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getCurrentUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions)];
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -6568,8 +6538,8 @@ var UserApiFactory = function (configuration, basePath, axios) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails: function (xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
return localVarFp.getCurrentUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then(function (request) { return request(axios, basePath); });
getUserDetails: function (xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions) {
return localVarFp.getUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then(function (request) { return request(axios, basePath); });
},
};
};
@@ -6588,15 +6558,15 @@ var UserApi = /** @class */ (function (_super) {
/**
* Get Logged in User
* @summary Get Logged in User
* @param {UserApiGetCurrentUserDetailsRequest} requestParameters Request parameters.
* @param {UserApiGetUserDetailsRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
* @memberof UserApi
*/
UserApi.prototype.getCurrentUserDetails = function (requestParameters, axiosOptions) {
UserApi.prototype.getUserDetails = function (requestParameters, axiosOptions) {
var _this = this;
if (requestParameters === void 0) { requestParameters = {}; }
return (0, exports.UserApiFp)(this.configuration).getCurrentUserDetails(requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
return (0, exports.UserApiFp)(this.configuration).getUserDetails(requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then(function (request) { return request(_this.axios, _this.basePath); });
};
return UserApi;
}(base_1.BaseAPI));

2
dist/sdk-output/api.js.map vendored
View File

File diff suppressed because one or more lines are too long

96
sdk-output/api.ts
View File

@@ -980,12 +980,6 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication PlexClientIdentifier required
await setApiKeyToObject(localVarHeaderParameter, "X-Plex-Client-Identifier", configuration)
// authentication PlexToken required
await setApiKeyToObject(localVarHeaderParameter, "X-Plex-Token", configuration)
if (strong !== undefined) {
localVarQueryParameter['strong'] = strong;
}
@@ -1059,12 +1053,6 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication PlexClientIdentifier required
await setApiKeyToObject(localVarHeaderParameter, "X-Plex-Client-Identifier", configuration)
// authentication PlexToken required
await setApiKeyToObject(localVarHeaderParameter, "X-Plex-Token", configuration)
if (xPlexDeviceName !== undefined && xPlexDeviceName !== null) {
localVarHeaderParameter['X-Plex-Device-Name'] = String(JSON.stringify(xPlexDeviceName));
}
@@ -7326,9 +7314,9 @@ export const SecurityApiAxiosParamCreator = function (configuration?: Configurat
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation: async (source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getSourceConnectionInformation: async (source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'source' is not null or undefined
assertParamExists('getConnectionInformation', 'source', source)
assertParamExists('getSourceConnectionInformation', 'source', source)
const localVarPath = `/security/resources`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -7499,8 +7487,8 @@ export const SecurityApiFp = function(configuration?: Configuration) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
async getConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions);
async getSourceConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getSourceConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
@@ -7546,8 +7534,8 @@ export const SecurityApiFactory = function (configuration?: Configuration, baseP
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void> {
return localVarFp.getConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then((request) => request(axios, basePath));
getSourceConnectionInformation(source: any, xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void> {
return localVarFp.getSourceConnectionInformation(source, xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then((request) => request(axios, basePath));
},
/**
* This endpoint provides the caller with a temporary token with the same access level as the caller\'s token. These tokens are valid for up to 48 hours and are destroyed if the server instance is restarted.
@@ -7571,64 +7559,64 @@ export const SecurityApiFactory = function (configuration?: Configuration, baseP
};
/**
* Request parameters for getConnectionInformation operation in SecurityApi.
* Request parameters for getSourceConnectionInformation operation in SecurityApi.
* @export
* @interface SecurityApiGetConnectionInformationRequest
* @interface SecurityApiGetSourceConnectionInformationRequest
*/
export interface SecurityApiGetConnectionInformationRequest {
export interface SecurityApiGetSourceConnectionInformationRequest {
/**
* The source identifier with an included prefix.
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly source: any
/**
* Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexDeviceName?: any
/**
* The type of device your application is running on Device name and or model number, eg &#x60;iPhone3,2&#x60;, &#x60;Motorola XOOM™&#x60;, &#x60;LG5200TV&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexDevice?: any
/**
* Operating system version, eg &#x60;4.3.1&#x60;, &#x60;10.6.7&#x60;, &#x60;3.2&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexPlatformVersion?: any
/**
* Platform name, eg &#x60;Web&#x60;, &#x60;iOS&#x60;, &#x60;MacOSX&#x60;, &#x60;Android&#x60;, &#x60;LG&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexPlatform?: any
/**
* Plex application name, eg &#x60;Laika&#x60;, &#x60;Plex Media Server&#x60;, &#x60;Media Link&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexProduct?: any
/**
* One or more of &#x60;[player, controller, server]&#x60;
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexProvides?: any
/**
* Your application version number
* @type {any}
* @memberof SecurityApiGetConnectionInformation
* @memberof SecurityApiGetSourceConnectionInformation
*/
readonly xPlexVersion?: any
}
@@ -7713,13 +7701,13 @@ export class SecurityApi extends BaseAPI {
/**
* If a caller requires connection details and a transient token for a source that is known to the server, for example a cloud media provider or shared PMS, then this endpoint can be called. This endpoint is only accessible with either an admin token or a valid transient token generated from an admin token. Note: requires Plex Media Server >= 1.15.4.
* @summary Get Source Connection Information
* @param {SecurityApiGetConnectionInformationRequest} requestParameters Request parameters.
* @param {SecurityApiGetSourceConnectionInformationRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
* @memberof SecurityApi
*/
public getConnectionInformation(requestParameters: SecurityApiGetConnectionInformationRequest, axiosOptions?: AxiosRequestConfig) {
return SecurityApiFp(this.configuration).getConnectionInformation(requestParameters.source, requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then((request) => request(this.axios, this.basePath));
public getSourceConnectionInformation(requestParameters: SecurityApiGetSourceConnectionInformationRequest, axiosOptions?: AxiosRequestConfig) {
return SecurityApiFp(this.configuration).getSourceConnectionInformation(requestParameters.source, requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then((request) => request(this.axios, this.basePath));
}
/**
@@ -8508,7 +8496,7 @@ export const UpdaterApiAxiosParamCreator = function (configuration?: Configurati
return {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -8746,7 +8734,7 @@ export const UpdaterApiFp = function(configuration?: Configuration) {
return {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -8810,7 +8798,7 @@ export const UpdaterApiFactory = function (configuration?: Configuration, basePa
return {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {any} [tonight] Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install
* @param {any} [skip] Indicate that the latest version should be marked as skipped. The &lt;Release&gt; entry for this version will have the &#x60;state&#x60; set to &#x60;skipped&#x60;.
* @param {any} [xPlexDeviceName] Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
@@ -9060,7 +9048,7 @@ export interface UpdaterApiQueryUpdateStatusRequest {
export class UpdaterApi extends BaseAPI {
/**
* Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed
* @summary Applying updates
* @summary Apply Updates
* @param {UpdaterApiApplyUpdatesRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
@@ -9115,7 +9103,7 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration)
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails: async (xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
getUserDetails: async (xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions: AxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/user`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -9196,8 +9184,8 @@ export const UserApiFp = function(configuration?: Configuration) {
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
async getCurrentUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getCurrentUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions);
async getUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
}
@@ -9223,64 +9211,64 @@ export const UserApiFactory = function (configuration?: Configuration, basePath?
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
*/
getCurrentUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void> {
return localVarFp.getCurrentUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then((request) => request(axios, basePath));
getUserDetails(xPlexDeviceName?: any, xPlexDevice?: any, xPlexPlatformVersion?: any, xPlexPlatform?: any, xPlexProduct?: any, xPlexProvides?: any, xPlexVersion?: any, axiosOptions?: any): AxiosPromise<void> {
return localVarFp.getUserDetails(xPlexDeviceName, xPlexDevice, xPlexPlatformVersion, xPlexPlatform, xPlexProduct, xPlexProvides, xPlexVersion, axiosOptions).then((request) => request(axios, basePath));
},
};
};
/**
* Request parameters for getCurrentUserDetails operation in UserApi.
* Request parameters for getUserDetails operation in UserApi.
* @export
* @interface UserApiGetCurrentUserDetailsRequest
* @interface UserApiGetUserDetailsRequest
*/
export interface UserApiGetCurrentUserDetailsRequest {
export interface UserApiGetUserDetailsRequest {
/**
* Primary name for the device eg. &#x60;Plex Web (Chrome)&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexDeviceName?: any
/**
* The type of device your application is running on Device name and or model number, eg &#x60;iPhone3,2&#x60;, &#x60;Motorola XOOM™&#x60;, &#x60;LG5200TV&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexDevice?: any
/**
* Operating system version, eg &#x60;4.3.1&#x60;, &#x60;10.6.7&#x60;, &#x60;3.2&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexPlatformVersion?: any
/**
* Platform name, eg &#x60;Web&#x60;, &#x60;iOS&#x60;, &#x60;MacOSX&#x60;, &#x60;Android&#x60;, &#x60;LG&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexPlatform?: any
/**
* Plex application name, eg &#x60;Laika&#x60;, &#x60;Plex Media Server&#x60;, &#x60;Media Link&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexProduct?: any
/**
* One or more of &#x60;[player, controller, server]&#x60;
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexProvides?: any
/**
* Your application version number
* @type {any}
* @memberof UserApiGetCurrentUserDetails
* @memberof UserApiGetUserDetails
*/
readonly xPlexVersion?: any
}
@@ -9295,13 +9283,13 @@ export class UserApi extends BaseAPI {
/**
* Get Logged in User
* @summary Get Logged in User
* @param {UserApiGetCurrentUserDetailsRequest} requestParameters Request parameters.
* @param {UserApiGetUserDetailsRequest} requestParameters Request parameters.
* @param {*} [axiosOptions] Override http request option.
* @throws {RequiredError}
* @memberof UserApi
*/
public getCurrentUserDetails(requestParameters: UserApiGetCurrentUserDetailsRequest = {}, axiosOptions?: AxiosRequestConfig) {
return UserApiFp(this.configuration).getCurrentUserDetails(requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then((request) => request(this.axios, this.basePath));
public getUserDetails(requestParameters: UserApiGetUserDetailsRequest = {}, axiosOptions?: AxiosRequestConfig) {
return UserApiFp(this.configuration).getUserDetails(requestParameters.xPlexDeviceName, requestParameters.xPlexDevice, requestParameters.xPlexPlatformVersion, requestParameters.xPlexPlatform, requestParameters.xPlexProduct, requestParameters.xPlexProvides, requestParameters.xPlexVersion, axiosOptions).then((request) => request(this.axios, this.basePath));
}
}