@greensecurity/javascript-sdk 0.45.0-beta.9 → 0.46.0-beta.1

package/src/models/webhooks/sendfullreportdestroyed.ts

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SendFullReportDestroyedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportDestroyedRequest$inboundSchema: z.ZodType<
+  SendFullReportDestroyedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportDestroyedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportDestroyedRequest$outboundSchema: z.ZodType<
+  SendFullReportDestroyedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportDestroyedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportDestroyedRequestToJSON(
+  sendFullReportDestroyedRequest: SendFullReportDestroyedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportDestroyedRequest$outboundSchema.parse(
+      sendFullReportDestroyedRequest,
+    ),
+  );
+}
+export function sendFullReportDestroyedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportDestroyedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportDestroyedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportDestroyedRequest' from JSON`,
+  );
+}

package/src/models/webhooks/sendfullreportupdated.ts

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SendFullReportUpdatedRequest = {
+  /**
+   * `t=<unix seconds>,v1=<hex hmac>`, one `v1` per active secret. Each is
+   *
+   * @remarks
+   * `HMAC-SHA256(secret, "<t>.<raw body>")`. Compare with a constant-time function and
+   * reject a timestamp that is not recent.
+   */
+  greenSecuritySignature: string;
+  /**
+   * The event this delivery belongs to. Route on it when one URL serves several events.
+   */
+  greenSecurityEvent: string;
+  /**
+   * Stable per delivery, including across retries. Key your de-duplication on it.
+   */
+  greenSecurityIdempotencyKey: string;
+  /**
+   * The entity in the body.
+   */
+  greenWebhookId: string;
+  fullReport: components.FullReport;
+};
+
+/** @internal */
+export const SendFullReportUpdatedRequest$inboundSchema: z.ZodType<
+  SendFullReportUpdatedRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  "Green-Security-Signature": types.string(),
+  "Green-Security-Event": types.string(),
+  "Green-Security-Idempotency-Key": types.string(),
+  "Green-Webhook-Id": types.string(),
+  FullReport: components.FullReport$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Green-Security-Signature": "greenSecuritySignature",
+    "Green-Security-Event": "greenSecurityEvent",
+    "Green-Security-Idempotency-Key": "greenSecurityIdempotencyKey",
+    "Green-Webhook-Id": "greenWebhookId",
+    "FullReport": "fullReport",
+  });
+});
+/** @internal */
+export type SendFullReportUpdatedRequest$Outbound = {
+  "Green-Security-Signature": string;
+  "Green-Security-Event": string;
+  "Green-Security-Idempotency-Key": string;
+  "Green-Webhook-Id": string;
+  FullReport: components.FullReport$Outbound;
+};
+
+/** @internal */
+export const SendFullReportUpdatedRequest$outboundSchema: z.ZodType<
+  SendFullReportUpdatedRequest$Outbound,
+  z.ZodTypeDef,
+  SendFullReportUpdatedRequest
+> = z.object({
+  greenSecuritySignature: z.string(),
+  greenSecurityEvent: z.string(),
+  greenSecurityIdempotencyKey: z.string(),
+  greenWebhookId: z.string(),
+  fullReport: components.FullReport$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    greenSecuritySignature: "Green-Security-Signature",
+    greenSecurityEvent: "Green-Security-Event",
+    greenSecurityIdempotencyKey: "Green-Security-Idempotency-Key",
+    greenWebhookId: "Green-Webhook-Id",
+    fullReport: "FullReport",
+  });
+});
+
+export function sendFullReportUpdatedRequestToJSON(
+  sendFullReportUpdatedRequest: SendFullReportUpdatedRequest,
+): string {
+  return JSON.stringify(
+    SendFullReportUpdatedRequest$outboundSchema.parse(
+      sendFullReportUpdatedRequest,
+    ),
+  );
+}
+export function sendFullReportUpdatedRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SendFullReportUpdatedRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SendFullReportUpdatedRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SendFullReportUpdatedRequest' from JSON`,
+  );
+}

