Readme updated & some polymorphic changes to Snapshots.

README.md

@@ -16,7 +16,7 @@ To add `elevenlabs-api` to your Maven project, use:
 <dependency>
     <groupId>net.andrewcpu</groupId>
     <artifactId>elevenlabs-api</artifactId>
-    <version>2.1</version>
+    <version>2.6</version>
 </dependency>
 ```
 The most up-to date package information can be found on the [Packages tab](https://github.com/AndrewCPU/elevenlabs-api/packages/)
@@ -36,46 +36,6 @@ ElevenLabs.setApiKey("YOUR_API_KEY_HERE");
 *For any public repository security, you should store your API key in an environment variable, or external from your source code.*
 
 - - -
-
-<!-- TOC -->
-### Table of Contents
-  * [Getting Started](#getting-started)
-    * [Installation](#installation)
-    * [Setting up your API Key](#setting-up-your-api-key)
-  * [Voices](#voices)
-    * [Accessing your List of Available Voices](#accessing-your-list-of-available-voices)
-    * [Accessing the Default Voice Settings](#accessing-the-default-voice-settings)
-    * [Getting a Voice by ID](#getting-a-voice-by-id)
-    * [Deleting a voice](#deleting-a-voice)
-    * [Retrieving an Updated VoiceSettings for a Voice](#retrieving-an-updated-voicesettings-for-a-voice)
-    * [Updating the VoiceSettings for a Voice](#updating-the-voicesettings-for-a-voice)
-    * [Editing a Voice](#editing-a-voice)
-    * [Creating a Voice](#creating-a-voice)
-    * [Generating Audio](#generating-audio)
-  * [Samples](#samples)
-    * [Accessing Voice Samples](#accessing-voice-samples)
-    * [Downloading a Sample](#downloading-a-sample)
-    * [Deleting a Sample](#deleting-a-sample)
-  * [History](#history)
-    * [Getting Generation History](#getting-generation-history)
-    * [Getting a History Item](#getting-a-history-item)
-    * [Downloading History](#downloading-history)
-    * [Deleting a HistoryItem](#deleting-a-historyitem)
-    * [Requesting the Voice for a HistoryItem](#requesting-the-voice-for-a-historyitem)
-    * [Downloading a HistoryItem Audio](#downloading-a-historyitem-audio)
-  * [User Management](#user-management)
-    * [Getting your Subscription](#getting-your-subscription)
-    * [Getting your User](#getting-your-user)
-  * [Exceptions](#exceptions)
-    * [*ElevenLabsAPINotInitiatedException*](#elevenlabsapinotinitiatedexception)
-    * [*ElevenLabsValidationException*](#elevenlabsvalidationexception)
-* [Misc](#misc)
-
-* [Links to ElevenLabs](#links-to-elevenlabs)
-    * [**ElevenLabs Website**: https://elevenlabs.io](#elevenlabs-website--httpselevenlabsio)
-    * [**ElevenLabs API Documentation**: https://api.elevenlabs.io/docs](#elevenlabs-api-documentation--httpsapielevenlabsiodocs)
-<!-- TOC -->
-
 ## Links to ElevenLabs
 ### **ElevenLabs Website**: https://elevenlabs.io
 ### **ElevenLabs API Documentation**: https://api.elevenlabs.io/docs
@@ -163,23 +123,201 @@ builder.withLabel("accent", "American");
 voice = builder.create();
 ```
 
