@mixedbread/sdk 0.5.0 → 0.7.2

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

@@ -0,0 +1,290 @@
+// 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;
+
+  /**
+   * Polling interval for the connector. Defaults to 30 minutes if not specified. Can
+   * be provided as:
+   *
+   * - int: Number of seconds (e.g., 1800 for 30 minutes)
+   * - str: Duration string (e.g., '30m', '1h', '2d') or ISO 8601 format (e.g.,
+   *   'PT30M', 'P1D') Valid range: 15 seconds to 30 days
+   */
+  polling_interval?: number | 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: Polling interval for the connector. Defaults to 30 minutes if not
+   * specified. Can be provided as:
+   *
+   * - int: Number of seconds (e.g., 1800 for 30 minutes)
+   * - str: Duration string (e.g., '30m', '1h', '2d') or ISO 8601 format (e.g.,
+   *   'PT30M', 'P1D') Valid range: 15 seconds to 30 days
+   */
+  polling_interval?: number | 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,
+  };
+}

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

@@ -0,0 +1,404 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ConnectorsAPI from './connectors';
+import {
+  ConnectorCreateParams,
+  ConnectorDeleteParams,
+  ConnectorDeleteResponse,
+  ConnectorListParams,
+  ConnectorRetrieveParams,
+  ConnectorUpdateParams,
+  Connectors,
+  DataSourceConnector,
+  DataSourceConnectorsLimitOffset,
+} from './connectors';
+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 DataSources extends APIResource {
+  connectors: ConnectorsAPI.Connectors = new ConnectorsAPI.Connectors(this._client);
+
+  /**
+   * Create a new data source.
+   *
+   * Args: params: The data source to create.
+   *
+   * Returns: The created data source.
+   */
+  create(body: DataSourceCreateParams, options?: RequestOptions): APIPromise<DataSource> {
+    return this._client.post('/v1/data_sources/', { body, ...options });
+  }
+
+  /**
+   * Get a data source by ID.
+   *
+   * Args: data_source_id: The ID of the data source to fetch.
+   *
+   * Returns: The data source.
+   */
+  retrieve(dataSourceID: string, options?: RequestOptions): APIPromise<DataSource> {
+    return this._client.get(path`/v1/data_sources/${dataSourceID}`, options);
+  }
+
+  /**
+   * Update a data source.
+   *
+   * Args: data_source_id: The ID of the data source to update. params: The data
+   * source to update.
+   *
+   * Returns: The updated data source.
+   */
+  update(
+    dataSourceID: string,
+    body: DataSourceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<DataSource> {
+    return this._client.put(path`/v1/data_sources/${dataSourceID}`, { body, ...options });
+  }
+
+  /**
+   * Get all data sources.
+   *
+   * Returns: The list of data sources.
+   */
+  list(
+    query: DataSourceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DataSourcesLimitOffset, DataSource> {
+    return this._client.getAPIList('/v1/data_sources/', LimitOffset<DataSource>, { query, ...options });
+  }
+
+  /**
+   * Delete a data source.
+   *
+   * Args: data_source_id: The ID of the data source to delete.
+   */
+  delete(dataSourceID: string, options?: RequestOptions): APIPromise<DataSourceDeleteResponse> {
+    return this._client.delete(path`/v1/data_sources/${dataSourceID}`, options);
+  }
+}
+
+export type DataSourcesLimitOffset = LimitOffset<DataSource>;
+
+/**
+ * Service-level representation of a data source.
+ */
+export interface DataSource {
+  /**
+   * The ID of the data source
+   */
+  id: string;
+
+  /**
+   * The creation time of the data source
+   */
+  created_at: string;
+
+  /**
+   * The last update time of the data source
+   */
+  updated_at: string;
+
+  /**
+   * The type of data source
+   */
+  type: DataSourceType;
+
+  /**
+   * The name of the data source
+   */
+  name: string;
+
+  /**
+   * The metadata of the data source
+   */
+  metadata: unknown;
+
+  /**
+   * Authentication parameters
+   */
+  auth_params: DataSourceOauth2Params | DataSource.DataSourceAPIKeyParams | null;
+
+  /**
+   * The type of the object
+   */
+  object?: 'data_source';
+}
+
+export namespace DataSource {
+  /**
+   * Authentication parameters for a API key data source.
+   */
+  export interface DataSourceAPIKeyParams {
+    type?: 'api_key';
+
+    /**
+     * The API key
+     */
+    api_key: string;
+  }
+}
+
+/**
+ * Authentication parameters for a OAuth data source.
+ */
+export interface DataSourceOauth2Params {
+  type?: 'oauth2';
+
+  /**
+   * The timestamp when the OAuth2 credentials were created
+   */
+  created_at?: string;
+
+  /**
+   * The OAuth2 scope
+   */
+  scope?: string;
+
+  /**
+   * The OAuth2 access token
+   */
+  access_token?: string | null;
+
+  /**
+   * The OAuth2 refresh token
+   */
+  refresh_token?: string | null;
+
+  /**
+   * The OAuth2 token type
+   */
+  token_type?: string | null;
+
+  /**
+   * The OAuth2 token expiration timestamp
+   */
+  expires_on?: string | null;
+
+  /**
+   * Additional parameters for the OAuth2 flow
+   */
+  additional_params?: Record<string, unknown> | null;
+}
+
+export type DataSourceType = 'notion' | 'linear';
+
+/**
+ * Deleted data source.
+ */
+export interface DataSourceDeleteResponse {
+  /**
+   * The ID of the data source
+   */
+  id: string;
+
+  /**
+   * Whether the data source was deleted
+   */
+  deleted?: boolean;
+
+  /**
+   * The type of the object
+   */
+  object?: 'data_source';
+}
+
+export type DataSourceCreateParams =
+  | DataSourceCreateParams.NotionDataSourceCreateOrUpdateParams
+  | DataSourceCreateParams.LinearDataSourceCreateOrUpdateParams;
+
+export declare namespace DataSourceCreateParams {
+  export interface NotionDataSourceCreateOrUpdateParams {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * The authentication parameters of the data source. Notion supports OAuth2 and API
+     * key.
+     */
+    auth_params?:
+      | NotionDataSourceCreateOrUpdateParams.OAuth2CreateOrUpdateParams
+      | NotionDataSourceCreateOrUpdateParams.APIKeyCreateOrUpdateParams
+      | null;
+  }
+
+  export namespace NotionDataSourceCreateOrUpdateParams {
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    export interface OAuth2CreateOrUpdateParams {
+      type?: 'oauth2';
+    }
+
+    /**
+     * Base class for API key create or update parameters.
+     */
+    export interface APIKeyCreateOrUpdateParams {
+      type?: 'api_key';
+
+      /**
+       * The API key
+       */
+      api_key: string;
+    }
+  }
+
+  export interface LinearDataSourceCreateOrUpdateParams {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    auth_params?: LinearDataSourceCreateOrUpdateParams.AuthParams | null;
+  }
+
+  export namespace LinearDataSourceCreateOrUpdateParams {
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    export interface AuthParams {
+      type?: 'oauth2';
+    }
+  }
+}
+
+export type DataSourceUpdateParams =
+  | DataSourceUpdateParams.NotionDataSourceCreateOrUpdateParams
+  | DataSourceUpdateParams.LinearDataSourceCreateOrUpdateParams;
+
+export declare namespace DataSourceUpdateParams {
+  export interface NotionDataSourceCreateOrUpdateParams {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * The authentication parameters of the data source. Notion supports OAuth2 and API
+     * key.
+     */
+    auth_params?:
+      | NotionDataSourceCreateOrUpdateParams.OAuth2CreateOrUpdateParams
+      | NotionDataSourceCreateOrUpdateParams.APIKeyCreateOrUpdateParams
+      | null;
+  }
+
+  export namespace NotionDataSourceCreateOrUpdateParams {
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    export interface OAuth2CreateOrUpdateParams {
+      type?: 'oauth2';
+    }
+
+    /**
+     * Base class for API key create or update parameters.
+     */
+    export interface APIKeyCreateOrUpdateParams {
+      type?: 'api_key';
+
+      /**
+       * The API key
+       */
+      api_key: string;
+    }
+  }
+
+  export interface LinearDataSourceCreateOrUpdateParams {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    auth_params?: LinearDataSourceCreateOrUpdateParams.AuthParams | null;
+  }
+
+  export namespace LinearDataSourceCreateOrUpdateParams {
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    export interface AuthParams {
+      type?: 'oauth2';
+    }
+  }
+}
+
+export interface DataSourceListParams extends LimitOffsetParams {}
+
+DataSources.Connectors = Connectors;
+
+export declare namespace DataSources {
+  export {
+    type DataSource as DataSource,
+    type DataSourceOauth2Params as DataSourceOauth2Params,
+    type DataSourceType as DataSourceType,
+    type DataSourceDeleteResponse as DataSourceDeleteResponse,
+    type DataSourcesLimitOffset as DataSourcesLimitOffset,
+    type DataSourceCreateParams as DataSourceCreateParams,
+    type DataSourceUpdateParams as DataSourceUpdateParams,
+    type DataSourceListParams as DataSourceListParams,
+  };
+
+  export {
+    Connectors as Connectors,
+    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,
+  };
+}

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

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Connectors,
+  type DataSourceConnector,
+  type ConnectorDeleteResponse,
+  type ConnectorCreateParams,
+  type ConnectorRetrieveParams,
+  type ConnectorUpdateParams,
+  type ConnectorListParams,
+  type ConnectorDeleteParams,
+  type DataSourceConnectorsLimitOffset,
+} from './connectors';
+export {
+  DataSources,
+  type DataSource,
+  type DataSourceOauth2Params,
+  type DataSourceType,
+  type DataSourceDeleteResponse,
+  type DataSourceCreateParams,
+  type DataSourceUpdateParams,
+  type DataSourceListParams,
+  type DataSourcesLimitOffset,
+} from './data-sources';

package/src/resources/data-sources.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './data-sources/index';