package/src/react-query/alertsListAlerts.ts

@@ -76,6 +76,8 @@ export type AlertsListAlertsQueryError =
  *
  * @remarks
  * List alerts for user.
+ *
+ * **Permissions.** Requires the `alerts.view` permission.
  */
 export function useAlertsListAlerts(
   request: operations.ListAlertsRequest,
@@ -100,6 +102,8 @@ export function useAlertsListAlerts(
  *
  * @remarks
  * List alerts for user.
+ *
+ * **Permissions.** Requires the `alerts.view` permission.
  */
 export function useAlertsListAlertsSuspense(
   request: operations.ListAlertsRequest,
@@ -127,6 +131,8 @@ export function useAlertsListAlertsSuspense(
  *
  * @remarks
  * List alerts for user.
+ *
+ * **Permissions.** Requires the `alerts.view` permission.
  */
 export function useAlertsListAlertsInfinite(
   request: operations.ListAlertsRequest,
@@ -162,6 +168,8 @@ export function useAlertsListAlertsInfinite(
  *
  * @remarks
  * List alerts for user.
+ *
+ * **Permissions.** Requires the `alerts.view` permission.
  */
 export function useAlertsListAlertsInfiniteSuspense(
   request: operations.ListAlertsRequest,

package/src/react-query/alertsUpdateUserAlerts.ts

@@ -51,6 +51,8 @@ export type AlertsUpdateUserAlertsMutationError =
  *
  * @remarks
  * Update user alerts
+ *
+ * **Permissions.** Requires the `alerts.edit` permission.
  */
 export function useAlertsUpdateUserAlertsMutation(
   options?: MutationHookOptions<

package/src/react-query/companiesAddCompanyManager.ts

@@ -54,6 +54,8 @@ export type CompaniesAddCompanyManagerMutationError =
  * A welcome email is sent to the new manager with login instructions.
  * Requires `company_managers` add permission. Company managers can add to their
  * own company; API users can add to companies in their marketplace app scope.
+ *
+ * **Permissions.** Requires the `company_managers.add` permission.
  */
 export function useCompaniesAddCompanyManagerMutation(
   options?: MutationHookOptions<

package/src/react-query/companiesGetCompany.ts

@@ -59,10 +59,14 @@ export type CompaniesGetCompanyQueryError =
  * @remarks
  * Get company details.
  *
+ * **Permissions.** Requires the `companies.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * company.location
- * company.vendor_type_restrictions
+ * - `company.location`
+ * - `company.vendor_type_restrictions`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesGetCompany(
   request: operations.GetCompanyRequest,
@@ -88,10 +92,14 @@ export function useCompaniesGetCompany(
  * @remarks
  * Get company details.
  *
+ * **Permissions.** Requires the `companies.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * company.location
- * company.vendor_type_restrictions
+ * - `company.location`
+ * - `company.vendor_type_restrictions`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesGetCompanySuspense(
   request: operations.GetCompanyRequest,

package/src/react-query/companiesListCompanyCredentials.ts

@@ -76,6 +76,14 @@ export type CompaniesListCompanyCredentialsQueryError =
  *
  * @remarks
  * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission. Callers who also hold `vendor_credentials.add` and can update the company trigger a recalculation of the required-credential set; everyone else reads the last computed set.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `vendor_credential.systems`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCredentials(
   request: operations.ListCompanyCredentialsRequest,
@@ -103,6 +111,14 @@ export function useCompaniesListCompanyCredentials(
  *
  * @remarks
  * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission. Callers who also hold `vendor_credentials.add` and can update the company trigger a recalculation of the required-credential set; everyone else reads the last computed set.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `vendor_credential.systems`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCredentialsSuspense(
   request: operations.ListCompanyCredentialsRequest,
@@ -130,6 +146,14 @@ export function useCompaniesListCompanyCredentialsSuspense(
  *
  * @remarks
  * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission. Callers who also hold `vendor_credentials.add` and can update the company trigger a recalculation of the required-credential set; everyone else reads the last computed set.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `vendor_credential.systems`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCredentialsInfinite(
   request: operations.ListCompanyCredentialsRequest,
@@ -171,6 +195,14 @@ export function useCompaniesListCompanyCredentialsInfinite(
  *
  * @remarks
  * Lists credentials required for the specified company, based on CompanyRequiredCredentials.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission. Callers who also hold `vendor_credentials.add` and can update the company trigger a recalculation of the required-credential set; everyone else reads the last computed set.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `vendor_credential.systems`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCredentialsInfiniteSuspense(
   request: operations.ListCompanyCredentialsRequest,

package/src/react-query/companiesListCompanyCredits.ts

@@ -76,6 +76,16 @@ export type CompaniesListCompanyCreditsQueryError =
  *
  * @remarks
  * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ *
+ * **Permissions.** Requires the `company_credits.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `entity`
+ * - `from_entity`
+ * - `to_entity`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCredits(
   request: operations.ListCompanyCreditsRequest,
@@ -103,6 +113,16 @@ export function useCompaniesListCompanyCredits(
  *
  * @remarks
  * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ *
+ * **Permissions.** Requires the `company_credits.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `entity`
+ * - `from_entity`
+ * - `to_entity`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCreditsSuspense(
   request: operations.ListCompanyCreditsRequest,
@@ -130,6 +150,16 @@ export function useCompaniesListCompanyCreditsSuspense(
  *
  * @remarks
  * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ *
+ * **Permissions.** Requires the `company_credits.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `entity`
+ * - `from_entity`
+ * - `to_entity`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCreditsInfinite(
   request: operations.ListCompanyCreditsRequest,
@@ -171,6 +201,16 @@ export function useCompaniesListCompanyCreditsInfinite(
  *
  * @remarks
  * Returns a paginated list of credits associated with the specified company, including incoming and outgoing transactions.
+ *
+ * **Permissions.** Requires the `company_credits.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `entity`
+ * - `from_entity`
+ * - `to_entity`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListCompanyCreditsInfiniteSuspense(
   request: operations.ListCompanyCreditsRequest,

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

@@ -0,0 +1,78 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GreenSecurityCore } from "../core.js";
+import { companiesListCompanyManagerContacts } from "../funcs/companiesListCompanyManagerContacts.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type CompaniesListCompanyManagerContactsQueryData =
+  operations.ListCompanyManagerContactsListCompanyManagerContactsOk;
+
+export function prefetchCompaniesListCompanyManagerContacts(
+  queryClient: QueryClient,
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildCompaniesListCompanyManagerContactsQuery(
+      client$,
+      request,
+      options,
+    ),
+  });
+}
+
+export function buildCompaniesListCompanyManagerContactsQuery(
+  client$: GreenSecurityCore,
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<CompaniesListCompanyManagerContactsQueryData>;
+} {
+  return {
+    queryKey: queryKeyCompaniesListCompanyManagerContacts(request.companyId),
+    queryFn: async function companiesListCompanyManagerContactsQueryFn(
+      ctx,
+    ): Promise<CompaniesListCompanyManagerContactsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(companiesListCompanyManagerContacts(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyCompaniesListCompanyManagerContacts(
+  companyId: number,
+): QueryKey {
+  return [
+    "@greensecurity/javascript-sdk",
+    "companies",
+    "listCompanyManagerContacts",
+    companyId,
+  ];
+}

package/src/react-query/companiesListCompanyManagerContacts.ts

@@ -0,0 +1,156 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+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 { useGreenSecurityContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildCompaniesListCompanyManagerContactsQuery,
+  CompaniesListCompanyManagerContactsQueryData,
+  prefetchCompaniesListCompanyManagerContacts,
+  queryKeyCompaniesListCompanyManagerContacts,
+} from "./companiesListCompanyManagerContacts.core.js";
+export {
+  buildCompaniesListCompanyManagerContactsQuery,
+  type CompaniesListCompanyManagerContactsQueryData,
+  prefetchCompaniesListCompanyManagerContacts,
+  queryKeyCompaniesListCompanyManagerContacts,
+};
+
+export type CompaniesListCompanyManagerContactsQueryError =
+  | errors.ApiErrorResponse
+  | GreenSecurityError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List the contact details of a company's managers
+ *
+ * @remarks
+ * Deprecated in favor of `/lookups/company_managers`, which returns the same list. Kept so app builds released before the move keep working.
+ * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission - the caller's role and their relationship to the record decide what is returned.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export function useCompaniesListCompanyManagerContacts(
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: QueryHookOptions<
+    CompaniesListCompanyManagerContactsQueryData,
+    CompaniesListCompanyManagerContactsQueryError
+  >,
+): UseQueryResult<
+  CompaniesListCompanyManagerContactsQueryData,
+  CompaniesListCompanyManagerContactsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useQuery({
+    ...buildCompaniesListCompanyManagerContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List the contact details of a company's managers
+ *
+ * @remarks
+ * Deprecated in favor of `/lookups/company_managers`, which returns the same list. Kept so app builds released before the move keep working.
+ * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission - the caller's role and their relationship to the record decide what is returned.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export function useCompaniesListCompanyManagerContactsSuspense(
+  request: operations.ListCompanyManagerContactsRequest,
+  options?: SuspenseQueryHookOptions<
+    CompaniesListCompanyManagerContactsQueryData,
+    CompaniesListCompanyManagerContactsQueryError
+  >,
+): UseSuspenseQueryResult<
+  CompaniesListCompanyManagerContactsQueryData,
+  CompaniesListCompanyManagerContactsQueryError
+> {
+  const client = useGreenSecurityContext();
+  return useSuspenseQuery({
+    ...buildCompaniesListCompanyManagerContactsQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setCompaniesListCompanyManagerContactsData(
+  client: QueryClient,
+  queryKeyBase: [companyId: number],
+  data: CompaniesListCompanyManagerContactsQueryData,
+): CompaniesListCompanyManagerContactsQueryData | undefined {
+  const key = queryKeyCompaniesListCompanyManagerContacts(...queryKeyBase);
+
+  return client.setQueryData<CompaniesListCompanyManagerContactsQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateCompaniesListCompanyManagerContacts(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[companyId: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyManagerContacts",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllCompaniesListCompanyManagerContacts(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@greensecurity/javascript-sdk",
+      "companies",
+      "listCompanyManagerContacts",
+    ],
+  });
+}

package/src/react-query/companiesListCompanyManagers.ts

@@ -76,6 +76,8 @@ export type CompaniesListCompanyManagersQueryError =
  *
  * @remarks
  * List or search company managers.
+ *
+ * **Permissions.** Requires the `company_managers.view` permission.
  */
 export function useCompaniesListCompanyManagers(
   request: operations.ListCompanyManagersRequest,
@@ -103,6 +105,8 @@ export function useCompaniesListCompanyManagers(
  *
  * @remarks
  * List or search company managers.
+ *
+ * **Permissions.** Requires the `company_managers.view` permission.
  */
 export function useCompaniesListCompanyManagersSuspense(
   request: operations.ListCompanyManagersRequest,
@@ -130,6 +134,8 @@ export function useCompaniesListCompanyManagersSuspense(
  *
  * @remarks
  * List or search company managers.
+ *
+ * **Permissions.** Requires the `company_managers.view` permission.
  */
 export function useCompaniesListCompanyManagersInfinite(
   request: operations.ListCompanyManagersRequest,
@@ -171,6 +177,8 @@ export function useCompaniesListCompanyManagersInfinite(
  *
  * @remarks
  * List or search company managers.
+ *
+ * **Permissions.** Requires the `company_managers.view` permission.
  */
 export function useCompaniesListCompanyManagersInfiniteSuspense(
   request: operations.ListCompanyManagersRequest,