@firebolt-js/core-client 1.0.0-next.5

package/dist/docs/TextToSpeech/index.md

@@ -0,0 +1,524 @@
+---
+title: TextToSpeech
+---
+
+# TextToSpeech Module
+
+---
+
+Version TextToSpeech 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [cancel](#cancel)
+  - [getspeechstate](#getspeechstate)
+  - [listvoices](#listvoices)
+  - [pause](#pause)
+  - [resume](#resume)
+  - [speak](#speak)
+- [Events](#events)
+  - [onNetworkerror](#onnetworkerror)
+  - [onPlaybackerror](#onplaybackerror)
+  - [onSpeechcomplete](#onspeechcomplete)
+  - [onSpeechinterrupted](#onspeechinterrupted)
+  - [onSpeechpause](#onspeechpause)
+  - [onSpeechresume](#onspeechresume)
+  - [onSpeechstart](#onspeechstart)
+  - [onWillspeak](#onwillspeak)
+- [Types](#types)
+  - [TTSStatus](#ttsstatus)
+  - [SpeechId](#speechid)
+  - [SpeechResponse](#speechresponse)
+  - [ListVoicesResponse](#listvoicesresponse)
+  - [SpeechState](#speechstate)
+  - [SpeechStateResponse](#speechstateresponse)
+  - [TTSStatusResponse](#ttsstatusresponse)
+  - [SpeechIdEvent](#speechidevent)
+
+## Overview
+
+A module for controlling and accessing Text To Speech over Firebolt.
+
+## Methods
+
+### cancel
+
+_This is a private RPC method._
+
+Cancels the speech for given speech id
+
+Parameters:
+
+| Param      | Type     | Required | Description                    |
+| ---------- | -------- | -------- | ------------------------------ |
+| `speechid` | `number` | true     | Identifier for the speech call |
+
+Result:
+
+[TTSStatusResponse](#ttsstatusresponse)
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Cancel a given speech id.
+
+---
+
+### getspeechstate
+
+_This is a private RPC method._
+
+Returns the state of the utterance.
+
+Parameters:
+
+| Param      | Type     | Required | Description                    |
+| ---------- | -------- | -------- | ------------------------------ |
+| `speechid` | `number` | true     | Identifier for the speech call |
+
+Result:
+
+[SpeechStateResponse](#speechstateresponse)
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+State for a given speech id.
+
+---
+
+### listvoices
+
+_This is a private RPC method._
+
+Returns the list of available voices as human-readable strings, e.g. 'ava', 'amelie', 'angelica'
+
+Parameters:
+
+| Param      | Type     | Required | Description                                                           |
+| ---------- | -------- | -------- | --------------------------------------------------------------------- |
+| `language` | `string` | true     | Language - string - BCP 47 <br/>pattern: ^[a-zA-Z]+([a-zA-Z0-9\-]\*)$ |
+
+Result:
+
+[ListVoicesResponse](#listvoicesresponse)
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Getting the list of voices
+
+---
+
+### pause
+
+_This is a private RPC method._
+
+Pauses the speech for given speech id
+
+Parameters:
+
+| Param      | Type     | Required | Description                    |
+| ---------- | -------- | -------- | ------------------------------ |
+| `speechid` | `number` | true     | Identifier for the speech call |
+
+Result:
+
+[TTSStatusResponse](#ttsstatusresponse)
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Pause a given speech id
+
+---
+
+### resume
+
+_This is a private RPC method._
+
+Resumes the speech for given speech id
+
+Parameters:
+
+| Param      | Type     | Required | Description                    |
+| ---------- | -------- | -------- | ------------------------------ |
+| `speechid` | `number` | true     | Identifier for the speech call |
+
+Result:
+
+[TTSStatusResponse](#ttsstatusresponse)
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Resume a given speech id.
+
+---
+
+### speak
+
+_This is a private RPC method._
+
+Speak the utterance immediately. Any ongoing speech is interrupted.
+
+Parameters:
+
+| Param  | Type     | Required | Description                                |
+| ------ | -------- | -------- | ------------------------------------------ |
+| `text` | `string` | true     | String to be converted to Audio for speech |
+
+Result:
+
+[SpeechResponse](#speechresponse)
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Getting the result of speak
+
+---
+
+## Events
+
+### onNetworkerror
+
+_This is a private RPC method._
+
+Utterance failed due to network error.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+### onPlaybackerror
+
+_This is a private RPC method._
+
+Utterance failed during playback.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+### onSpeechcomplete
+
+_This is a private RPC method._
+
+Speech completed successfully.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+### onSpeechinterrupted
+
+_This is a private RPC method._
+
+Speech was stopped, due to another call to speak or cancel.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+### onSpeechpause
+
+_This is a private RPC method._
+
+Ongoing speech was paused.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+### onSpeechresume
+
+_This is a private RPC method._
+
+Paused speech was resumed.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+### onSpeechstart
+
+_This is a private RPC method._
+
+Utterance is about to be spoken.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+### onWillspeak
+
+_This is a private RPC method._
+
+Text to speech conversion is about to start.
+
+Parameters:
+
+| Param    | Type      | Required | Description |
+| -------- | --------- | -------- | ----------- |
+| `listen` | `boolean` | false    |             |
+
+Result:
+
+Capabilities:
+
+| Role | Capability                                     |
+| ---- | ---------------------------------------------- |
+| uses | xrn:firebolt:capability:text-to-speech:general |
+
+#### Examples
+
+Default Example
+
+---
+
+## Types
+
+### TTSStatus
+
+```typescript
+type TTSStatus = number
+```
+
+---
+
+### SpeechId
+
+```typescript
+type SpeechId = number
+```
+
+---
+
+### SpeechResponse
+
+```typescript
+type SpeechResponse = {
+  speechid: number
+  TTS_Status: TTSStatus
+  success: boolean
+}
+```
+
+See also:
+
+[TTSStatus](#ttsstatus)
+
+---
+
+### ListVoicesResponse
+
+```typescript
+type ListVoicesResponse = {
+  TTS_Status: TTSStatus
+  voices: string[]
+}
+```
+
+See also:
+
+[TTSStatus](#ttsstatus)
+
+---
+
+### SpeechState
+
+0 = SPEECH_PENDING, 1 = SPEECH_IN_PROGRESS, 2 = SPEECH_PAUSED, 3 = SPEECH_NOT_FOUND
+
+```typescript
+type SpeechState = number
+```
+
+---
+
+### SpeechStateResponse
+
+```typescript
+type SpeechStateResponse = {
+  speechstate: SpeechState // 0 = SPEECH_PENDING, 1 = SPEECH_IN_PROGRESS, 2 = SPEECH_PAUSED, 3 = SPEECH_NOT_FOUND
+  TTS_Status: TTSStatus
+  success: boolean
+}
+```
+
+See also:
+
+[SpeechState](#speechstate)
+[TTSStatus](#ttsstatus)
+
+---
+
+### TTSStatusResponse
+
+```typescript
+type TTSStatusResponse = {
+  TTS_Status: TTSStatus
+  success: boolean
+}
+```
+
+See also:
+
+[TTSStatus](#ttsstatus)
+
+---
+
+### SpeechIdEvent
+
+```typescript
+type SpeechIdEvent = {
+  speechid: number
+}
+```
+
+---

package/dist/docs/Types/schemas/index.md

@@ -0,0 +1,37 @@
+---
+title: Types
+---
+
+# Types
+
+---
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Types](#types-1)
+  - [SemanticVersion](#semanticversion)
+  - [FlatMap](#flatmap)
+
+## Types
+
+### SemanticVersion
+
+```typescript
+type SemanticVersion = {
+  major: number
+  minor: number
+  patch: number
+  readable: string
+}
+```
+
+---
+
+### FlatMap
+
+```typescript
+type FlatMap = [property: string]: string | number | boolean
+```
+
+---