@avallon-labs/sdk 36.10.0 → 37.0.0-staging.930

package/dist/index.d.ts

@@ -1781,9 +1781,13 @@ type ScheduleAction = {
  * OpenAPI spec version: 1.0.0
  */
 /**
- * When the schedule fires, in the given time zone
+ * When the schedule fires
  */
 type ScheduleRule = {
+    type: "once";
+    /** The moment it fires, in UTC, e.g. "2026-09-01T14:00:00Z" */
+    at: string;
+} | {
     type: "hourly";
     /**
      * Minute, 0-59
@@ -1849,7 +1853,7 @@ type CreateScheduleBody = {
      * @maxLength 200
      */
     name?: string;
-    /** Whether the schedule starts firing right away. Defaults to true. */
+    /** Whether the schedule starts firing right away. Defaults to true. Must be omitted or true for `once` rules. */
     enabled?: boolean;
 };
 
@@ -5197,9 +5201,13 @@ type ScheduleActionOutput = {
  * OpenAPI spec version: 1.0.0
  */
 /**
- * When the schedule fires, in the given time zone
+ * When the schedule fires
  */
 type ScheduleRuleOutput = {
+    type: "once";
+    /** The moment it fires, in UTC, e.g. "2026-09-01T14:00:00Z" */
+    at: string;
+} | {
     type: "hourly";
     /**
      * Minute, 0-59
@@ -5265,7 +5273,7 @@ interface Schedule {
     rule: ScheduleRuleOutput;
     /** Whether the schedule currently fires. Disabled never fires. */
     enabled: boolean;
-    /** When the schedule fires next, in UTC. Null while disabled. */
+    /** When the schedule fires next, in UTC. Null while disabled, or once a one-off has fired. */
     next_run_at: string | null;
     /** Actor that created the schedule */
     created_by: string;
@@ -5737,7 +5745,7 @@ type UpdateScheduleBody = {
     rule?: ScheduleRule;
     /** Human-readable name. Send null to clear it. */
     name?: string | null;
-    /** Whether the schedule fires. Disabled never fires. */
+    /** Whether the schedule fires. Disabled never fires. Must be omitted or true for `once` rules. */
     enabled?: boolean;
 };
 
@@ -8915,11 +8923,11 @@ type AwaitedInput$8<T> = PromiseLike<T> | T;
 type Awaited$8<O> = O extends AwaitedInput$8<infer T> ? T : never;
 type SecondParameter$8<T extends (...args: never) => unknown> = Parameters<T>[1];
 /**
- * Create a schedule that repeatedly performs an action on a recurring rule.
+ * Create a schedule that performs an action, either repeatedly or once.
 
-`action` describes **what** happens — today only `trigger_worker`, which starts a worker run with the given scope. `rule` describes **when**, in the tenant's own time zone: an IANA identifier such as `America/Chicago`, resolved across DST transitions.
+`action` describes **what** happens — today only `trigger_worker`, which starts a worker run with the given scope. `rule` describes **when**: `hourly`, `daily` and `weekly` recur in the tenant's own time zone — an IANA identifier such as `America/Chicago`, resolved across DST transitions — while `once` fires a single time at a UTC instant.
 
-The response's `next_run_at` is the first occurrence strictly after the moment of creation. Create with `enabled: false` to stage a schedule without letting it fire.
+The response's `next_run_at` is the first occurrence strictly after the moment of creation; a rule that resolves to no such occurrence is rejected. Create with `enabled: false` to stage a recurring schedule without letting it fire. A one-off is always enabled: delete it to cancel it, and its `next_run_at` becomes null once it has fired.
 
 Requires the `schedules:write` permission.
  * @summary Create a schedule
@@ -8999,6 +9007,8 @@ declare const useGetSchedule: <TError = ErrorType<ErrorResponse>>(scheduleId: st
 };
 /**
  * Update a schedule's rule, name, or enabled state.
+
+Changing the rule moves `next_run_at` to the first occurrence after the update; a rule that resolves to no such occurrence is rejected. One-off schedules are always enabled — delete one to cancel it before it fires.
  * @summary Update a schedule
  */
 declare const getUpdateScheduleUrl: (scheduleId: string) => string;