@rippling/rippling-sdk 0.2.0-alpha.52 → 0.2.0-alpha.54

package/src/client.ts

@@ -19,6 +19,13 @@ import { AbstractPage, PageCursorURLResponse } from './core/pagination';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
+import {
+  BreakTypeListParams,
+  BreakTypeListResponse,
+  BreakTypeListResponsesPageCursorURL,
+  BreakTypeRetrieveResponse,
+  BreakTypes,
+} from './resources/break-types';
 import {
   BusinessPartnerGroup,
   BusinessPartnerGroupCreateParams,
@@ -323,6 +330,13 @@ import {
   ReportRunRetrieveResponse,
   ReportRuns,
 } from './resources/report-runs';
+import {
+  ScheduledJobAssignmentListParams,
+  ScheduledJobAssignmentListResponse,
+  ScheduledJobAssignmentListResponsesPageCursorURL,
+  ScheduledJobAssignmentRetrieveResponse,
+  ScheduledJobAssignments,
+} from './resources/scheduled-job-assignments';
 import {
   ScheduleCreateParams,
   ScheduleCreateResponse,
@@ -365,6 +379,18 @@ import {
   ShiftassignmentUpdateResponse,
   Shiftassignments,
 } from './resources/shiftassignments';
+import {
+  SoftwareDeploymentCreateParams,
+  SoftwareDeploymentCreateResponse,
+  SoftwareDeploymentListParams,
+  SoftwareDeploymentListResponse,
+  SoftwareDeploymentListResponsesPageCursorURL,
+  SoftwareDeploymentRetrieveParams,
+  SoftwareDeploymentRetrieveResponse,
+  SoftwareDeploymentUpdateParams,
+  SoftwareDeploymentUpdateResponse,
+  SoftwareDeployments,
+} from './resources/software-deployments';
 import { SSOMe, SSOMeListParams, SSOMeResource } from './resources/sso-me';
 import {
   Team,
@@ -443,6 +469,18 @@ import {
   WorkLocations,
   WorkLocationsPageCursorURL,
 } from './resources/work-locations';
+import {
+  WorkerTimeSplitCreateParams,
+  WorkerTimeSplitCreateResponse,
+  WorkerTimeSplitListParams,
+  WorkerTimeSplitListResponse,
+  WorkerTimeSplitListResponsesPageCursorURL,
+  WorkerTimeSplitRetrieveParams,
+  WorkerTimeSplitRetrieveResponse,
+  WorkerTimeSplitUpdateParams,
+  WorkerTimeSplitUpdateResponse,
+  WorkerTimeSplits,
+} from './resources/worker-time-splits';
 import {
   Worker,
   WorkerListParams,
@@ -1350,6 +1388,10 @@ export class RipplingSDK {
    * Job related information for the company
    */
   jobPayRateExceptions: API.JobPayRateExceptions = new API.JobPayRateExceptions(this);
+  /**
+   * Break types configured by the company for time tracking
+   */
+  breakTypes: API.BreakTypes = new API.BreakTypes(this);
   /**
    * Someone who applies to a job requisition opened by the company
    */
@@ -1445,10 +1487,18 @@ export class RipplingSDK {
    * Schedules used by the company
    */
   schedules: API.Schedules = new API.Schedules(this);
+  /**
+   * Job related information for the company
+   */
+  scheduledJobAssignments: API.ScheduledJobAssignments = new API.ScheduledJobAssignments(this);
   /**
    * Shift assignments assigned to workers
    */
   shiftassignments: API.Shiftassignments = new API.Shiftassignments(this);
+  /**
+   * Software deployed to company devices
+   */
+  softwareDeployments: API.SoftwareDeployments = new API.SoftwareDeployments(this);
   /**
    * Job titles used by the company
    */
@@ -1457,6 +1507,10 @@ export class RipplingSDK {
    * Unassigned shifts that are part of a schedule
    */
   unassignedshifts: API.Unassignedshifts = new API.Unassignedshifts(this);
+  /**
+   * Job related information for the company
+   */
+  workerTimeSplits: API.WorkerTimeSplits = new API.WorkerTimeSplits(this);
   /**
    * Execute workflow actions like sending emails, Slack messages, and notifications
    */
@@ -1501,6 +1555,7 @@ RipplingSDK.BusinessPartnerGroups = BusinessPartnerGroups;
 RipplingSDK.Functions = Functions;
 RipplingSDK.JobAssignments = JobAssignments;
 RipplingSDK.JobPayRateExceptions = JobPayRateExceptions;
+RipplingSDK.BreakTypes = BreakTypes;
 RipplingSDK.Candidates = Candidates;
 RipplingSDK.CandidateApplications = CandidateApplications;
 RipplingSDK.CompanyLegalEntities = CompanyLegalEntities;
@@ -1527,9 +1582,12 @@ RipplingSDK.PlatformCapabilities = PlatformCapabilities;
 RipplingSDK.Reports = Reports;
 RipplingSDK.ReportRuns = ReportRuns;
 RipplingSDK.Schedules = Schedules;
+RipplingSDK.ScheduledJobAssignments = ScheduledJobAssignments;
 RipplingSDK.Shiftassignments = Shiftassignments;
+RipplingSDK.SoftwareDeployments = SoftwareDeployments;
 RipplingSDK.Titles = Titles;
 RipplingSDK.Unassignedshifts = Unassignedshifts;
+RipplingSDK.WorkerTimeSplits = WorkerTimeSplits;
 RipplingSDK.WorkflowActionExecutions = WorkflowActionExecutions;
 RipplingSDK.ShiftAssignments = ShiftAssignments;
 RipplingSDK.UnassignedShifts = UnassignedShifts;
@@ -1833,6 +1891,14 @@ export declare namespace RipplingSDK {
     type JobPayRateExceptionListChangeLogParams as JobPayRateExceptionListChangeLogParams,
   };
 
+  export {
+    BreakTypes as BreakTypes,
+    type BreakTypeListResponse as BreakTypeListResponse,
+    type BreakTypeRetrieveResponse as BreakTypeRetrieveResponse,
+    type BreakTypeListResponsesPageCursorURL as BreakTypeListResponsesPageCursorURL,
+    type BreakTypeListParams as BreakTypeListParams,
+  };
+
   export {
     Candidates as Candidates,
     type CandidateListResponse as CandidateListResponse,
@@ -2038,6 +2104,14 @@ export declare namespace RipplingSDK {
     type ScheduleUpdateParams as ScheduleUpdateParams,
   };
 
+  export {
+    ScheduledJobAssignments as ScheduledJobAssignments,
+    type ScheduledJobAssignmentListResponse as ScheduledJobAssignmentListResponse,
+    type ScheduledJobAssignmentRetrieveResponse as ScheduledJobAssignmentRetrieveResponse,
+    type ScheduledJobAssignmentListResponsesPageCursorURL as ScheduledJobAssignmentListResponsesPageCursorURL,
+    type ScheduledJobAssignmentListParams as ScheduledJobAssignmentListParams,
+  };
+
   export {
     Shiftassignments as Shiftassignments,
     type ShiftassignmentListResponse as ShiftassignmentListResponse,
@@ -2051,6 +2125,19 @@ export declare namespace RipplingSDK {
     type ShiftassignmentUpdateParams as ShiftassignmentUpdateParams,
   };
 
+  export {
+    SoftwareDeployments as SoftwareDeployments,
+    type SoftwareDeploymentListResponse as SoftwareDeploymentListResponse,
+    type SoftwareDeploymentCreateResponse as SoftwareDeploymentCreateResponse,
+    type SoftwareDeploymentRetrieveResponse as SoftwareDeploymentRetrieveResponse,
+    type SoftwareDeploymentUpdateResponse as SoftwareDeploymentUpdateResponse,
+    type SoftwareDeploymentListResponsesPageCursorURL as SoftwareDeploymentListResponsesPageCursorURL,
+    type SoftwareDeploymentListParams as SoftwareDeploymentListParams,
+    type SoftwareDeploymentCreateParams as SoftwareDeploymentCreateParams,
+    type SoftwareDeploymentRetrieveParams as SoftwareDeploymentRetrieveParams,
+    type SoftwareDeploymentUpdateParams as SoftwareDeploymentUpdateParams,
+  };
+
   export {
     Titles as Titles,
     type TitleListResponse as TitleListResponse,
@@ -2076,6 +2163,19 @@ export declare namespace RipplingSDK {
     type UnassignedshiftUpdateParams as UnassignedshiftUpdateParams,
   };
 
+  export {
+    WorkerTimeSplits as WorkerTimeSplits,
+    type WorkerTimeSplitListResponse as WorkerTimeSplitListResponse,
+    type WorkerTimeSplitCreateResponse as WorkerTimeSplitCreateResponse,
+    type WorkerTimeSplitRetrieveResponse as WorkerTimeSplitRetrieveResponse,
+    type WorkerTimeSplitUpdateResponse as WorkerTimeSplitUpdateResponse,
+    type WorkerTimeSplitListResponsesPageCursorURL as WorkerTimeSplitListResponsesPageCursorURL,
+    type WorkerTimeSplitListParams as WorkerTimeSplitListParams,
+    type WorkerTimeSplitCreateParams as WorkerTimeSplitCreateParams,
+    type WorkerTimeSplitRetrieveParams as WorkerTimeSplitRetrieveParams,
+    type WorkerTimeSplitUpdateParams as WorkerTimeSplitUpdateParams,
+  };
+
   export {
     WorkflowActionExecutions as WorkflowActionExecutions,
     type WorkflowActionExecutionCreateResponse as WorkflowActionExecutionCreateResponse,

package/src/lib/manifest/_helpers.ts

@@ -129,12 +129,14 @@ export const ALLOWED_SUMMARY_OUTPUT: Record<SummaryAggregation, ReadonlySet<Fiel
  * used as a summary filter at all": field types **absent from this map**
  * are rejected as filter fields entirely. The UI-hidden types are:
  *
- *   SELECT / RADIO          — array-valued at the RQL layer; the
+ *   SELECT                  — array-valued at the RQL layer; the
  *                             "is this option selected?" semantics are
- *                             ambiguous for aggregations. Users are
- *                             expected to model a plain BOOLEAN on the
- *                             child CO (updated via Rule) and filter
- *                             on that.
+ *                             ambiguous for aggregations.
+ *   RADIO                   — single-value choice fields are not supported
+ *                             by the summary filter condition builder.
+ *                             When a choice should drive an aggregate filter,
+ *                             model a plain BOOLEAN on the child CO, update it
+ *                             with a `Rule` action, and filter on that.
  *   LONG_TEXT               — backend hard-rejects (parent_child_util.py).
  *   OG_REFERENCE_FIELD      — lookup/parent-child: filter-on-what is
  *                             ambiguous (id vs. name vs. edge metadata).

package/src/lib/manifest/index.ts

@@ -186,3 +186,29 @@ export {
   type ValidationLoadFromExistingOptions,
   type ValidationProps,
 } from './validation';
+
+export {
+  Workflow,
+  type WorkflowAutomationEventType,
+  type WorkflowAnnualSchedule,
+  type WorkflowBusinessTrigger,
+  type WorkflowCronSchedule,
+  type WorkflowCustomSchedule,
+  type WorkflowCustomScheduleFrequencyUnit,
+  type WorkflowDateRelativeOperatorType,
+  type WorkflowDateRelativeTrigger,
+  type WorkflowDeletionIdentifier,
+  type WorkflowManualTrigger,
+  type WorkflowMonthlyOnDayOfWeekSchedule,
+  type WorkflowMonthlySchedule,
+  type WorkflowOneTimeSchedule,
+  type WorkflowProps,
+  type WorkflowQuarterlySchedule,
+  type WorkflowRecordChangeOperationType,
+  type WorkflowRecordChangeTrigger,
+  type WorkflowScheduledFrequencyType,
+  type WorkflowScheduledTrigger,
+  type WorkflowTimeOfDaySchedule,
+  type WorkflowTrigger,
+  type WorkflowTriggerBase,
+} from './workflow';

package/src/lib/manifest/manifest-builder.ts

@@ -24,7 +24,8 @@ export type ManifestComponentType =
   | 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW'
   | 'CUSTOM_OBJECT_VALIDATION_RULE'
   | 'FUNCTION'
-  | 'SDUI_PAGE';
+  | 'SDUI_PAGE'
+  | 'WORKFLOW_DEFINITION';
 
 /**
  * Static side of a manifest component class.

package/src/lib/manifest/rule.ts

@@ -23,8 +23,9 @@ export interface RuleAction {
   /**
    * Set the target field to a fixed value. Mutually exclusive with `rqlFormula`.
    *
-   * Optional. For `SELECT` / `RADIO` fields, pass a string or single-element array —
-   * both are normalized to an array on the wire.
+   * Optional. For `SelectField` targets, pass one option value or an array of option
+   * values; a scalar is serialized as a single-element array. For `RadioField` targets,
+   * pass exactly one option value as a scalar; arrays are rejected.
    */
   fixedValue?: any;
   /**
@@ -68,8 +69,8 @@ export interface RuleProps {
    * Controls when an `UPDATE` trigger fires relative to the condition.
    * One of `'MEETS_CONDITION_AFTER_ONLY'` | `'MEETS_CONDITION_BEFORE_OR_AFTER'`.
    *
-   * Conditional. Only meaningful when `triggerType` is `'UPDATE'` or `'CREATE_OR_UPDATE'`.
-   * @default `'MEETS_CONDITION_AFTER_ONLY'`
+   * Conditional. Required when `triggerType` is `'UPDATE'` or `'CREATE_OR_UPDATE'`.
+   * Must be omitted when `triggerType` is `'CREATE'`.
    */
   updateTriggerType?: UpdateTriggerType;
   /**
@@ -91,16 +92,28 @@ export interface RuleLoadFromExistingOptions extends ExistingManifestContextOpti
   customObjectApiName?: string;
 }
 
-/** SELECT / RADIO rule actions use list `fixed_value` (Rippling rule builder). */
+const VALID_TRIGGERS: TriggerType[] = ['CREATE', 'UPDATE', 'CREATE_OR_UPDATE'];
+const VALID_UPDATE_TRIGGER_TYPES: UpdateTriggerType[] = [
+  'MEETS_CONDITION_AFTER_ONLY',
+  'MEETS_CONDITION_BEFORE_OR_AFTER',
+];
+
 function fixedValueToWire(targetField: Field, value: any): any {
   const ft = targetField.getFieldType();
-  if (ft !== 'SELECT' && ft !== 'RADIO') {
-    return value;
+  if (ft === 'SELECT') {
+    return Array.isArray(value) ? value : [value];
   }
-  if (Array.isArray(value)) {
+
+  if (ft === 'RADIO') {
+    if (Array.isArray(value)) {
+      throw new TypeError(
+        `Rule.fixedValue for RADIO field ${targetField.getApiName()} must be a scalar value.`,
+      );
+    }
     return value;
   }
-  return [value];
+
+  return value;
 }
 
 function actionToDict(action: RuleAction): Record<string, any> {
@@ -119,6 +132,37 @@ function hasOwn(value: Record<string, any>, key: string): boolean {
   return Object.prototype.hasOwnProperty.call(value, key);
 }
 
+function validateTriggerConfig(props: Pick<RuleProps, 'triggerType' | 'updateTriggerType'>): void {
+  if (!VALID_TRIGGERS.includes(props.triggerType)) {
+    throw new Error(
+      `Invalid trigger_type: ${props.triggerType}. Must be one of: ${VALID_TRIGGERS.join(', ')}`,
+    );
+  }
+
+  if (props.triggerType === 'CREATE') {
+    if (props.updateTriggerType != null) {
+      throw new Error('updateTriggerType must be omitted when triggerType is CREATE.');
+    }
+    return;
+  }
+
+  if (props.updateTriggerType == null) {
+    throw new Error(
+      `updateTriggerType is required when triggerType is ${
+        props.triggerType
+      }. Must be one of: ${VALID_UPDATE_TRIGGER_TYPES.join(', ')}`,
+    );
+  }
+
+  if (!VALID_UPDATE_TRIGGER_TYPES.includes(props.updateTriggerType)) {
+    throw new Error(
+      `Invalid update_trigger_type: ${
+        props.updateTriggerType
+      }. Must be one of: ${VALID_UPDATE_TRIGGER_TYPES.join(', ')}`,
+    );
+  }
+}
+
 /**
  * Defines a record-triggered automation rule and registers it with the manifest.
  *
@@ -161,14 +205,10 @@ export class Rule {
    * @param customObject - The custom object this rule is attached to.
    * @param props - Initialization properties.
    * @throws {Error} If `props.triggerType` is not one of `'CREATE'`, `'UPDATE'`, `'CREATE_OR_UPDATE'`.
+   * @throws {Error} If `props.updateTriggerType` is missing or invalid for update-style triggers.
    */
   constructor(customObject: CustomObject, props: RuleProps) {
-    const VALID_TRIGGERS: TriggerType[] = ['CREATE', 'UPDATE', 'CREATE_OR_UPDATE'];
-    if (!VALID_TRIGGERS.includes(props.triggerType)) {
-      throw new Error(
-        `Invalid trigger_type: ${props.triggerType}. Must be one of: ${VALID_TRIGGERS.join(', ')}`,
-      );
-    }
+    validateTriggerConfig(props);
     this._flowId = props.flowId ?? generateId('flow');
     this._customObjectApiName = customObject.getApiName();
     this._flowName = props.flowName;

package/src/lib/manifest/workflow.ts

@@ -0,0 +1,244 @@
+import { generateId } from './_helpers';
+import type { ManifestFunction } from './manifest-function';
+import type { ManifestComponentDeletion, ManifestScope } from './manifest-builder';
+
+export type WorkflowAutomationEventType =
+  | 'AUTOMATION_EVENT_TYPE_BUSINESS'
+  | 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE'
+  | 'AUTOMATION_EVENT_TYPE_SCHEDULED'
+  | 'AUTOMATION_EVENT_TYPE_MANUAL'
+  | 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
+
+export type WorkflowRecordChangeOperationType =
+  | 'RECORD_CHANGE_OPERATION_TYPE_CREATE'
+  | 'RECORD_CHANGE_OPERATION_TYPE_UPDATE'
+  | 'RECORD_CHANGE_OPERATION_TYPE_DELETE'
+  | 'RECORD_CHANGE_OPERATION_TYPE_CREATE_OR_UPDATE';
+
+export type WorkflowDateRelativeOperatorType =
+  | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_EQ'
+  | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_WITHIN'
+  | 'DATE_RELATIVE_TRIGGER_OPERATOR_TYPE_BETWEEN';
+
+export type WorkflowScheduledFrequencyType =
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_DAILY'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKDAY_DAILY'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_WEEKLY'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_BIWEEKLY'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_MONTHLY_ON_DAY_OF_WEEK'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ONE_TIME'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_QUARTERLY'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_ANNUALLY'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CUSTOM'
+  | 'SCHEDULED_TRIGGER_FREQUENCY_TYPE_CRON';
+
+export type WorkflowCustomScheduleFrequencyUnit =
+  | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_DAYS'
+  | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_WEEKS'
+  | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MONTHS'
+  | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_YEARS'
+  | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_HOURS'
+  | 'CUSTOM_SCHEDULE_TRIGGER_FREQUENCY_UNIT_MINUTES';
+
+export interface WorkflowTimeOfDaySchedule {
+  hour_of_day: number;
+  minute_of_hour?: number;
+}
+
+export interface WorkflowOneTimeSchedule extends WorkflowTimeOfDaySchedule {
+  year: number;
+  month_of_year: number;
+  day_of_month: number;
+}
+
+export interface WorkflowWeeklySchedule extends WorkflowTimeOfDaySchedule {
+  day_of_week: number[];
+}
+
+export interface WorkflowMonthlySchedule extends WorkflowTimeOfDaySchedule {
+  day_of_month: number;
+  start_month?: number;
+}
+
+export interface WorkflowMonthlyOnDayOfWeekSchedule extends WorkflowTimeOfDaySchedule {
+  day_of_week: number;
+  day_of_month: number;
+}
+
+export interface WorkflowQuarterlySchedule extends WorkflowTimeOfDaySchedule {
+  day_of_month: number;
+  month_of_year: number;
+}
+
+export interface WorkflowAnnualSchedule extends WorkflowTimeOfDaySchedule {
+  day_of_month: number;
+  month_of_year: number;
+  start_month?: number;
+}
+
+export interface WorkflowCronSchedule {
+  cron_expression: string;
+}
+
+export interface WorkflowCustomSchedule extends WorkflowTimeOfDaySchedule {
+  custom_schedule_frequency: WorkflowCustomScheduleFrequencyUnit;
+  custom_schedule_frequency_value: number;
+  daily_schedule?: WorkflowTimeOfDaySchedule;
+  weekly_schedule?: WorkflowWeeklySchedule;
+  monthly_schedule?: WorkflowMonthlySchedule;
+  annual_schedule?: WorkflowAnnualSchedule;
+}
+
+export interface WorkflowTriggerBase {
+  automation_event_type: WorkflowAutomationEventType;
+  og_module?: string;
+  base_model?: string;
+  rql_formula?: string;
+  is_basic_workflow?: boolean;
+  og_category?: string;
+  condition_builder_mode?: string;
+  conditions_tree?: string;
+}
+
+export interface WorkflowBusinessTrigger extends WorkflowTriggerBase {
+  automation_event_type: 'AUTOMATION_EVENT_TYPE_BUSINESS';
+  event_name: string;
+  business_event_trigger?: {
+    navigation_path?: string;
+  };
+}
+
+export interface WorkflowRecordChangeTrigger extends WorkflowTriggerBase {
+  automation_event_type: 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE';
+  record_change_operation_type: WorkflowRecordChangeOperationType;
+}
+
+export interface WorkflowDateRelativeTrigger extends WorkflowTriggerBase {
+  automation_event_type: 'AUTOMATION_EVENT_TYPE_DATE_RELATIVE';
+  date_relative_trigger: {
+    hour_of_day: number;
+    minute_of_hour?: number;
+    timezone?: string;
+    base_model_date_field_rql_path?: string;
+    trigger_on_anniversary?: boolean;
+    date_range_operator?: WorkflowDateRelativeOperatorType;
+    should_trigger_exactly_once_per_trigger_object?: boolean;
+    operands?: Array<{ time_delta?: { days: number } }>;
+  };
+}
+
+export interface WorkflowScheduledTrigger extends WorkflowTriggerBase {
+  automation_event_type: 'AUTOMATION_EVENT_TYPE_SCHEDULED';
+  scheduled_trigger: {
+    frequency: WorkflowScheduledFrequencyType;
+    timezone: string;
+    daily_schedule?: WorkflowTimeOfDaySchedule;
+    weekday_schedule?: WorkflowTimeOfDaySchedule;
+    one_time_schedule?: WorkflowOneTimeSchedule;
+    weekly_schedule?: WorkflowWeeklySchedule;
+    bi_weekly_schedule?: WorkflowWeeklySchedule;
+    monthly_schedule?: WorkflowMonthlySchedule;
+    monthly_on_day_of_week_schedule?: WorkflowMonthlyOnDayOfWeekSchedule;
+    quarterly_schedule?: WorkflowQuarterlySchedule;
+    annual_schedule?: WorkflowAnnualSchedule;
+    cron_schedule?: WorkflowCronSchedule;
+    custom_schedule?: WorkflowCustomSchedule;
+  };
+}
+
+export interface WorkflowManualTrigger extends WorkflowTriggerBase {
+  automation_event_type: 'AUTOMATION_EVENT_TYPE_MANUAL';
+}
+
+export type WorkflowTrigger =
+  | WorkflowBusinessTrigger
+  | WorkflowRecordChangeTrigger
+  | WorkflowDateRelativeTrigger
+  | WorkflowScheduledTrigger
+  | WorkflowManualTrigger;
+
+export interface WorkflowDeletionIdentifier {
+  definitionId: string;
+}
+
+export interface WorkflowProps {
+  /**
+   * Stable workflow definition id. Auto-generated when omitted.
+   */
+  definitionId?: string;
+  /**
+   * Workflow title shown to admins.
+   */
+  title: string;
+  /**
+   * Short workflow description shown to admins.
+   */
+  description: string;
+  /**
+   * The function this workflow runs. Pass a live {@link ManifestFunction} reference,
+   * or a raw api_name string for functions defined outside this manifest.
+   *
+   * Required.
+   */
+  function: ManifestFunction | string;
+  /**
+   * Trigger definition in the workflows v2 proto JSON shape.
+   */
+  trigger: WorkflowTrigger;
+}
+
+/**
+ * Defines a simple Workflow Studio workflow and registers it with the manifest.
+ *
+ * This intentionally models only the authoring inputs we need today: workflow
+ * metadata, trigger JSON, and the function reference. The installer/backend can
+ * derive the graph from these fields later.
+ */
+export class Workflow {
+  static readonly componentType = 'WORKFLOW_DEFINITION' as const;
+
+  static toDeletionIdentifier(identifier: WorkflowDeletionIdentifier | string): ManifestComponentDeletion {
+    const definitionId = typeof identifier === 'string' ? identifier : identifier.definitionId;
+    return {
+      type: Workflow.componentType,
+      definition_id: definitionId,
+    };
+  }
+
+  private readonly _definitionId: string;
+  private readonly _title: string;
+  private readonly _description: string;
+  private readonly _functionApiName: string;
+  private readonly _trigger: WorkflowTrigger;
+
+  constructor(scope: ManifestScope, props: WorkflowProps) {
+    if (!props.function) throw new Error('function is required');
+    this._definitionId = props.definitionId ?? generateId('workflow');
+    this._title = props.title;
+    this._description = props.description;
+    this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
+    this._trigger = props.trigger;
+    scope._register(this);
+  }
+
+  getDefinitionId(): string {
+    return this._definitionId;
+  }
+
+  toDict(): Record<string, any> {
+    const component: Record<string, any> = {
+      type: Workflow.componentType,
+      definition_id: this._definitionId,
+      version_status: 'VERSION_STATUS_DRAFT',
+      trigger_status: 'TRIGGER_STATUS_INACTIVE',
+      trigger: this._trigger,
+      workflow_meta: {
+        name: this._title,
+        description: this._description,
+      },
+      function_api_name: this._functionApiName,
+    };
+    return component;
+  }
+}