cadenya 0.16.0

package/src/resources/document-namespaces.ts

@@ -0,0 +1,145 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { CursorPagination, type CursorPaginationParams, PagePromise } from '../core/pagination';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class DocumentNamespaces extends APIResource {
+  /**
+   * Creates a new document namespace in the workspace
+   */
+  create(body: DocumentNamespaceCreateParams, options?: RequestOptions): APIPromise<DocumentNamespace> {
+    return this._client.post('/v1/document_namespaces', { body, ...options });
+  }
+
+  /**
+   * Retrieves a document namespace by ID from the workspace
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DocumentNamespace> {
+    return this._client.get(path`/v1/document_namespaces/${id}`, options);
+  }
+
+  /**
+   * Updates a document namespace in the workspace
+   */
+  update(
+    pathID: string,
+    body: DocumentNamespaceUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<DocumentNamespace> {
+    return this._client.patch(path`/v1/document_namespaces/${pathID}`, { body, ...options });
+  }
+
+  /**
+   * Lists all document namespaces in the workspace
+   */
+  list(
+    query: DocumentNamespaceListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DocumentNamespacesCursorPagination, DocumentNamespace> {
+    return this._client.getAPIList('/v1/document_namespaces', CursorPagination<DocumentNamespace>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Deletes a document namespace from the workspace
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/document_namespaces/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type DocumentNamespacesCursorPagination = CursorPagination<DocumentNamespace>;
+
+/**
+ * DocumentNamespace is a container that categorizes and organizes documents.
+ * Namespaces support use cases such as customer-specific documents, regionalized
+ * documentation, and agent-created episodic memories. A namespace can hold
+ * thousands of documents, and each document belongs to exactly one namespace.
+ */
+export interface DocumentNamespace {
+  /**
+   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+   */
+  metadata?: Shared.ResourceMetadata;
+
+  /**
+   * DocumentNamespaceSpec defines the properties of a document namespace.
+   */
+  spec?: DocumentNamespaceSpec;
+}
+
+/**
+ * DocumentNamespaceSpec defines the properties of a document namespace.
+ */
+export interface DocumentNamespaceSpec {
+  /**
+   * Status of the document namespace
+   */
+  status?:
+    | 'DOCUMENT_STATUS_UNSPECIFIED'
+    | 'DOCUMENT_STATUS_ENABLED'
+    | 'DOCUMENT_STATUS_DISABLED'
+    | 'DOCUMENT_STATUS_ARCHIVED';
+
+  /**
+   * Human-readable summary describing the purpose of this namespace
+   */
+  summary?: string;
+}
+
+export interface DocumentNamespaceCreateParams {
+  /**
+   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+   */
+  metadata?: Shared.ResourceMetadata;
+
+  /**
+   * DocumentNamespaceSpec defines the properties of a document namespace.
+   */
+  spec?: DocumentNamespaceSpec;
+}
+
+export interface DocumentNamespaceUpdateParams {
+  /**
+   * Unique identifier of the document namespace to update
+   */
+  body_id?: string;
+
+  /**
+   * Standard metadata for persistent, named resources (e.g., agents, tools, prompts)
+   */
+  metadata?: Shared.ResourceMetadata;
+
+  /**
+   * DocumentNamespaceSpec defines the properties of a document namespace.
+   */
+  spec?: DocumentNamespaceSpec;
+
+  /**
+   * Fields to update (if empty, all fields are updated)
+   */
+  updateMask?: string;
+}
+
+export interface DocumentNamespaceListParams extends CursorPaginationParams {}
+
+export declare namespace DocumentNamespaces {
+  export {
+    type DocumentNamespace as DocumentNamespace,
+    type DocumentNamespaceSpec as DocumentNamespaceSpec,
+    type DocumentNamespacesCursorPagination as DocumentNamespacesCursorPagination,
+    type DocumentNamespaceCreateParams as DocumentNamespaceCreateParams,
+    type DocumentNamespaceUpdateParams as DocumentNamespaceUpdateParams,
+    type DocumentNamespaceListParams as DocumentNamespaceListParams,
+  };
+}