@studyfetch/sdk 1.1.1 → 1.2.0

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,

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

@@ -7,6 +7,14 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class Usage extends APIResource {
+  /**
+   * Get organization usage statistics
+   *
+   * @example
+   * ```ts
+   * await client.v1.organizations.usage.list('id');
+   * ```
+   */
   list(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/organizations/${id}/usage`, {
       ...options,

package/src/resources/v1/scenarios/component.ts

@@ -7,6 +7,14 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class Component extends APIResource {
+  /**
+   * Get scenario by component ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.component.retrieve('componentId');
+   * ```
+   */
   retrieve(componentID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/scenarios/component/${componentID}`, {
       ...options,
@@ -14,13 +22,33 @@ export class Component extends APIResource {
     });
   }
 
-  update(componentID: string, options?: RequestOptions): APIPromise<void> {
+  /**
+   * Update scenario by component ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.component.update('componentId', {
+   *   body: 'body',
+   * });
+   * ```
+   */
+  update(componentID: string, params: ComponentUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { body } = params;
     return this._client.put(path`/api/v1/scenarios/component/${componentID}`, {
+      body: body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * Delete scenario by component ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.component.delete('componentId');
+   * ```
+   */
   delete(componentID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/api/v1/scenarios/component/${componentID}`, {
       ...options,
@@ -28,3 +56,11 @@ export class Component extends APIResource {
     });
   }
 }
+
+export interface ComponentUpdateParams {
+  body: string;
+}
+
+export declare namespace Component {
+  export { type ComponentUpdateParams as ComponentUpdateParams };
+}

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

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Component } from './component';
-export { Scenarios } from './scenarios';
+export { Component, type ComponentUpdateParams } from './component';
+export { Scenarios, type ScenarioCreateParams, type ScenarioUpdateParams } from './scenarios';
 export { Sessions } from './sessions';
 export { Submissions } from './submissions/index';

package/src/resources/v1/scenarios/scenarios.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import * as ComponentAPI from './component';
-import { Component } from './component';
+import { Component, ComponentUpdateParams } from './component';
 import * as SessionsAPI from './sessions';
 import { Sessions } from './sessions';
 import * as SubmissionsAPI from './submissions/submissions';
@@ -17,13 +17,31 @@ export class Scenarios extends APIResource {
   sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
   submissions: SubmissionsAPI.Submissions = new SubmissionsAPI.Submissions(this._client);
 
-  create(options?: RequestOptions): APIPromise<void> {
+  /**
+   * Create a new scenario
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.create({ body: 'body' });
+   * ```
+   */
+  create(params: ScenarioCreateParams, options?: RequestOptions): APIPromise<void> {
+    const { body } = params;
     return this._client.post('/api/v1/scenarios', {
+      body: body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * Get scenario by ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.retrieve('id');
+   * ```
+   */
   retrieve(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/scenarios/${id}`, {
       ...options,
@@ -31,13 +49,31 @@ export class Scenarios extends APIResource {
     });
   }
 
-  update(id: string, options?: RequestOptions): APIPromise<void> {
+  /**
+   * Update scenario
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.update('id', { body: 'body' });
+   * ```
+   */
+  update(id: string, params: ScenarioUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { body } = params;
     return this._client.put(path`/api/v1/scenarios/${id}`, {
+      body: body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * Get all scenarios
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.list();
+   * ```
+   */
   list(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/scenarios', {
       ...options,
@@ -45,6 +81,14 @@ export class Scenarios extends APIResource {
     });
   }
 
+  /**
+   * Delete scenario
+   *
+   * @example
+   * ```ts
+   * await client.v1.scenarios.delete('id');
+   * ```
+   */
   delete(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.delete(path`/api/v1/scenarios/${id}`, {
       ...options,
@@ -52,6 +96,12 @@ export class Scenarios extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.scenarios.getStats('id');
+   * ```
+   */
   getStats(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/scenarios/${id}/stats`, {
       ...options,
@@ -59,6 +109,12 @@ export class Scenarios extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.scenarios.submit('id');
+   * ```
+   */
   submit(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/scenarios/${id}/submit`, {
       ...options,
@@ -67,12 +123,25 @@ export class Scenarios extends APIResource {
   }
 }
 
+export interface ScenarioCreateParams {
+  body: string;
+}
+
+export interface ScenarioUpdateParams {
+  body: string;
+}
+
 Scenarios.Component = Component;
 Scenarios.Sessions = Sessions;
 Scenarios.Submissions = Submissions;
 
 export declare namespace Scenarios {
-  export { Component as Component };
+  export {
+    type ScenarioCreateParams as ScenarioCreateParams,
+    type ScenarioUpdateParams as ScenarioUpdateParams,
+  };
+
+  export { Component as Component, type ComponentUpdateParams as ComponentUpdateParams };
 
   export { Sessions as Sessions };
 

package/src/resources/v1/scenarios/sessions.ts

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class Sessions extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.scenarios.sessions.complete('sessionId');
+   * ```
+   */
   complete(sessionID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.put(path`/api/v1/scenarios/sessions/${sessionID}/complete`, {
       ...options,
@@ -14,6 +20,12 @@ export class Sessions extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.scenarios.sessions.start('id');
+   * ```
+   */
   start(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/scenarios/${id}/sessions/start`, {
       ...options,

package/src/resources/v1/scenarios/submissions/user.ts

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../../internal/request-options';
 import { path } from '../../../../internal/utils/path';
 
 export class User extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.scenarios.submissions.user.retrieve('id');
+   * ```
+   */
   retrieve(id: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/scenarios/${id}/submissions/user`, {
       ...options,
@@ -14,6 +20,12 @@ export class User extends APIResource {
     });
   }
 
+  /**
+   * @example
+   * ```ts
+   * await client.v1.scenarios.submissions.user.list();
+   * ```
+   */
   list(options?: RequestOptions): APIPromise<void> {
     return this._client.get('/api/v1/scenarios/submissions/user', {
       ...options,

package/src/resources/v1/tests/component.ts

@@ -7,6 +7,12 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 export class Component extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.tests.component.list('componentId');
+   * ```
+   */
   list(componentID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/tests/component/${componentID}/list`, {
       ...options,

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

@@ -1,4 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { Component } from './component';
-export { Tests } from './tests';
+export {
+  Tests,
+  type TestCreateParams,
+  type TestRetakeParams,
+  type TestSubmitParams,
+  type TestSubmitAnswerParams,
+} from './tests';

package/src/resources/v1/tests/tests.ts

@@ -11,13 +11,32 @@ import { path } from '../../../internal/utils/path';
 export class Tests extends APIResource {
   component: ComponentAPI.Component = new ComponentAPI.Component(this._client);
 
-  create(options?: RequestOptions): APIPromise<void> {
+  /**
+   * Create a new test
+   *
+   * @example
+   * ```ts
+   * await client.v1.tests.create({
+   *   componentId: 'componentId',
+   * });
+   * ```
+   */
+  create(body: TestCreateParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post('/api/v1/tests/create', {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
+  /**
+   * Get test by ID
+   *
+   * @example
+   * ```ts
+   * await client.v1.tests.retrieve('testId');
+   * ```
+   */
   retrieve(testID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/tests/${testID}`, {
       ...options,
@@ -25,6 +44,14 @@ export class Tests extends APIResource {
     });
   }
 
+  /**
+   * Get test results
+   *
+   * @example
+   * ```ts
+   * await client.v1.tests.getResults('testId');
+   * ```
+   */
   getResults(testID: string, options?: RequestOptions): APIPromise<void> {
     return this._client.get(path`/api/v1/tests/${testID}/results`, {
       ...options,
@@ -32,30 +59,115 @@ export class Tests extends APIResource {
     });
   }
 
-  retake(testID: string, options?: RequestOptions): APIPromise<void> {
+  /**
+   * Retake a test
+   *
+   * @example
+   * ```ts
+   * await client.v1.tests.retake('testId');
+   * ```
+   */
+  retake(testID: string, body: TestRetakeParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/tests/${testID}/retake`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  submit(testID: string, options?: RequestOptions): APIPromise<void> {
+  /**
+   * Submit completed test
+   *
+   * @example
+   * ```ts
+   * await client.v1.tests.submit('testId');
+   * ```
+   */
+  submit(testID: string, body: TestSubmitParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/tests/${testID}/submit`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
-  submitAnswer(testID: string, options?: RequestOptions): APIPromise<void> {
+  /**
+   * Submit test answer
+   *
+   * @example
+   * ```ts
+   * await client.v1.tests.submitAnswer('testId', {
+   *   answer: 'answer',
+   *   questionId: 'questionId',
+   * });
+   * ```
+   */
+  submitAnswer(testID: string, body: TestSubmitAnswerParams, options?: RequestOptions): APIPromise<void> {
     return this._client.post(path`/api/v1/tests/${testID}/submit-answer`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 }
 
+export interface TestCreateParams {
+  /**
+   * Component ID
+   */
+  componentId: string;
+
+  /**
+   * Test name (optional)
+   */
+  name?: string;
+
+  /**
+   * User ID (optional)
+   */
+  userId?: string;
+}
+
+export interface TestRetakeParams {
+  /**
+   * User ID (optional)
+   */
+  userId?: string;
+}
+
+export interface TestSubmitParams {
+  /**
+   * User ID (optional)
+   */
+  userId?: string;
+}
+
+export interface TestSubmitAnswerParams {
+  /**
+   * User answer
+   */
+  answer: string;
+
+  /**
+   * Question ID
+   */
+  questionId: string;
+
+  /**
+   * User ID (optional)
+   */
+  userId?: string;
+}
+
 Tests.Component = Component;
 
 export declare namespace Tests {
+  export {
+    type TestCreateParams as TestCreateParams,
+    type TestRetakeParams as TestRetakeParams,
+    type TestSubmitParams as TestSubmitParams,
+    type TestSubmitAnswerParams as TestSubmitAnswerParams,
+  };
+
   export { Component as Component };
 }

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

@@ -0,0 +1,65 @@
+// 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 { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Component extends APIResource {
+  /**
+   * @example
+   * ```ts
+   * await client.v1.upload.component.completeUpload(
+   *   'componentId',
+   * );
+   * ```
+   */
+  completeUpload(componentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/api/v1/upload/component/${componentID}/complete`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.upload.component.getPresignedURL(
+   *   'componentId',
+   * );
+   * ```
+   */
+  getPresignedURL(componentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/api/v1/upload/component/${componentID}/presigned-url`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.upload.component.uploadFile('componentId');
+   * ```
+   */
+  uploadFile(componentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/api/v1/upload/component/${componentID}/file`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * @example
+   * ```ts
+   * await client.v1.upload.component.uploadURL('componentId');
+   * ```
+   */
+  uploadURL(componentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/api/v1/upload/component/${componentID}/url`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}

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

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Component } from './component';
+export { Upload } from './upload';