@hookdeck/outpost-sdk 0.6.0 → 0.7.0

package/src/funcs/attemptsList.ts

@@ -0,0 +1,187 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { OutpostCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { OutpostError } from "../models/errors/outposterror.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List Attempts (Admin)
+ *
+ * @remarks
+ * Retrieves a paginated list of attempts across all tenants. This is an admin-only endpoint that requires the Admin API Key.
+ *
+ * When `tenant_id` is not provided, returns attempts from all tenants. When `tenant_id` is provided, returns only attempts for that tenant.
+ */
+export function attemptsList(
+  client: OutpostCore,
+  request: operations.AdminListAttemptsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.AttemptPaginatedResult,
+    | errors.APIErrorResponse
+    | OutpostError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: OutpostCore,
+  request: operations.AdminListAttemptsRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.AttemptPaginatedResult,
+      | errors.APIErrorResponse
+      | OutpostError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.AdminListAttemptsRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/attempts")();
+
+  const query = encodeFormQuery({
+    "destination_id": payload.destination_id,
+    "dir": payload.dir,
+    "event_id": payload.event_id,
+    "include": payload.include,
+    "limit": payload.limit,
+    "next": payload.next,
+    "order_by": payload.order_by,
+    "prev": payload.prev,
+    "status": payload.status,
+    "tenant_id": payload.tenant_id,
+    "time[gte]": payload["time[gte]"],
+    "time[lte]": payload["time[lte]"],
+    "topic": payload.topic,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "adminListAttempts",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "422", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.AttemptPaginatedResult,
+    | errors.APIErrorResponse
+    | OutpostError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.AttemptPaginatedResult$inboundSchema),
+    M.jsonErr(422, errors.APIErrorResponse$inboundSchema),
+    M.fail([401, "4XX"]),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/{eventsListDeliveries.ts → attemptsRetry.ts}

@@ -2,9 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod/v3";
 import { OutpostCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeJSON } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -19,26 +18,30 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
 import { OutpostError } from "../models/errors/outposterror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as operations from "../models/operations/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List Event Delivery Attempts
+ * Retry Event Delivery
  *
  * @remarks
- * Retrieves a list of delivery attempts for a specific event, including response details.
+ * Triggers a retry for delivering an event to a destination. The event must exist and the destination must be enabled and match the event's topic.
+ *
+ * When authenticated with a Tenant JWT, only events belonging to that tenant can be retried.
+ * When authenticated with Admin API Key, events from any tenant can be retried.
  */
-export function eventsListDeliveries(
+export function attemptsRetry(
   client: OutpostCore,
-  request: operations.ListTenantEventDeliveriesRequest,
+  request: components.RetryRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    Array<components.DeliveryAttempt>,
+    components.SuccessResponse,
+    | errors.APIErrorResponse
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -58,12 +61,13 @@ export function eventsListDeliveries(
 
 async function $do(
   client: OutpostCore,
-  request: operations.ListTenantEventDeliveriesRequest,
+  request: components.RetryRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      Array<components.DeliveryAttempt>,
+      components.SuccessResponse,
+      | errors.APIErrorResponse
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -78,33 +82,19 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      operations.ListTenantEventDeliveriesRequest$outboundSchema.parse(value),
+    (value) => components.RetryRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = null;
-
-  const pathParams = {
-    event_id: encodeSimple("event_id", payload.event_id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
-  };
+  const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/tenants/{tenant_id}/events/{event_id}/deliveries")(
-    pathParams,
-  );
+  const path = pathToFunc("/retry")();
 
   const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
     Accept: "application/json",
   }));
 
@@ -114,7 +104,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listTenantEventDeliveries",
+    operationID: "retryEvent",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -128,7 +118,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "GET",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -143,7 +133,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["400", "404", "422", "4XX", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -152,8 +142,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    Array<components.DeliveryAttempt>,
+    components.SuccessResponse,
+    | errors.APIErrorResponse
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -163,10 +158,11 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, z.array(components.DeliveryAttempt$inboundSchema)),
-    M.fail([404, "4XX"]),
+    M.json(202, components.SuccessResponse$inboundSchema),
+    M.jsonErr(422, errors.APIErrorResponse$inboundSchema),
+    M.fail([400, 404, "4XX"]),
     M.fail("5XX"),
-  )(response, req);
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/{eventsGetByDestination.ts → destinationsGetAttempt.ts}

@@ -3,7 +3,7 @@
  */
 
 import { OutpostCore } from "../core.js";
-import { encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -26,18 +26,18 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get Event by Destination
+ * Get Destination Attempt
  *
  * @remarks
- * Retrieves a specific event associated with a specific destination for the tenant.
+ * Retrieves details for a specific attempt scoped to a destination.
  */
-export function eventsGetByDestination(
+export function destinationsGetAttempt(
   client: OutpostCore,
-  request: operations.GetTenantEventByDestinationRequest,
+  request: operations.GetTenantDestinationAttemptRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    components.Event,
+    components.Attempt,
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -57,12 +57,12 @@ export function eventsGetByDestination(
 
 async function $do(
   client: OutpostCore,
-  request: operations.GetTenantEventByDestinationRequest,
+  request: operations.GetTenantDestinationAttemptRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      components.Event,
+      components.Attempt,
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -78,7 +78,7 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.GetTenantEventByDestinationRequest$outboundSchema.parse(value),
+      operations.GetTenantDestinationAttemptRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -88,11 +88,11 @@ async function $do(
   const body = null;
 
   const pathParams = {
-    destination_id: encodeSimple("destination_id", payload.destination_id, {
+    attempt_id: encodeSimple("attempt_id", payload.attempt_id, {
       explode: false,
       charEncoding: "percent",
     }),
-    event_id: encodeSimple("event_id", payload.event_id, {
+    destination_id: encodeSimple("destination_id", payload.destination_id, {
       explode: false,
       charEncoding: "percent",
     }),
@@ -104,9 +104,13 @@ async function $do(
   };
 
   const path = pathToFunc(
-    "/tenants/{tenant_id}/destinations/{destination_id}/events/{event_id}",
+    "/tenants/{tenant_id}/destinations/{destination_id}/attempts/{attempt_id}",
   )(pathParams);
 
+  const query = encodeFormQuery({
+    "include": payload.include,
+  });
+
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
@@ -117,7 +121,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getTenantEventByDestination",
+    operationID: "getTenantDestinationAttempt",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -135,6 +139,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
@@ -156,7 +161,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    components.Event,
+    components.Attempt,
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -166,7 +171,7 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.Event$inboundSchema),
+    M.json(200, components.Attempt$inboundSchema),
     M.fail([404, "4XX"]),
     M.fail("5XX"),
   )(response, req);

package/src/funcs/{eventsListByDestination.ts → destinationsListAttempts.ts}

@@ -10,6 +10,7 @@ import { safeParse } from "../lib/schemas.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
 import {
   ConnectionError,
   InvalidRequestError,
@@ -17,6 +18,7 @@ import {
   RequestTimeoutError,
   UnexpectedClientError,
 } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
 import { OutpostError } from "../models/errors/outposterror.js";
 import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
@@ -25,18 +27,19 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * List Events by Destination
+ * List Destination Attempts
  *
  * @remarks
- * Retrieves events associated with a specific destination for the tenant.
+ * Retrieves a paginated list of attempts scoped to a specific destination.
  */
-export function eventsListByDestination(
+export function destinationsListAttempts(
   client: OutpostCore,
-  request: operations.ListTenantEventsByDestinationRequest,
+  request: operations.ListTenantDestinationAttemptsRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.ListTenantEventsByDestinationResponse,
+    components.AttemptPaginatedResult,
+    | errors.APIErrorResponse
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -56,12 +59,13 @@ export function eventsListByDestination(
 
 async function $do(
   client: OutpostCore,
-  request: operations.ListTenantEventsByDestinationRequest,
+  request: operations.ListTenantDestinationAttemptsRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.ListTenantEventsByDestinationResponse,
+      components.AttemptPaginatedResult,
+      | errors.APIErrorResponse
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -77,7 +81,7 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.ListTenantEventsByDestinationRequest$outboundSchema.parse(
+      operations.ListTenantDestinationAttemptsRequest$outboundSchema.parse(
         value,
       ),
     "Input validation failed",
@@ -101,16 +105,21 @@ async function $do(
   };
 
   const path = pathToFunc(
-    "/tenants/{tenant_id}/destinations/{destination_id}/events",
+    "/tenants/{tenant_id}/destinations/{destination_id}/attempts",
   )(pathParams);
 
   const query = encodeFormQuery({
-    "end": payload.end,
+    "dir": payload.dir,
+    "event_id": payload.event_id,
+    "include": payload.include,
     "limit": payload.limit,
     "next": payload.next,
+    "order_by": payload.order_by,
     "prev": payload.prev,
-    "start": payload.start,
     "status": payload.status,
+    "time[gte]": payload["time[gte]"],
+    "time[lte]": payload["time[lte]"],
+    "topic": payload.topic,
   });
 
   const headers = new Headers(compactMap({
@@ -123,7 +132,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "listTenantEventsByDestination",
+    operationID: "listTenantDestinationAttempts",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -153,7 +162,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["404", "422", "4XX", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -162,8 +171,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.ListTenantEventsByDestinationResponse,
+    components.AttemptPaginatedResult,
+    | errors.APIErrorResponse
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -173,10 +187,11 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.ListTenantEventsByDestinationResponse$inboundSchema),
+    M.json(200, components.AttemptPaginatedResult$inboundSchema),
+    M.jsonErr(422, errors.APIErrorResponse$inboundSchema),
     M.fail([404, "4XX"]),
     M.fail("5XX"),
-  )(response, req);
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/eventsGet.ts

@@ -30,10 +30,13 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Retrieves details for a specific event.
+ *
+ * When authenticated with a Tenant JWT, only events belonging to that tenant can be accessed.
+ * When authenticated with Admin API Key, events from any tenant can be accessed.
  */
 export function eventsGet(
   client: OutpostCore,
-  request: operations.GetTenantEventRequest,
+  request: operations.GetEventRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -57,7 +60,7 @@ export function eventsGet(
 
 async function $do(
   client: OutpostCore,
-  request: operations.GetTenantEventRequest,
+  request: operations.GetEventRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -77,7 +80,7 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.GetTenantEventRequest$outboundSchema.parse(value),
+    (value) => operations.GetEventRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -91,14 +94,9 @@ async function $do(
       explode: false,
       charEncoding: "percent",
     }),
-    tenant_id: encodeSimple(
-      "tenant_id",
-      payload.tenant_id ?? client._options.tenantId,
-      { explode: false, charEncoding: "percent" },
-    ),
   };
 
-  const path = pathToFunc("/tenants/{tenant_id}/events/{event_id}")(pathParams);
+  const path = pathToFunc("/events/{event_id}")(pathParams);
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
@@ -110,7 +108,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getTenantEvent",
+    operationID: "getEvent",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,