@mobilerun/sdk 4.0.0 → 5.2.0

package/src/resources/workflows/flows/actions.ts

@@ -0,0 +1,149 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as FlowsAPI from './flows';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Actions extends APIResource {
+  /**
+   * Return the ordered list of actions attached to a flow, including any nested
+   * child actions. Returns 404 if the flow does not exist.
+   */
+  list(flowID: string, options?: RequestOptions): APIPromise<ActionListResponse> {
+    return this._client.get(path`/flows/${flowID}/actions`, options);
+  }
+
+  /**
+   * Append a single action to a flow at the given `position`, optionally nesting it
+   * under a `parentFlowActionId` or supplying its own `children`. Supports a
+   * `nameOverride`, param `overrides`, and `continueOnError`. Returns 404 if the
+   * flow does not exist.
+   */
+  add(flowID: string, body: ActionAddParams, options?: RequestOptions): APIPromise<ActionAddResponse> {
+    return this._client.post(path`/flows/${flowID}/actions`, { body, ...options });
+  }
+
+  /**
+   * Remove a single action from a flow by its `flowActionId`. Returns 404 if the
+   * flow or flow action does not exist.
+   */
+  remove(
+    flowActionID: string,
+    params: ActionRemoveParams,
+    options?: RequestOptions,
+  ): APIPromise<ActionRemoveResponse> {
+    const { flowId } = params;
+    return this._client.delete(path`/flows/${flowId}/actions/${flowActionID}`, options);
+  }
+
+  /**
+   * Replace a flow's entire action list with the supplied set (at least one
+   * required). Each action references an `actionId` and a unique `position`, and may
+   * include nested `children`, a `nameOverride`, param `overrides`, and a
+   * `continueOnError` flag. Returns 404 if the flow does not exist.
+   */
+  replace(
+    flowID: string,
+    body: ActionReplaceParams,
+    options?: RequestOptions,
+  ): APIPromise<ActionReplaceResponse> {
+    return this._client.put(path`/flows/${flowID}/actions`, { body, ...options });
+  }
+}
+
+export interface FlowAction {
+  id: string;
+
+  actionId: string;
+
+  continueOnError: boolean;
+
+  createdAt: string | null;
+
+  flowId: string;
+
+  nameOverride: string | null;
+
+  overrides: FlowAction.Overrides | null;
+
+  parentFlowActionId: string | null;
+
+  position: number;
+}
+
+export namespace FlowAction {
+  export interface Overrides {
+    params?: { [key: string]: unknown };
+  }
+}
+
+export interface ActionListResponse {
+  data: Array<FlowAction>;
+}
+
+export interface ActionAddResponse {
+  data: FlowAction;
+}
+
+export interface ActionRemoveResponse {
+  message: string;
+}
+
+export interface ActionReplaceResponse {
+  data: Array<FlowAction>;
+}
+
+export interface ActionAddParams {
+  actionId: string;
+
+  position: number;
+
+  children?: Array<FlowsAPI.FlowChildActionInput>;
+
+  continueOnError?: boolean;
+
+  nameOverride?: string;
+
+  overrides?: FlowsAPI.FlowActionOverrides | null;
+
+  parentFlowActionId?: string | null;
+}
+
+export interface ActionRemoveParams {
+  flowId: string;
+}
+
+export interface ActionReplaceParams {
+  actions: Array<ActionReplaceParams.Action>;
+}
+
+export namespace ActionReplaceParams {
+  export interface Action {
+    actionId: string;
+
+    position: number;
+
+    children?: Array<FlowsAPI.FlowChildActionInput>;
+
+    continueOnError?: boolean;
+
+    nameOverride?: string;
+
+    overrides?: FlowsAPI.FlowActionOverrides | null;
+  }
+}
+
+export declare namespace Actions {
+  export {
+    type FlowAction as FlowAction,
+    type ActionListResponse as ActionListResponse,
+    type ActionAddResponse as ActionAddResponse,
+    type ActionRemoveResponse as ActionRemoveResponse,
+    type ActionReplaceResponse as ActionReplaceResponse,
+    type ActionAddParams as ActionAddParams,
+    type ActionRemoveParams as ActionRemoveParams,
+    type ActionReplaceParams as ActionReplaceParams,
+  };
+}

