@shionstream/shionstream-sdk

v1.0.1

Published

12 days ago

TypeScript SDK for ShionStream API

Downloads

601

0High
0Medium
0Low

goxstream

dyzulk

@shionstream/[email protected]

A TypeScript SDK client for the api.gox.my.id API.

Usage

First, install the SDK from npm.

npm install @shionstream/shionstream-sdk --save

Next, try it out.

import {
  Configuration,
  AnimeApi,
} from '@shionstream/shionstream-sdk';
import type { V1AnimeGetRequest } from '@shionstream/shionstream-sdk';

async function example() {
  console.log("🚀 Testing @shionstream/shionstream-sdk SDK...");
  const api = new AnimeApi();

  const body = {
    // string (optional)
    page: page_example,
    // string (optional)
    limit: limit_example,
    // string (optional)
    search: search_example,
    // string (optional)
    type: type_example,
    // string (optional)
    status: status_example,
    // string (optional)
    genre: genre_example,
    // string (optional)
    season: season_example,
    // string (optional)
    year: year_example,
    // 'latest' | 'popular' | 'score' (optional)
    sort: sort_example,
  } satisfies V1AnimeGetRequest;

  try {
    const data = await api.v1AnimeGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

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

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AnimeApi | v1AnimeGet | GET /v1/anime | List Anime Catalog AnimeApi | v1AnimeSlugGet | GET /v1/anime/{slug} | Get Anime Details by Slug CommentsApi | v1CommentsGet | GET /v1/comments | Get Episode Comments CommentsApi | v1CommentsIdLikePost | POST /v1/comments/{id}/like | Like or Dislike Comment CommentsApi | v1CommentsIdReportPost | POST /v1/comments/{id}/report | Report Comment CommentsApi | v1CommentsPost | POST /v1/comments | Create Comment DashboardApi | v1DashboardAnimeGet | GET /v1/dashboard/anime | Get Administrative Anime List DashboardApi | v1DashboardCategoriesGet | GET /v1/dashboard/categories | Get Category & Genre Distributions DashboardApi | v1DashboardEpisodesGet | GET /v1/dashboard/episodes | Get Administrative Episodes List DashboardApi | v1DashboardModerationGet | GET /v1/dashboard/moderation | Get Comment Moderation Reports DashboardApi | v1DashboardModerationIdPatch | PATCH /v1/dashboard/moderation/{id} | Resolve or Dismiss Moderation Report DashboardApi | v1DashboardOverviewGet | GET /v1/dashboard/overview | Get Dashboard Overview DashboardApi | v1DashboardRolesGet | GET /v1/dashboard/roles | Get System Roles & Permissions DashboardApi | v1DashboardSeasonsGet | GET /v1/dashboard/seasons | Get Seasonal Broadcast Distributions DashboardApi | v1DashboardStatsGet | GET /v1/dashboard/stats | Get Platform Stats DashboardApi | v1DashboardUsersGet | GET /v1/dashboard/users | Get Users Directory (Admin Only) EpisodesApi | v1AnimeSlugEpisodesGet | GET /v1/anime/{slug}/episodes | List Episodes by Anime Slug EpisodesApi | v1EpisodesIdStreamGet | GET /v1/episodes/{id}/stream | Get Episode Stream Sources SampleApi | v1ProtectedSampleGet | GET /v1/protected/sample | Protected Sample Endpoint SystemApi | healthGet | GET /health | Health Check UploadApi | v1UploadHlsPost | POST /v1/upload/hls | Upload HLS Package to Cloudflare R2 UploadApi | v1UploadImagePost | POST /v1/upload/image | Upload Image to Cloudflare R2 UserApi | v1UserHistoryDelete | DELETE /v1/user/history | Clear All History UserApi | v1UserHistoryGet | GET /v1/user/history | Get Watch History UserApi | v1UserHistoryIdDelete | DELETE /v1/user/history/{id} | Delete History Item UserApi | v1UserHistoryPost | POST /v1/user/history | Record Playback Progress UserApi | v1UserProfileGet | GET /v1/user/profile | Get User Profile UserApi | v1UserSettingsGet | GET /v1/user/settings | Get User Settings UserApi | v1UserSettingsPatch | PATCH /v1/user/settings | Update User Settings UserApi | v1UserWatchlistAnimeIdDelete | DELETE /v1/user/watchlist/{animeId} | Remove from Watchlist UserApi | v1UserWatchlistAnimeIdPatch | PATCH /v1/user/watchlist/{animeId} | Update Watchlist Entry UserApi | v1UserWatchlistGet | GET /v1/user/watchlist | Get User Watchlist UserApi | v1UserWatchlistPost | POST /v1/user/watchlist | Add to Watchlist

Models

Authorization

Authentication schemes defined for the API:

Bearer

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

About

This TypeScript SDK client supports the Fetch API and is automatically generated for ShionStream API using the OpenAPI specification.

API version: 1.0.0
Package version: 1.0.1
Generator version: 7.26.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

For more information, please visit https://gox.my.id

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Apache-2.0