@studyfetch/sdk 1.2.0 → 1.3.0

package/src/resources/v1/materials/materials.ts

@@ -6,7 +6,13 @@ import { Bulk } from './bulk';
 import * as TestAPI from './test';
 import { Test } from './test';
 import * as UploadAPI from './upload';
-import { Upload, UploadUploadFileParams, UploadUploadFromURLParams } from './upload';
+import {
+  Upload,
+  UploadUploadFileParams,
+  UploadUploadFileResponse,
+  UploadUploadFromURLParams,
+  UploadUploadFromURLResponse,
+} from './upload';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
@@ -22,18 +28,14 @@ export class Materials extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.materials.create({
+   * const material = await client.v1.materials.create({
    *   content: { type: 'text' },
    *   name: 'Chapter 1 - Introduction',
    * });
    * ```
    */
-  create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  create(body: MaterialCreateParams, options?: RequestOptions): APIPromise<MaterialCreateResponse> {
+    return this._client.post('/api/v1/materials', { body, ...options });
   }
 
   /**
@@ -41,14 +43,11 @@ export class Materials extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.materials.retrieve('id');
+   * const material = await client.v1.materials.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.get(path`/api/v1/materials/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  retrieve(id: string, options?: RequestOptions): APIPromise<MaterialRetrieveResponse> {
+    return this._client.get(path`/api/v1/materials/${id}`, options);
   }
 
   /**
@@ -56,15 +55,14 @@ export class Materials extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.materials.list();
+   * const materials = await client.v1.materials.list();
    * ```
    */
-  list(query: MaterialListParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
-    return this._client.get('/api/v1/materials', {
-      query,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  list(
+    query: MaterialListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<MaterialListResponse> {
+    return this._client.get('/api/v1/materials', { query, ...options });
   }
 
   /**
@@ -181,6 +179,244 @@ export class Materials extends APIResource {
   }
 }
 
+export interface MaterialCreateResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: MaterialCreateResponse.Content;
+
+  /**
+   * Content type
+   */
+  contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
+
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+
+  /**
+   * Folder ID
+   */
+  folderId: string | null;
+
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Material status
+   */
+  status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
+
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * Material metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace MaterialCreateResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+}
+
+export interface MaterialRetrieveResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: MaterialRetrieveResponse.Content;
+
+  /**
+   * Content type
+   */
+  contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
+
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+
+  /**
+   * Folder ID
+   */
+  folderId: string | null;
+
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Material status
+   */
+  status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
+
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * Material metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace MaterialRetrieveResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+}
+
+export type MaterialListResponse = Array<MaterialListResponse.MaterialListResponseItem>;
+
+export namespace MaterialListResponse {
+  export interface MaterialListResponseItem {
+    /**
+     * Material ID
+     */
+    _id: string;
+
+    /**
+     * Material content
+     */
+    content: MaterialListResponseItem.Content;
+
+    /**
+     * Content type
+     */
+    contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
+
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+
+    /**
+     * Folder ID
+     */
+    folderId: string | null;
+
+    /**
+     * Material name
+     */
+    name: string;
+
+    /**
+     * Organization ID
+     */
+    organizationId: string;
+
+    /**
+     * Material status
+     */
+    status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
+
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+
+    /**
+     * Material metadata
+     */
+    metadata?: unknown;
+
+    /**
+     * Usage information
+     */
+    usage?: unknown;
+  }
+
+  export namespace MaterialListResponseItem {
+    /**
+     * Material content
+     */
+    export interface Content {
+      filename?: string;
+
+      fileSize?: number;
+
+      mimeType?: string;
+
+      s3Key?: string;
+
+      s3Url?: string;
+
+      text?: string;
+
+      url?: string;
+    }
+  }
+}
+
 export interface MaterialCreateParams {
   /**
    * Content details
@@ -242,6 +478,9 @@ Materials.Test = Test;
 
 export declare namespace Materials {
   export {
+    type MaterialCreateResponse as MaterialCreateResponse,
+    type MaterialRetrieveResponse as MaterialRetrieveResponse,
+    type MaterialListResponse as MaterialListResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialListParams as MaterialListParams,
     type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
@@ -249,6 +488,8 @@ export declare namespace Materials {
 
   export {
     Upload as Upload,
+    type UploadUploadFileResponse as UploadUploadFileResponse,
+    type UploadUploadFromURLResponse as UploadUploadFromURLResponse,
     type UploadUploadFileParams as UploadUploadFileParams,
     type UploadUploadFromURLParams as UploadUploadFromURLParams,
   };

package/src/resources/v1/materials/upload.ts

@@ -39,19 +39,17 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.materials.upload.uploadFile({
-   *   file: fs.createReadStream('path/to/file'),
-   *   name: 'name',
-   * });
+   * const response =
+   *   await client.v1.materials.upload.uploadFile({
+   *     file: fs.createReadStream('path/to/file'),
+   *     name: 'name',
+   *   });
    * ```
    */
-  uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<void> {
+  uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<UploadUploadFileResponse> {
     return this._client.post(
       '/api/v1/materials/upload',
-      multipartFormRequestOptions(
-        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
-        this._client,
-      ),
+      multipartFormRequestOptions({ body, ...options }, this._client),
     );
   }
 
@@ -60,18 +58,174 @@ export class Upload extends APIResource {
    *
    * @example
    * ```ts
-   * await client.v1.materials.upload.uploadFromURL({
-   *   name: 'name',
-   *   url: 'url',
-   * });
+   * const response =
+   *   await client.v1.materials.upload.uploadFromURL({
+   *     name: 'name',
+   *     url: 'url',
+   *   });
    * ```
    */
-  uploadFromURL(body: UploadUploadFromURLParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/upload/url', {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  uploadFromURL(
+    body: UploadUploadFromURLParams,
+    options?: RequestOptions,
+  ): APIPromise<UploadUploadFromURLResponse> {
+    return this._client.post('/api/v1/materials/upload/url', { body, ...options });
+  }
+}
+
+export interface UploadUploadFileResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: UploadUploadFileResponse.Content;
+
+  /**
+   * Content type
+   */
+  contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
+
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+
+  /**
+   * Folder ID
+   */
+  folderId: string | null;
+
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Material status
+   */
+  status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
+
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * Material metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace UploadUploadFileResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
+  }
+}
+
+export interface UploadUploadFromURLResponse {
+  /**
+   * Material ID
+   */
+  _id: string;
+
+  /**
+   * Material content
+   */
+  content: UploadUploadFromURLResponse.Content;
+
+  /**
+   * Content type
+   */
+  contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
+
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+
+  /**
+   * Folder ID
+   */
+  folderId: string | null;
+
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Material status
+   */
+  status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
+
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * Material metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Usage information
+   */
+  usage?: unknown;
+}
+
+export namespace UploadUploadFromURLResponse {
+  /**
+   * Material content
+   */
+  export interface Content {
+    filename?: string;
+
+    fileSize?: number;
+
+    mimeType?: string;
+
+    s3Key?: string;
+
+    s3Url?: string;
+
+    text?: string;
+
+    url?: string;
   }
 }
 
@@ -108,6 +262,8 @@ export interface UploadUploadFromURLParams {
 
 export declare namespace Upload {
   export {
+    type UploadUploadFileResponse as UploadUploadFileResponse,
+    type UploadUploadFromURLResponse as UploadUploadFromURLResponse,
     type UploadUploadFileParams as UploadUploadFileParams,
     type UploadUploadFromURLParams as UploadUploadFromURLParams,
   };

package/src/resources/v1/v1.ts

@@ -4,9 +4,14 @@ import { APIResource } from '../../core/resource';
 import * as ComponentsAPI from './components';
 import {
   ComponentCreateParams,
+  ComponentCreateResponse,
   ComponentEmbedParams,
+  ComponentEmbedResponse,
   ComponentListParams,
+  ComponentListResponse,
+  ComponentRetrieveResponse,
   ComponentUpdateParams,
+  ComponentUpdateResponse,
   Components,
 } from './components';
 import * as ExplainersAPI from './explainers';
@@ -59,8 +64,11 @@ import { Embed, EmbedGetThemeParams, EmbedVerifyParams } from './embed/embed';
 import * as MaterialsAPI from './materials/materials';
 import {
   MaterialCreateParams,
+  MaterialCreateResponse,
   MaterialGetDownloadURLParams,
   MaterialListParams,
+  MaterialListResponse,
+  MaterialRetrieveResponse,
   Materials,
 } from './materials/materials';
 import * as OrganizationsAPI from './organizations/organizations';
@@ -126,6 +134,9 @@ export declare namespace V1 {
 
   export {
     Materials as Materials,
+    type MaterialCreateResponse as MaterialCreateResponse,
+    type MaterialRetrieveResponse as MaterialRetrieveResponse,
+    type MaterialListResponse as MaterialListResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialListParams as MaterialListParams,
     type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
@@ -150,6 +161,11 @@ export declare namespace V1 {
 
   export {
     Components as Components,
+    type ComponentCreateResponse as ComponentCreateResponse,
+    type ComponentRetrieveResponse as ComponentRetrieveResponse,
+    type ComponentUpdateResponse as ComponentUpdateResponse,
+    type ComponentListResponse as ComponentListResponse,
+    type ComponentEmbedResponse as ComponentEmbedResponse,
     type ComponentCreateParams as ComponentCreateParams,
     type ComponentUpdateParams as ComponentUpdateParams,
     type ComponentListParams as ComponentListParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.2.0'; // x-release-please-version
+export const VERSION = '1.3.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.2.0";
+export declare const VERSION = "1.3.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.2.0";
+export declare const VERSION = "1.3.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.2.0'; // x-release-please-version
+exports.VERSION = '1.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.2.0'; // x-release-please-version
+export const VERSION = '1.3.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map