package/src/resources/workflows/flows/flows.ts

@@ -0,0 +1,284 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as FlowsAPI from './flows';
+import * as Shared from '../../shared';
+import * as WorkflowsAPI from '../workflows';
+import * as ActionsAPI from './actions';
+import {
+  ActionAddParams,
+  ActionAddResponse,
+  ActionListResponse,
+  ActionRemoveParams,
+  ActionRemoveResponse,
+  ActionReplaceParams,
+  ActionReplaceResponse,
+  Actions,
+  FlowAction,
+} from './actions';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Flows extends APIResource {
+  actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
+
+  /**
+   * Create a flow that binds a trigger (`triggerId`) to an ordered list of actions,
+   * with at least one action required. Optional settings include target `deviceIds`,
+   * a cooldown (`cooldownSeconds`/`cooldownScope`), and webhook notifications on
+   * success or failure.
+   */
+  create(body: FlowCreateParams, options?: RequestOptions): APIPromise<FlowCreateResponse> {
+    return this._client.post('/flows', { body, ...options });
+  }
+
+  /**
+   * Fetch a single flow by its ID, including its trigger binding, configuration, and
+   * current status. Returns 404 if no flow matches.
+   */
+  retrieve(flowID: string, options?: RequestOptions): APIPromise<FlowRetrieveResponse> {
+    return this._client.get(path`/flows/${flowID}`, options);
+  }
+
+  /**
+   * Partially update a flow's settings — name, trigger binding, enabled state,
+   * target devices, cooldown, or notifications; all fields are optional. Actions are
+   * managed through the flow-actions endpoints, not here. Returns 404 if the flow
+   * does not exist.
+   */
+  update(
+    flowID: string,
+    body: FlowUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FlowUpdateResponse> {
+    return this._client.patch(path`/flows/${flowID}`, { body, ...options });
+  }
+
+  /**
+   * Return a paginated list of flows. Supports filtering by `triggerId`, `enabled`,
+   * one or more health `status` values (healthy, failing, blocked), `mine` (flows
+   * created by the calling actor), `createdBy` (flows created by a given actor id —
+   * mutually exclusive with `mine`), plus free-text `search` and ordering.
+   */
+  list(
+    query: FlowListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FlowListResponse> {
+    return this._client.get('/flows', { query, ...options });
+  }
+
+  /**
+   * Delete a flow by its ID. Returns 404 if no flow matches.
+   */
+  delete(flowID: string, options?: RequestOptions): APIPromise<FlowDeleteResponse> {
+    return this._client.delete(path`/flows/${flowID}`, options);
+  }
+
+  /**
+   * Create a copy of an existing flow, including its actions and settings. The
+   * optional body can override the new flow's `name` and target `deviceIds`. Returns
+   * 404 if the source flow does not exist.
+   */
+  clone(
+    flowID: string,
+    body: FlowCloneParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<FlowCloneResponse> {
+    return this._client.post(path`/flows/${flowID}/clone`, { body, ...options });
+  }
+
+  /**
+   * Clear a flow's blocked status after fixing the underlying issue. Idempotent —
+   * safe to call on already-healthy flows.
+   */
+  unblock(flowID: string, options?: RequestOptions): APIPromise<FlowUnblockResponse> {
+    return this._client.post(path`/flows/${flowID}/unblock`, options);
+  }
+}
+
+export interface FlowActionOverrides {
+  params?: { [key: string]: unknown };
+}
+
+export interface FlowChildActionInput {
+  actionId: string;
+
+  position: number;
+
+  continueOnError?: boolean;
+
+  nameOverride?: string;
+
+  overrides?: FlowActionOverrides | null;
+}
+
+export interface FlowCreateResponse {
+  data: WorkflowsAPI.Flow;
+}
+
+export interface FlowRetrieveResponse {
+  data: WorkflowsAPI.Flow;
+}
+
+export interface FlowUpdateResponse {
+  data: WorkflowsAPI.Flow;
+}
+
+export interface FlowListResponse {
+  items: Array<WorkflowsAPI.Flow>;
+
+  pagination: Shared.Pagination;
+}
+
+export interface FlowDeleteResponse {
+  message: string;
+}
+
+export interface FlowCloneResponse {
+  data: WorkflowsAPI.Flow;
+}
+
+export interface FlowUnblockResponse {
+  data: WorkflowsAPI.Flow;
+}
+
+export interface FlowCreateParams {
+  actions: Array<FlowCreateParams.Action>;
+
+  name: string;
+
+  triggerId: string;
+
+  cooldownScope?: 'flow' | 'device';
+
+  cooldownSeconds?: number | null;
+
+  description?: string;
+
+  deviceIds?: Array<string>;
+
+  enabled?: boolean;
+
+  healthMonitoringEnabled?: boolean;
+
+  notifyOnFailure?: boolean;
+
+  notifyOnSuccess?: boolean;
+
+  notifyWebhookId?: string | null;
+
+  selfHealingEnabled?: boolean;
+
+  selfHealingMaxAttempts?: number;
+}
+
+export namespace FlowCreateParams {
+  export interface Action {
+    actionId: string;
+
+    position: number;
+
+    children?: Array<FlowsAPI.FlowChildActionInput>;
+
+    continueOnError?: boolean;
+
+    nameOverride?: string;
+
+    overrides?: FlowsAPI.FlowActionOverrides | null;
+  }
+}
+
+export interface FlowUpdateParams {
+  cooldownScope?: 'flow' | 'device';
+
+  cooldownSeconds?: number | null;
+
+  description?: string;
+
+  deviceIds?: Array<string>;
+
+  enabled?: boolean;
+
+  healthMonitoringEnabled?: boolean;
+
+  name?: string;
+
+  notifyOnFailure?: boolean;
+
+  notifyOnSuccess?: boolean;
+
+  notifyWebhookId?: string | null;
+
+  selfHealingEnabled?: boolean;
+
+  selfHealingMaxAttempts?: number;
+
+  triggerId?: string;
+}
+
+export interface FlowListParams {
+  createdBy?: string;
+
+  /**
+   * Only include flows with this enabled state.
+   */
+  enabled?: 'true' | 'false';
+
+  /**
+   * Only include flows created by you.
+   */
+  mine?: 'true' | 'false';
+
+  orderBy?: 'name' | 'createdAt' | 'updatedAt';
+
+  orderByDirection?: 'asc' | 'desc';
+
+  page?: number;
+
+  pageSize?: number;
+
+  search?: string;
+
+  status?: Array<'healthy' | 'failing' | 'blocked'>;
+
+  triggerId?: string;
+}
+
+export interface FlowCloneParams {
+  deviceIds?: Array<string>;
+
+  name?: string;
+}
+
+Flows.Actions = Actions;
+
+export declare namespace Flows {
+  export {
+    type FlowActionOverrides as FlowActionOverrides,
+    type FlowChildActionInput as FlowChildActionInput,
+    type FlowCreateResponse as FlowCreateResponse,
+    type FlowRetrieveResponse as FlowRetrieveResponse,
+    type FlowUpdateResponse as FlowUpdateResponse,
+    type FlowListResponse as FlowListResponse,
+    type FlowDeleteResponse as FlowDeleteResponse,
+    type FlowCloneResponse as FlowCloneResponse,
+    type FlowUnblockResponse as FlowUnblockResponse,
+    type FlowCreateParams as FlowCreateParams,
+    type FlowUpdateParams as FlowUpdateParams,
+    type FlowListParams as FlowListParams,
+    type FlowCloneParams as FlowCloneParams,
+  };
+
+  export {
+    Actions as Actions,
+    type FlowAction as FlowAction,
+    type ActionListResponse as ActionListResponse,
+    type ActionAddResponse as ActionAddResponse,
+    type ActionRemoveResponse as ActionRemoveResponse,
+    type ActionReplaceResponse as ActionReplaceResponse,
+    type ActionAddParams as ActionAddParams,
+    type ActionRemoveParams as ActionRemoveParams,
+    type ActionReplaceParams as ActionReplaceParams,
+  };
+}

package/src/resources/workflows/flows/index.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Actions,
+  type FlowAction,
+  type ActionListResponse,
+  type ActionAddResponse,
+  type ActionRemoveResponse,
+  type ActionReplaceResponse,
+  type ActionAddParams,
+  type ActionRemoveParams,
+  type ActionReplaceParams,
+} from './actions';
+export {
+  Flows,
+  type FlowActionOverrides,
+  type FlowChildActionInput,
+  type FlowCreateResponse,
+  type FlowRetrieveResponse,
+  type FlowUpdateResponse,
+  type FlowListResponse,
+  type FlowDeleteResponse,
+  type FlowCloneResponse,
+  type FlowUnblockResponse,
+  type FlowCreateParams,
+  type FlowUpdateParams,
+  type FlowListParams,
+  type FlowCloneParams,
+} from './flows';

package/src/resources/workflows/flows.ts

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

package/src/resources/workflows/index.ts

@@ -0,0 +1,68 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  ActionCatalog,
+  type ActionCatalogEntry,
+  type ActionCatalogRetrieveResponse,
+  type ActionCatalogListResponse,
+  type ActionCatalogListParams,
+} from './action-catalog';
+export {
+  Actions,
+  type Action,
+  type ActionCreateResponse,
+  type ActionRetrieveResponse,
+  type ActionUpdateResponse,
+  type ActionListResponse,
+  type ActionDeleteResponse,
+  type ActionCreateParams,
+  type ActionUpdateParams,
+  type ActionListParams,
+} from './actions/index';
+export {
+  Events,
+  type EventDryRunResponse,
+  type EventIngestResponse,
+  type EventDryRunParams,
+  type EventIngestParams,
+} from './events/index';
+export {
+  Executions,
+  type FlowExecution,
+  type ExecutionRetrieveResponse,
+  type ExecutionListResponse,
+  type ExecutionGetMetricsResponse,
+  type ExecutionListParams,
+  type ExecutionGetMetricsParams,
+} from './executions';
+export {
+  Flows,
+  type FlowActionOverrides,
+  type FlowChildActionInput,
+  type FlowCreateResponse,
+  type FlowRetrieveResponse,
+  type FlowUpdateResponse,
+  type FlowListResponse,
+  type FlowDeleteResponse,
+  type FlowCloneResponse,
+  type FlowUnblockResponse,
+  type FlowCreateParams,
+  type FlowUpdateParams,
+  type FlowListParams,
+  type FlowCloneParams,
+} from './flows/index';
+export { Timezones, type TimezoneListResponse } from './timezones';
+export {
+  Triggers,
+  type TriggerCreateResponse,
+  type TriggerRetrieveResponse,
+  type TriggerUpdateResponse,
+  type TriggerListResponse,
+  type TriggerDeleteResponse,
+  type TriggerFireResponse,
+  type TriggerCreateParams,
+  type TriggerUpdateParams,
+  type TriggerListParams,
+  type TriggerFireParams,
+} from './triggers';
+export { Workflows, type Flow } from './workflows';

package/src/resources/workflows/timezones.ts

@@ -0,0 +1,22 @@
+// 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 { RequestOptions } from '../../internal/request-options';
+
+export class Timezones extends APIResource {
+  /**
+   * List supported IANA timezones
+   */
+  list(options?: RequestOptions): APIPromise<TimezoneListResponse> {
+    return this._client.get('/timezones', options);
+  }
+}
+
+export interface TimezoneListResponse {
+  data: Array<string>;
+}
+
+export declare namespace Timezones {
+  export { type TimezoneListResponse as TimezoneListResponse };
+}