@mobilerun/sdk 4.0.0 → 5.2.0

package/src/resources/webhooks/webhooks.ts

@@ -0,0 +1,503 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as DeliveriesAPI from './deliveries';
+import {
+  Deliveries,
+  DeliveryListForWebhookParams,
+  DeliveryListForWebhookResponse,
+  DeliveryListParams,
+  DeliveryListResponse,
+  DeliveryRetrieveAttemptsParams,
+  DeliveryRetrieveAttemptsResponse,
+  DeliveryStatsParams,
+  DeliveryStatsResponse,
+} from './deliveries';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Webhooks extends APIResource {
+  deliveries: DeliveriesAPI.Deliveries = new DeliveriesAPI.Deliveries(this._client);
+
+  /**
+   * Creates a webhook subscription with a delivery URL and an optional list of event
+   * types to subscribe to (defaults to all when omitted). The response includes the
+   * generated signing secret, which is returned only once at creation time and
+   * cannot be retrieved later.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.create({
+   *   url: 'https://example.com/webhooks/droidrun',
+   * });
+   * ```
+   */
+  create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse> {
+    return this._client.post('/webhooks', { body, ...options });
+  }
+
+  /**
+   * Returns a single webhook subscription by id, including its URL, subscribed event
+   * types, state, and system-observed delivery health. The signing secret is never
+   * included.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.retrieve(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<WebhookRetrieveResponse> {
+    return this._client.get(path`/webhooks/${id}`, options);
+  }
+
+  /**
+   * Updates a webhook subscription. Any combination of the subscribed event types,
+   * state (ACTIVE or DISABLED), and description may be changed, and at least one
+   * field must be supplied. Setting state to ACTIVE re-enables a subscription that
+   * was auto-blocked after sustained delivery failures.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.update(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  update(
+    id: string,
+    body: WebhookUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WebhookUpdateResponse> {
+    return this._client.patch(path`/webhooks/${id}`, { body, ...options });
+  }
+
+  /**
+   * Returns a paginated list of your webhook subscriptions, optionally filtered by
+   * status (active, failing, blocked, or disabled) and/or by `search` (a
+   * case-insensitive substring match against the URL or description). The response
+   * also includes per-status counts across all of your subscriptions.
+   *
+   * @example
+   * ```ts
+   * const webhooks = await client.webhooks.list();
+   * ```
+   */
+  list(
+    query: WebhookListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WebhookListResponse> {
+    return this._client.get('/webhooks', { query, ...options });
+  }
+
+  /**
+   * Deletes a webhook subscription so it stops receiving deliveries. Returns 204 No
+   * Content on success.
+   *
+   * @example
+   * ```ts
+   * await client.webhooks.delete(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/webhooks/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Returns the catalog of event types that webhook subscriptions can subscribe to,
+   * grouped by source. Use the returned type identifiers as the `eventTypes` values
+   * when creating or updating a webhook.
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhooks.eventTypes();
+   * ```
+   */
+  eventTypes(options?: RequestOptions): APIPromise<WebhookEventTypesResponse> {
+    return this._client.get('/event-types', options);
+  }
+
+  /**
+   * Generates a new signing secret for the webhook subscription and returns it once
+   * in the response. The previous secret is replaced immediately, so any signature
+   * verification on your endpoint must be updated to use the new value.
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhooks.rotateSecret(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  rotateSecret(id: string, options?: RequestOptions): APIPromise<WebhookRotateSecretResponse> {
+    return this._client.post(path`/webhooks/${id}/rotate-secret`, options);
+  }
+
+  /**
+   * Sends a single test payload to the webhook subscription URL to verify
+   * connectivity. The response reports whether the attempt succeeded along with the
+   * returned HTTP status code or error, if any.
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhooks.testDelivery(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   * );
+   * ```
+   */
+  testDelivery(id: string, options?: RequestOptions): APIPromise<WebhookTestDeliveryResponse> {
+    return this._client.post(path`/webhooks/${id}/test`, options);
+  }
+}
+
+export interface WebhookCreateResponse {
+  data: WebhookCreateResponse.Data;
+}
+
+export namespace WebhookCreateResponse {
+  export interface Data {
+    id: string;
+
+    blockedAt: string | null;
+
+    blockedReason: string | null;
+
+    createdAt: string;
+
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
+    description: string | null;
+
+    eventTypes: Array<string>;
+
+    /**
+     * System-observed delivery health. `blocked` endpoints are auto-disabled after
+     * sustained failure; PATCH state=ACTIVE to re-enable.
+     */
+    health: 'healthy' | 'failing' | 'blocked';
+
+    /**
+     * Signing secret — shown only once. Store it now.
+     */
+    secret: string;
+
+    signingEnabled: boolean;
+
+    state: 'ACTIVE' | 'DISABLED' | 'DELETED';
+
+    updatedAt: string;
+
+    url: string;
+  }
+}
+
+export interface WebhookRetrieveResponse {
+  data: WebhookRetrieveResponse.Data;
+}
+
+export namespace WebhookRetrieveResponse {
+  export interface Data {
+    id: string;
+
+    blockedAt: string | null;
+
+    blockedReason: string | null;
+
+    createdAt: string;
+
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
+    description: string | null;
+
+    eventTypes: Array<string>;
+
+    /**
+     * System-observed delivery health. `blocked` endpoints are auto-disabled after
+     * sustained failure; PATCH state=ACTIVE to re-enable.
+     */
+    health: 'healthy' | 'failing' | 'blocked';
+
+    signingEnabled: boolean;
+
+    state: 'ACTIVE' | 'DISABLED' | 'DELETED';
+
+    updatedAt: string;
+
+    url: string;
+  }
+}
+
+export interface WebhookUpdateResponse {
+  data: WebhookUpdateResponse.Data;
+}
+
+export namespace WebhookUpdateResponse {
+  export interface Data {
+    id: string;
+
+    blockedAt: string | null;
+
+    blockedReason: string | null;
+
+    createdAt: string;
+
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
+    description: string | null;
+
+    eventTypes: Array<string>;
+
+    /**
+     * System-observed delivery health. `blocked` endpoints are auto-disabled after
+     * sustained failure; PATCH state=ACTIVE to re-enable.
+     */
+    health: 'healthy' | 'failing' | 'blocked';
+
+    signingEnabled: boolean;
+
+    state: 'ACTIVE' | 'DISABLED' | 'DELETED';
+
+    updatedAt: string;
+
+    url: string;
+  }
+}
+
+export interface WebhookListResponse {
+  counts: WebhookListResponse.Counts;
+
+  items: Array<WebhookListResponse.Item>;
+
+  pagination: Shared.Pagination;
+}
+
+export namespace WebhookListResponse {
+  export interface Counts {
+    active: number;
+
+    blocked: number;
+
+    disabled: number;
+
+    failing: number;
+
+    total: number;
+  }
+
+  export interface Item {
+    id: string;
+
+    blockedAt: string | null;
+
+    blockedReason: string | null;
+
+    createdAt: string;
+
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
+    description: string | null;
+
+    eventTypes: Array<string>;
+
+    /**
+     * System-observed delivery health. `blocked` endpoints are auto-disabled after
+     * sustained failure; PATCH state=ACTIVE to re-enable.
+     */
+    health: 'healthy' | 'failing' | 'blocked';
+
+    signingEnabled: boolean;
+
+    state: 'ACTIVE' | 'DISABLED' | 'DELETED';
+
+    updatedAt: string;
+
+    url: string;
+  }
+}
+
+export interface WebhookEventTypesResponse {
+  data: WebhookEventTypesResponse.Data;
+}
+
+export namespace WebhookEventTypesResponse {
+  export interface Data {
+    schemaVersion: 1;
+
+    sources: Array<Data.Source>;
+  }
+
+  export namespace Data {
+    export interface Source {
+      events: Array<Source.Event>;
+
+      source: string;
+    }
+
+    export namespace Source {
+      export interface Event {
+        description: string;
+
+        surfaces: Event.Surfaces;
+
+        type: string;
+      }
+
+      export namespace Event {
+        export interface Surfaces {
+          feed: boolean;
+
+          toast: boolean;
+
+          webhook: boolean;
+        }
+      }
+    }
+  }
+}
+
+export interface WebhookRotateSecretResponse {
+  data: WebhookRotateSecretResponse.Data;
+}
+
+export namespace WebhookRotateSecretResponse {
+  export interface Data {
+    id: string;
+
+    blockedAt: string | null;
+
+    blockedReason: string | null;
+
+    createdAt: string;
+
+    /**
+     * Id of the actor who created this endpoint. Null when no creator was recorded.
+     */
+    createdBy: string | null;
+
+    description: string | null;
+
+    eventTypes: Array<string>;
+
+    /**
+     * System-observed delivery health. `blocked` endpoints are auto-disabled after
+     * sustained failure; PATCH state=ACTIVE to re-enable.
+     */
+    health: 'healthy' | 'failing' | 'blocked';
+
+    /**
+     * Signing secret — shown only once. Store it now.
+     */
+    secret: string;
+
+    signingEnabled: boolean;
+
+    state: 'ACTIVE' | 'DISABLED' | 'DELETED';
+
+    updatedAt: string;
+
+    url: string;
+  }
+}
+
+export interface WebhookTestDeliveryResponse {
+  data: WebhookTestDeliveryResponse.Data;
+}
+
+export namespace WebhookTestDeliveryResponse {
+  export interface Data {
+    error: string | null;
+
+    statusCode: number | null;
+
+    success: boolean;
+  }
+}
+
+export interface WebhookCreateParams {
+  url: string;
+
+  description?: string;
+
+  eventTypes?: Array<string>;
+}
+
+export interface WebhookUpdateParams {
+  description?: string | null;
+
+  eventTypes?: Array<string>;
+
+  state?: 'ACTIVE' | 'DISABLED';
+}
+
+export interface WebhookListParams {
+  /**
+   * Only include webhooks created by this actor id. Mutually exclusive with `mine`.
+   */
+  createdBy?: string;
+
+  /**
+   * When true, only include webhooks created by you (not just owned by your org).
+   */
+  mine?: 'true' | 'false';
+
+  page?: number;
+
+  pageSize?: number;
+
+  /**
+   * Case-insensitive substring match against the URL or description.
+   */
+  search?: string;
+
+  status?: 'active' | 'failing' | 'blocked' | 'disabled';
+}
+
+Webhooks.Deliveries = Deliveries;
+
+export declare namespace Webhooks {
+  export {
+    type WebhookCreateResponse as WebhookCreateResponse,
+    type WebhookRetrieveResponse as WebhookRetrieveResponse,
+    type WebhookUpdateResponse as WebhookUpdateResponse,
+    type WebhookListResponse as WebhookListResponse,
+    type WebhookEventTypesResponse as WebhookEventTypesResponse,
+    type WebhookRotateSecretResponse as WebhookRotateSecretResponse,
+    type WebhookTestDeliveryResponse as WebhookTestDeliveryResponse,
+    type WebhookCreateParams as WebhookCreateParams,
+    type WebhookUpdateParams as WebhookUpdateParams,
+    type WebhookListParams as WebhookListParams,
+  };
+
+  export {
+    Deliveries as Deliveries,
+    type DeliveryListResponse as DeliveryListResponse,
+    type DeliveryListForWebhookResponse as DeliveryListForWebhookResponse,
+    type DeliveryRetrieveAttemptsResponse as DeliveryRetrieveAttemptsResponse,
+    type DeliveryStatsResponse as DeliveryStatsResponse,
+    type DeliveryListParams as DeliveryListParams,
+    type DeliveryListForWebhookParams as DeliveryListForWebhookParams,
+    type DeliveryRetrieveAttemptsParams as DeliveryRetrieveAttemptsParams,
+    type DeliveryStatsParams as DeliveryStatsParams,
+  };
+}

package/src/resources/webhooks.ts

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

package/src/resources/workflows/action-catalog.ts

@@ -0,0 +1,74 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class ActionCatalog extends APIResource {
+  /**
+   * Fetch a single action catalog entry by its ID, including its service, method,
+   * and parameter schema. Returns 404 if no entry matches.
+   */
+  retrieve(catalogEntryID: string, options?: RequestOptions): APIPromise<ActionCatalogRetrieveResponse> {
+    return this._client.get(path`/action-catalog/${catalogEntryID}`, options);
+  }
+
+  /**
+   * Return a paginated list of catalog entries — the service/method templates that
+   * actions are created from, each carrying its parameter schema. Supports filtering
+   * by `service`.
+   */
+  list(
+    query: ActionCatalogListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ActionCatalogListResponse> {
+    return this._client.get('/action-catalog', { query, ...options });
+  }
+}
+
+export interface ActionCatalogEntry {
+  id: string;
+
+  createdAt: string | null;
+
+  description: string | null;
+
+  method: string;
+
+  name: string;
+
+  service: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
+
+  updatedAt: string | null;
+
+  paramsSchema?: unknown;
+}
+
+export interface ActionCatalogRetrieveResponse {
+  data: ActionCatalogEntry;
+}
+
+export interface ActionCatalogListResponse {
+  items: Array<ActionCatalogEntry>;
+
+  pagination: Shared.Pagination;
+}
+
+export interface ActionCatalogListParams {
+  page?: number;
+
+  pageSize?: number;
+
+  service?: 'tasks_api' | 'devices_api' | 'agents_api' | 'webhooks';
+}
+
+export declare namespace ActionCatalog {
+  export {
+    type ActionCatalogEntry as ActionCatalogEntry,
+    type ActionCatalogRetrieveResponse as ActionCatalogRetrieveResponse,
+    type ActionCatalogListResponse as ActionCatalogListResponse,
+    type ActionCatalogListParams as ActionCatalogListParams,
+  };
+}