@greensecurity/javascript-sdk 0.44.0-beta.55 → 0.44.0-beta.57

package/src/funcs/validateWebhook.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as webhooks from "../models/webhooks/index.js";
+import { ERR, Result } from "../types/fp.js";
+import { WebhookAuthenticationError } from "../types/webhooks.js";
+
+export async function validateWebhook(client: GreenSecurityCore, {
+  request: rawRequest,
+  secret,
+}: {
+  request: {
+    body: BodyInit;
+    method: string;
+    url: string;
+    headers: Record<string, string> | Headers;
+  } | Request;
+  secret: string;
+}): Promise<
+  Result<
+    | webhooks.SendVendorCreatedRequest
+    | webhooks.SendVendorUpdatedRequest
+    | webhooks.SendVendorDestroyedRequest
+    | webhooks.SendTargetFacilityStatusChangeCreatedRequest
+    | webhooks.SendTargetFacilityStatusChangeUpdatedRequest
+    | webhooks.SendTargetFacilityStatusChangeDestroyedRequest
+    | webhooks.SendVendorScanCreatedRequest
+    | webhooks.SendVendorScanUpdatedRequest
+    | webhooks.SendVendorScanDestroyedRequest
+    | webhooks.SendVisitorCheckinCreatedRequest
+    | webhooks.SendVisitorCheckinUpdatedRequest
+    | webhooks.SendVisitorCheckinDestroyedRequest,
+    SDKValidationError | WebhookAuthenticationError
+  >
+> {
+  const request = normalizeRequest(rawRequest);
+  const verifyResult = await client._verifyWebhook({ request, secret });
+  if (!verifyResult.ok) {
+    return verifyResult;
+  }
+  const jsonString = await request.text();
+  const knownSchemas = [
+    webhooks.sendVendorCreatedRequestFromJSON,
+    webhooks.sendVendorUpdatedRequestFromJSON,
+    webhooks.sendVendorDestroyedRequestFromJSON,
+    webhooks.sendTargetFacilityStatusChangeCreatedRequestFromJSON,
+    webhooks.sendTargetFacilityStatusChangeUpdatedRequestFromJSON,
+    webhooks.sendTargetFacilityStatusChangeDestroyedRequestFromJSON,
+    webhooks.sendVendorScanCreatedRequestFromJSON,
+    webhooks.sendVendorScanUpdatedRequestFromJSON,
+    webhooks.sendVendorScanDestroyedRequestFromJSON,
+    webhooks.sendVisitorCheckinCreatedRequestFromJSON,
+    webhooks.sendVisitorCheckinUpdatedRequestFromJSON,
+    webhooks.sendVisitorCheckinDestroyedRequestFromJSON,
+  ];
+
+  for (const schema of knownSchemas) {
+    const ret = schema(jsonString);
+    if (ret.ok) {
+      return ret;
+    }
+  }
+
+  return ERR(
+    new SDKValidationError(
+      "No matching schema found for the given webhook payload",
+      jsonString,
+      jsonString,
+    ),
+  );
+}
+
+function normalizeRequest(
+  request: {
+    body: BodyInit;
+    method: string;
+    url: string;
+    headers: Record<string, string> | Headers;
+  } | Request,
+): Request {
+  if (request instanceof Request) {
+    return request;
+  }
+  return new Request(request.url, request);
+}

package/src/funcs/webhooksCreateWebhookEndpoint.ts

@@ -0,0 +1,185 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Register a webhook endpoint
+ *
+ * @remarks
+ * Registers a URL to receive one or more events, and returns the endpoint together with its
+ * signing secret. **The secret is only ever returned by this call** — store it before you
+ * move on, it cannot be read back afterwards.
+ *
+ * `subscriptions` takes event names, objects naming a `model`, an `action` and their own
+ * `expands`, or a mix of the two. Only the pair of URL and event has to be unique, so the
+ * events may be split over as many endpoints as you like, sharing a URL or not, as long as
+ * no URL hears the same event twice. A receiver taking several events on one path routes on
+ * the `Green-Security-Event` header.
+ *
+ * `consumers` decides which entities you hear about and is validated against your own
+ * access: naming a facility, system, company or user you cannot reach is rejected with a
+ * `401`. Omit it and the endpoint is scoped to your own entity — for administrators and
+ * site-wide marketplace app installations, to every event of the site.
+ *
+ * Requires the `webhook` / `add` permission.
+ */
+export function webhooksCreateWebhookEndpoint(
+  client: GreenSecurityCore,
+  request: components.WebhookEndpointCreate,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.WebhookEndpoint,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: components.WebhookEndpointCreate,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.WebhookEndpoint,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.WebhookEndpointCreate$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/webhooks")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: "createWebhookEndpoint",
+    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: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.WebhookEndpoint,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, components.WebhookEndpoint$inboundSchema),
+    M.jsonErr([400, 401, 403, 422], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "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/webhooksDeleteWebhookEndpoint.ts

@@ -0,0 +1,183 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GreenSecurityCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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 { GreenSecurityError } from "../models/errors/greensecurityerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.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";
+
+/**
+ * Deletes the webhook endpoint with the given ID.
+ *
+ * @remarks
+ * Stops the deliveries and removes the endpoint together with its delivery history.
+ *
+ * Endpoints are also removed on your behalf when the marketplace app installation they were
+ * registered under is narrowed or uninstalled, so an integration never keeps receiving
+ * events for entities it lost access to.
+ *
+ * Requires the `webhook` / `delete` permission.
+ */
+export function webhooksDeleteWebhookEndpoint(
+  client: GreenSecurityCore,
+  request: operations.DeleteWebhookEndpointRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.DeleteApiResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GreenSecurityCore,
+  request: operations.DeleteWebhookEndpointRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.DeleteApiResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.DeleteWebhookEndpointRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/webhooks/{id}")(pathParams);
+
+  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: "deleteWebhookEndpoint",
+    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: "DELETE",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.DeleteApiResponse,
+    | errors.ApiErrorResponse
+    | GreenSecurityError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.DeleteApiResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 404, 422], errors.ApiErrorResponse$inboundSchema),
+    M.fail("4XX"),
+    M.fail([500, "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/webhooksGetWebhookEndpoint.ts

@@ -31,7 +31,13 @@ import { Result } from "../types/fp.js";
  * Retrieves the webhook endpoint with the given ID.
  *
  * @remarks
- * Returns the definition of a webhook endpoint by ID.
+ * Returns the definition of a webhook endpoint by ID. `secrets` is not included: the signing
+ * secret is only returned by `POST /webhooks`.
+ *
+ * An endpoint you cannot see is reported as `404`, so an ID belonging to somebody else is
+ * indistinguishable from one that does not exist.
+ *
+ * Requires the `webhook` / `view` permission.
  */
 export function webhooksGetWebhookEndpoint(
   client: GreenSecurityCore,
@@ -164,7 +170,7 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, components.WebhookEndpoint$inboundSchema),
-    M.jsonErr([400, 401, 403, 404], errors.ApiErrorResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 404, 422], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "5XX"]),
   )(response, req, { extraFields: responseFields });

