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

package/src/react-query/webhooksDeleteWebhookEndpoint.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { webhooksDeleteWebhookEndpoint } from "../funcs/webhooksDeleteWebhookEndpoint.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.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 { unwrapAsync } from "../types/fp.js";
+import { useGreenSecurityContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type WebhooksDeleteWebhookEndpointMutationVariables = {
+  request: operations.DeleteWebhookEndpointRequest;
+  options?: RequestOptions;
+};
+
+export type WebhooksDeleteWebhookEndpointMutationData =
+  components.DeleteApiResponse;
+
+export type WebhooksDeleteWebhookEndpointMutationError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * 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 useWebhooksDeleteWebhookEndpointMutation(
+  options?: MutationHookOptions<
+    WebhooksDeleteWebhookEndpointMutationData,
+    WebhooksDeleteWebhookEndpointMutationError,
+    WebhooksDeleteWebhookEndpointMutationVariables
+  >,
+): UseMutationResult<
+  WebhooksDeleteWebhookEndpointMutationData,
+  WebhooksDeleteWebhookEndpointMutationError,
+  WebhooksDeleteWebhookEndpointMutationVariables
+> {
+  const client = useGreenSecurityContext();
+  return useMutation({
+    ...buildWebhooksDeleteWebhookEndpointMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyWebhooksDeleteWebhookEndpoint(): MutationKey {
+  return ["@greensecurity/javascript-sdk", "webhooks", "deleteWebhookEndpoint"];
+}
+
+export function buildWebhooksDeleteWebhookEndpointMutation(
+  client$: GreenSecurityCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: WebhooksDeleteWebhookEndpointMutationVariables,
+  ) => Promise<WebhooksDeleteWebhookEndpointMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyWebhooksDeleteWebhookEndpoint(),
+    mutationFn: function webhooksDeleteWebhookEndpointMutationFn({
+      request,
+      options,
+    }): Promise<WebhooksDeleteWebhookEndpointMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(webhooksDeleteWebhookEndpoint(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/webhooksGetWebhookEndpoint.ts

@@ -56,7 +56,13 @@ export type WebhooksGetWebhookEndpointQueryError =
  * 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 useWebhooksGetWebhookEndpoint(
   request: operations.GetWebhookEndpointRequest,
@@ -83,7 +89,13 @@ export function useWebhooksGetWebhookEndpoint(
  * 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 useWebhooksGetWebhookEndpointSuspense(
   request: operations.GetWebhookEndpointRequest,

package/src/react-query/webhooksListAllWebhookEndpoints.core.ts

@@ -14,8 +14,20 @@ import { 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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+import { pageIteratorToJSON } from "./_types.js";
 export type WebhooksListAllWebhookEndpointsQueryData =
-  operations.ListAllWebhookEndpointsListAllWebhookEndpointsOk;
+  operations.ListAllWebhookEndpointsResponse;
+
+export type WebhooksListAllWebhookEndpointsInfiniteQueryData = PageIterator<
+  operations.ListAllWebhookEndpointsResponse,
+  { page: number }
+>;
+
+export type WebhooksListAllWebhookEndpointsPageParams = PageIterator<
+  operations.ListAllWebhookEndpointsResponse,
+  { page: number }
+>["~next"];
 
 export function prefetchWebhooksListAllWebhookEndpoints(
   queryClient: QueryClient,
@@ -32,6 +44,25 @@ export function prefetchWebhooksListAllWebhookEndpoints(
   });
 }
 
+export function prefetchWebhooksListAllWebhookEndpointsInfinite(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListAllWebhookEndpointsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchInfiniteQuery({
+    ...buildWebhooksListAllWebhookEndpointsInfiniteQuery(
+      client$,
+      request,
+      options,
+    ),
+    initialPageParam: undefined as WebhooksListAllWebhookEndpointsPageParams,
+    getNextPageParam: (
+      previousPage: WebhooksListAllWebhookEndpointsInfiniteQueryData,
+    ) => previousPage["~next"],
+  });
+}
+
 export function buildWebhooksListAllWebhookEndpointsQuery(
   client$: GreenSecurityCore,
   request: operations.ListAllWebhookEndpointsRequest,
@@ -72,6 +103,60 @@ export function buildWebhooksListAllWebhookEndpointsQuery(
   };
 }
 
+export function buildWebhooksListAllWebhookEndpointsInfiniteQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListAllWebhookEndpointsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext<
+      QueryKey,
+      WebhooksListAllWebhookEndpointsPageParams
+    >,
+  ) => Promise<WebhooksListAllWebhookEndpointsInfiniteQueryData>;
+} {
+  return {
+    queryKey: queryKeyWebhooksListAllWebhookEndpointsInfinite({
+      page: request.page,
+      itemsPerPage: request.itemsPerPage,
+      desc: request.desc,
+      sort: request.sort,
+    }),
+    queryFn: async function webhooksListAllWebhookEndpointsQuery(
+      ctx,
+    ): Promise<WebhooksListAllWebhookEndpointsInfiniteQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      if (!ctx.pageParam) {
+        const pageResult = await unwrapResultIterator(
+          webhooksListAllWebhookEndpoints(
+            client$,
+            request,
+            mergedOptions,
+          ),
+        );
+        return pageIteratorToJSON(pageResult);
+      }
+      const pageResult = await unwrapResultIterator(
+        webhooksListAllWebhookEndpoints(
+          client$,
+          {
+            ...request,
+            page: ctx.pageParam.page,
+          },
+          mergedOptions,
+        ),
+      );
+      return pageIteratorToJSON(pageResult);
+    },
+  };
+}
+
 export function queryKeyWebhooksListAllWebhookEndpoints(
   parameters: {
     page?: number | undefined;
@@ -87,3 +172,20 @@ export function queryKeyWebhooksListAllWebhookEndpoints(
     parameters,
   ];
 }
+
+export function queryKeyWebhooksListAllWebhookEndpointsInfinite(
+  parameters: {
+    page?: number | undefined;
+    itemsPerPage?: number | undefined;
+    desc?: components.Desc | undefined;
+    sort?: string | null | undefined;
+  },
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "webhooks",
+    "listAllWebhookEndpoints",
+    "infinite",
+    parameters,
+  ];
+}

package/src/react-query/webhooksListAllWebhookEndpoints.ts

@@ -3,10 +3,16 @@
  */
 
 import {
+  InfiniteData,
   InvalidateQueryFilters,
   QueryClient,
+  QueryKey,
+  useInfiniteQuery,
+  UseInfiniteQueryResult,
   useQuery,
   UseQueryResult,
+  useSuspenseInfiniteQuery,
+  UseSuspenseInfiniteQueryResult,
   useSuspenseQuery,
   UseSuspenseQueryResult,
 } from "@tanstack/react-query";
@@ -25,20 +31,32 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import * as operations from "../models/operations/index.js";
 import { useGreenSecurityContext } from "./_context.js";
 import {
+  InfiniteQueryHookOptions,
   QueryHookOptions,
+  SuspenseInfiniteQueryHookOptions,
   SuspenseQueryHookOptions,
   TupleToPrefixes,
 } from "./_types.js";
 import {
+  buildWebhooksListAllWebhookEndpointsInfiniteQuery,
   buildWebhooksListAllWebhookEndpointsQuery,
   prefetchWebhooksListAllWebhookEndpoints,
+  prefetchWebhooksListAllWebhookEndpointsInfinite,
   queryKeyWebhooksListAllWebhookEndpoints,
+  queryKeyWebhooksListAllWebhookEndpointsInfinite,
+  WebhooksListAllWebhookEndpointsInfiniteQueryData,
+  WebhooksListAllWebhookEndpointsPageParams,
   WebhooksListAllWebhookEndpointsQueryData,
 } from "./webhooksListAllWebhookEndpoints.core.js";
 export {
+  buildWebhooksListAllWebhookEndpointsInfiniteQuery,
   buildWebhooksListAllWebhookEndpointsQuery,
   prefetchWebhooksListAllWebhookEndpoints,
+  prefetchWebhooksListAllWebhookEndpointsInfinite,
   queryKeyWebhooksListAllWebhookEndpoints,
+  queryKeyWebhooksListAllWebhookEndpointsInfinite,
+  type WebhooksListAllWebhookEndpointsInfiniteQueryData,
+  type WebhooksListAllWebhookEndpointsPageParams,
   type WebhooksListAllWebhookEndpointsQueryData,
 };
 
@@ -57,7 +75,13 @@ export type WebhooksListAllWebhookEndpointsQueryError =
  * 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 useWebhooksListAllWebhookEndpoints(
   request: operations.ListAllWebhookEndpointsRequest,
@@ -84,7 +108,13 @@ export function useWebhooksListAllWebhookEndpoints(
  * 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 useWebhooksListAllWebhookEndpointsSuspense(
   request: operations.ListAllWebhookEndpointsRequest,
@@ -107,6 +137,100 @@ export function useWebhooksListAllWebhookEndpointsSuspense(
   });
 }
 
+/**
+ * List all webhook endpoints
+ *
+ * @remarks
+ * 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 useWebhooksListAllWebhookEndpointsInfinite(
+  request: operations.ListAllWebhookEndpointsRequest,
+  options?: InfiniteQueryHookOptions<
+    WebhooksListAllWebhookEndpointsInfiniteQueryData,
+    WebhooksListAllWebhookEndpointsQueryError
+  >,
+): UseInfiniteQueryResult<
+  InfiniteData<
+    WebhooksListAllWebhookEndpointsInfiniteQueryData,
+    WebhooksListAllWebhookEndpointsPageParams
+  >,
+  WebhooksListAllWebhookEndpointsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useInfiniteQuery<
+    WebhooksListAllWebhookEndpointsInfiniteQueryData,
+    WebhooksListAllWebhookEndpointsQueryError,
+    InfiniteData<
+      WebhooksListAllWebhookEndpointsInfiniteQueryData,
+      WebhooksListAllWebhookEndpointsPageParams
+    >,
+    QueryKey,
+    WebhooksListAllWebhookEndpointsPageParams
+  >({
+    ...buildWebhooksListAllWebhookEndpointsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
+/**
+ * List all webhook endpoints
+ *
+ * @remarks
+ * 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 useWebhooksListAllWebhookEndpointsInfiniteSuspense(
+  request: operations.ListAllWebhookEndpointsRequest,
+  options?: SuspenseInfiniteQueryHookOptions<
+    WebhooksListAllWebhookEndpointsInfiniteQueryData,
+    WebhooksListAllWebhookEndpointsQueryError
+  >,
+): UseSuspenseInfiniteQueryResult<
+  InfiniteData<
+    WebhooksListAllWebhookEndpointsInfiniteQueryData,
+    WebhooksListAllWebhookEndpointsPageParams
+  >,
+  WebhooksListAllWebhookEndpointsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseInfiniteQuery<
+    WebhooksListAllWebhookEndpointsInfiniteQueryData,
+    WebhooksListAllWebhookEndpointsQueryError,
+    InfiniteData<
+      WebhooksListAllWebhookEndpointsInfiniteQueryData,
+      WebhooksListAllWebhookEndpointsPageParams
+    >,
+    QueryKey,
+    WebhooksListAllWebhookEndpointsPageParams
+  >({
+    ...buildWebhooksListAllWebhookEndpointsInfiniteQuery(
+      client,
+      request,
+      options,
+    ),
+    initialPageParam: options?.initialPageParam,
+    getNextPageParam: (previousPage) => previousPage["~next"],
+    ...options,
+  });
+}
+
 export function setWebhooksListAllWebhookEndpointsData(
   client: QueryClient,
   queryKeyBase: [

package/src/react-query/webhooksUpdatesTheWebhookEndpointWithTheGivenId.ts

@@ -51,7 +51,31 @@ export type WebhooksUpdatesTheWebhookEndpointWithTheGivenIdMutationError =
  * Updates the webhook endpoint with the given ID.
  *
  * @remarks
- * Updates the webhook endpoint with the given ID.
+ * Changes the URL, the events, their expansion scopes or the consumers of an endpoint.
+ * Anything you leave out keeps its current value.
+ *
+ * Two properties replace rather than merge: naming any consumer clears the others, and
+ * `subscriptions` replaces every event, so an event you do not list again is dropped along
+ * with its scopes. `expand` on its own, without `subscriptions`, re-scopes the events the
+ * endpoint already receives — each one takes the scopes that name its own entity, so an
+ * endpoint receiving two models can be re-scoped in a single request (send `[]` to clear every
+ * scope). A scope naming an entity the endpoint does not receive applies to nothing and is
+ * rejected. New consumers are re-authorized against your own access, so an endpoint cannot be
+ * pointed at an entity you could not have registered it for in the first place.
+ *
+ * Changing `webhook_url` is reserved to whoever registered the endpoint, and to admins.
+ * Deliveries are filtered by the registering user's access, so a new destination would receive
+ * whatever that access reaches — if you did not register it, register your own instead.
+ *
+ * Changing the URL or the consumers withdraws the deliveries still queued for this endpoint.
+ * Their payloads were serialized for the previous configuration, so they would otherwise
+ * arrive at the new destination describing the old one. Changing only `subscriptions` or
+ * `expand` leaves queued deliveries alone.
+ *
+ * The signing secret cannot be rotated here, and `id`, `signature_algo` and `secrets` are
+ * ignored if you send them back.
+ *
+ * Requires the `webhook` / `edit` permission.
  */
 export function useWebhooksUpdatesTheWebhookEndpointWithTheGivenIdMutation(
   options?: MutationHookOptions<

package/src/sdk/sdk.ts

@@ -2,7 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { validateWebhook } from "../funcs/validateWebhook.js";
 import { ClientSDK } from "../lib/sdks.js";
+import * as webhooks from "../models/webhooks/index.js";
+import { unwrapAsync } from "../types/fp.js";
 import { Alerts } from "./alerts.js";
 import { Companies } from "./companies.js";
 import { DataRequests } from "./datarequests.js";
@@ -112,4 +115,35 @@ export class GreenSecurity extends ClientSDK {
   get lookups(): Lookups {
     return (this._lookups ??= new Lookups(this._options));
   }
+
+  async validateWebhook({
+    request,
+    secret,
+  }: {
+    request: {
+      body: string;
+      headers: Record<string, string> | Headers;
+      url: string;
+      method: string;
+    } | Request;
+    secret: string;
+  }): Promise<
+    | webhooks.SendVendorCreatedRequest
+    | webhooks.SendVendorUpdatedRequest
+    | webhooks.SendVendorDestroyedRequest
+    | webhooks.SendTargetFacilityStatusChangeCreatedRequest
+    | webhooks.SendTargetFacilityStatusChangeUpdatedRequest
+    | webhooks.SendTargetFacilityStatusChangeDestroyedRequest
+    | webhooks.SendVendorScanCreatedRequest
+    | webhooks.SendVendorScanUpdatedRequest
+    | webhooks.SendVendorScanDestroyedRequest
+    | webhooks.SendVisitorCheckinCreatedRequest
+    | webhooks.SendVisitorCheckinUpdatedRequest
+    | webhooks.SendVisitorCheckinDestroyedRequest
+  > {
+    return unwrapAsync(validateWebhook(
+      this,
+      { request, secret },
+    ));
+  }
 }

package/src/sdk/webhooks.ts

@@ -2,6 +2,8 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { webhooksCreateWebhookEndpoint } from "../funcs/webhooksCreateWebhookEndpoint.js";
+import { webhooksDeleteWebhookEndpoint } from "../funcs/webhooksDeleteWebhookEndpoint.js";
 import { webhooksGetWebhookEndpoint } from "../funcs/webhooksGetWebhookEndpoint.js";
 import { webhooksListAllWebhookEndpoints } from "../funcs/webhooksListAllWebhookEndpoints.js";
 import { webhooksUpdatesTheWebhookEndpointWithTheGivenId } from "../funcs/webhooksUpdatesTheWebhookEndpointWithTheGivenId.js";
@@ -9,19 +11,60 @@ 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";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class Webhooks extends ClientSDK {
   /**
    * 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.
    */
   async listAllWebhookEndpoints(
     request: operations.ListAllWebhookEndpointsRequest,
     options?: RequestOptions,
-  ): Promise<operations.ListAllWebhookEndpointsListAllWebhookEndpointsOk> {
-    return unwrapAsync(webhooksListAllWebhookEndpoints(
+  ): Promise<
+    PageIterator<operations.ListAllWebhookEndpointsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(webhooksListAllWebhookEndpoints(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async createWebhookEndpoint(
+    request: components.WebhookEndpointCreate,
+    options?: RequestOptions,
+  ): Promise<components.WebhookEndpoint> {
+    return unwrapAsync(webhooksCreateWebhookEndpoint(
       this,
       request,
       options,
@@ -32,7 +75,13 @@ export class Webhooks extends ClientSDK {
    * 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.
    */
   async getWebhookEndpoint(
     request: operations.GetWebhookEndpointRequest,
@@ -49,7 +98,31 @@ export class Webhooks extends ClientSDK {
    * Updates the webhook endpoint with the given ID.
    *
    * @remarks
-   * Updates the webhook endpoint with the given ID.
+   * Changes the URL, the events, their expansion scopes or the consumers of an endpoint.
+   * Anything you leave out keeps its current value.
+   *
+   * Two properties replace rather than merge: naming any consumer clears the others, and
+   * `subscriptions` replaces every event, so an event you do not list again is dropped along
+   * with its scopes. `expand` on its own, without `subscriptions`, re-scopes the events the
+   * endpoint already receives — each one takes the scopes that name its own entity, so an
+   * endpoint receiving two models can be re-scoped in a single request (send `[]` to clear every
+   * scope). A scope naming an entity the endpoint does not receive applies to nothing and is
+   * rejected. New consumers are re-authorized against your own access, so an endpoint cannot be
+   * pointed at an entity you could not have registered it for in the first place.
+   *
+   * Changing `webhook_url` is reserved to whoever registered the endpoint, and to admins.
+   * Deliveries are filtered by the registering user's access, so a new destination would receive
+   * whatever that access reaches — if you did not register it, register your own instead.
+   *
+   * Changing the URL or the consumers withdraws the deliveries still queued for this endpoint.
+   * Their payloads were serialized for the previous configuration, so they would otherwise
+   * arrive at the new destination describing the old one. Changing only `subscriptions` or
+   * `expand` leaves queued deliveries alone.
+   *
+   * The signing secret cannot be rotated here, and `id`, `signature_algo` and `secrets` are
+   * ignored if you send them back.
+   *
+   * Requires the `webhook` / `edit` permission.
    */
   async updatesTheWebhookEndpointWithTheGivenId(
     request: operations.UpdatesTheWebhookEndpointWithTheGivenIdRequest,
@@ -61,4 +134,27 @@ export class Webhooks extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * 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.
+   */
+  async deleteWebhookEndpoint(
+    request: operations.DeleteWebhookEndpointRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteApiResponse> {
+    return unwrapAsync(webhooksDeleteWebhookEndpoint(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/types/index.ts

@@ -11,3 +11,5 @@ export { createPageIterator } from "./operations.js";
 export * from "./primitives.js";
 export { RFCDate } from "./rfcdate.js";
 export * from "./unrecognized.js";
+export type { WebhookRecipient } from "./webhooks.js";
+export type { WebhookAuthenticationError } from "./webhooks.js";