@hookdeck/outpost-sdk 0.7.0 → 0.9.0

package/src/funcs/eventsGet.ts

@@ -18,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";
@@ -36,11 +37,14 @@ import { Result } from "../types/fp.js";
  */
 export function eventsGet(
   client: OutpostCore,
-  request: operations.GetEventRequest,
+  eventId: string,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     components.Event,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -53,19 +57,22 @@ export function eventsGet(
 > {
   return new APIPromise($do(
     client,
-    request,
+    eventId,
     options,
   ));
 }
 
 async function $do(
   client: OutpostCore,
-  request: operations.GetEventRequest,
+  eventId: string,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
       components.Event,
+      | errors.UnauthorizedError
+      | errors.NotFoundError
+      | errors.InternalServerError
       | OutpostError
       | ResponseValidationError
       | ConnectionError
@@ -78,8 +85,12 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.GetEventRequest = {
+    eventId: eventId,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) => operations.GetEventRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
@@ -102,7 +113,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -113,7 +125,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -137,7 +149,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["404", "4XX", "5XX"],
+    errorCodes: ["401", "404", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -146,8 +158,15 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     components.Event,
+    | errors.UnauthorizedError
+    | errors.NotFoundError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -158,9 +177,12 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.Event$inboundSchema),
-    M.fail([404, "4XX"]),
+    M.jsonErr(401, errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(404, errors.NotFoundError$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$inboundSchema),
+    M.fail("4XX"),
     M.fail("5XX"),
-  )(response, req);
+  )(response, req, { extraFields: responseFields });
   if (!result.ok) {
     return [result, { status: "complete", request: req, response }];
   }

package/src/funcs/eventsList.ts

@@ -3,6 +3,7 @@
  */
 
 import { OutpostCore } from "../core.js";
+import { dlv } from "../lib/dlv.js";
 import { encodeFormQuery } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -10,7 +11,6 @@ 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,
@@ -25,31 +25,42 @@ 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";
+import {
+  createPageIterator,
+  haltIterator,
+  PageIterator,
+  Paginator,
+} from "../types/operations.js";
 
 /**
- * List Events (Admin)
+ * List Events
  *
  * @remarks
- * Retrieves a list of events across all tenants. This is an admin-only endpoint that requires the Admin API Key.
+ * Retrieves a list of events.
  *
- * When `tenant_id` is not provided, returns events from all tenants. When `tenant_id` is provided, returns only events for that tenant.
+ * When authenticated with a Tenant JWT, returns only events belonging to that tenant.
+ * When authenticated with Admin API Key, returns events across all tenants. Use `tenant_id` query parameter to filter by tenant.
  */
 export function eventsList(
   client: OutpostCore,
-  request: operations.AdminListEventsRequest,
+  request: operations.ListEventsRequest,
   options?: RequestOptions,
 ): APIPromise<
-  Result<
-    components.EventPaginatedResult,
-    | errors.APIErrorResponse
-    | OutpostError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+  PageIterator<
+    Result<
+      operations.ListEventsResponse,
+      | errors.UnauthorizedError
+      | errors.InternalServerError
+      | OutpostError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { cursor: string }
   >
 > {
   return new APIPromise($do(
@@ -61,32 +72,36 @@ export function eventsList(
 
 async function $do(
   client: OutpostCore,
-  request: operations.AdminListEventsRequest,
+  request: operations.ListEventsRequest,
   options?: RequestOptions,
 ): Promise<
   [
-    Result<
-      components.EventPaginatedResult,
-      | errors.APIErrorResponse
-      | OutpostError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+    PageIterator<
+      Result<
+        operations.ListEventsResponse,
+        | errors.UnauthorizedError
+        | errors.InternalServerError
+        | OutpostError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { cursor: string }
     >,
     APICall,
   ]
 > {
   const parsed = safeParse(
     request,
-    (value) => operations.AdminListEventsRequest$outboundSchema.parse(value),
+    (value) => operations.ListEventsRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
+    return [haltIterator(parsed), { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -95,12 +110,15 @@ async function $do(
 
   const query = encodeFormQuery({
     "dir": payload.dir,
+    "id": payload.id,
     "limit": payload.limit,
     "next": payload.next,
     "order_by": payload.order_by,
     "prev": payload.prev,
     "tenant_id": payload.tenant_id,
+    "time[gt]": payload["time[gt]"],
     "time[gte]": payload["time[gte]"],
+    "time[lt]": payload["time[lt]"],
     "time[lte]": payload["time[lte]"],
     "topic": payload.topic,
   });
@@ -109,18 +127,19 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "adminListEvents",
+    operationID: "listEvents",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -139,18 +158,18 @@ async function $do(
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
   if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
+    return [haltIterator(requestRes), { status: "invalid" }];
   }
   const req = requestRes.value;
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "422", "4XX", "5XX"],
+    errorCodes: ["401", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req }];
+    return [haltIterator(doResult), { status: "request-error", request: req }];
   }
   const response = doResult.value;
 
@@ -158,9 +177,10 @@ async function $do(
     HttpMeta: { Response: response, Request: req },
   };
 
-  const [result] = await M.match<
-    components.EventPaginatedResult,
-    | errors.APIErrorResponse
+  const [result, raw] = await M.match<
+    operations.ListEventsResponse,
+    | errors.UnauthorizedError
+    | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
     | ConnectionError
@@ -170,14 +190,73 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, components.EventPaginatedResult$inboundSchema),
-    M.jsonErr(422, errors.APIErrorResponse$inboundSchema),
-    M.fail([401, "4XX"]),
+    M.json(200, operations.ListEventsResponse$inboundSchema, { key: "Result" }),
+    M.jsonErr(401, errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(500, errors.InternalServerError$inboundSchema),
+    M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {
-    return [result, { status: "complete", request: req, response }];
+    return [haltIterator(result), {
+      status: "complete",
+      request: req,
+      response,
+    }];
   }
 
-  return [result, { status: "complete", request: req, response }];
+  const nextFunc = (
+    responseData: unknown,
+  ): {
+    next: Paginator<
+      Result<
+        operations.ListEventsResponse,
+        | errors.UnauthorizedError
+        | errors.InternalServerError
+        | OutpostError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { cursor: string };
+  } => {
+    const nextCursor = dlv(responseData, "pagination.next");
+    if (typeof nextCursor !== "string") {
+      return { next: () => null };
+    }
+    if (nextCursor.trim() === "") {
+      return { next: () => null };
+    }
+    const results = dlv(responseData, "models");
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.limit ?? 100;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      eventsList(
+        client,
+        {
+          ...request,
+          next: nextCursor,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { cursor: nextCursor } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
 }

package/src/funcs/publishEvent.ts

@@ -105,7 +105,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -116,7 +117,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -141,7 +142,6 @@ async function $do(
   const doResult = await client._do(req, {
     context,
     errorCodes: [
-      "400",
       "401",
       "403",
       "404",
@@ -199,7 +199,7 @@ async function $do(
   >(
     M.json(202, components.PublishResponse$inboundSchema),
     M.jsonErr(404, errors.NotFoundError$inboundSchema),
-    M.jsonErr([403, 407], errors.UnauthorizedError$inboundSchema),
+    M.jsonErr([401, 403, 407], errors.UnauthorizedError$inboundSchema),
     M.jsonErr(408, errors.TimeoutError$inboundSchema),
     M.jsonErr(429, errors.RateLimitedError$inboundSchema),
     M.jsonErr([413, 414, 415, 422, 431], errors.BadRequestError$inboundSchema),
@@ -211,7 +211,7 @@ async function $do(
     ),
     M.jsonErr(510, errors.BadRequestError$inboundSchema),
     M.jsonErr(511, errors.UnauthorizedError$inboundSchema),
-    M.fail([400, 401, 409, "4XX"]),
+    M.fail([409, "4XX"]),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {

package/src/funcs/{schemasGetDestinationTypeJwt.ts → schemasGetDestinationType.ts}

@@ -32,18 +32,18 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Returns the input schema for a specific destination type.
  */
-export function schemasGetDestinationTypeJwt(
+export function schemasGetDestinationType(
   client: OutpostCore,
-  request: operations.GetDestinationTypeSchemaRequest,
+  type: operations.GetDestinationTypeSchemaType,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     components.DestinationTypeSchema,
+    | errors.NotFoundError
     | errors.UnauthorizedError
     | errors.TimeoutError
     | errors.RateLimitedError
     | errors.BadRequestError
-    | errors.NotFoundError
     | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
@@ -57,24 +57,24 @@ export function schemasGetDestinationTypeJwt(
 > {
   return new APIPromise($do(
     client,
-    request,
+    type,
     options,
   ));
 }
 
 async function $do(
   client: OutpostCore,
-  request: operations.GetDestinationTypeSchemaRequest,
+  type: operations.GetDestinationTypeSchemaType,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
       components.DestinationTypeSchema,
+      | errors.NotFoundError
       | errors.UnauthorizedError
       | errors.TimeoutError
       | errors.RateLimitedError
       | errors.BadRequestError
-      | errors.NotFoundError
       | errors.InternalServerError
       | OutpostError
       | ResponseValidationError
@@ -88,8 +88,12 @@ async function $do(
     APICall,
   ]
 > {
+  const input: operations.GetDestinationTypeSchemaRequest = {
+    type: type,
+  };
+
   const parsed = safeParse(
-    request,
+    input,
     (value) =>
       operations.GetDestinationTypeSchemaRequest$outboundSchema.parse(value),
     "Input validation failed",
@@ -113,7 +117,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -124,7 +129,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -189,11 +194,11 @@ async function $do(
 
   const [result] = await M.match<
     components.DestinationTypeSchema,
+    | errors.NotFoundError
     | errors.UnauthorizedError
     | errors.TimeoutError
     | errors.RateLimitedError
     | errors.BadRequestError
-    | errors.NotFoundError
     | errors.InternalServerError
     | OutpostError
     | ResponseValidationError
@@ -205,7 +210,8 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.DestinationTypeSchema$inboundSchema),
-    M.jsonErr([403, 407], errors.UnauthorizedError$inboundSchema),
+    M.jsonErr(404, errors.NotFoundError$inboundSchema),
+    M.jsonErr([401, 403, 407], errors.UnauthorizedError$inboundSchema),
     M.jsonErr(408, errors.TimeoutError$inboundSchema),
     M.jsonErr(429, errors.RateLimitedError$inboundSchema),
     M.jsonErr(
@@ -220,7 +226,7 @@ async function $do(
     ),
     M.jsonErr(510, errors.BadRequestError$inboundSchema),
     M.jsonErr(511, errors.UnauthorizedError$inboundSchema),
-    M.fail([401, 404, "4XX"]),
+    M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {

package/src/funcs/{schemasListDestinationTypesJwt.ts → schemasListDestinationTypes.ts}

@@ -30,7 +30,7 @@ import { Result } from "../types/fp.js";
  * @remarks
  * Returns a list of JSON-based input schemas for each available destination type.
  */
-export function schemasListDestinationTypesJwt(
+export function schemasListDestinationTypes(
   client: OutpostCore,
   options?: RequestOptions,
 ): APIPromise<
@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -100,7 +101,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiKey,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -181,7 +182,7 @@ async function $do(
   >(
     M.json(200, z.array(components.DestinationTypeSchema$inboundSchema)),
     M.jsonErr(404, errors.NotFoundError$inboundSchema),
-    M.jsonErr([403, 407], errors.UnauthorizedError$inboundSchema),
+    M.jsonErr([401, 403, 407], errors.UnauthorizedError$inboundSchema),
     M.jsonErr(408, errors.TimeoutError$inboundSchema),
     M.jsonErr(429, errors.RateLimitedError$inboundSchema),
     M.jsonErr(
@@ -196,7 +197,7 @@ async function $do(
     ),
     M.jsonErr(510, errors.BadRequestError$inboundSchema),
     M.jsonErr(511, errors.UnauthorizedError$inboundSchema),
-    M.fail([401, "4XX"]),
+    M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });
   if (!result.ok) {