@studyfetch/sdk 1.1.1 → 1.3.0

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,237 @@ 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
+   * const response =
+   *   await client.v1.materials.upload.uploadFile({
+   *     file: fs.createReadStream('path/to/file'),
+   *     name: 'name',
+   *   });
+   * ```
+   */
+  uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<UploadUploadFileResponse> {
+    return this._client.post(
+      '/api/v1/materials/upload',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
   }
 
-  start(options?: RequestOptions): APIPromise<void> {
-    return this._client.post('/api/v1/materials/upload', {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  /**
+   * Upload material from URL
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.v1.materials.upload.uploadFromURL({
+   *     name: 'name',
+   *     url: 'url',
+   *   });
+   * ```
+   */
+  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;
   }
 }
+
+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 UploadUploadFileResponse as UploadUploadFileResponse,
+    type UploadUploadFromURLResponse as UploadUploadFromURLResponse,
+    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,

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

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
 export class Invite extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.invite.create('id');
+   * ```
+   */
   create(id: string, body: InviteCreateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/organizations/${id}/team/invite`, {
       body,
@@ -15,6 +21,14 @@ export class Invite extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.invite.retrievePreview(
+   *   'token',
+   * );
+   * ```
+   */
   retrievePreview(token: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/organizations/team/invite/${token}/preview`, {
       ...options,

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

@@ -11,6 +11,12 @@ import { path } from '../../../../internal/utils/path';
 export class Team extends APIResource {
   invite: InviteAPI.Invite = new InviteAPI.Invite(this._client);
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.list('id');
+   * ```
+   */
   list(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/organizations/${id}/team`, {
       ...options,
@@ -18,6 +24,14 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.delete('email', {
+   *   id: 'id',
+   * });
+   * ```
+   */
   delete(email: string, params: TeamDeleteParams, options?: RequestOptions): APIPromise<void> {
     const { id } = params;
     return this._client.delete(path`/api/v1/organizations/${id}/team/${email}`, {
@@ -26,6 +40,12 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.acceptInvite();
+   * ```
+   */
   acceptInvite(body: TeamAcceptInviteParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/organizations/team/accept-invite', {
       body,
@@ -34,6 +54,14 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.resendInvite('email', {
+   *   id: 'id',
+   * });
+   * ```
+   */
   resendInvite(email: string, params: TeamResendInviteParams, options?: RequestOptions): APIPromise<void> {
     const { id } = params;
     return this._client.post(path`/api/v1/organizations/${id}/team/${email}/resend-invite`, {
@@ -42,6 +70,12 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.retrieveDetailed('id');
+   * ```
+   */
   retrieveDetailed(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/organizations/${id}/team/detailed`, {
       ...options,
@@ -49,6 +83,14 @@ export class Team extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.team.updateRole('email', {
+   *   id: 'id',
+   * });
+   * ```
+   */
   updateRole(email: string, params: TeamUpdateRoleParams, options?: RequestOptions): APIPromise<void> {
     const { id, ...body } = params;
     return this._client.put(path`/api/v1/organizations/${id}/team/${email}/role`, {

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

@@ -6,6 +6,12 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
 export class Theme extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.theme.create();
+   * ```
+   */
   create(options?: RequestOptions): APIPromise<void> {
     return this._client.put('/api/v1/organizations/theme', {
       ...options,
@@ -13,6 +19,12 @@ export class Theme extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.organizations.theme.list();
+   * ```
+   */
   list(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/organizations/theme', {
       ...options,