-### Generating Audio
+### Generating Audio (TTS + STS)
 To generate an audio file with a given `Voice`, you can utilize the `Voice#generate(...)` functions.
 Depending on how you access your `Voice`, (with or without settings), will decide whether you can use the implicit `voiceSettings` or if you have to specify the `VoiceSettings` object to use. Unless explicitly requesting the `Voice` without settings, every `Voice` object SHOULD contain its default `VoiceSettings`.
 ```java
-Voice voice;
-File file = voice.generate(String text);
-File file = voice.generate(String text, VoiceSettings settings);
-File file = voice.generate(String text, String model, VoiceSettings settings);
-File file = voice.generate(String text, String model);
 
-InputStream inputStream = voice.generateStream(String text);
-InputStream inputStream = voice.generateStream(String text, VoiceSettings settings);
-InputStream inputStream = voice.generateStream(String text, String model, VoiceSettings settings);
-InputStream inputStream = voice.generateStream(String text, String model);
+Voice voice;
+
+File file = voice.generate("Hello world!", "my_favorite_model");
+...
+//Available Functions:
+public File generate(String text, String model);
+
+public File generate(String text, String model, VoiceSettings settings);
+
+public File generate(String text, String model, VoiceSettings settings, GeneratedAudioOutputFormat outputFormat, StreamLatencyOptimization streamLatencyOptimization);
+
+public File generate(String text, String model, VoiceSettings settings, GeneratedAudioOutputFormat outputFormat);
+
+public File generate(String text, VoiceSettings settings, GeneratedAudioOutputFormat outputFormat);
+
+public File generate(String text, VoiceSettings settings, StreamLatencyOptimization streamLatencyOptimization);
+
+public File generate(String text, VoiceSettings settings, GeneratedAudioOutputFormat outputFormat, StreamLatencyOptimization streamLatencyOptimization);
+
+public File generate(String text, GeneratedAudioOutputFormat outputFormat, StreamLatencyOptimization streamLatencyOptimization);
+
+public File generate(String text, StreamLatencyOptimization streamLatencyOptimization);
+
+public File generate(String text, VoiceSettings settings);
+
+public File generate(String text);
+
+public InputStream generateStream(String text, String model);
+
+public InputStream generateStream(String text, String model, VoiceSettings settings);
+
+public InputStream generateStream(String text, VoiceSettings settings);
+
+public InputStream generateStream(String text);
+
+public InputStream generateStream(String text, String model, GeneratedAudioOutputFormat generatedAudioOutputFormat, StreamLatencyOptimization streamLatencyOptimization);
+
+public InputStream generateStream(String text, String model, GeneratedAudioOutputFormat generatedAudioOutputFormat, StreamLatencyOptimization streamLatencyOptimization, VoiceSettings settings);
+
+public InputStream generateStream(String text, VoiceSettings settings, GeneratedAudioOutputFormat generatedAudioOutputFormat, StreamLatencyOptimization streamLatencyOptimization);
+
+public InputStream generateStream(String text, GeneratedAudioOutputFormat generatedAudioOutputFormat, StreamLatencyOptimization streamLatencyOptimization);
+
+public InputStream generateStream(String text, String model, StreamLatencyOptimization streamLatencyOptimization);
+
+public InputStream generateStream(String text, String model, StreamLatencyOptimization streamLatencyOptimization, VoiceSettings settings);
+
+public InputStream generateStream(String text, VoiceSettings settings, StreamLatencyOptimization streamLatencyOptimization);
+
+public InputStream generateStream(String text, StreamLatencyOptimization streamLatencyOptimization);
+
+public File speechToSpeech(File audioFile, StreamLatencyOptimization latencyOptimization, String modelId, VoiceSettings voiceSettings);
+
+public File speechToSpeech(File audioFile, StreamLatencyOptimization latencyOptimization, String modelId);
+
+public File speechToSpeech(File audioFile, String modelId);
+
+public InputStream speechToSpeechStream(File audioFile, StreamLatencyOptimization latencyOptimization, String modelId, VoiceSettings voiceSettings);
+
+public InputStream speechToSpeechStream(File audioFile, StreamLatencyOptimization latencyOptimization, String modelId);
+
+public InputStream speechToSpeechStream(File audioFile, String modelId);
+
 ```
 - - -
