@studyfetch/sdk 1.42.0 → 1.43.0

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

@@ -96,6 +96,18 @@ export class Materials extends APIResource {
     });
   }
 
+  /**
+   * Attempts to cancel a currently running PDF processing job
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.materials.cancelJob('id');
+   * ```
+   */
+  cancelJob(id: string, options?: RequestOptions): APIPromise<MaterialCancelJobResponse> {
+    return this._client.post(path`/api/v1/materials/${id}/cancel-job`, options);
+  }
+
   /**
    * Creates a material and waits for processing to finish before returning. Useful
    * for synchronous API usage.
@@ -211,6 +223,21 @@ export class Materials extends APIResource {
     return this._client.get(path`/api/v1/materials/${id}/download-url`, { query, ...options });
   }
 
+  /**
+   * Returns the current status of a PDF processing job including progress
+   * information
+   *
+   * @example
+   * ```ts
+   * const response = await client.v1.materials.getJobStatus(
+   *   'id',
+   * );
+   * ```
+   */
+  getJobStatus(id: string, options?: RequestOptions): APIPromise<MaterialGetJobStatusResponse> {
+    return this._client.get(path`/api/v1/materials/${id}/job-status`, options);
+  }
+
   /**
    * Move material to a different folder
    *
@@ -484,6 +511,12 @@ export interface MaterialListResponse {
   totalPages?: number;
 }
 
+export interface MaterialCancelJobResponse {
+  message?: string;
+
+  success?: boolean;
+}
+
 export type MaterialCreateBatchUploadURLsResponse =
   Array<MaterialCreateBatchUploadURLsResponse.MaterialCreateBatchUploadURLsResponseItem>;
 
@@ -574,6 +607,88 @@ export interface MaterialGetDownloadURLResponse {
   downloadUrl: string;
 }
 
+export interface MaterialGetJobStatusResponse {
+  /**
+   * Job completion time
+   */
+  completedAt?: string;
+
+  /**
+   * Error message if job failed
+   */
+  error?: string;
+
+  /**
+   * Unique job identifier
+   */
+  jobId?: string;
+
+  progress?: MaterialGetJobStatusResponse.Progress;
+
+  resultSummary?: MaterialGetJobStatusResponse.ResultSummary;
+
+  /**
+   * Job start time
+   */
+  startedAt?: string;
+
+  /**
+   * Current job status
+   */
+  status?: 'pending' | 'running' | 'completed' | 'failed' | 'cancelled';
+}
+
+export namespace MaterialGetJobStatusResponse {
+  export interface Progress {
+    /**
+     * Current batch being processed
+     */
+    currentBatch?: number;
+
+    /**
+     * Completion percentage (0-100)
+     */
+    percentage?: number;
+
+    /**
+     * Images processed so far
+     */
+    processedImages?: number;
+
+    /**
+     * Total number of batches
+     */
+    totalBatches?: number;
+
+    /**
+     * Total images to process
+     */
+    totalImages?: number;
+  }
+
+  export interface ResultSummary {
+    /**
+     * Number of images processed
+     */
+    imagesProcessed?: number;
+
+    /**
+     * Total processing time in milliseconds
+     */
+    processingTimeMs?: number;
+
+    /**
+     * Whether text was extracted
+     */
+    textExtracted?: boolean;
+
+    /**
+     * Length of extracted text
+     */
+    textLength?: number;
+  }
+}
+
 export interface MaterialSearchResponse {
   /**
    * Whether results were filtered by scope
@@ -922,9 +1037,11 @@ export declare namespace Materials {
     type MaterialResponse as MaterialResponse,
     type Reference as Reference,
     type MaterialListResponse as MaterialListResponse,
+    type MaterialCancelJobResponse as MaterialCancelJobResponse,
     type MaterialCreateBatchUploadURLsResponse as MaterialCreateBatchUploadURLsResponse,
     type MaterialGetDebugInfoResponse as MaterialGetDebugInfoResponse,
     type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse,
+    type MaterialGetJobStatusResponse as MaterialGetJobStatusResponse,
     type MaterialSearchResponse as MaterialSearchResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialUpdateParams as MaterialUpdateParams,

package/src/resources/v1/pdf-generator/get.ts

@@ -0,0 +1,75 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+
+export class Get extends APIResource {}
+
+export interface PdfResponse {
+  /**
+   * PDF presentation ID
+   */
+  _id: string;
+
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+
+  /**
+   * Locale of the presentation
+   */
+  locale: string;
+
+  /**
+   * Number of slides
+   */
+  numberOfSlides: number;
+
+  /**
+   * Organization ID
+   */
+  organizationId: string;
+
+  /**
+   * Topic of the presentation
+   */
+  topic: string;
+
+  /**
+   * Transcript of each slide
+   */
+  transcript: Array<PdfResponse.Transcript>;
+
+  /**
+   * Update timestamp
+   */
+  updatedAt: string;
+
+  /**
+   * URL to the generated PDF on S3
+   */
+  url: string;
+
+  /**
+   * User ID
+   */
+  userId?: string;
+}
+
+export namespace PdfResponse {
+  export interface Transcript {
+    /**
+     * Description of the slide content and OCR text
+     */
+    descriptionOfPage: string;
+
+    /**
+     * Page number of the slide
+     */
+    pageNum: number;
+  }
+}
+
+export declare namespace Get {
+  export { type PdfResponse as PdfResponse };
+}

package/src/resources/v1/pdf-generator/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Get, type PdfResponse } from './get';
+export {
+  PdfGenerator,
+  type PdfGeneratorCreateResponse,
+  type PdfGeneratorDeleteResponse,
+  type PdfGeneratorGetAllResponse,
+  type PdfGeneratorCreateParams,
+} from './pdf-generator';

package/src/resources/v1/pdf-generator/pdf-generator.ts

@@ -0,0 +1,112 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as GetAPI from './get';
+import { Get, PdfResponse } from './get';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class PdfGenerator extends APIResource {
+  get: GetAPI.Get = new GetAPI.Get(this._client);
+
+  /**
+   * Generate a new PDF presentation
+   *
+   * @example
+   * ```ts
+   * const pdfGenerator = await client.v1.pdfGenerator.create({
+   *   locale: 'locale',
+   *   numberOfSlides: 1,
+   *   topic: 'topic',
+   * });
+   * ```
+   */
+  create(body: PdfGeneratorCreateParams, options?: RequestOptions): APIPromise<PdfGeneratorCreateResponse> {
+    return this._client.post('/api/v1/pdf-generator/create', { body, ...options });
+  }
+
+  /**
+   * Delete a PDF presentation by ID
+   *
+   * @example
+   * ```ts
+   * const pdfGenerator = await client.v1.pdfGenerator.delete(
+   *   'id',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<PdfGeneratorDeleteResponse> {
+    return this._client.delete(path`/api/v1/pdf-generator/delete/${id}`, options);
+  }
+
+  /**
+   * Get all PDF presentations
+   *
+   * @example
+   * ```ts
+   * const pdfResponses = await client.v1.pdfGenerator.getAll();
+   * ```
+   */
+  getAll(options?: RequestOptions): APIPromise<PdfGeneratorGetAllResponse> {
+    return this._client.get('/api/v1/pdf-generator/get', options);
+  }
+
+  /**
+   * Get a PDF presentation by ID
+   *
+   * @example
+   * ```ts
+   * const pdfResponse = await client.v1.pdfGenerator.getByID(
+   *   'id',
+   * );
+   * ```
+   */
+  getByID(id: string, options?: RequestOptions): APIPromise<GetAPI.PdfResponse> {
+    return this._client.get(path`/api/v1/pdf-generator/get/${id}`, options);
+  }
+}
+
+export interface PdfGeneratorCreateResponse {
+  presentation?: GetAPI.PdfResponse;
+
+  success?: boolean;
+}
+
+export interface PdfGeneratorDeleteResponse {
+  message?: string;
+
+  success?: boolean;
+}
+
+export type PdfGeneratorGetAllResponse = Array<GetAPI.PdfResponse>;
+
+export interface PdfGeneratorCreateParams {
+  /**
+   * Locale/language for the presentation (e.g., en-US, es-ES, fr-FR)
+   */
+  locale: string;
+
+  /**
+   * Number of slides to generate
+   */
+  numberOfSlides: number;
+
+  /**
+   * The topic for the PDF presentation
+   */
+  topic: string;
+}
+
+PdfGenerator.Get = Get;
+
+export declare namespace PdfGenerator {
+  export {
+    type PdfGeneratorCreateResponse as PdfGeneratorCreateResponse,
+    type PdfGeneratorDeleteResponse as PdfGeneratorDeleteResponse,
+    type PdfGeneratorGetAllResponse as PdfGeneratorGetAllResponse,
+    type PdfGeneratorCreateParams as PdfGeneratorCreateParams,
+  };
+
+  export { Get as Get, type PdfResponse as PdfResponse };
+}

package/src/resources/v1/pdf-generator.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './pdf-generator/index';

package/src/resources/v1/v1.ts

@@ -66,6 +66,7 @@ import * as MaterialsAPI from './materials/materials';
 import {
   Content,
   GeneratedMaterialResponse,
+  MaterialCancelJobResponse,
   MaterialCreateAndProcessParams,
   MaterialCreateBatchUploadURLsParams,
   MaterialCreateBatchUploadURLsResponse,
@@ -75,6 +76,7 @@ import {
   MaterialGetDebugInfoResponse,
   MaterialGetDownloadURLParams,
   MaterialGetDownloadURLResponse,
+  MaterialGetJobStatusResponse,
   MaterialListParams,
   MaterialListResponse,
   MaterialMoveParams,
@@ -86,6 +88,14 @@ import {
   Materials,
   Reference,
 } from './materials/materials';
+import * as PdfGeneratorAPI from './pdf-generator/pdf-generator';
+import {
+  PdfGenerator,
+  PdfGeneratorCreateParams,
+  PdfGeneratorCreateResponse,
+  PdfGeneratorDeleteResponse,
+  PdfGeneratorGetAllResponse,
+} from './pdf-generator/pdf-generator';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -102,6 +112,7 @@ export class V1 extends APIResource {
     this._client,
   );
   materials: MaterialsAPI.Materials = new MaterialsAPI.Materials(this._client);
+  pdfGenerator: PdfGeneratorAPI.PdfGenerator = new PdfGeneratorAPI.PdfGenerator(this._client);
 
   /**
    * Test MongoDB connection and get outbound IP
@@ -128,6 +139,7 @@ V1.Chat = Chat;
 V1.ChatAnalytics = ChatAnalytics;
 V1.AssignmentGrader = AssignmentGrader;
 V1.Materials = Materials;
+V1.PdfGenerator = PdfGenerator;
 
 export declare namespace V1 {
   export {
@@ -207,9 +219,11 @@ export declare namespace V1 {
     type MaterialResponse as MaterialResponse,
     type Reference as Reference,
     type MaterialListResponse as MaterialListResponse,
+    type MaterialCancelJobResponse as MaterialCancelJobResponse,
     type MaterialCreateBatchUploadURLsResponse as MaterialCreateBatchUploadURLsResponse,
     type MaterialGetDebugInfoResponse as MaterialGetDebugInfoResponse,
     type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse,
+    type MaterialGetJobStatusResponse as MaterialGetJobStatusResponse,
     type MaterialSearchResponse as MaterialSearchResponse,
     type MaterialCreateParams as MaterialCreateParams,
     type MaterialUpdateParams as MaterialUpdateParams,
@@ -223,4 +237,12 @@ export declare namespace V1 {
     type MaterialRenameParams as MaterialRenameParams,
     type MaterialSearchParams as MaterialSearchParams,
   };
+
+  export {
+    PdfGenerator as PdfGenerator,
+    type PdfGeneratorCreateResponse as PdfGeneratorCreateResponse,
+    type PdfGeneratorDeleteResponse as PdfGeneratorDeleteResponse,
+    type PdfGeneratorGetAllResponse as PdfGeneratorGetAllResponse,
+    type PdfGeneratorCreateParams as PdfGeneratorCreateParams,
+  };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.42.0'; // x-release-please-version
+export const VERSION = '1.43.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.42.0";
+export declare const VERSION = "1.43.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.42.0'; // x-release-please-version
+exports.VERSION = '1.43.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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