feat(api): Update with gen4_turbo, org endpoint (#96)

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 3
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-256f9e345a6be31b0c9fc494e70c5ff977f52316c2a7b07f388154522e74d7bb.yml
-openapi_spec_hash: 209a527f6ae5a1c2ed3a0e105df23277
-config_hash: b2e67f7e840f18a352ace32dc0778534
+configured_endpoints: 4
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-8572445174f75794a6c3bdd3ffacd7ea80b140bb5ffbf59656e7da3668228249.yml
+openapi_spec_hash: 8b99d38d0511b6f4291a7d39c12d580e
+config_hash: 77ce816c37172a537f337abfaf2d65a9

README.md

@@ -28,7 +28,7 @@ const client = new RunwayML({
 
 async function main() {
   const imageToVideo = await client.imageToVideo.create({
-    model: 'gen3a_turbo',
+    model: 'gen4_turbo',
     promptImage: 'https://example.com/assets/bunny.jpg',
     promptText: 'The bunny is eating a carrot',
   });
@@ -53,7 +53,7 @@ const client = new RunwayML({
 
 async function main() {
   const params: RunwayML.ImageToVideoCreateParams = {
-    model: 'gen3a_turbo',
+    model: 'gen4_turbo',
     promptImage: 'https://example.com/assets/bunny.jpg',
     promptText: 'The bunny is eating a carrot',
   };
@@ -76,7 +76,7 @@ a subclass of `APIError` will be thrown:
 async function main() {
   const imageToVideo = await client.imageToVideo
     .create({
-      model: 'gen3a_turbo',
+      model: 'gen4_turbo',
       promptImage: 'https://example.com/assets/bunny.jpg',
       promptText: 'The bunny is eating a carrot',
     })
@@ -123,7 +123,7 @@ const client = new RunwayML({
 });
 
 // Or, configure per-request:
-await client.imageToVideo.create({ model: 'gen3a_turbo', promptImage: 'https://example.com/assets/bunny.jpg', promptText: 'The bunny is eating a carrot' }, {
+await client.imageToVideo.create({ model: 'gen4_turbo', promptImage: 'https://example.com/assets/bunny.jpg', promptText: 'The bunny is eating a carrot' }, {
   maxRetries: 5,
 });
 ```
@@ -140,7 +140,7 @@ const client = new RunwayML({
 });
 
 // Override per-request:
-await client.imageToVideo.create({ model: 'gen3a_turbo', promptImage: 'https://example.com/assets/bunny.jpg', promptText: 'The bunny is eating a carrot' }, {
+await client.imageToVideo.create({ model: 'gen4_turbo', promptImage: 'https://example.com/assets/bunny.jpg', promptText: 'The bunny is eating a carrot' }, {
   timeout: 5 * 1000,
 });
 ```
@@ -163,7 +163,7 @@ const client = new RunwayML();
 
 const response = await client.imageToVideo
   .create({
-    model: 'gen3a_turbo',
+    model: 'gen4_turbo',
     promptImage: 'https://example.com/assets/bunny.jpg',
     promptText: 'The bunny is eating a carrot',
   })
@@ -173,7 +173,7 @@ console.log(response.statusText); // access the underlying Response object
 
 const { data: imageToVideo, response: raw } = await client.imageToVideo
   .create({
-    model: 'gen3a_turbo',
+    model: 'gen4_turbo',
     promptImage: 'https://example.com/assets/bunny.jpg',
     promptText: 'The bunny is eating a carrot',
   })
@@ -285,7 +285,7 @@ const client = new RunwayML({
 // Override per-request:
 await client.imageToVideo.create(
   {
-    model: 'gen3a_turbo',
+    model: 'gen4_turbo',
     promptImage: 'https://example.com/assets/bunny.jpg',
     promptText: 'The bunny is eating a carrot',
   },

api.md

@@ -18,3 +18,13 @@ Types:
 Methods:
 
 - <code title="post /v1/image_to_video">client.imageToVideo.<a href="./src/resources/image-to-video.ts">create</a>({ ...params }) -> ImageToVideoCreateResponse</code>
+
+# Organization
+
+Types:
+
+- <code><a href="./src/resources/organization.ts">OrganizationRetrieveResponse</a></code>
+
+Methods:
+
+- <code title="get /v1/organization">client.organization.<a href="./src/resources/organization.ts">retrieve</a>() -> OrganizationRetrieveResponse</code>

src/index.ts

@@ -10,6 +10,7 @@ import {
   ImageToVideoCreateParams,
   ImageToVideoCreateResponse,
 } from './resources/image-to-video';
+import { Organization, OrganizationRetrieveResponse } from './resources/organization';
 import { TaskRetrieveResponse, Tasks } from './resources/tasks';
 
 export interface ClientOptions {
@@ -140,6 +141,7 @@ export class RunwayML extends Core.APIClient {
 
   tasks: API.Tasks = new API.Tasks(this);
   imageToVideo: API.ImageToVideo = new API.ImageToVideo(this);
+  organization: API.Organization = new API.Organization(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
@@ -180,6 +182,7 @@ export class RunwayML extends Core.APIClient {
 
 RunwayML.Tasks = Tasks;
 RunwayML.ImageToVideo = ImageToVideo;
+RunwayML.Organization = Organization;
 export declare namespace RunwayML {
   export type RequestOptions = Core.RequestOptions;
 
@@ -190,6 +193,8 @@ export declare namespace RunwayML {
     type ImageToVideoCreateResponse as ImageToVideoCreateResponse,
     type ImageToVideoCreateParams as ImageToVideoCreateParams,
   };
+
+  export { Organization as Organization, type OrganizationRetrieveResponse as OrganizationRetrieveResponse };
 }
 
 export { toFile, fileFromPath } from './uploads';

src/resources/image-to-video.ts

@@ -27,7 +27,7 @@ export interface ImageToVideoCreateParams {
   /**
    * The model variant to use.
    */
-  model: 'gen3a_turbo';
+  model: 'gen4_turbo' | 'gen3a_turbo';
 
   /**
    * A HTTPS URL or data URI containing an encoded image to be used as the first
@@ -43,20 +43,22 @@ export interface ImageToVideoCreateParams {
 
   promptText?: string;
 
-  ratio?: '1280:768' | '768:1280';
+  ratio?:
+    | '1280:720'
+    | '720:1280'
+    | '1104:832'
+    | '832:1104'
+    | '960:960'
+    | '1584:672'
+    | '1280:768'
+    | '768:1280';
 
   /**
    * If unspecified, a random number is chosen. Varying the seed integer is a way to
    * get different results for the same other request parameters. Using the same seed
    * integer for an identical request will produce similar results.
    */
   seed?: number;
-
-  /**
-   * A boolean indicating whether or not the output video will contain a Runway
-   * watermark.
-   */
-  watermark?: boolean;
 }
 
 export namespace ImageToVideoCreateParams {
@@ -65,6 +67,8 @@ export namespace ImageToVideoCreateParams {
      * The position of the image in the output video. "first" will use the image as the
      * first frame of the video, "last" will use the image as the last frame of the
      * video.
+     *
+     * "last" is currently supported for `gen3a_turbo` only.
      */
     position: 'first' | 'last';
 

src/resources/index.ts

@@ -5,4 +5,5 @@ export {
   type ImageToVideoCreateResponse,
   type ImageToVideoCreateParams,
 } from './image-to-video';
+export { Organization, type OrganizationRetrieveResponse } from './organization';
 export { Tasks, type TaskRetrieveResponse } from './tasks';

src/resources/organization.ts

@@ -0,0 +1,150 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class Organization extends APIResource {
+  /**
+   * Get usage tier and credit balance information about the organization associated
+   * with the API key used to make the request.
+   */
+  retrieve(options?: Core.RequestOptions): Core.APIPromise<OrganizationRetrieveResponse> {
+    return this._client.get('/v1/organization', options);
+  }
+}
+
+export interface OrganizationRetrieveResponse {
+  /**
+   * The number of credits remaining in the organization account.
+   */
+  creditBalance: number;
+
+  /**
+   * Limits associated with the organization's tier.
+   */
+  tier: OrganizationRetrieveResponse.Tier;
+
+  /**
+   * Usage data for the organization.
+   */
+  usage: OrganizationRetrieveResponse.Usage;
+}
+
+export namespace OrganizationRetrieveResponse {
+  /**
+   * Limits associated with the organization's tier.
+   */
+  export interface Tier {
+    /**
+     * The maximum number of credits that can be purchased in a month.
+     */
+    maxMonthlyCreditSpend: number;
+
+    /**
+     * An object containing model-specific limits. Each key represents a model.
+     */
+    models: Tier.Models;
+  }
+
+  export namespace Tier {
+    /**
+     * An object containing model-specific limits. Each key represents a model.
+     */
+    export interface Models {
+      /**
+       * Limits associated with the gen3a_turbo model.
+       */
+      gen3a_turbo?: Models.Gen3aTurbo;
+
+      /**
+       * Limits associated with the gen4_turbo model.
+       */
+      gen4_turbo?: Models.Gen4Turbo;
+    }
+
+    export namespace Models {
+      /**
+       * Limits associated with the gen3a_turbo model.
+       */
+      export interface Gen3aTurbo {
+        /**
+         * The maximum number of generations that can be run concurrently for this model.
+         */
+        maxConcurrentGenerations: number;
+
+        /**
+         * The maximum number of generations that can be created each day for this model.
+         */
+        maxDailyGenerations: number;
+      }
+
+      /**
+       * Limits associated with the gen4_turbo model.
+       */
+      export interface Gen4Turbo {
+        /**
+         * The maximum number of generations that can be run concurrently for this model.
+         */
+        maxConcurrentGenerations: number;
+
+        /**
+         * The maximum number of generations that can be created each day for this model.
+         */
+        maxDailyGenerations: number;
+      }
+    }
+  }
+
+  /**
+   * Usage data for the organization.
+   */
+  export interface Usage {
+    /**
+     * Usage data for each model.
+     */
+    models: Usage.Models;
+  }
+
+  export namespace Usage {
+    /**
+     * Usage data for each model.
+     */
+    export interface Models {
+      /**
+       * Usage data for the gen3a_turbo model.
+       */
+      gen3a_turbo?: Models.Gen3aTurbo;
+
+      /**
+       * Usage data for the gen4_turbo model.
+       */
+      gen4_turbo?: Models.Gen4Turbo;
+    }
+
+    export namespace Models {
+      /**
+       * Usage data for the gen3a_turbo model.
+       */
+      export interface Gen3aTurbo {
+        /**
+         * The number of generations that have been run for this model in the past day.
+         */
+        dailyGenerations: number;
+      }
+
+      /**
+       * Usage data for the gen4_turbo model.
+       */
+      export interface Gen4Turbo {
+        /**
+         * The number of generations that have been run for this model in the past day.
+         */
+        dailyGenerations: number;
+      }
+    }
+  }
+}
+
+export declare namespace Organization {
+  export { type OrganizationRetrieveResponse as OrganizationRetrieveResponse };
+}

tests/api-resources/image-to-video.test.ts

@@ -11,7 +11,7 @@ const client = new RunwayML({
 describe('resource imageToVideo', () => {
   test('create: only required params', async () => {
     const responsePromise = client.imageToVideo.create({
-      model: 'gen3a_turbo',
+      model: 'gen4_turbo',
       promptImage: 'https://example.com',
     });
     const rawResponse = await responsePromise.asResponse();
@@ -25,13 +25,12 @@ describe('resource imageToVideo', () => {
 
   test('create: required and optional params', async () => {
     const response = await client.imageToVideo.create({
-      model: 'gen3a_turbo',
+      model: 'gen4_turbo',
       promptImage: 'https://example.com',
       duration: 5,
       promptText: 'promptText',
-      ratio: '1280:768',
+      ratio: '1280:720',
       seed: 0,
-      watermark: true,
     });
   });
 });

tests/api-resources/organization.test.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import RunwayML from '@runwayml/sdk';
+import { Response } from 'node-fetch';
+
+const client = new RunwayML({
+  apiKey: 'My API Key',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource organization', () => {
+  test('retrieve', async () => {
+    const responsePromise = client.organization.retrieve();
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('retrieve: request options instead of params are passed correctly', async () => {
+    // ensure the request options are being passed correctly by passing an invalid HTTP method in order to cause an error
+    await expect(client.organization.retrieve({ path: '/_stainless_unknown_path' })).rejects.toThrow(
+      RunwayML.NotFoundError,
+    );
+  });
+});