@scenario-labs/sdk 3.1.0 → 3.3.0

package/src/resources/projects/webhook-endpoints/events.ts

@@ -0,0 +1,179 @@
+// 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';
+import { path } from '../../../internal/utils/path';
+import { omitUndefined } from '../../../internal/utils/values';
+
+export class Events extends APIResource {
+  /**
+   * Retrieve one delivery event of one of the project's webhook endpoints
+   */
+  retrieve(
+    eventID: string,
+    params: EventRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<EventRetrieveResponse> {
+    const { projectId, webhookEndpointId } = params;
+    return this._client.get(
+      path`/projects/${projectId}/webhook-endpoints/${webhookEndpointId}/events/${eventID}`,
+      options,
+    );
+  }
+
+  /**
+   * List the project's webhook events
+   */
+  list(
+    webhookEndpointID: string,
+    params: EventListParams,
+    options?: RequestOptions,
+  ): APIPromise<EventListResponse> {
+    const { projectId, ...query } = params;
+    return this._client.get(path`/projects/${projectId}/webhook-endpoints/${webhookEndpointID}/events`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
+  }
+}
+
+export interface EventRetrieveResponse {
+  webhookEvent: EventRetrieveResponse.WebhookEvent;
+}
+
+export namespace EventRetrieveResponse {
+  export interface WebhookEvent {
+    id: string;
+
+    attempts: Array<WebhookEvent.Attempt>;
+
+    createdAt: string;
+
+    endpointId: string;
+
+    payload: unknown;
+
+    sentAt: string;
+
+    status: 'created' | 'failed' | 'retrying' | 'success';
+
+    /**
+     * Every event a webhook endpoint can subscribe to: a project endpoint takes the
+     * job lifecycle events, a team endpoint takes the alert events.
+     */
+    type:
+      | '*'
+      | 'asset.download.completed'
+      | 'asset.download.created'
+      | 'asset.download.failed'
+      | 'generation.completed'
+      | 'generation.created'
+      | 'generation.failed'
+      | 'inference.cancelled'
+      | 'inference.completed'
+      | 'inference.created'
+      | 'inference.failed'
+      | 'model.download.completed'
+      | 'model.download.created'
+      | 'model.download.failed'
+      | 'model.training.cancelled'
+      | 'model.training.completed'
+      | 'model.training.failed'
+      | 'model.training.started'
+      | 'team.credit.threshold.crossed';
+
+    updatedAt: string;
+  }
+
+  export namespace WebhookEvent {
+    export interface Attempt {
+      responseStatusCode: number;
+
+      sentAt: string;
+    }
+  }
+}
+
+export interface EventListResponse {
+  /**
+   * A list of the project webhook events
+   */
+  items: Array<EventListResponse.Item>;
+
+  /**
+   * A token to query the next page of events
+   */
+  nextPaginationToken?: string;
+}
+
+export namespace EventListResponse {
+  export interface Item {
+    id: string;
+
+    endpointId: string;
+
+    status: 'created' | 'failed' | 'retrying' | 'success';
+
+    /**
+     * Every event a webhook endpoint can subscribe to: a project endpoint takes the
+     * job lifecycle events, a team endpoint takes the alert events.
+     */
+    type:
+      | '*'
+      | 'asset.download.completed'
+      | 'asset.download.created'
+      | 'asset.download.failed'
+      | 'generation.completed'
+      | 'generation.created'
+      | 'generation.failed'
+      | 'inference.cancelled'
+      | 'inference.completed'
+      | 'inference.created'
+      | 'inference.failed'
+      | 'model.download.completed'
+      | 'model.download.created'
+      | 'model.download.failed'
+      | 'model.training.cancelled'
+      | 'model.training.completed'
+      | 'model.training.failed'
+      | 'model.training.started'
+      | 'team.credit.threshold.crossed';
+
+    updatedAt: string;
+  }
+}
+
+export interface EventRetrieveParams {
+  /**
+   * The project Id
+   */
+  projectId: string;
+
+  /**
+   * The webhook endpoint that delivered the event
+   */
+  webhookEndpointId: string;
+}
+
+export interface EventListParams {
+  /**
+   * Path param: The project Id
+   */
+  projectId: string;
+
+  /**
+   * Query param: A token you received in a previous request to query the next page
+   * of items
+   */
+  paginationToken?: string;
+}
+
+export declare namespace Events {
+  export {
+    type EventRetrieveResponse as EventRetrieveResponse,
+    type EventListResponse as EventListResponse,
+    type EventRetrieveParams as EventRetrieveParams,
+    type EventListParams as EventListParams,
+  };
+}

package/src/resources/projects/webhook-endpoints/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Events,
+  type EventRetrieveResponse,
+  type EventListResponse,
+  type EventRetrieveParams,
+  type EventListParams,
+} from './events';
+export {
+  WebhookEndpoints,
+  type WebhookEndpointCreateResponse,
+  type WebhookEndpointUpdateResponse,
+  type WebhookEndpointListResponse,
+  type WebhookEndpointDeleteResponse,
+  type WebhookEndpointCreateParams,
+  type WebhookEndpointUpdateParams,
+  type WebhookEndpointDeleteParams,
+} from './webhook-endpoints';

package/src/resources/projects/webhook-endpoints/webhook-endpoints.ts

@@ -0,0 +1,452 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as EventsAPI from './events';
+import {
+  EventListParams,
+  EventListResponse,
+  EventRetrieveParams,
+  EventRetrieveResponse,
+  Events,
+} from './events';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class WebhookEndpoints extends APIResource {
+  events: EventsAPI.Events = new EventsAPI.Events(this._client);
+
+  /**
+   * Register a new webhook endpoint for the project
+   */
+  create(
+    projectID: string,
+    body: WebhookEndpointCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<WebhookEndpointCreateResponse> {
+    return this._client.post(path`/projects/${projectID}/webhook-endpoints`, { body, ...options });
+  }
+
+  /**
+   * Update a particular webhook endpoint for a project
+   */
+  update(
+    webhookEndpointID: string,
+    params: WebhookEndpointUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<WebhookEndpointUpdateResponse> {
+    const { projectId, ...body } = params;
+    return this._client.put(path`/projects/${projectId}/webhook-endpoints/${webhookEndpointID}`, {
+      body,
+      ...options,
+    });
+  }
+
+  /**
+   * List the project's webhook endpoints
+   */
+  list(projectID: string, options?: RequestOptions): APIPromise<WebhookEndpointListResponse> {
+    return this._client.get(path`/projects/${projectID}/webhook-endpoints`, options);
+  }
+
+  /**
+   * Delete a particular webhook endpoint by its Id
+   */
+  delete(
+    webhookEndpointID: string,
+    params: WebhookEndpointDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<unknown> {
+    const { projectId } = params;
+    return this._client.delete(path`/projects/${projectId}/webhook-endpoints/${webhookEndpointID}`, options);
+  }
+}
+
+export interface WebhookEndpointCreateResponse {
+  /**
+   * The creation response, and the only one that carries the secret: it is generated
+   * once and never returned again, so a client that loses it has to recreate the
+   * endpoint.
+   */
+  webhookEndpoint: WebhookEndpointCreateResponse.WebhookEndpoint;
+}
+
+export namespace WebhookEndpointCreateResponse {
+  /**
+   * The creation response, and the only one that carries the secret: it is generated
+   * once and never returned again, so a client that loses it has to recreate the
+   * endpoint.
+   */
+  export interface WebhookEndpoint {
+    /**
+     * The ID of the webhook endpoint
+     */
+    id: string;
+
+    /**
+     * The date and time the webhook endpoint was created
+     */
+    createdAt: string;
+
+    /**
+     * Whether the webhook is enabled
+     */
+    enabled: boolean;
+
+    /**
+     * The events that trigger the webhook. ['*'] indicates that all events are enabled
+     */
+    enabledEvents: Array<
+      | '*'
+      | 'asset.download.completed'
+      | 'asset.download.created'
+      | 'asset.download.failed'
+      | 'generation.completed'
+      | 'generation.created'
+      | 'generation.failed'
+      | 'inference.cancelled'
+      | 'inference.completed'
+      | 'inference.created'
+      | 'inference.failed'
+      | 'model.download.completed'
+      | 'model.download.created'
+      | 'model.download.failed'
+      | 'model.training.cancelled'
+      | 'model.training.completed'
+      | 'model.training.failed'
+      | 'model.training.started'
+      | 'team.credit.threshold.crossed'
+    >;
+
+    /**
+     * The number of calls to the webhook endpoint that have failed
+     */
+    nbFailedCalls: number;
+
+    /**
+     * The number of calls to the webhook endpoint
+     */
+    nbTotalCalls: number;
+
+    /**
+     * The ID of the owner of the webhook endpoint: a project id for job lifecycle
+     * events, a team id for alert events
+     */
+    ownerId: string;
+
+    /**
+     * Whether the owner is a project or a team. Required to tell them apart: a project
+     * created before the team/project split shares its team's id
+     */
+    ownerType: 'project' | 'team';
+
+    /**
+     * The endpoint's secret, used to generate webhook signatures
+     */
+    secret: string;
+
+    /**
+     * The date and time the webhook endpoint was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The URL of the webhook endpoint
+     */
+    url: string;
+
+    /**
+     * A description of the webhook endpoint
+     */
+    description?: string;
+  }
+}
+
+export interface WebhookEndpointUpdateResponse {
+  webhookEndpoint: WebhookEndpointUpdateResponse.WebhookEndpoint;
+}
+
+export namespace WebhookEndpointUpdateResponse {
+  export interface WebhookEndpoint {
+    /**
+     * The ID of the webhook endpoint
+     */
+    id: string;
+
+    /**
+     * The date and time the webhook endpoint was created
+     */
+    createdAt: string;
+
+    /**
+     * Whether the webhook is enabled
+     */
+    enabled: boolean;
+
+    /**
+     * The events that trigger the webhook. ['*'] indicates that all events are enabled
+     */
+    enabledEvents: Array<
+      | '*'
+      | 'asset.download.completed'
+      | 'asset.download.created'
+      | 'asset.download.failed'
+      | 'generation.completed'
+      | 'generation.created'
+      | 'generation.failed'
+      | 'inference.cancelled'
+      | 'inference.completed'
+      | 'inference.created'
+      | 'inference.failed'
+      | 'model.download.completed'
+      | 'model.download.created'
+      | 'model.download.failed'
+      | 'model.training.cancelled'
+      | 'model.training.completed'
+      | 'model.training.failed'
+      | 'model.training.started'
+      | 'team.credit.threshold.crossed'
+    >;
+
+    /**
+     * The number of calls to the webhook endpoint that have failed
+     */
+    nbFailedCalls: number;
+
+    /**
+     * The number of calls to the webhook endpoint
+     */
+    nbTotalCalls: number;
+
+    /**
+     * The ID of the owner of the webhook endpoint: a project id for job lifecycle
+     * events, a team id for alert events
+     */
+    ownerId: string;
+
+    /**
+     * Whether the owner is a project or a team. Required to tell them apart: a project
+     * created before the team/project split shares its team's id
+     */
+    ownerType: 'project' | 'team';
+
+    /**
+     * The date and time the webhook endpoint was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The URL of the webhook endpoint
+     */
+    url: string;
+
+    /**
+     * A description of the webhook endpoint
+     */
+    description?: string;
+  }
+}
+
+export interface WebhookEndpointListResponse {
+  /**
+   * A list of the project webhooks
+   */
+  webhookEndpoints: Array<WebhookEndpointListResponse.WebhookEndpoint>;
+}
+
+export namespace WebhookEndpointListResponse {
+  export interface WebhookEndpoint {
+    /**
+     * The ID of the webhook endpoint
+     */
+    id: string;
+
+    /**
+     * The date and time the webhook endpoint was created
+     */
+    createdAt: string;
+
+    /**
+     * Whether the webhook is enabled
+     */
+    enabled: boolean;
+
+    /**
+     * The events that trigger the webhook. ['*'] indicates that all events are enabled
+     */
+    enabledEvents: Array<
+      | '*'
+      | 'asset.download.completed'
+      | 'asset.download.created'
+      | 'asset.download.failed'
+      | 'generation.completed'
+      | 'generation.created'
+      | 'generation.failed'
+      | 'inference.cancelled'
+      | 'inference.completed'
+      | 'inference.created'
+      | 'inference.failed'
+      | 'model.download.completed'
+      | 'model.download.created'
+      | 'model.download.failed'
+      | 'model.training.cancelled'
+      | 'model.training.completed'
+      | 'model.training.failed'
+      | 'model.training.started'
+      | 'team.credit.threshold.crossed'
+    >;
+
+    /**
+     * The number of calls to the webhook endpoint that have failed
+     */
+    nbFailedCalls: number;
+
+    /**
+     * The number of calls to the webhook endpoint
+     */
+    nbTotalCalls: number;
+
+    /**
+     * The ID of the owner of the webhook endpoint: a project id for job lifecycle
+     * events, a team id for alert events
+     */
+    ownerId: string;
+
+    /**
+     * Whether the owner is a project or a team. Required to tell them apart: a project
+     * created before the team/project split shares its team's id
+     */
+    ownerType: 'project' | 'team';
+
+    /**
+     * The date and time the webhook endpoint was updated
+     */
+    updatedAt: string;
+
+    /**
+     * The URL of the webhook endpoint
+     */
+    url: string;
+
+    /**
+     * A description of the webhook endpoint
+     */
+    description?: string;
+  }
+}
+
+export type WebhookEndpointDeleteResponse = unknown;
+
+export interface WebhookEndpointCreateParams {
+  /**
+   * The events that trigger the webhook. ['*'] indicates that all events are enabled
+   */
+  enabledEvents: Array<
+    | '*'
+    | 'asset.download.completed'
+    | 'asset.download.created'
+    | 'asset.download.failed'
+    | 'generation.completed'
+    | 'generation.created'
+    | 'generation.failed'
+    | 'inference.cancelled'
+    | 'inference.completed'
+    | 'inference.created'
+    | 'inference.failed'
+    | 'model.download.completed'
+    | 'model.download.created'
+    | 'model.download.failed'
+    | 'model.training.cancelled'
+    | 'model.training.completed'
+    | 'model.training.failed'
+    | 'model.training.started'
+    | 'team.credit.threshold.crossed'
+  >;
+
+  /**
+   * The URL of the webhook endpoint. Must be an absolute http(s) URL
+   */
+  url: string;
+
+  /**
+   * A description of the webhook endpoint
+   */
+  description?: string;
+}
+
+export interface WebhookEndpointUpdateParams {
+  /**
+   * Path param: The project Id
+   */
+  projectId: string;
+
+  /**
+   * Body param: A description of the webhook endpoint
+   */
+  description?: string;
+
+  /**
+   * Body param: Whether the webhook is enabled
+   */
+  enabled?: boolean;
+
+  /**
+   * Body param: The events that trigger the webhook. ['*'] indicates that all events
+   * are enabled
+   */
+  enabledEvents?: Array<
+    | '*'
+    | 'asset.download.completed'
+    | 'asset.download.created'
+    | 'asset.download.failed'
+    | 'generation.completed'
+    | 'generation.created'
+    | 'generation.failed'
+    | 'inference.cancelled'
+    | 'inference.completed'
+    | 'inference.created'
+    | 'inference.failed'
+    | 'model.download.completed'
+    | 'model.download.created'
+    | 'model.download.failed'
+    | 'model.training.cancelled'
+    | 'model.training.completed'
+    | 'model.training.failed'
+    | 'model.training.started'
+    | 'team.credit.threshold.crossed'
+  >;
+
+  /**
+   * Body param: The URL of the webhook endpoint. Must be an absolute http(s) URL
+   */
+  url?: string;
+}
+
+export interface WebhookEndpointDeleteParams {
+  /**
+   * The project Id
+   */
+  projectId: string;
+}
+
+WebhookEndpoints.Events = Events;
+
+export declare namespace WebhookEndpoints {
+  export {
+    type WebhookEndpointCreateResponse as WebhookEndpointCreateResponse,
+    type WebhookEndpointUpdateResponse as WebhookEndpointUpdateResponse,
+    type WebhookEndpointListResponse as WebhookEndpointListResponse,
+    type WebhookEndpointDeleteResponse as WebhookEndpointDeleteResponse,
+    type WebhookEndpointCreateParams as WebhookEndpointCreateParams,
+    type WebhookEndpointUpdateParams as WebhookEndpointUpdateParams,
+    type WebhookEndpointDeleteParams as WebhookEndpointDeleteParams,
+  };
+
+  export {
+    Events as Events,
+    type EventRetrieveResponse as EventRetrieveResponse,
+    type EventListResponse as EventListResponse,
+    type EventRetrieveParams as EventRetrieveParams,
+    type EventListParams as EventListParams,
+  };
+}

package/src/resources/projects/webhook-endpoints.ts

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

package/src/resources/projects.ts

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