shukka_sdk (EXPERIMENTAL)

Operations an API key (or panel session) can call under /api/v1/apps/{appSlug}, the upload protocol, and the public no-auth feed. Session-only admin operations (delete the app, API key lifecycle, instance-level routes under /api/admin) are not documented here.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Generator version: 7.26.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  shukka_sdk: 0.1.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  shukka_sdk:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  shukka_sdk:
    path: /path/to/shukka_sdk

Getting Started

Please follow the installation procedure and then run the following:

import 'package:shukka_sdk/shukka_sdk.dart';


final api = ShukkaSdk().getAppApi();
final String appSlug = appSlug_example; // String | 

try {
    final response = await api.getApp(appSlug);
    print(response);
} on DioException catch (e) {
    print("Exception when calling AppApi->getApp: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://updates.example.com

Class Method HTTP request Description
AppApi getApp GET /api/v1/apps/{appSlug} Get app
AppApi updateApp PATCH /api/v1/apps/{appSlug} Update app settings
ChannelsApi createChannel POST /api/v1/apps/{appSlug}/channels Create a channel
ChannelsApi deleteChannel DELETE /api/v1/apps/{appSlug}/channels/{channel} Delete a channel
ChannelsApi getChannelTrend GET /api/v1/apps/{appSlug}/channels/{channel}/trend Channel hit trend
ChannelsApi listChannels GET /api/v1/apps/{appSlug}/channels List channels
ChannelsApi setCurrentVersion PATCH /api/v1/apps/{appSlug}/channels/{channel} Set current version
FeedApi getChannelFeed GET /api/update/{appSlug}/{channel} Get channel feed
FeedApi getChannelRelease GET /api/v1/apps/{appSlug}/channels/{channel}/release Get channel release
FeedApi getFeedFile GET /api/update/{appSlug}/{channel}/{filename} Get public feed
NotesApi deleteNote DELETE /api/v1/apps/{appSlug}/channels/{channel}/versions/{version}/notes/{locale} Delete a locale note
NotesApi getEditorNotes GET /api/v1/apps/{appSlug}/channels/{channel}/versions/{version}/notes Get editor notes
NotesApi listPublicNotes GET /api/v1/apps/{appSlug}/channels/{channel}/notes Get public notes
NotesApi saveNotesConfig PUT /api/v1/apps/{appSlug}/notes-config Save notes config
NotesApi upsertNote PUT /api/v1/apps/{appSlug}/channels/{channel}/versions/{version}/notes/{locale} Upsert a locale note
UploadApi finalizeUpload POST /api/v1/upload/finalize Finalize upload
UploadApi initUpload POST /api/v1/upload/init Start upload
VersionsApi deleteVersion DELETE /api/v1/apps/{appSlug}/channels/{channel}/versions/{version} Delete a version
VersionsApi getArtifact GET /api/v1/apps/{appSlug}/channels/{channel}/versions/{version}/artifacts/{filename} Get artifact
VersionsApi getReleaseMetadata GET /api/v1/apps/{appSlug}/channels/{channel}/versions/{version}/metadata Get release metadata
VersionsApi getVersionTrend GET /api/v1/apps/{appSlug}/channels/{channel}/versions/{version}/trend Version hit trend
VersionsApi replaceReleaseMetadata PUT /api/v1/apps/{appSlug}/channels/{channel}/versions/{version}/metadata Replace release metadata

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

apiKey

  • Type: HTTP Bearer Token authentication (shk_)

session

  • Type: API key
  • API key parameter name: shukka_session
  • Location:

Author

Libraries

shukka_sdk