Heapstream TypeScript SDK 1.1.0

Welcome to the Heapstream SDK documentation. This guide will help you get started with integrating and using the Heapstream SDK in your project.

Versions

• API version: 1.0
• SDK version: 1.1.0

About the API

Explore the API documentation for Heapstream.com! ## Authentication Authentication is done through Basic Authentication wikipedia RFC7617. For username you should use the id of the ApiKey. For password you should use the password of the ApiKey.

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Basic Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models
• License

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: TypeScript >= 4.8.4

Installation

To get started with the SDK, we recommend installing using npm:

npm install @heapstream/heapstream

Authentication

Basic Authentication

The Heapstream API uses Basic Authentication.

You need to provide your username and password when initializing the SDK.

Setting the Username and Password

When you initialize the SDK, you can set the username and password as follows:

const sdk = new Heapstream({ username: 'YOUR_USERNAME', password: 'YOUR_PASSWORD' });

If you need to set or update the username and password after initializing the SDK, you can use:

const sdk = new Heapstream();
sdk.username = 'YOUR_USERNAME';
sdk.password = 'YOUR_PASSWORD';

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

const heapstream = new Heapstream({ timeout: 10000 });

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

import { Heapstream } from '@heapstream/heapstream';

(async () => {
  const heapstream = new Heapstream({
    username: 'YOUR_USERNAME',
    password: 'YOUR_PASSWORD',
  });

  const { data } = await heapstream.project.listProjects();

  console.log(data);
})();

Services

The SDK provides various services to interact with the API.

| Name | | :------------------------------------------------------------------- | | ProjectService | | DirectUploadService | | PlayerService | | StatsService | | VideoService | | AudioTrackService | | PosterService | | TextTrackService | | WatermarkService | | WebhookService |

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

| Name | Description | | :--------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------- | | ProjectList | | | ProjectCreate | | | Project | | | ProjectEdit | | | DirectUploadStart | Schema used to start a multipart direct upload to our S3 storage. | | DirectUploadResponse | | | DirectUploadListPart | | | DirectUploadCompleteArgs | | | PartIdResponse | | | PlayerList | | | PlayerCreate | | | Player | | | PlayerEdit | | | EngagementStats | | | PerformanceStats | | | VideoList | | | VideoStatus | | | VideoFetch | | | Video | | | VideoEdit | | | PresetList | | | AudioTrackList | | | AudioTrackCreate | | | AudioTrack | | | AudioTrackEdit | | | PosterList | | | MultipartFile | | | Poster | | | PosterEdit | | | TextTrackList | | | TextTrackCreate | | | TextTrack | | | TextTrackGenerate | | | TextTrackEdit | | | WatermarkList | | | WatermarkCreate | | | Watermark | | | WebhookList | | | WebhookCreate | | | Webhook | | | TtAutoLang | | | UploadMetadata | The nested schema to upload a video. | | EncodingTier | | | Asset | | | AssetError | | | AssetErrorType | | | DirectUploadPart | | | PlayerLogoPosition | | | PlayerSkin | | | OnlyTrueEnum | | | EngagementStatsRow | | | PerformanceStatsRow | | | Pagination | Pagination response schema Used to serialize pagination metadata. Its main purpose is to document the pagination metadata. | | Preset | | | PresetType | | | AudioTrackStatus | | | AudioTrackType | | | TextTrackStatus | | | TextTrackType | | | TextTrackUploadType | | | AutoCaption | | | WatermarkPosition | |

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.