@studyfetch/sdk 1.1.1 → 1.2.0

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

@@ -6,7 +6,7 @@ import { Bulk } from './bulk';
 import * as TestAPI from './test';
 import { Test } from './test';
 import * as UploadAPI from './upload';
-import { Upload } from './upload';
+import { Upload, UploadUploadFileParams, UploadUploadFromURLParams } from './upload';
 import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
@@ -17,6 +17,17 @@ export class Materials extends APIResource {
   bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
   test: TestAPI.Test = new TestAPI.Test(this._client);
 
+  /**
+   * Create a new material
+   *
+   * @example
+   * ```ts
+   * 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,
@@ -25,6 +36,14 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * Get material by ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.materials.retrieve('id');
+   * ```
+   */
   retrieve(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/materials/${id}`, {
       ...options,
@@ -32,13 +51,30 @@ export class Materials extends APIResource {
     });
   }
 
-  list(options?: RequestOptions): APIPromise<void> {
+  /**
+   * Get all materials for organization
+   *
+   * @example
+   * ```ts
+   * 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]),
     });
   }
 
+  /**
+   * Delete material
+   *
+   * @example
+   * ```ts
+   * await client.v1.materials.delete('id');
+   * ```
+   */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/api/v1/materials/${id}`, {
       ...options,
@@ -46,13 +82,25 @@ export class Materials extends APIResource {
     });
   }
 
-  batchCreate(options?: RequestOptions): APIPromise<void> {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.createBatch();
+   * ```
+   */
+  createBatch(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/batch', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.debug('id');
+   * ```
+   */
   debug(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/materials/${id}/debug`, {
       ...options,
@@ -60,6 +108,14 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.getDownloadURL('id', {
+   *   expiresIn: 'expiresIn',
+   * });
+   * ```
+   */
   getDownloadURL(
     id: string,
     query: MaterialGetDownloadURLParams,
@@ -72,6 +128,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.move('id');
+   * ```
+   */
   move(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/materials/${id}/move`, {
       ...options,
@@ -79,6 +141,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.rename('id');
+   * ```
+   */
   rename(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/materials/${id}/rename`, {
       ...options,
@@ -86,6 +154,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.reprocess('id');
+   * ```
+   */
   reprocess(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/materials/${id}/reprocess`, {
       ...options,
@@ -93,6 +167,12 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.search();
+   * ```
+   */
   search(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/search', {
       ...options,
@@ -101,7 +181,56 @@ export class Materials extends APIResource {
   }
 }
 
-export interface MaterialCreateParams {}
+export interface MaterialCreateParams {
+  /**
+   * Content details
+   */
+  content: MaterialCreateParams.Content;
+
+  /**
+   * Name of the material
+   */
+  name: string;
+
+  /**
+   * Folder ID to place the material in
+   */
+  folderId?: string;
+}
+
+export namespace MaterialCreateParams {
+  /**
+   * Content details
+   */
+  export interface Content {
+    /**
+     * Type of content
+     */
+    type: 'text' | 'pdf' | 'video' | 'audio' | 'url';
+
+    /**
+     * URL to fetch content from
+     */
+    sourceUrl?: string;
+
+    /**
+     * Text content (for text type)
+     */
+    text?: string;
+
+    /**
+     * URL to the content (for url type)
+     */
+    url?: string;
+  }
+}
+
+export interface MaterialListParams {
+  /**
+   * Filter by folder ID
+   */
+  folderId?: string;
+}
 
 export interface MaterialGetDownloadURLParams {
   expiresIn: string;
@@ -114,10 +243,15 @@ Materials.Test = Test;
 export declare namespace Materials {
   export {
     type MaterialCreateParams as MaterialCreateParams,
+    type MaterialListParams as MaterialListParams,
     type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
   };
 
-  export { Upload as Upload };
+  export {
+    Upload as Upload,
+    type UploadUploadFileParams as UploadUploadFileParams,
+    type UploadUploadFromURLParams as UploadUploadFromURLParams,
+  };
 
   export { Bulk as Bulk };
 

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

@@ -6,28 +6,52 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Test extends APIResource {
-  epubProcessing(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/test/epub-processing', {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.performOcr();
+   * ```
+   */
+  performOcr(options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/materials/test/ocr', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  imageProcessing(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/test/image-processing', {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.processEpub();
+   * ```
+   */
+  processEpub(options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/materials/test/epub-processing', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  ocr(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/test/ocr', {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.processImage();
+   * ```
+   */
+  processImage(options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/api/v1/materials/test/image-processing', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  videoProcessing(options?: RequestOptions): APIPromise<void> {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.test.processVideo();
+   * ```
+   */
+  processVideo(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/test/video-processing', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),

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

@@ -2,17 +2,31 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { type Uploadable } from '../../../core/uploads';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
+import { multipartFormRequestOptions } from '../../../internal/uploads';
 
 export class Upload extends APIResource {
-  complete(options?: RequestOptions): APIPromise<void> {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.upload.completeUpload();
+   * ```
+   */
+  completeUpload(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/upload/complete', {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.materials.upload.getPresignedURL();
+   * ```
+   */
   getPresignedURL(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/materials/upload/presigned-url', {
       ...options,
@@ -20,17 +34,81 @@ export class Upload extends APIResource {
     });
   }
 
-  getURL(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/upload/url', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  /**
+   * Upload a material file
+   *
+   * @example
+   * ```ts
+   * await client.v1.materials.upload.uploadFile({
+   *   file: fs.createReadStream('path/to/file'),
+   *   name: 'name',
+   * });
+   * ```
+   */
+  uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(
+      '/api/v1/materials/upload',
+      multipartFormRequestOptions(
+        { body, ...options, headers: buildHeaders([{ Accept: '*/*' }, options?.headers]) },
+        this._client,
+      ),
+    );
   }
 
-  start(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/upload', {
+  /**
+   * Upload material from URL
+   *
+   * @example
+   * ```ts
+   * 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]),
     });
   }
 }
+
+export interface UploadUploadFileParams {
+  file: Uploadable;
+
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * Folder ID (optional)
+   */
+  folderId?: string;
+}
+
+export interface UploadUploadFromURLParams {
+  /**
+   * Material name
+   */
+  name: string;
+
+  /**
+   * URL to fetch content from
+   */
+  url: string;
+
+  /**
+   * Folder ID (optional)
+   */
+  folderId?: string;
+}
+
+export declare namespace Upload {
+  export {
+    type UploadUploadFileParams as UploadUploadFileParams,
+    type UploadUploadFromURLParams as UploadUploadFromURLParams,
+  };
+}

package/src/resources/v1/organizations/api-keys.ts

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class APIKeys extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.apiKeys.delete('keyId');
+   * ```
+   */
   delete(keyID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/api/v1/organizations/api-keys/${keyID}`, {
       ...options,
@@ -14,13 +20,30 @@ export class APIKeys extends APIResource {
     });
   }
 
-  apiKeys(options?: RequestOptions): APIPromise<void> {
+  /**
+   * Create new API key
+   *
+   * @example
+   * ```ts
+   * await client.v1.organizations.apiKeys.apiKeys({
+   *   name: 'name',
+   * });
+   * ```
+   */
+  apiKeys(body: APIKeyAPIKeysParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/organizations/api-keys', {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.apiKeys.retrieveAPIKeys();
+   * ```
+   */
   retrieveAPIKeys(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/organizations/api-keys', {
       ...options,
@@ -28,3 +51,14 @@ export class APIKeys extends APIResource {
     });
   }
 }
+
+export interface APIKeyAPIKeysParams {
+  /**
+   * API key name
+   */
+  name: string;
+}
+
+export declare namespace APIKeys {
+  export { type APIKeyAPIKeysParams as APIKeyAPIKeysParams };
+}

package/src/resources/v1/organizations/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { APIKeys } from './api-keys';
+export { APIKeys, type APIKeyAPIKeysParams } from './api-keys';
 export { Logo } from './logo/index';
 export { Organizations, type OrganizationUpdateParams } from './organizations';
 export { Profile, type UpdateOrganization, type ProfilePatchAllParams } from './profile/index';

package/src/resources/v1/organizations/logo/logo.ts

@@ -10,6 +10,12 @@ import { RequestOptions } from '../../../../internal/request-options';
 export class Logo extends APIResource {
   upload: UploadAPI.Upload = new UploadAPI.Upload(this._client);
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.logo.deleteAll();
+   * ```
+   */
   deleteAll(options?: RequestOptions): APIPromise<void> {
     return this._client.delete('/api/v1/organizations/logo', {
       ...options,

package/src/resources/v1/organizations/logo/upload.ts

@@ -6,6 +6,12 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 
 export class Upload extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.logo.upload.complete();
+   * ```
+   */
   complete(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/organizations/logo/upload/complete', {
       ...options,
@@ -13,6 +19,12 @@ export class Upload extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.logo.upload.presignedURL();
+   * ```
+   */
   presignedURL(options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/organizations/logo/upload/presigned-url', {
       ...options,

package/src/resources/v1/organizations/organizations.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import * as APIKeysAPI from './api-keys';
-import { APIKeys } from './api-keys';
+import { APIKeyAPIKeysParams, APIKeys } from './api-keys';
 import * as ThemeAPI from './theme';
 import { Theme } from './theme';
 import * as UsageAPI from './usage';
@@ -32,6 +32,12 @@ export class Organizations extends APIResource {
   logo: LogoAPI.Logo = new LogoAPI.Logo(this._client);
   team: TeamAPI.Team = new TeamAPI.Team(this._client);
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.retrieve('id');
+   * ```
+   */
   retrieve(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/organizations/${id}`, {
       ...options,
@@ -39,6 +45,12 @@ export class Organizations extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.update('id');
+   * ```
+   */
   update(id: string, body: OrganizationUpdateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.put(path`/api/v1/organizations/${id}`, {
       body,
@@ -66,7 +78,7 @@ export declare namespace Organizations {
     type ProfilePatchAllParams as ProfilePatchAllParams,
   };
 
-  export { APIKeys as APIKeys };
+  export { APIKeys as APIKeys, type APIKeyAPIKeysParams as APIKeyAPIKeysParams };
 
   export { Usage as Usage };
 

package/src/resources/v1/organizations/profile/models.ts

@@ -6,6 +6,12 @@ import { buildHeaders } from '../../../../internal/headers';
 import { RequestOptions } from '../../../../internal/request-options';
 
 export class Models extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.models.retrieveAvailable();
+   * ```
+   */
   retrieveAvailable(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/organizations/profile/models/available', {
       ...options,

package/src/resources/v1/organizations/profile/profile.ts

@@ -13,6 +13,14 @@ export class Profile extends APIResource {
   models: ModelsAPI.Models = new ModelsAPI.Models(this._client);
   team: TeamAPI.Team = new TeamAPI.Team(this._client);
 
+  /**
+   * Get current organization profile
+   *
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.list();
+   * ```
+   */
   list(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/organizations/profile', {
       ...options,
@@ -20,6 +28,12 @@ export class Profile extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.patchAll();
+   * ```
+   */
   patchAll(body: ProfilePatchAllParams, options?: RequestOptions): APIPromise<void> {
     return this._client.patch('/api/v1/organizations/profile', {
       body,

package/src/resources/v1/organizations/profile/team.ts

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
 export class Team extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.team.list();
+   * ```
+   */
   list(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/organizations/profile/team', {
       ...options,
@@ -14,6 +20,12 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.team.delete('email');
+   * ```
+   */
   delete(email: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/api/v1/organizations/profile/team/${email}`, {
       ...options,
@@ -21,6 +33,12 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.team.invite();
+   * ```
+   */
   invite(body: TeamInviteParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/organizations/profile/team/invite', {
       body,
@@ -29,6 +47,14 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.team.resendInvite(
+   *   'email',
+   * );
+   * ```
+   */
   resendInvite(email: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/organizations/profile/team/${email}/resend-invite`, {
       ...options,
@@ -36,6 +62,12 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.team.retrieveDetailed();
+   * ```
+   */
   retrieveDetailed(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/organizations/profile/team/detailed', {
       ...options,
@@ -43,6 +75,14 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.profile.team.updateRole(
+   *   'email',
+   * );
+   * ```
+   */
   updateRole(email: string, body: TeamUpdateRoleParams, options?: RequestOptions): APIPromise<void> {
     return this._client.put(path`/api/v1/organizations/profile/team/${email}/role`, {
       body,