fix(api): fix generate method name (#59)

Author: stainless-app[bot]

README.md

@@ -25,7 +25,7 @@ import Lmnt from 'lmnt-node';
 const client = new Lmnt();
 
 async function main() {
-  const response = await client.speech.synthesize({ text: 'hello world.', voice: 'ava' });
+  const response = await client.speech.generate({ text: 'hello world.', voice: 'ava' });
 
   console.log(response.audio);
 }
@@ -44,8 +44,8 @@ import Lmnt from 'lmnt-node';
 const client = new Lmnt();
 
 async function main() {
-  const params: Lmnt.SpeechSynthesizeParams = { text: 'hello world.', voice: 'ava' };
-  const response: Lmnt.SpeechSynthesizeResponse = await client.speech.synthesize(params);
+  const params: Lmnt.SpeechGenerateParams = { text: 'hello world.', voice: 'ava' };
+  const response: Lmnt.SpeechGenerateResponse = await client.speech.generate(params);
 }
 
 main();
@@ -62,17 +62,15 @@ a subclass of `APIError` will be thrown:
 <!-- prettier-ignore -->
 ```ts
 async function main() {
-  const response = await client.speech
-    .synthesize({ text: 'hello world.', voice: 'ava' })
-    .catch(async (err) => {
-      if (err instanceof Lmnt.APIError) {
-        console.log(err.status); // 400
-        console.log(err.name); // BadRequestError
-        console.log(err.headers); // {server: 'nginx', ...}
-      } else {
-        throw err;
-      }
-    });
+  const response = await client.speech.generate({ text: 'hello world.', voice: 'ava' }).catch(async (err) => {
+    if (err instanceof Lmnt.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
 }
 
 main();
@@ -107,7 +105,7 @@ const client = new Lmnt({
 });
 
 // Or, configure per-request:
-await client.speech.synthesize({ text: 'hello world.', voice: 'ava' }, {
+await client.speech.generate({ text: 'hello world.', voice: 'ava' }, {
   maxRetries: 5,
 });
 ```
@@ -124,7 +122,7 @@ const client = new Lmnt({
 });
 
 // Override per-request:
-await client.speech.synthesize({ text: 'hello world.', voice: 'ava' }, {
+await client.speech.generate({ text: 'hello world.', voice: 'ava' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -145,12 +143,12 @@ You can also use the `.withResponse()` method to get the raw `Response` along wi
 ```ts
 const client = new Lmnt();
 
-const response = await client.speech.synthesize({ text: 'hello world.', voice: 'ava' }).asResponse();
+const response = await client.speech.generate({ text: 'hello world.', voice: 'ava' }).asResponse();
 console.log(response.headers.get('X-My-Header'));
 console.log(response.statusText); // access the underlying Response object
 
 const { data: response, response: raw } = await client.speech
-  .synthesize({ text: 'hello world.', voice: 'ava' })
+  .generate({ text: 'hello world.', voice: 'ava' })
   .withResponse();
 console.log(raw.headers.get('X-My-Header'));
 console.log(response.audio);
@@ -257,7 +255,7 @@ const client = new Lmnt({
 });
 
 // Override per-request:
-await client.speech.synthesize(
+await client.speech.generate(
   { text: 'hello world.', voice: 'ava' },
   {
     httpAgent: new http.Agent({ keepAlive: false }),

api.md

@@ -2,11 +2,11 @@
 
 Types:
 
-- <code><a href="./src/resources/speech.ts">SpeechSynthesizeResponse</a></code>
+- <code><a href="./src/resources/speech.ts">SpeechGenerateResponse</a></code>
 
 Methods:
 
-- <code title="post /v1/ai/speech">client.speech.<a href="./src/resources/speech.ts">synthesize</a>({ ...params }) -> SpeechSynthesizeResponse</code>
+- <code title="post /v1/ai/speech">client.speech.<a href="./src/resources/speech.ts">generate</a>({ ...params }) -> SpeechGenerateResponse</code>
 
 # Accounts
 

src/index.ts

@@ -6,7 +6,7 @@ import * as Errors from './error';
 import * as Uploads from './uploads';
 import * as API from './resources/index';
 import { AccountRetrieveResponse, Accounts } from './resources/accounts';
-import { Speech, SpeechSynthesizeParams, SpeechSynthesizeResponse } from './resources/speech';
+import { Speech, SpeechGenerateParams, SpeechGenerateResponse } from './resources/speech';
 import {
   Voice,
   VoiceCreateParams,
@@ -179,8 +179,8 @@ export declare namespace Lmnt {
 
   export {
     Speech as Speech,
-    type SpeechSynthesizeResponse as SpeechSynthesizeResponse,
-    type SpeechSynthesizeParams as SpeechSynthesizeParams,
+    type SpeechGenerateResponse as SpeechGenerateResponse,
+    type SpeechGenerateParams as SpeechGenerateParams,
   };
 
   export { Accounts as Accounts, type AccountRetrieveResponse as AccountRetrieveResponse };

src/resources/index.ts

@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Accounts, type AccountRetrieveResponse } from './accounts';
-export { Speech, type SpeechSynthesizeResponse, type SpeechSynthesizeParams } from './speech';
+export { Speech, type SpeechGenerateResponse, type SpeechGenerateParams } from './speech';
 export {
   Voices,
   type Voice,

src/resources/speech.ts

@@ -10,15 +10,15 @@ export class Speech extends APIResource {
    * the seed used in speech generation, and optionally an object detailing the
    * duration of each word spoken.
    */
-  synthesize(
-    body: SpeechSynthesizeParams,
+  generate(
+    body: SpeechGenerateParams,
     options?: Core.RequestOptions,
-  ): Core.APIPromise<SpeechSynthesizeResponse> {
+  ): Core.APIPromise<SpeechGenerateResponse> {
     return this._client.post('/v1/ai/speech', Core.multipartFormRequestOptions({ body, ...options }));
   }
 }
 
-export interface SpeechSynthesizeResponse {
+export interface SpeechGenerateResponse {
   /**
    * The base64-encoded audio file; the format is determined by the `format`
    * parameter.
@@ -38,10 +38,10 @@ export interface SpeechSynthesizeResponse {
    * [example of this object](https://imgur.com/Uw6qNzY.png) for the input string
    * "Hello world!"
    */
-  durations?: Array<SpeechSynthesizeResponse.Duration>;
+  durations?: Array<SpeechGenerateResponse.Duration>;
 }
 
-export namespace SpeechSynthesizeResponse {
+export namespace SpeechGenerateResponse {
   export interface Duration {
     /**
      * The spoken duration of each synthesized input element, in seconds.
@@ -60,7 +60,7 @@ export namespace SpeechSynthesizeResponse {
   }
 }
 
-export interface SpeechSynthesizeParams {
+export interface SpeechGenerateParams {
   /**
    * The text to synthesize; max 5000 characters per request (including spaces)
    */
@@ -123,7 +123,7 @@ export interface SpeechSynthesizeParams {
 
 export declare namespace Speech {
   export {
-    type SpeechSynthesizeResponse as SpeechSynthesizeResponse,
-    type SpeechSynthesizeParams as SpeechSynthesizeParams,
+    type SpeechGenerateResponse as SpeechGenerateResponse,
+    type SpeechGenerateParams as SpeechGenerateParams,
   };
 }

tests/api-resources/speech.test.ts

@@ -9,8 +9,8 @@ const client = new Lmnt({
 });
 
 describe('resource speech', () => {
-  test('synthesize: only required params', async () => {
-    const responsePromise = client.speech.synthesize({ text: 'hello world.', voice: 'ava' });
+  test('generate: only required params', async () => {
+    const responsePromise = client.speech.generate({ text: 'hello world.', voice: 'ava' });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
     const response = await responsePromise;
@@ -20,8 +20,8 @@ describe('resource speech', () => {
     expect(dataAndResponse.response).toBe(rawResponse);
   });
 
-  test('synthesize: required and optional params', async () => {
-    const response = await client.speech.synthesize({
+  test('generate: required and optional params', async () => {
+    const response = await client.speech.generate({
       text: 'hello world.',
       voice: 'ava',
       conversational: true,