+## Audio Native Projects
+### Creating an Audio Native Project
+You can create audio native projects using the AudioNative API.
+```java
+CreateAudioEnabledProjectRequest request = new CreateAudioEnabledProjectRequest()
+        .setName("Project name")
+        .setImage("https://...com/img.png")
+        .setAuthor("Andrew")
+        .setSmall(true)
+        .setTextColor("red")
+        .setBackgroundColor("black")
+        .setSessionization(3)
+        .setVoiceId("aso23809")
+        .setModelId("my_favorite_model")
+        .setFile(new File("input.dat"))
+        .setAutoConvert(true);
 
+CreateAudioEnabledProjectModelResponse response = ElevenLabs.getAudioNativeAPI()
+                                                             .createAudioEnabledProject(request);
+```
+
+- - -
+## Projects
+## Create a project
+You can create a new project using the AddProjectRequest builder.
+```java
+AddProjectRequest request = new AddProjectRequest()
+                                .setName("name")
+        .setFromUrl("...")
+        .setFromDocument(new File("file.dat"))
+        .setDefaultTitleVoiceId("voiceA")
+        .setDefaultParagraphVoiceId("voiceB")
+        .setDefaultModelId("the_default_model_of_your_dreams")
+        .setProjectOutputQuality(ProjectOutputQuality.STANDARD)
+        .setTitle("Big Title")
+        .setAuthor("Best Author")
+        .setIsbnNumber("THE. ISBN.")
+        .setAcxVolumeNormalization(true);
+
+Project project = Project.addProject(request);
+
+```
+
+## Get a Project
+Get a project by it's specific project ID.
+```java
+Project project = Project.getProjectById(projectId);
+```
+
+## Get all Projects
+Get all of the projects associated with your account.
+```java
+List<Project> projects = Project.getProjects();
+```
+
+## Interacting with Projects
+```java
+Project project;
+// Delete a project
+String deleteResult = project.delete();
+
+// Convert a project
+String conversionResult = project.convertProject();
+
+//Get the project's snapshots.
+List<ProjectSnapshot> snapshots = project.getSnapshots();
+
+// Access your chapters from memory
+List<Chapter> chapters = project.getChapters();
+
+// Refresh your local Project's chapters from the API
+chapters = project.fetchUpdatedChapters(); // This will update the existing project object and return the list of new chapters 
+
+// Get a chapter by ID
+Chapter chapter = project.getChapterById(chapterId);
+
+// Delete a chapter
+String result = project.deleteChapter(chapter);
+
+// Convert a chapter
+String result = project.convertChapter(chapter);
+
+// Get chapter snapshots
+List<ChapterSnapshot> snapshots = project.getChapterSnapshots(chapter);
+
+```
+
+## Interacting with Chapters
+```java
+Project project;
+Chapter chapter = project.getChapterById("chapter_id");
+
+// Delete a chapter
+chapter.deleteChapter(project.getProjectId());
+
+// Convert a chapter
+chapter.convertChapter(project.getProjectId());
+
+// Get a chapter's snapshots
+List<ChapterSnapshot> snapshots = chapter.getChapterSnapshots(project.getProjectId());
+
+// 
+
+```
+
+## Accessing Snapshot Audio
+Accessing a ProjectSnapshot audio stream:
+```java
+Project project;
+List<ProjectSnapshot> projectSnapshots = project.getSnapshots();
+ProjectSnapshot first = projectSnapshots.get(0);
+InputStream audio = first.getAudioStream();
+```
+
+Accessing a ChapterSnapshot audio stream:
+```java
+Project project;
+Chapter chapter;
+List<ChapterSnapshot> chapterSnapshots = project.getChapterSnapshots(chapter);
+ChapterSnapshot first = chapterSnapshots.get(0);
+InputStream audio = first.getAudioStream();
+```
+
+Both ProjectSnapshot and ChapterSnapshot are of type Snapshot.
+- - -
 ## Samples
 A `Sample` is used as the training data for a given `Voice` model.
 ### Accessing Voice Samples
