Skip to content

About

Official powershell SDK for ShionStream API

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository
BranchesTags

Repository files navigation

ShionStream.Client - the PowerShell module for the ShionStream API

Modular anime streaming and metadata API built with Hono on Cloudflare Workers.

This PowerShell module is automatically generated for ShionStream API using OpenAPI specification:

  • API version: 1.0.0
  • SDK version: 0.1.2
  • Generator version: 7.26.0
  • Build package: org.openapitools.codegen.languages.PowerShellClientCodegen For more information, please visit https://gox.my.id

Frameworks supported

  • PowerShell 6.2 or later

Dependencies

Installation

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\ShionStream.Client' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\ShionStream.Client' -Prefix prefix

To uninstall the module, simply run:

Remove-Module -FullyQualifiedName @{ModuleName = "ShionStream.Client"; ModuleVersion = "0.1.2"}

Tests

To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

All URIs are relative to https://api.gox.my.id

Class Method HTTP request Description
AnimeApi Invoke-V1AnimeGet GET /v1/anime List Anime Catalog
AnimeApi Invoke-V1AnimeSlugGet GET /v1/anime/{slug} Get Anime Details by Slug
CommentsApi Invoke-V1CommentsGet GET /v1/comments Get Episode Comments
CommentsApi Invoke-V1CommentsIdLikePost POST /v1/comments/{id}/like Like or Dislike Comment
CommentsApi Invoke-V1CommentsIdReportPost POST /v1/comments/{id}/report Report Comment
CommentsApi Invoke-V1CommentsPost POST /v1/comments Create Comment
DashboardApi Invoke-V1DashboardAnimeGet GET /v1/dashboard/anime Get Administrative Anime List
DashboardApi Invoke-V1DashboardCategoriesGet GET /v1/dashboard/categories Get Category & Genre Distributions
DashboardApi Invoke-V1DashboardEpisodesGet GET /v1/dashboard/episodes Get Administrative Episodes List
DashboardApi Invoke-V1DashboardModerationGet GET /v1/dashboard/moderation Get Comment Moderation Reports
DashboardApi Invoke-V1DashboardModerationIdPatch PATCH /v1/dashboard/moderation/{id} Resolve or Dismiss Moderation Report
DashboardApi Invoke-V1DashboardOverviewGet GET /v1/dashboard/overview Get Dashboard Overview
DashboardApi Invoke-V1DashboardRolesGet GET /v1/dashboard/roles Get System Roles & Permissions
DashboardApi Invoke-V1DashboardSeasonsGet GET /v1/dashboard/seasons Get Seasonal Broadcast Distributions
DashboardApi Invoke-V1DashboardStatsGet GET /v1/dashboard/stats Get Platform Stats
DashboardApi Invoke-V1DashboardUsersGet GET /v1/dashboard/users Get Users Directory (Admin Only)
EpisodesApi Invoke-V1AnimeSlugEpisodesGet GET /v1/anime/{slug}/episodes List Episodes by Anime Slug
EpisodesApi Invoke-V1EpisodesIdStreamGet GET /v1/episodes/{id}/stream Get Episode Stream Sources
SampleApi Invoke-V1ProtectedSampleGet GET /v1/protected/sample Protected Sample Endpoint
SystemApi Invoke-HealthGet GET /health Health Check
UploadApi Invoke-V1UploadHlsPost POST /v1/upload/hls Upload HLS Package to Cloudflare R2
UploadApi Invoke-V1UploadImagePost POST /v1/upload/image Upload Image to Cloudflare R2
UserApi Invoke-V1UserHistoryDelete DELETE /v1/user/history Clear All History
UserApi Invoke-V1UserHistoryGet GET /v1/user/history Get Watch History
UserApi Invoke-V1UserHistoryIdDelete DELETE /v1/user/history/{id} Delete History Item
UserApi Invoke-V1UserHistoryPost POST /v1/user/history Record Playback Progress
UserApi Invoke-V1UserProfileGet GET /v1/user/profile Get User Profile
UserApi Invoke-V1UserSettingsGet GET /v1/user/settings Get User Settings
UserApi Invoke-V1UserSettingsPatch PATCH /v1/user/settings Update User Settings
UserApi Invoke-V1UserWatchlistAnimeIdDelete DELETE /v1/user/watchlist/{animeId} Remove from Watchlist
UserApi Invoke-V1UserWatchlistAnimeIdPatch PATCH /v1/user/watchlist/{animeId} Update Watchlist Entry
UserApi Invoke-V1UserWatchlistGet GET /v1/user/watchlist Get User Watchlist
UserApi Invoke-V1UserWatchlistPost POST /v1/user/watchlist Add to Watchlist

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

Bearer

  • Type: HTTP Bearer Token authentication (JWT / API-Key)

About

Official powershell SDK for ShionStream API

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages