@parall/sdk 1.20.1 → 1.21.0

package/src/types.ts

@@ -406,6 +406,11 @@ export interface LoginRequest {
   password: string;
 }
 
+export interface ChangePasswordRequest {
+  current_password: string;
+  new_password: string;
+}
+
 export interface CreateChatRequest {
   type: ChatType;
   org_id: string;
@@ -677,6 +682,123 @@ export interface UpdateProjectRequest {
   sort_order?: number;
 }
 
+// ============================================================
+// Schedule Types
+// ============================================================
+
+export type ScheduleSpecType = 'cron' | 'interval' | 'one_shot';
+export type ScheduleStatus = 'active' | 'paused' | 'completed' | 'cancelled';
+export type ScheduleCancelReason = 'user_cancel' | 'attached_gone' | 'target_ineligible';
+export type ScheduleRunStatus = 'delivered' | 'missed' | 'failed';
+
+export interface Schedule {
+  id: string;
+  org_id: string;
+  creator_id: string;
+  target_id: string;
+  attached_to_uri: string | null;
+  name: string;
+  description: string;
+  spec_type: ScheduleSpecType;
+  cron_expr: string | null;
+  interval_seconds: number | null;
+  run_at: string | null;
+  timezone: string;
+  start_at: string | null;
+  end_at: string | null;
+  max_runs: number | null;
+  catchup_window_seconds: number;
+  status: ScheduleStatus;
+  cancel_reason: ScheduleCancelReason | null;
+  next_fire_at: string | null;
+  last_fire_at: string | null;
+  run_count: number;
+  created_at: string;
+  updated_at: string;
+}
+
+export interface ScheduleRun {
+  id: string;
+  schedule_id: string;
+  scheduled_fire_at: string;
+  actual_fired_at: string;
+  status: ScheduleRunStatus;
+  fired_description: string | null;
+  fired_attached_uri: string | null;
+  dispatch_event_id: string | null;
+  inbox_item_id: string | null;
+  error: string | null;
+  created_at: string;
+}
+
+export interface CreateScheduleInput {
+  name: string;
+  description: string;
+  target_id: string;
+  attached_to_uri?: string;
+  spec_type: ScheduleSpecType;
+  cron_expr?: string;
+  interval_seconds?: number;
+  run_at?: string;
+  timezone?: string;
+  start_at?: string;
+  end_at?: string;
+  max_runs?: number;
+  catchup_window_seconds?: number;
+}
+
+export interface UpdateScheduleInput {
+  name?: string;
+  description?: string;
+  target_id?: string;
+  attached_to_uri?: string;
+  /** Explicitly clear attached_to_uri. Server honors this over `attached_to_uri`. */
+  attached_to_uri_clear?: boolean;
+  cron_expr?: string;
+  interval_seconds?: number;
+  run_at?: string;
+  timezone?: string;
+  start_at?: string;
+  /** Explicitly clear start_at. Server honors this over `start_at`. */
+  start_at_clear?: boolean;
+  end_at?: string;
+  /** Explicitly clear end_at. Server honors this over `end_at`. */
+  end_at_clear?: boolean;
+  max_runs?: number;
+  /** Explicitly clear max_runs. Server honors this over `max_runs`. */
+  max_runs_clear?: boolean;
+  catchup_window_seconds?: number;
+}
+
+export interface ScheduleFilters {
+  attached_to?: string;
+  target_id?: string;
+  creator_id?: string;
+  /** Comma-separated list of statuses (e.g. 'active,paused'). */
+  status?: string;
+  cursor?: string;
+  limit?: number;
+}
+
+export interface ScheduleRunFilters {
+  cursor?: string;
+  limit?: number;
+}
+
+// Schedule WS event data
+export type ScheduleCreatedData = Schedule;
+export type ScheduleUpdatedData = Schedule;
+export interface ScheduleDeletedData {
+  schedule_id: string;
+  org_id: string;
+}
+export interface ScheduleFiredData {
+  schedule_id: string;
+  run_id: string;
+  scheduled_fire_at: string;
+  actual_fired_at: string;
+}
+
 // ============================================================
 // Wiki Types
 // ============================================================
@@ -842,6 +964,34 @@ export interface WikiBrokenRef extends WikiFileRef {
   reason: string;
 }
 
+// WikiAnchorRef is a (path, rev) pair pointing at a specific blob snapshot
+// the caller wants to check for outdatedness.
+export interface WikiAnchorRef {
+  path: string;
+  rev: string;
+}
+
+export interface WikiAnchorStatusRequest {
+  refs: WikiAnchorRef[];
+}
+
+// WikiAnchorStatus reports whether the file at (path, rev) is still byte-
+// identical to HEAD. Refs the caller cannot read are silently dropped from
+// the response, so a missing entry indicates either a forbidden path or a
+// malformed request entry — callers treat both as "unknown" (not outdated).
+export interface WikiAnchorStatus {
+  path: string;
+  rev: string;
+  blob_sha_at_rev?: string;
+  blob_sha_at_head?: string;
+  outdated: boolean;
+  file_exists_at_head: boolean;
+}
+
+export interface WikiAnchorStatusResponse {
+  results: WikiAnchorStatus[];
+}
+
 export interface WikiRefsCheckResponse {
   wiki_id: string;
   wiki_slug: string;
@@ -975,11 +1125,40 @@ export interface WikiBlob {
   path: string;
   ref: string;
   resolved_rev?: string;
-  line_count: number;
-  content: string;
   size: number;
-  encoding: string;
+  // Text / inline-binary responses carry `content` + `line_count`.
+  // Binary (LFS pointer or inline blob served as `signed_url`) responses
+  // omit `content` and `line_count` and set `encoding = "signed_url"`
+  // with the two signed_url fields populated. See
+  // docs/engineering-design/wiki-file-storage-design.md §读路径 SSOT.
+  encoding: 'utf-8' | 'base64' | 'signed_url';
+  content?: string;
+  line_count?: number;
   sha256?: string;
+  // Phase 2 additions for the binary response shape:
+  mime?: string;
+  is_lfs?: boolean;
+  content_sha?: string;
+  signed_url?: string;
+  signed_url_expires_at?: string;
+}
+
+export type WikiStoredAs = 'git_blob' | 'lfs_pointer';
+
+/** Response from POST /uploads or POST /changesets/{csId}/files. */
+export interface WikiFileUploadResponse {
+  path: string;
+  size: number;
+  stored_as: WikiStoredAs;
+  commit_sha: string;
+  content_sha: string;
+}
+
+/** Response from POST /files/preview-url — short-lived signed URL for
+ * browser `<img>`/`<video>`/`<iframe>` src. TTL is 5 minutes by default. */
+export interface WikiFilePreviewUrlResponse {
+  url: string;
+  expires_at: string;
 }
 
 // ============================================================
@@ -1192,11 +1371,6 @@ export interface CreateAgentStepRequest {
   projection?: boolean; // project text steps to chat message or task comment (controlled by agent's run_config)
 }
 
-export interface CreateAgentTaskBackfillCommentRequest {
-  task_id: string;
-  body: string;
-}
-
 export interface UpdateAgentSessionRequest {
   status: string;
   trigger_message_id?: string;
@@ -1261,7 +1435,7 @@ export interface CommentDeletedData {
 export type InboxItemType =
   | 'mention' | 'task_assign' | 'task_update'
   | 'task_comment' | 'approval_request'
-  | 'agent_alert' | 'invitation';
+  | 'agent_alert' | 'invitation' | 'schedule_fire';
 
 export interface InboxItem {
   id: string;
@@ -1289,7 +1463,7 @@ export interface InboxItem {
 // Dispatch Types (agent event delivery)
 // ============================================================
 
-export type DispatchEventType = 'message' | 'task_assign' | 'task_comment';
+export type DispatchEventType = 'message' | 'task_assign' | 'task_comment' | 'schedule.fire';
 export type DispatchStatus = 'pending' | 'acked';
 
 export interface DispatchEvent {
@@ -1391,6 +1565,10 @@ export type WsEventMap = {
   'inbox.bulk_update': InboxBulkUpdateData;
   'read_position.updated': ReadPositionUpdateData;
   'dispatch.new': DispatchNewData;
+  'schedule.created': ScheduleCreatedData;
+  'schedule.updated': ScheduleUpdatedData;
+  'schedule.deleted': ScheduleDeletedData;
+  'schedule.fired': ScheduleFiredData;
 };
 
 // Invitation WS event data