@mixedbread/sdk 0.5.0 → 0.6.0

package/src/resources/api-keys.ts

@@ -0,0 +1,225 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { LimitOffset, type LimitOffsetParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class APIKeys extends APIResource {
+  /**
+   * Create a new API key.
+   *
+   * Args: params: The parameters for creating the API key.
+   *
+   * Returns: ApiKeyCreated: The response containing the details of the created API
+   * key.
+   */
+  create(body: APIKeyCreateParams, options?: RequestOptions): APIPromise<APIKeyCreated> {
+    return this._client.post('/v1/api-keys', { body, ...options });
+  }
+
+  /**
+   * Retrieve details of a specific API key by its ID.
+   *
+   * Args: api_key_id: The ID of the API key to retrieve.
+   *
+   * Returns: ApiKey: The response containing the API key details.
+   */
+  retrieve(apiKeyID: string, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.get(path`/v1/api-keys/${apiKeyID}`, options);
+  }
+
+  /**
+   * List all API keys for the authenticated user.
+   *
+   * Args: pagination: The pagination options
+   *
+   * Returns: A list of API keys belonging to the user.
+   */
+  list(
+    query: APIKeyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<APIKeysLimitOffset, APIKey> {
+    return this._client.getAPIList('/v1/api-keys', LimitOffset<APIKey>, { query, ...options });
+  }
+
+  /**
+   * Delete a specific API key by its ID.
+   *
+   * Args: api_key_id: The ID of the API key to delete.
+   *
+   * Returns: ApiKeyDeleted: The response containing the details of the deleted API
+   * key.
+   */
+  delete(apiKeyID: string, options?: RequestOptions): APIPromise<APIKeyDeleteResponse> {
+    return this._client.delete(path`/v1/api-keys/${apiKeyID}`, options);
+  }
+
+  /**
+   * Reroll the secret for a specific API key by its ID.
+   *
+   * This generates a new secret key, invalidating the old one.
+   *
+   * Args: api_key_id: The ID of the API key to reroll.
+   *
+   * Returns: ApiKeyCreated: The response containing the API key details with the new
+   * secret key.
+   */
+  reroll(apiKeyID: string, options?: RequestOptions): APIPromise<APIKeyCreated> {
+    return this._client.post(path`/v1/api-keys/${apiKeyID}/reroll`, options);
+  }
+
+  /**
+   * Revoke a specific API key by its ID.
+   *
+   * Args: api_key_id: The ID of the API key to revoke.
+   *
+   * Returns: ApiKey: The response containing the details of the revoked API key.
+   */
+  revoke(apiKeyID: string, options?: RequestOptions): APIPromise<APIKey> {
+    return this._client.post(path`/v1/api-keys/${apiKeyID}/revoke`, options);
+  }
+}
+
+export type APIKeysLimitOffset = LimitOffset<APIKey>;
+
+/**
+ * Response model for an API key.
+ */
+export interface APIKey {
+  /**
+   * The ID of the API key
+   */
+  id: string;
+
+  /**
+   * The name of the API key
+   */
+  name: string;
+
+  /**
+   * The redacted value of the API key
+   */
+  redacted_value: string;
+
+  /**
+   * The expiration datetime of the API key
+   */
+  expires_at?: string | null;
+
+  /**
+   * The creation datetime of the API key
+   */
+  created_at: string;
+
+  /**
+   * The last update datetime of the API key
+   */
+  updated_at: string;
+
+  /**
+   * The last active datetime of the API key
+   */
+  last_active_at?: string | null;
+
+  /**
+   * The type of the object
+   */
+  object?: 'api_key';
+}
+
+/**
+ * Response model for creating an API key.
+ */
+export interface APIKeyCreated {
+  /**
+   * The ID of the API key
+   */
+  id: string;
+
+  /**
+   * The name of the API key
+   */
+  name: string;
+
+  /**
+   * The redacted value of the API key
+   */
+  redacted_value: string;
+
+  /**
+   * The expiration datetime of the API key
+   */
+  expires_at?: string | null;
+
+  /**
+   * The creation datetime of the API key
+   */
+  created_at: string;
+
+  /**
+   * The last update datetime of the API key
+   */
+  updated_at: string;
+
+  /**
+   * The last active datetime of the API key
+   */
+  last_active_at?: string | null;
+
+  /**
+   * The type of the object
+   */
+  object?: 'api_key';
+
+  /**
+   * The value of the API key
+   */
+  value: string;
+}
+
+/**
+ * Response model for deleting an API key.
+ */
+export interface APIKeyDeleteResponse {
+  /**
+   * The ID of the deleted API key
+   */
+  id: string;
+
+  /**
+   * Whether the API key was deleted
+   */
+  deleted: boolean;
+
+  /**
+   * The type of the object deleted
+   */
+  object?: 'api_key';
+}
+
+export interface APIKeyCreateParams {
+  /**
+   * A name/description for the API key
+   */
+  name?: string;
+
+  /**
+   * Optional expiration datetime
+   */
+  expires_at?: string | null;
+}
+
+export interface APIKeyListParams extends LimitOffsetParams {}
+
+export declare namespace APIKeys {
+  export {
+    type APIKey as APIKey,
+    type APIKeyCreated as APIKeyCreated,
+    type APIKeyDeleteResponse as APIKeyDeleteResponse,
+    type APIKeysLimitOffset as APIKeysLimitOffset,
+    type APIKeyCreateParams as APIKeyCreateParams,
+    type APIKeyListParams as APIKeyListParams,
+  };
+}

package/src/resources/chat.ts

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Chat extends APIResource {
+  /**
+   * Create a chat completion using the provided parameters.
+   *
+   * Generates a completion response based on the chat messages and model parameters
+   * provided. The response can be either a full completion or streamed chunks
+   * depending on the request parameters.
+   *
+   * Args: params: Parameters for creating the chat completion including messages,
+   * model selection, and generation settings user: The authenticated user making the
+   * request
+   *
+   * Returns: Either a ChatCompletion containing the full response, or
+   * ChatCompletionChunk for streaming
+   *
+   * Raises: HTTPException: If there is an error creating the completion (500)
+   */
+  createCompletion(options?: RequestOptions): APIPromise<unknown> {
+    return this._client.post('/v1/chat/completions', options);
+  }
+}
+
+export type ChatCreateCompletionResponse = unknown;
+
+export declare namespace Chat {
+  export { type ChatCreateCompletionResponse as ChatCreateCompletionResponse };
+}

package/src/resources/data-sources/connectors.ts

@@ -0,0 +1,280 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { LimitOffset, type LimitOffsetParams, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Connectors extends APIResource {
+  /**
+   * Create a new connector.
+   *
+   * Args: data_source_id: The ID of the data source to create a connector for.
+   * params: The connector to create.
+   *
+   * Returns: The created connector.
+   */
+  create(
+    dataSourceID: string,
+    body: ConnectorCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<DataSourceConnector> {
+    return this._client.post(path`/v1/data_sources/${dataSourceID}/connectors`, { body, ...options });
+  }
+
+  /**
+   * Get a connector by ID.
+   *
+   * Args: data_source_id: The ID of the data source to get a connector for.
+   * connector_id: The ID of the connector to get.
+   *
+   * Returns: The connector.
+   */
+  retrieve(
+    connectorID: string,
+    params: ConnectorRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<DataSourceConnector> {
+    const { data_source_id } = params;
+    return this._client.get(path`/v1/data_sources/${data_source_id}/connectors/${connectorID}`, options);
+  }
+
+  /**
+   * Update a connector.
+   *
+   * Args: data_source_id: The ID of the data source to update a connector for.
+   * connector_id: The ID of the connector to update. params: The connector to
+   * update.
+   *
+   * Returns: The updated connector.
+   */
+  update(
+    connectorID: string,
+    params: ConnectorUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<DataSourceConnector> {
+    const { data_source_id, ...body } = params;
+    return this._client.put(path`/v1/data_sources/${data_source_id}/connectors/${connectorID}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * Get all connectors for a data source.
+   *
+   * Args: data_source_id: The ID of the data source to get connectors for.
+   * pagination: The pagination options.
+   *
+   * Returns: The list of connectors.
+   */
+  list(
+    dataSourceID: string,
+    query: ConnectorListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DataSourceConnectorsLimitOffset, DataSourceConnector> {
+    return this._client.getAPIList(
+      path`/v1/data_sources/${dataSourceID}/connectors`,
+      LimitOffset<DataSourceConnector>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Delete a connector.
+   *
+   * Args: data_source_id: The ID of the data source to delete a connector for.
+   * connector_id: The ID of the connector to delete.
+   *
+   * Returns: The deleted connector.
+   */
+  delete(
+    connectorID: string,
+    params: ConnectorDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<ConnectorDeleteResponse> {
+    const { data_source_id } = params;
+    return this._client.delete(path`/v1/data_sources/${data_source_id}/connectors/${connectorID}`, options);
+  }
+}
+
+export type DataSourceConnectorsLimitOffset = LimitOffset<DataSourceConnector>;
+
+/**
+ * Service-level representation of a connector.
+ */
+export interface DataSourceConnector {
+  /**
+   * The ID of the connector
+   */
+  id: string;
+
+  /**
+   * The creation time of the connector
+   */
+  created_at: string;
+
+  /**
+   * The last update time of the connector
+   */
+  updated_at: string;
+
+  /**
+   * The ID of the vector store
+   */
+  vector_store_id: string;
+
+  /**
+   * The ID of the data source
+   */
+  data_source_id: string;
+
+  /**
+   * The name of the connector
+   */
+  name?: string;
+
+  /**
+   * The metadata of the connector
+   */
+  metadata: unknown;
+
+  /**
+   * The polling interval of the connector
+   */
+  polling_interval: string;
+
+  /**
+   * The start time of the connector
+   */
+  started_at: string | null;
+
+  /**
+   * The finish time of the connector
+   */
+  finished_at: string | null;
+
+  /**
+   * The last sync time of the connector
+   */
+  last_synced_at: string | null;
+
+  /**
+   * The sync status of the connector
+   */
+  status: 'idle' | 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+
+  /**
+   * The sync error of the connector
+   */
+  error: string | null;
+
+  /**
+   * The type of the object
+   */
+  object?: 'data_source.connector';
+}
+
+/**
+ * Deleted connector.
+ */
+export interface ConnectorDeleteResponse {
+  /**
+   * The ID of the connector
+   */
+  id: string;
+
+  /**
+   * Whether the connector was deleted
+   */
+  deleted?: boolean;
+
+  /**
+   * The type of the object
+   */
+  object?: 'data_source.connector';
+}
+
+export interface ConnectorCreateParams {
+  /**
+   * The ID of the vector store
+   */
+  vector_store_id: string;
+
+  /**
+   * The name of the connector
+   */
+  name?: string;
+
+  /**
+   * Whether the connector should be synced after creation
+   */
+  trigger_sync?: boolean;
+
+  /**
+   * The metadata of the connector
+   */
+  metadata?: unknown;
+
+  /**
+   * The polling interval of the connector
+   */
+  polling_interval?: string | null;
+}
+
+export interface ConnectorRetrieveParams {
+  /**
+   * The ID of the data source to get a connector for
+   */
+  data_source_id: string;
+}
+
+export interface ConnectorUpdateParams {
+  /**
+   * Path param: The ID of the data source to update a connector for
+   */
+  data_source_id: string;
+
+  /**
+   * Body param: The name of the connector
+   */
+  name?: string | null;
+
+  /**
+   * Body param: The metadata of the connector
+   */
+  metadata?: Record<string, unknown> | null;
+
+  /**
+   * Body param: Whether the connector should be synced after update
+   */
+  trigger_sync?: boolean | null;
+
+  /**
+   * Body param: The polling interval of the connector
+   */
+  polling_interval?: string | null;
+}
+
+export interface ConnectorListParams extends LimitOffsetParams {}
+
+export interface ConnectorDeleteParams {
+  /**
+   * The ID of the data source to delete a connector for
+   */
+  data_source_id: string;
+}
+
+export declare namespace Connectors {
+  export {
+    type DataSourceConnector as DataSourceConnector,
+    type ConnectorDeleteResponse as ConnectorDeleteResponse,
+    type DataSourceConnectorsLimitOffset as DataSourceConnectorsLimitOffset,
+    type ConnectorCreateParams as ConnectorCreateParams,
+    type ConnectorRetrieveParams as ConnectorRetrieveParams,
+    type ConnectorUpdateParams as ConnectorUpdateParams,
+    type ConnectorListParams as ConnectorListParams,
+    type ConnectorDeleteParams as ConnectorDeleteParams,
+  };
+}