package/src/funcs/webhooksListAllWebhookEndpoints.ts

@@ -25,29 +25,44 @@ 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 all webhook endpoints
  *
  * @remarks
- * Returns a list of your webhook endpoints.
+ * Returns the webhook endpoints you can see: the ones you registered, plus the ones scoped
+ * to an entity you belong to. `secrets` is never included here, it is only returned once by
+ * `POST /webhooks`.
+ *
+ * Sortable by `id`, `webhook_url`, `created_at` and `updated_at`.
+ *
+ * Requires the `webhook` / `view` permission.
  */
 export function webhooksListAllWebhookEndpoints(
   client: GreenSecurityCore,
   request: operations.ListAllWebhookEndpointsRequest,
   options?: RequestOptions,
 ): APIPromise<
-  Result<
-    operations.ListAllWebhookEndpointsListAllWebhookEndpointsOk,
-    | errors.ApiErrorResponse
-    | GreenSecurityError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+  PageIterator<
+    Result<
+      operations.ListAllWebhookEndpointsResponse,
+      | errors.ApiErrorResponse
+      | GreenSecurityError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    { page: number }
   >
 > {
   return new APIPromise($do(
@@ -63,17 +78,20 @@ async function $do(
   options?: RequestOptions,
 ): Promise<
   [
-    Result<
-      operations.ListAllWebhookEndpointsListAllWebhookEndpointsOk,
-      | errors.ApiErrorResponse
-      | GreenSecurityError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+    PageIterator<
+      Result<
+        operations.ListAllWebhookEndpointsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >,
+      { page: number }
     >,
     APICall,
   ]
@@ -85,7 +103,7 @@ async function $do(
     "Input validation failed",
   );
   if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
+    return [haltIterator(parsed), { status: "invalid" }];
   }
   const payload = parsed.value;
   const body = null;
@@ -133,7 +151,7 @@ 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;
 
@@ -145,7 +163,7 @@ async function $do(
     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;
 
@@ -153,8 +171,8 @@ async function $do(
     HttpMeta: { Response: response, Request: req },
   };
 
-  const [result] = await M.match<
-    operations.ListAllWebhookEndpointsListAllWebhookEndpointsOk,
+  const [result, raw] = await M.match<
+    operations.ListAllWebhookEndpointsResponse,
     | errors.ApiErrorResponse
     | GreenSecurityError
     | ResponseValidationError
@@ -165,17 +183,72 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(
-      200,
-      operations.ListAllWebhookEndpointsListAllWebhookEndpointsOk$inboundSchema,
-    ),
-    M.jsonErr([400, 401, 403], errors.ApiErrorResponse$inboundSchema),
+    M.json(200, operations.ListAllWebhookEndpointsResponse$inboundSchema, {
+      key: "Result",
+    }),
+    M.jsonErr([400, 401, 403, 422], errors.ApiErrorResponse$inboundSchema),
     M.fail("4XX"),
     M.fail([500, "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.ListAllWebhookEndpointsResponse,
+        | errors.ApiErrorResponse
+        | GreenSecurityError
+        | ResponseValidationError
+        | ConnectionError
+        | RequestAbortedError
+        | RequestTimeoutError
+        | InvalidRequestError
+        | UnexpectedClientError
+        | SDKValidationError
+      >
+    >;
+    "~next"?: { page: number };
+  } => {
+    const page = request?.page ?? 1;
+    const nextPage = page + 1;
+
+    if (!responseData) {
+      return { next: () => null };
+    }
+    const results = (responseData as { items: unknown }).items;
+    if (!Array.isArray(results) || !results.length) {
+      return { next: () => null };
+    }
+    const limit = request?.itemsPerPage ?? 0;
+    if (results.length < limit) {
+      return { next: () => null };
+    }
+
+    const nextVal = () =>
+      webhooksListAllWebhookEndpoints(
+        client,
+        {
+          ...request,
+          page: nextPage,
+        },
+        options,
+      );
+
+    return { next: nextVal, "~next": { page: nextPage } };
+  };
+
+  const page = { ...result, ...nextFunc(raw) };
+  return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, {
+    status: "complete",
+    request: req,
+    response,
+  }];
 }