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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.377.3

Browse Source
This commit is contained in:
speakeasybot
2024-08-23 00:09:43 +00:00
parent 7585dd0b5c
commit 322299ad95
653 changed files with 7027 additions and 1277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/sdks/search/README.md
View File

@@ -32,8 +32,8 @@ This request is intended to be very fast, and called as the user types.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -55,10 +55,10 @@ var res = await sdk.Search.PerformSearchAsync(
| `SectionId` | *double* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `Limit` | *double* | :heavy_minus_sign: | The number of items to return per hub | 5 |
### Response
**[PerformSearchResponse](../../Models/Requests/PerformSearchResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -66,6 +66,7 @@ var res = await sdk.Search.PerformSearchAsync(
| PlexAPI.Models.Errors.PerformSearchResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## PerformVoiceSearch
This endpoint performs a search specifically tailored towards voice or other imprecise input which may work badly with the substring and spell-checking heuristics used by the `/hubs/search` endpoint.
@@ -78,8 +79,8 @@ Results, as well as their containing per-type hubs, contain a `distance` attribu
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -101,10 +102,10 @@ var res = await sdk.Search.PerformVoiceSearchAsync(
| `SectionId` | *double* | :heavy_minus_sign: | This gives context to the search, and can result in re-ordering of search result hubs | |
| `Limit` | *double* | :heavy_minus_sign: | The number of items to return per hub | 5 |
### Response
**[PerformVoiceSearchResponse](../../Models/Requests/PerformVoiceSearchResponse.md)**
### Errors
| Error Object | Status Code | Content Type |
@@ -112,6 +113,7 @@ var res = await sdk.Search.PerformVoiceSearchAsync(
| PlexAPI.Models.Errors.PerformVoiceSearchResponseBody | 401 | application/json |
| PlexAPI.Models.Errors.SDKException | 4xx-5xx | */* |
## GetSearchResults
This will search the database for the string provided.
@@ -120,8 +122,8 @@ This will search the database for the string provided.
```csharp
using PlexAPI;
using PlexAPI.Models.Components;
using PlexAPI.Models.Requests;
using PlexAPI.Models.Components;
var sdk = new PlexAPISDK(
accessToken: "<YOUR_API_KEY_HERE>",
@@ -138,10 +140,10 @@ var res = await sdk.Search.GetSearchResultsAsync(query: "110");
| ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ | ------------------------------ |
| `Query` | *string* | :heavy_check_mark: | The search query string to use | 110 |
### Response
**[GetSearchResultsResponse](../../Models/Requests/GetSearchResultsResponse.md)**
### Errors
| Error Object | Status Code | Content Type |