@hookdeck/outpost-sdk 0.0.2

package/src/sdk/destinations.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { destinationsCreate } from "../funcs/destinationsCreate.js";
+import { destinationsDelete } from "../funcs/destinationsDelete.js";
+import { destinationsDisable } from "../funcs/destinationsDisable.js";
+import { destinationsEnable } from "../funcs/destinationsEnable.js";
+import { destinationsGet } from "../funcs/destinationsGet.js";
+import { destinationsList } from "../funcs/destinationsList.js";
+import { destinationsUpdate } from "../funcs/destinationsUpdate.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Destinations extends ClientSDK {
+  /**
+   * List Destinations
+   *
+   * @remarks
+   * Return a list of the destinations for the tenant. The endpoint is not paged.
+   */
+  async list(
+    security: operations.ListTenantDestinationsSecurity,
+    request: operations.ListTenantDestinationsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<components.Destination>> {
+    return unwrapAsync(destinationsList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create Destination
+   *
+   * @remarks
+   * Creates a new destination for the tenant. The request body structure depends on the `type`.
+   */
+  async create(
+    security: operations.CreateTenantDestinationSecurity,
+    request: operations.CreateTenantDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<components.Destination> {
+    return unwrapAsync(destinationsCreate(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Destination
+   *
+   * @remarks
+   * Retrieves details for a specific destination.
+   */
+  async get(
+    security: operations.GetTenantDestinationSecurity,
+    request: operations.GetTenantDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<components.Destination> {
+    return unwrapAsync(destinationsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Update Destination
+   *
+   * @remarks
+   * Updates the configuration of an existing destination. The request body structure depends on the destination's `type`. Type itself cannot be updated. May return an OAuth redirect URL for certain types.
+   */
+  async update(
+    security: operations.UpdateTenantDestinationSecurity,
+    request: operations.UpdateTenantDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<operations.UpdateTenantDestinationResponse> {
+    return unwrapAsync(destinationsUpdate(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete Destination
+   *
+   * @remarks
+   * Deletes a specific destination.
+   */
+  async delete(
+    security: operations.DeleteTenantDestinationSecurity,
+    request: operations.DeleteTenantDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<components.SuccessResponse> {
+    return unwrapAsync(destinationsDelete(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Enable Destination
+   *
+   * @remarks
+   * Enables a previously disabled destination.
+   */
+  async enable(
+    security: operations.EnableTenantDestinationSecurity,
+    request: operations.EnableTenantDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<components.Destination> {
+    return unwrapAsync(destinationsEnable(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Disable Destination
+   *
+   * @remarks
+   * Disables a previously enabled destination.
+   */
+  async disable(
+    security: operations.DisableTenantDestinationSecurity,
+    request: operations.DisableTenantDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<components.Destination> {
+    return unwrapAsync(destinationsDisable(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/events.ts

@@ -0,0 +1,130 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { eventsGet } from "../funcs/eventsGet.js";
+import { eventsGetByDestination } from "../funcs/eventsGetByDestination.js";
+import { eventsList } from "../funcs/eventsList.js";
+import { eventsListByDestination } from "../funcs/eventsListByDestination.js";
+import { eventsListDeliveries } from "../funcs/eventsListDeliveries.js";
+import { eventsRetry } from "../funcs/eventsRetry.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Events extends ClientSDK {
+  /**
+   * List Events
+   *
+   * @remarks
+   * Retrieves a list of events for the tenant, supporting cursor navigation (details TBD) and filtering.
+   */
+  async list(
+    security: operations.ListTenantEventsSecurity,
+    request: operations.ListTenantEventsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<components.Event>> {
+    return unwrapAsync(eventsList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Event
+   *
+   * @remarks
+   * Retrieves details for a specific event.
+   */
+  async get(
+    security: operations.GetTenantEventSecurity,
+    request: operations.GetTenantEventRequest,
+    options?: RequestOptions,
+  ): Promise<components.Event> {
+    return unwrapAsync(eventsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List Event Delivery Attempts
+   *
+   * @remarks
+   * Retrieves a list of delivery attempts for a specific event, including response details.
+   */
+  async listDeliveries(
+    security: operations.ListTenantEventDeliveriesSecurity,
+    request: operations.ListTenantEventDeliveriesRequest,
+    options?: RequestOptions,
+  ): Promise<Array<components.DeliveryAttempt>> {
+    return unwrapAsync(eventsListDeliveries(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List Events by Destination
+   *
+   * @remarks
+   * Retrieves events associated with a specific destination for the tenant.
+   */
+  async listByDestination(
+    security: operations.ListTenantEventsByDestinationSecurity,
+    request: operations.ListTenantEventsByDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<Array<components.Event>> {
+    return unwrapAsync(eventsListByDestination(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Event by Destination
+   *
+   * @remarks
+   * Retrieves a specific event associated with a specific destination for the tenant.
+   */
+  async getByDestination(
+    security: operations.GetTenantEventByDestinationSecurity,
+    request: operations.GetTenantEventByDestinationRequest,
+    options?: RequestOptions,
+  ): Promise<components.Event> {
+    return unwrapAsync(eventsGetByDestination(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Retry Event Delivery
+   *
+   * @remarks
+   * Triggers a retry for a failed event delivery.
+   */
+  async retry(
+    security: operations.RetryTenantEventSecurity,
+    request: operations.RetryTenantEventRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(eventsRetry(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/health.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { healthCheck } from "../funcs/healthCheck.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Health extends ClientSDK {
+  /**
+   * Health Check
+   *
+   * @remarks
+   * Simple health check endpoint.
+   */
+  async check(
+    options?: RequestOptions,
+  ): Promise<string> {
+    return unwrapAsync(healthCheck(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/index.ts

@@ -0,0 +1,5 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./sdk.js";

package/src/sdk/publish.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { publishEvent } from "../funcs/publishEvent.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Publish extends ClientSDK {
+  /**
+   * Publish Event
+   *
+   * @remarks
+   * Publishes an event to the specified topic, potentially routed to a specific destination. Requires Admin API Key.
+   */
+  async event(
+    request: components.PublishRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(publishEvent(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/schemas.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { schemasGet } from "../funcs/schemasGet.js";
+import { schemasGetDestinationTypeJwt } from "../funcs/schemasGetDestinationTypeJwt.js";
+import { schemasListDestinationTypesJwt } from "../funcs/schemasListDestinationTypesJwt.js";
+import { schemasListTenantDestinationTypes } from "../funcs/schemasListTenantDestinationTypes.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Schemas extends ClientSDK {
+  /**
+   * List Destination Type Schemas (for Tenant)
+   *
+   * @remarks
+   * Returns a list of JSON-based input schemas for each available destination type. Requires Admin API Key or Tenant JWT.
+   */
+  async listTenantDestinationTypes(
+    security: operations.ListTenantDestinationTypeSchemasSecurity,
+    request: operations.ListTenantDestinationTypeSchemasRequest,
+    options?: RequestOptions,
+  ): Promise<Array<components.DestinationTypeSchema>> {
+    return unwrapAsync(schemasListTenantDestinationTypes(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Destination Type Schema (for Tenant)
+   *
+   * @remarks
+   * Returns the input schema for a specific destination type. Requires Admin API Key or Tenant JWT.
+   */
+  async get(
+    security: operations.GetTenantDestinationTypeSchemaSecurity,
+    request: operations.GetTenantDestinationTypeSchemaRequest,
+    options?: RequestOptions,
+  ): Promise<components.DestinationTypeSchema> {
+    return unwrapAsync(schemasGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List Destination Type Schemas (JWT Auth)
+   *
+   * @remarks
+   * Returns a list of JSON-based input schemas for each available destination type (infers tenant from JWT).
+   */
+  async listDestinationTypesJwt(
+    security: operations.ListDestinationTypeSchemasJwtSecurity,
+    options?: RequestOptions,
+  ): Promise<Array<components.DestinationTypeSchema>> {
+    return unwrapAsync(schemasListDestinationTypesJwt(
+      this,
+      security,
+      options,
+    ));
+  }
+
+  /**
+   * Get Destination Type Schema (JWT Auth)
+   *
+   * @remarks
+   * Returns the input schema for a specific destination type (infers tenant from JWT).
+   */
+  async getDestinationTypeJwt(
+    security: operations.GetDestinationTypeSchemaJwtSecurity,
+    request: operations.GetDestinationTypeSchemaJwtRequest,
+    options?: RequestOptions,
+  ): Promise<components.DestinationTypeSchema> {
+    return unwrapAsync(schemasGetDestinationTypeJwt(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Destinations } from "./destinations.js";
+import { Events } from "./events.js";
+import { Health } from "./health.js";
+import { Publish } from "./publish.js";
+import { Schemas } from "./schemas.js";
+import { Tenants } from "./tenants.js";
+import { Topics } from "./topics.js";
+
+export class Outpost extends ClientSDK {
+  private _health?: Health;
+  get health(): Health {
+    return (this._health ??= new Health(this._options));
+  }
+
+  private _tenants?: Tenants;
+  get tenants(): Tenants {
+    return (this._tenants ??= new Tenants(this._options));
+  }
+
+  private _destinations?: Destinations;
+  get destinations(): Destinations {
+    return (this._destinations ??= new Destinations(this._options));
+  }
+
+  private _publish?: Publish;
+  get publish(): Publish {
+    return (this._publish ??= new Publish(this._options));
+  }
+
+  private _schemas?: Schemas;
+  get schemas(): Schemas {
+    return (this._schemas ??= new Schemas(this._options));
+  }
+
+  private _topics?: Topics;
+  get topics(): Topics {
+    return (this._topics ??= new Topics(this._options));
+  }
+
+  private _events?: Events;
+  get events(): Events {
+    return (this._events ??= new Events(this._options));
+  }
+}

package/src/sdk/tenants.ts

@@ -0,0 +1,138 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { tenantsDelete } from "../funcs/tenantsDelete.js";
+import { tenantsGet } from "../funcs/tenantsGet.js";
+import { tenantsGetPortalUrl } from "../funcs/tenantsGetPortalUrl.js";
+import { tenantsGetPortalUrlJwtContext } from "../funcs/tenantsGetPortalUrlJwtContext.js";
+import { tenantsGetToken } from "../funcs/tenantsGetToken.js";
+import { tenantsGetTokenJwtContext } from "../funcs/tenantsGetTokenJwtContext.js";
+import { tenantsUpsert } from "../funcs/tenantsUpsert.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Tenants extends ClientSDK {
+  /**
+   * Create or Update Tenant
+   *
+   * @remarks
+   * Idempotently creates or updates a tenant. Required before associating destinations.
+   */
+  async upsert(
+    request: operations.UpsertTenantRequest,
+    options?: RequestOptions,
+  ): Promise<components.Tenant> {
+    return unwrapAsync(tenantsUpsert(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Tenant
+   *
+   * @remarks
+   * Retrieves details for a specific tenant.
+   */
+  async get(
+    security: operations.GetTenantSecurity,
+    request: operations.GetTenantRequest,
+    options?: RequestOptions,
+  ): Promise<components.Tenant> {
+    return unwrapAsync(tenantsGet(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete Tenant
+   *
+   * @remarks
+   * Deletes the tenant and all associated destinations.
+   */
+  async delete(
+    security: operations.DeleteTenantSecurity,
+    request: operations.DeleteTenantRequest,
+    options?: RequestOptions,
+  ): Promise<components.SuccessResponse> {
+    return unwrapAsync(tenantsDelete(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Portal Redirect URL
+   *
+   * @remarks
+   * Returns a redirect URL containing a JWT to authenticate the user with the portal.
+   */
+  async getPortalUrl(
+    request: operations.GetTenantPortalUrlRequest,
+    options?: RequestOptions,
+  ): Promise<components.PortalRedirect> {
+    return unwrapAsync(tenantsGetPortalUrl(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Tenant JWT Token
+   *
+   * @remarks
+   * Returns a JWT token scoped to the tenant for safe browser API calls.
+   */
+  async getToken(
+    request: operations.GetTenantTokenRequest,
+    options?: RequestOptions,
+  ): Promise<components.TenantToken> {
+    return unwrapAsync(tenantsGetToken(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Portal Redirect URL (JWT Auth Context)
+   *
+   * @remarks
+   * Returns a redirect URL containing a JWT to authenticate the user with the portal (infers tenant from JWT). Requires Admin API Key.
+   */
+  async getPortalUrlJwtContext(
+    request: operations.GetPortalUrlJwtContextRequest,
+    options?: RequestOptions,
+  ): Promise<components.PortalRedirect> {
+    return unwrapAsync(tenantsGetPortalUrlJwtContext(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Tenant JWT Token (JWT Auth Context)
+   *
+   * @remarks
+   * Returns a JWT token scoped to the tenant (infers tenant from JWT). Requires Admin API Key.
+   */
+  async getTokenJwtContext(
+    options?: RequestOptions,
+  ): Promise<components.TenantToken> {
+    return unwrapAsync(tenantsGetTokenJwtContext(
+      this,
+      options,
+    ));
+  }
+}

package/src/sdk/topics.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { topicsList } from "../funcs/topicsList.js";
+import { topicsListJwt } from "../funcs/topicsListJwt.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Topics extends ClientSDK {
+  /**
+   * List Available Topics (for Tenant)
+   *
+   * @remarks
+   * Returns a list of available event topics configured in the Outpost instance. Requires Admin API Key or Tenant JWT.
+   */
+  async list(
+    security: operations.ListTenantTopicsSecurity,
+    request: operations.ListTenantTopicsRequest,
+    options?: RequestOptions,
+  ): Promise<Array<string>> {
+    return unwrapAsync(topicsList(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List Available Topics (JWT Auth)
+   *
+   * @remarks
+   * Returns a list of available event topics configured in the Outpost instance (infers tenant from JWT).
+   */
+  async listJwt(
+    security: operations.ListTopicsJwtSecurity,
+    options?: RequestOptions,
+  ): Promise<Array<string>> {
+    return unwrapAsync(topicsListJwt(
+      this,
+      security,
+      options,
+    ));
+  }
+}