@openrouter/sdk 0.0.0-beta.9 → 0.0.1-beta.1

package/docs/sdks/models/README.md

@@ -3,19 +3,21 @@
 
 ## Overview
 
+Model information endpoints
+
 ### Available Operations
 
-* [getModelsCount](#getmodelscount) - Get total count of available models
-* [getModels](#getmodels) - List all models and their properties
-* [getModelsUser](#getmodelsuser) - List models filtered by user provider preferences
+* [count](#count) - Get total count of available models
+* [list](#list) - List all models and their properties
+* [listForUser](#listforuser) - List models filtered by user provider preferences
 
-## getModelsCount
+## count
 
 Get total count of available models
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/models/count" method="get" path="/models/count" -->
+<!-- UsageSnippet language="typescript" operationID="listModelsCount" method="get" path="/models/count" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -24,7 +26,7 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.models.getModelsCount();
+  const result = await openRouter.models.count();
 
   console.log(result);
 }
@@ -38,7 +40,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { modelsGetModelsCount } from "@openrouter/sdk/funcs/modelsGetModelsCount.js";
+import { modelsCount } from "@openrouter/sdk/funcs/modelsCount.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,12 +49,12 @@ const openRouter = new OpenRouterCore({
 });
 
 async function run() {
-  const res = await modelsGetModelsCount(openRouter);
+  const res = await modelsCount(openRouter);
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("modelsGetModelsCount failed:", res.error);
+    console.log("modelsCount failed:", res.error);
   }
 }
 
@@ -72,18 +74,18 @@ associated utilities.
 ```tsx
 import {
   // Query hooks for fetching data.
-  useModelsGetModelsCount,
-  useModelsGetModelsCountSuspense,
+  useModelsCount,
+  useModelsCountSuspense,
 
   // Utility for prefetching data during server-side rendering and in React
   // Server Components that will be immediately available to client components
   // using the hooks.
-  prefetchModelsGetModelsCount,
+  prefetchModelsCount,
   
   // Utility to invalidate the query cache for this query in response to
   // mutations and other user actions.
-  invalidateAllModelsGetModelsCount,
-} from "@openrouter/sdk/react-query/modelsGetModelsCount.js";
+  invalidateAllModelsCount,
+} from "@openrouter/sdk/react-query/modelsCount.js";
 ```
 
 ### Parameters
@@ -96,22 +98,21 @@ import {
 
 ### Response
 
-**Promise\<[operations.GetModelsCountResponse](../../models/operations/getmodelscountresponse.md)\>**
+**Promise\<[operations.ListModelsCountResponse](../../models/operations/listmodelscountresponse.md)\>**
 
 ### Errors
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |
 
-## getModels
+## list
 
 List all models and their properties
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/models" method="get" path="/models" -->
+<!-- UsageSnippet language="typescript" operationID="getModels" method="get" path="/models" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -120,7 +121,12 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.models.getModels();
+  const result = await openRouter.models.list({
+    category: "<value>",
+    supportedParameters: "<value>",
+    useRss: "<value>",
+    useRssChatLinks: "<value>",
+  });
 
   console.log(result);
 }
@@ -134,7 +140,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { modelsGetModels } from "@openrouter/sdk/funcs/modelsGetModels.js";
+import { modelsList } from "@openrouter/sdk/funcs/modelsList.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -143,12 +149,17 @@ const openRouter = new OpenRouterCore({
 });
 
 async function run() {
-  const res = await modelsGetModels(openRouter);
+  const res = await modelsList(openRouter, {
+    category: "<value>",
+    supportedParameters: "<value>",
+    useRss: "<value>",
+    useRssChatLinks: "<value>",
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("modelsGetModels failed:", res.error);
+    console.log("modelsList failed:", res.error);
   }
 }
 
@@ -168,26 +179,26 @@ associated utilities.
 ```tsx
 import {
   // Query hooks for fetching data.
-  useModelsGetModels,
-  useModelsGetModelsSuspense,
+  useModelsList,
+  useModelsListSuspense,
 
   // Utility for prefetching data during server-side rendering and in React
   // Server Components that will be immediately available to client components
   // using the hooks.
-  prefetchModelsGetModels,
+  prefetchModelsList,
   
   // Utilities to invalidate the query cache for this query in response to
   // mutations and other user actions.
-  invalidateModelsGetModels,
-  invalidateAllModelsGetModels,
-} from "@openrouter/sdk/react-query/modelsGetModels.js";
+  invalidateModelsList,
+  invalidateAllModelsList,
+} from "@openrouter/sdk/react-query/modelsList.js";
 ```
 
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetModelsRequestRequest](../../models/operations/getmodelsrequestrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetModelsRequest](../../models/operations/getmodelsrequest.md)                                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
@@ -198,25 +209,24 @@ import {
 
 ### Errors
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |
 
-## getModelsUser
+## listForUser
 
 List models filtered by user provider preferences
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/models/user" method="get" path="/models/user" -->
+<!-- UsageSnippet language="typescript" operationID="listModelsUser" method="get" path="/models/user" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
 const openRouter = new OpenRouter();
 
 async function run() {
-  const result = await openRouter.models.getModelsUser({
+  const result = await openRouter.models.listForUser({
     bearer: process.env["OPENROUTER_BEARER"] ?? "",
   });
 
@@ -232,21 +242,21 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { modelsGetModelsUser } from "@openrouter/sdk/funcs/modelsGetModelsUser.js";
+import { modelsListForUser } from "@openrouter/sdk/funcs/modelsListForUser.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const openRouter = new OpenRouterCore();
 
 async function run() {
-  const res = await modelsGetModelsUser(openRouter, {
+  const res = await modelsListForUser(openRouter, {
     bearer: process.env["OPENROUTER_BEARER"] ?? "",
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("modelsGetModelsUser failed:", res.error);
+    console.log("modelsListForUser failed:", res.error);
   }
 }
 
@@ -266,36 +276,35 @@ associated utilities.
 ```tsx
 import {
   // Query hooks for fetching data.
-  useModelsGetModelsUser,
-  useModelsGetModelsUserSuspense,
+  useModelsListForUser,
+  useModelsListForUserSuspense,
 
   // Utility for prefetching data during server-side rendering and in React
   // Server Components that will be immediately available to client components
   // using the hooks.
-  prefetchModelsGetModelsUser,
+  prefetchModelsListForUser,
   
   // Utility to invalidate the query cache for this query in response to
   // mutations and other user actions.
-  invalidateAllModelsGetModelsUser,
-} from "@openrouter/sdk/react-query/modelsGetModelsUser.js";
+  invalidateAllModelsListForUser,
+} from "@openrouter/sdk/react-query/modelsListForUser.js";
 ```
 
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `security`                                                                                                                                                                     | [operations.GetModelsUserSecurity](../../models/operations/getmodelsusersecurity.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The security requirements to use for the request.                                                                                                                              |
+| `security`                                                                                                                                                                     | [operations.ListModelsUserSecurity](../../models/operations/listmodelsusersecurity.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The security requirements to use for the request.                                                                                                                              |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.GetModelsUserResponse](../../models/operations/getmodelsuserresponse.md)\>**
+**Promise\<[operations.ListModelsUserResponse](../../models/operations/listmodelsuserresponse.md)\>**
 
 ### Errors
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | 4XX                  | application/json     |
-| errors.ErrorResponse | 5XX                  | application/json     |
+| Error Type                    | Status Code                   | Content Type                  |
+| ----------------------------- | ----------------------------- | ----------------------------- |
+| errors.OpenRouterDefaultError | 4XX, 5XX                      | \*/\*                         |

package/docs/sdks/parameters/README.md

@@ -0,0 +1,117 @@
+# ParametersT
+(*parameters*)
+
+## Overview
+
+Parameters endpoints
+
+### Available Operations
+
+* [getParameters](#getparameters) - Get a model's supported parameters and data about which are most popular
+
+## getParameters
+
+Get a model's supported parameters and data about which are most popular
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getParameters" method="get" path="/parameters/{author}/{slug}" -->
+```typescript
+import { OpenRouter } from "@openrouter/sdk";
+
+const openRouter = new OpenRouter();
+
+async function run() {
+  const result = await openRouter.parameters.getParameters({
+    bearer: process.env["OPENROUTER_BEARER"] ?? "",
+  }, {
+    author: "<value>",
+    slug: "<value>",
+    provider: "Google AI Studio",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OpenRouterCore } from "@openrouter/sdk/core.js";
+import { parametersGetParameters } from "@openrouter/sdk/funcs/parametersGetParameters.js";
+
+// Use `OpenRouterCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const openRouter = new OpenRouterCore();
+
+async function run() {
+  const res = await parametersGetParameters(openRouter, {
+    bearer: process.env["OPENROUTER_BEARER"] ?? "",
+  }, {
+    author: "<value>",
+    slug: "<value>",
+    provider: "Google AI Studio",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("parametersGetParameters failed:", res.error);
+  }
+}
+
+run();
+```
+
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useParametersGetParameters,
+  useParametersGetParametersSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchParametersGetParameters,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateParametersGetParameters,
+  invalidateAllParametersGetParameters,
+} from "@openrouter/sdk/react-query/parametersGetParameters.js";
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetParametersRequest](../../models/operations/getparametersrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `security`                                                                                                                                                                     | [operations.GetParametersSecurity](../../models/operations/getparameterssecurity.md)                                                                                           | :heavy_check_mark:                                                                                                                                                             | The security requirements to use for the request.                                                                                                                              |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.GetParametersResponse](../../models/operations/getparametersresponse.md)\>**
+
+### Errors
+
+| Error Type           | Status Code          | Content Type         |
+| -------------------- | -------------------- | -------------------- |
+| errors.ErrorResponse | 4XX                  | application/json     |
+| errors.ErrorResponse | 5XX                  | application/json     |

package/docs/sdks/providers/README.md

@@ -3,17 +3,19 @@
 
 ## Overview
 
+Provider information endpoints
+
 ### Available Operations
 
-* [getProviders](#getproviders) - List all available model providers
+* [list](#list) - List all providers
 
-## getProviders
+## list
 
-List all available model providers
+List all providers
 
 ### Example Usage
 
-<!-- UsageSnippet language="typescript" operationID="get_/providers" method="get" path="/providers" -->
+<!-- UsageSnippet language="typescript" operationID="listProviders" method="get" path="/providers" -->
 ```typescript
 import { OpenRouter } from "@openrouter/sdk";
 
@@ -22,7 +24,7 @@ const openRouter = new OpenRouter({
 });
 
 async function run() {
-  const result = await openRouter.providers.getProviders();
+  const result = await openRouter.providers.list();
 
   console.log(result);
 }
@@ -36,7 +38,7 @@ The standalone function version of this method:
 
 ```typescript
 import { OpenRouterCore } from "@openrouter/sdk/core.js";
-import { providersGetProviders } from "@openrouter/sdk/funcs/providersGetProviders.js";
+import { providersList } from "@openrouter/sdk/funcs/providersList.js";
 
 // Use `OpenRouterCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -45,12 +47,12 @@ const openRouter = new OpenRouterCore({
 });
 
 async function run() {
-  const res = await providersGetProviders(openRouter);
+  const res = await providersList(openRouter);
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("providersGetProviders failed:", res.error);
+    console.log("providersList failed:", res.error);
   }
 }
 
@@ -70,18 +72,18 @@ associated utilities.
 ```tsx
 import {
   // Query hooks for fetching data.
-  useProvidersGetProviders,
-  useProvidersGetProvidersSuspense,
+  useProvidersList,
+  useProvidersListSuspense,
 
   // Utility for prefetching data during server-side rendering and in React
   // Server Components that will be immediately available to client components
   // using the hooks.
-  prefetchProvidersGetProviders,
+  prefetchProvidersList,
   
   // Utility to invalidate the query cache for this query in response to
   // mutations and other user actions.
-  invalidateAllProvidersGetProviders,
-} from "@openrouter/sdk/react-query/providersGetProviders.js";
+  invalidateAllProvidersList,
+} from "@openrouter/sdk/react-query/providersList.js";
 ```
 
 ### Parameters
@@ -94,7 +96,7 @@ import {
 
 ### Response
 
-**Promise\<[operations.GetProvidersResponse](../../models/operations/getprovidersresponse.md)\>**
+**Promise\<[operations.ListProvidersResponse](../../models/operations/listprovidersresponse.md)\>**
 
 ### Errors