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

ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.405.6

Browse Source
This commit is contained in:
speakeasybot
2024-10-01 00:11:35 +00:00
parent c65c9e0cae
commit 636840a553
51 changed files with 809 additions and 866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/sdks/plex/README.md
View File

@@ -65,12 +65,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------------- | --------------------------------------- | --------------------------------------- |
| sdkerrors.GetCompanionsDataBadRequest | 400 | application/json |
| sdkerrors.GetCompanionsDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetUserFriends
@@ -121,12 +120,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------ | ------------------------------------ | ------------------------------------ |
| sdkerrors.GetUserFriendsBadRequest | 400 | application/json |
| sdkerrors.GetUserFriendsUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetGeoData
@@ -176,12 +174,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------------- | -------------------------------- | -------------------------------- |
| sdkerrors.GetGeoDataBadRequest | 400 | application/json |
| sdkerrors.GetGeoDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetHomeData
@@ -232,12 +229,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| --------------------------------- | --------------------------------- | --------------------------------- |
| sdkerrors.GetHomeDataBadRequest | 400 | application/json |
| sdkerrors.GetHomeDataUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetServerResources
@@ -266,7 +262,7 @@ func main() {
)
ctx := context.Background()
res, err := s.Plex.GetServerResources(ctx, operations.IncludeHTTPSEnable.ToPointer(), operations.IncludeRelayEnable.ToPointer(), operations.IncludeIPv6Enable.ToPointer())
res, err := s.Plex.GetServerResources(ctx, operations.IncludeHTTPSEnable.ToPointer(), operations.IncludeRelayEnable.ToPointer(), operations.IncludeIPv6Enable.ToPointer(), plexgo.String("gcgzw5rz2xovp84b4vha3a40"))
if err != nil {
log.Fatal(err)
}
@@ -278,13 +274,14 @@ func main() {
### Parameters
| Parameter | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
| `includeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
| Parameter | Type | Required | Description | Example |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. | |
| `includeHTTPS` | [*operations.IncludeHTTPS](../../models/operations/includehttps.md) | :heavy_minus_sign: | Include Https entries in the results | 1 |
| `includeRelay` | [*operations.IncludeRelay](../../models/operations/includerelay.md) | :heavy_minus_sign: | Include Relay addresses in the results <br/>E.g: https://10-0-0-25.bbf8e10c7fa20447cacee74cd9914cde.plex.direct:32400<br/> | 1 |
| `includeIPv6` | [*operations.IncludeIPv6](../../models/operations/includeipv6.md) | :heavy_minus_sign: | Include IPv6 entries in the results | 1 |
| `clientID` | **string* | :heavy_minus_sign: | The unique identifier for the client application. This is used to track the client application and its usage. (UUID, serial number, or other number unique per device) | gcgzw5rz2xovp84b4vha3a40 |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. | |
### Response
@@ -292,12 +289,11 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- |
| sdkerrors.GetServerResourcesBadRequest | 400 | application/json |
| sdkerrors.GetServerResourcesUnauthorized | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetPin
@@ -349,11 +345,10 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| sdkerrors.GetPinBadRequest | 400 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |
## GetTokenByPinID
@@ -367,6 +362,7 @@ package main
import(
"github.com/LukeHagar/plexgo"
"context"
"github.com/LukeHagar/plexgo/models/operations"
"log"
)
@@ -380,7 +376,9 @@ func main() {
)
ctx := context.Background()
res, err := s.Plex.GetTokenByPinID(ctx, 408895)
res, err := s.Plex.GetTokenByPinID(ctx, operations.GetTokenByPinIDRequest{
PinID: 408895,
})
if err != nil {
log.Fatal(err)
}
@@ -392,11 +390,11 @@ func main() {
### Parameters
| Parameter | Type | Required | Description |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
| `pinID` | *int64* | :heavy_check_mark: | The PinID to retrieve an access token for |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. |
| Parameter | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `ctx` | [context.Context](https://pkg.go.dev/context#Context) | :heavy_check_mark: | The context to use for the request. |
| `request` | [operations.GetTokenByPinIDRequest](../../models/operations/gettokenbypinidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
| `opts` | [][operations.Option](../../models/operations/option.md) | :heavy_minus_sign: | The options for this request. |
### Response
@@ -404,8 +402,8 @@ func main() {
### Errors
| Error Object | Status Code | Content Type |
| Error Type | Status Code | Content Type |
| ------------------------------------- | ------------------------------------- | ------------------------------------- |
| sdkerrors.GetTokenByPinIDBadRequest | 400 | application/json |
| sdkerrors.GetTokenByPinIDResponseBody | 404 | application/json |
| sdkerrors.SDKError | 4xx-5xx | */* |
| sdkerrors.SDKError | 4XX, 5XX | \*/\* |