@@ -248,6 +386,10 @@ A `HistoryItem` is a previous TTS generation. You can download the generation as
 HistoryItem item;
 File file = item.downloadAudio();
 ```
+- - -
+### Projects
+The `Projects`
+
 - - -
 
 ## User Management

pom.xml

@@ -60,7 +60,7 @@
 
     <groupId>net.andrewcpu</groupId>
     <artifactId>elevenlabs-api</artifactId>
-    <version>2.4</version>
+    <version>2.7-SNAPSHOT</version>
 
     <properties>
         <maven.compiler.source>11</maven.compiler.source>

src/main/java/net/andrewcpu/elevenlabs/model/projects/Chapter.java

@@ -1,9 +1,27 @@
 package net.andrewcpu.elevenlabs.model.projects;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import net.andrewcpu.elevenlabs.ElevenLabs;
 import net.andrewcpu.elevenlabs.model.ElevenModel;
 
+import java.util.List;
+
 public class Chapter extends ElevenModel {
+
+	public String deleteChapter(String projectId) {
+		return ElevenLabs.getProjectsAPI().deleteChapter(projectId, chapterId);
+	}
+
+	public String convertChapter(String projectId) {
+		return ElevenLabs.getProjectsAPI().convertChapter(projectId, chapterId);
+	}
+
+	public List<ChapterSnapshot> getChapterSnapshots(String projectId) {
+		return ElevenLabs.getProjectsAPI().getChapterSnapshots(projectId, chapterId);
+	}
+
+
 	@JsonProperty("chapter_id")
 	private String chapterId;
 
@@ -24,4 +42,66 @@ public class Chapter extends ElevenModel {
 
 	@JsonProperty("statistics")
 	private Statistics statistics;
+
+	public Chapter() {
+	}
+
+	public Chapter(String chapterId, String name, long lastConversionDateUnix, double conversionProgress, boolean canBeDownloaded, String state, Statistics statistics) {
+		this.chapterId = chapterId;
+		this.name = name;
+		this.lastConversionDateUnix = lastConversionDateUnix;
+		this.conversionProgress = conversionProgress;
+		this.canBeDownloaded = canBeDownloaded;
+		this.state = state;
+		this.statistics = statistics;
+	}
+
+	@JsonIgnore
+	public String getChapterId() {
+		return chapterId;
+	}
+
+	@JsonIgnore
+	public String getName() {
+		return name;
+	}
+
+	@JsonIgnore
+	public long getLastConversionDateUnix() {
+		return lastConversionDateUnix;
+	}
+
+	@JsonIgnore
+	public double getConversionProgress() {
+		return conversionProgress;
+	}
+
+	@JsonIgnore
+	public boolean isCanBeDownloaded() {
+		return canBeDownloaded;
+	}
+
+	@JsonIgnore
+	public String getState() {
+		return state;
+	}
+
+	@JsonIgnore
+	public Statistics getStatistics() {
+		return statistics;
+	}
+
+	@Override
+	@JsonIgnore
+	public String toString() {
+		return "Chapter{" +
+				"chapterId='" + chapterId + '\'' +
+				", name='" + name + '\'' +
+				", lastConversionDateUnix=" + lastConversionDateUnix +
+				", conversionProgress=" + conversionProgress +
+				", canBeDownloaded=" + canBeDownloaded +
+				", state='" + state + '\'' +
+				", statistics=" + statistics +
+				'}';
+	}
 }

src/main/java/net/andrewcpu/elevenlabs/model/projects/ChapterSnapshot.java

@@ -2,34 +2,34 @@ package net.andrewcpu.elevenlabs.model.projects;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import net.andrewcpu.elevenlabs.ElevenLabs;
 import net.andrewcpu.elevenlabs.model.ElevenModel;
 
-public class ChapterSnapshot extends ElevenModel {
+import java.io.InputStream;
+
+public class ChapterSnapshot extends Snapshot {
+
+	@Override
+	public InputStream getAudioStream() {
+		return ElevenLabs.getProjectsAPI().getChapterSnapshotAudioStream(projectId, chapterId, chapterSnapshotId);
+	}
+
 	public ChapterSnapshot() {
+		super();
 	}
 
 	public ChapterSnapshot(String chapterSnapshotId, String projectId, String chapterId, long createdAtUnix, String name) {
+		super(projectId, createdAtUnix, name);
 		this.chapterSnapshotId = chapterSnapshotId;
-		this.projectId = projectId;
 		this.chapterId = chapterId;
-		this.createdAtUnix = createdAtUnix;
-		this.name = name;
 	}
 
 	@JsonProperty("chapter_snapshot_id")
 	private String chapterSnapshotId;
 
-	@JsonProperty("project_id")
-	private String projectId;
-
 	@JsonProperty("chapter_id")
 	private String chapterId;
 
-	@JsonProperty("created_at_unix")
-	private long createdAtUnix;
-
-	@JsonProperty("name")
-	private String name;
 
 	@JsonIgnore
 	public String getChapterSnapshotId() {
@@ -40,20 +40,6 @@ public class ChapterSnapshot extends ElevenModel {
 		return chapterId;
 	}
 
-	@JsonIgnore
-	public String getProjectId() {
-		return projectId;
-	}
-
-	@JsonIgnore
-	public long getCreatedAtUnix() {
-		return createdAtUnix;
-	}
-
-	@JsonIgnore
-	public String getName() {
-		return name;
-	}
 
 	@Override
 	@JsonIgnore

src/main/java/net/andrewcpu/elevenlabs/model/projects/Project.java

@@ -4,6 +4,7 @@ import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import net.andrewcpu.elevenlabs.ElevenLabs;
 import net.andrewcpu.elevenlabs.model.ElevenModel;
+import net.andrewcpu.elevenlabs.model.request.AddProjectRequest;
 
 import java.util.List;
 
@@ -13,6 +14,63 @@ public class Project extends ElevenModel {
 		return ElevenLabs.getProjectsAPI().getProjects();
 	}
 
+	public static Project addProject(AddProjectRequest builder) {
+		return ElevenLabs.getProjectsAPI().addProject(builder);
+	}
+
+	public static Project getProjectById(String projectId) {
+		return ElevenLabs.getProjectsAPI().getProject(projectId);
+	}
+
+	public List<Chapter> fetchUpdatedChapters() {
+		this.chapters = ElevenLabs.getProjectsAPI().getChapters(projectId);
+		return this.chapters;
+	}
+
+	public String deleteChapter(Chapter chapter) {
+		return chapter.deleteChapter(projectId);
+	}
+
+	public String convertChapter(Chapter chapter) {
+		return chapter.convertChapter(projectId);
+	}
+
+	public List<ChapterSnapshot> getChapterSnapshots(Chapter chapter) {
+		return chapter.getChapterSnapshots(projectId);
+	}
+
+	public String deleteProject() {
+		return ElevenLabs.getProjectsAPI().deleteProject(projectId);
+	}
+
+	public String convertProject() {
+		return ElevenLabs.getProjectsAPI().convertProject(projectId);
+	}
+
+	public List<ProjectSnapshot> getSnapshots() {
+		return ElevenLabs.getProjectsAPI().getProjectSnapshots(projectId);
+	}
+
+	public Chapter getChapterById(String chapterId) {
+		return ElevenLabs.getProjectsAPI().getChapterById(projectId, chapterId);
+	}
+
+	public Project(String projectId, String name, long unixCreateDate, String defaultTitleVoiceId, String defaultParagraphVoiceId, String defaultModelId, long lastConversionDateUnix, boolean canBeDownloaded, String state, List<Chapter> chapters) {
+		this.projectId = projectId;
+		this.name = name;
+		this.unixCreateDate = unixCreateDate;
+		this.defaultTitleVoiceId = defaultTitleVoiceId;
+		this.defaultParagraphVoiceId = defaultParagraphVoiceId;
+		this.defaultModelId = defaultModelId;
+		this.lastConversionDateUnix = lastConversionDateUnix;
+		this.canBeDownloaded = canBeDownloaded;
+		this.state = state;
+		this.chapters = chapters;
+	}
+
+	public Project() {
+	}
+
 	@JsonProperty("project_id")
 	private String projectId;
 

src/main/java/net/andrewcpu/elevenlabs/model/projects/ProjectSnapshot.java

@@ -2,55 +2,40 @@ package net.andrewcpu.elevenlabs.model.projects;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import net.andrewcpu.elevenlabs.ElevenLabs;
 import net.andrewcpu.elevenlabs.model.ElevenModel;
 
-public class ProjectSnapshot extends ElevenModel {
+import java.io.InputStream;
+
+public class ProjectSnapshot extends Snapshot {
+
+	@Override
+	public InputStream getAudioStream() {
+		return ElevenLabs.getProjectsAPI().getProjectSnapshotAudioStream(projectId, projectSnapshotId);
+	}
+
 	public ProjectSnapshot() {
+		super();
 	}
 
 	public ProjectSnapshot(String projectSnapshotId, String projectId, long createdAtUnix, String name) {
+		super(projectId, createdAtUnix, name);
 		this.projectSnapshotId = projectSnapshotId;
-		this.projectId = projectId;
-		this.createdAtUnix = createdAtUnix;
-		this.name = name;
 	}
 
 	@JsonProperty("project_snapshot_id")
 	private String projectSnapshotId;
 
-	@JsonProperty("project_id")
-	private String projectId;
-
-	@JsonProperty("created_at_unix")
-	private long createdAtUnix;
-
-	@JsonProperty("name")
-	private String name;
 
 	@JsonIgnore
 	public String getProjectSnapshotId() {
 		return projectSnapshotId;
 	}
 
-	@JsonIgnore
-	public String getProjectId() {
-		return projectId;
-	}
-
-	@JsonIgnore
-	public long getCreatedAtUnix() {
-		return createdAtUnix;
-	}
-
-	@JsonIgnore
-	public String getName() {
-		return name;
-	}
 
 	@Override
-	@JsonIgnore
 	public String toString() {
-		return "Snapshot{" +
+		return "ProjectSnapshot{" +
 				"projectSnapshotId='" + projectSnapshotId + '\'' +
 				", projectId='" + projectId + '\'' +
 				", createdAtUnix=" + createdAtUnix +

src/main/java/net/andrewcpu/elevenlabs/model/projects/Snapshot.java

@@ -0,0 +1,54 @@
+package net.andrewcpu.elevenlabs.model.projects;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import net.andrewcpu.elevenlabs.model.ElevenModel;
+
+import java.io.InputStream;
+
+public abstract class Snapshot extends ElevenModel {
+	@JsonProperty("project_id")
+	protected String projectId;
+
+	@JsonProperty("created_at_unix")
+	protected long createdAtUnix;
+
+	@JsonProperty("name")
+	protected String name;
+
+	public Snapshot(String projectId, long createdAtUnix, String name) {
+		this.projectId = projectId;
+		this.createdAtUnix = createdAtUnix;
+		this.name = name;
+	}
+
+	public Snapshot() {
+	}
+
+	public abstract InputStream getAudioStream();
+
+	@JsonIgnore
+	public String getProjectId() {
+		return projectId;
+	}
+
+	@JsonIgnore
+	public long getCreatedAtUnix() {
+		return createdAtUnix;
+	}
+
+	@JsonIgnore
+	public String getName() {
+		return name;
+	}
+
+	@Override
+	@JsonIgnore
+	public String toString() {
+		return "Snapshot{" +
+				"projectId='" + projectId + '\'' +
+				", createdAtUnix=" + createdAtUnix +
+				", name='" + name + '\'' +
+				'}';
+	}
+}