@greensecurity/javascript-sdk 0.45.0 → 0.46.0-beta.2

package/src/models/operations/listorsearchfacilities.ts

@@ -22,6 +22,17 @@ export const Targeted = {
  */
 export type Targeted = ClosedEnum<typeof Targeted>;
 
+/**
+ * Narrow the listing to facilities that are selectable for a given product. `credentialing` restricts the response to facilities in the caller's own site that use credentialing and are publicly listed — exactly the facilities `POST /api/vendors` accepts as a `primary_facility_id`, so a picker built on this endpoint cannot offer a facility that the create call would then reject.
+ */
+export const Use = {
+  Credentialing: "credentialing",
+} as const;
+/**
+ * Narrow the listing to facilities that are selectable for a given product. `credentialing` restricts the response to facilities in the caller's own site that use credentialing and are publicly listed — exactly the facilities `POST /api/vendors` accepts as a `primary_facility_id`, so a picker built on this endpoint cannot offer a facility that the create call would then reject.
+ */
+export type Use = ClosedEnum<typeof Use>;
+
 export type ListOrSearchFacilitiesRequest = {
   /**
    * A comma-separated list of object attributes to sort on.
@@ -75,6 +86,10 @@ export type ListOrSearchFacilitiesRequest = {
    * For Company Manager callers, filter facilities by whether the manager's company has already targeted them via a `CompanyTargetFacility` link. Only `false` is accepted — restricts the response to same-site facilities the company has not yet targeted (useful when discovering candidate facilities the company could newly target). The facilities a company already targets are available from `GET /api/companies/{company_id}/target-facilities`. Ignored for non-Company-Manager callers.
    */
   targeted?: Targeted | undefined;
+  /**
+   * Narrow the listing to facilities that are selectable for a given product. `credentialing` restricts the response to facilities in the caller's own site that use credentialing and are publicly listed — exactly the facilities `POST /api/vendors` accepts as a `primary_facility_id`, so a picker built on this endpoint cannot offer a facility that the create call would then reject.
+   */
+  use?: Use | undefined;
 };
 
 /**
@@ -96,6 +111,11 @@ export type ListOrSearchFacilitiesResponse = {
 export const Targeted$outboundSchema: z.ZodNativeEnum<typeof Targeted> = z
   .nativeEnum(Targeted);
 
+/** @internal */
+export const Use$outboundSchema: z.ZodNativeEnum<typeof Use> = z.nativeEnum(
+  Use,
+);
+
 /** @internal */
 export type ListOrSearchFacilitiesRequest$Outbound = {
   sort?: string | null | undefined;
@@ -110,6 +130,7 @@ export type ListOrSearchFacilitiesRequest$Outbound = {
   latitude?: number | undefined;
   longitude?: number | undefined;
   targeted?: string | undefined;
+  use?: string | undefined;
 };
 
 /** @internal */
@@ -130,6 +151,7 @@ export const ListOrSearchFacilitiesRequest$outboundSchema: z.ZodType<
   latitude: z.number().optional(),
   longitude: z.number().optional(),
   targeted: Targeted$outboundSchema.optional(),
+  use: Use$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",

package/src/models/operations/listorsearchvendorinvitees.ts

@@ -35,6 +35,21 @@ export type ListOrSearchVendorInviteesRequest = {
    * Search for objects by the search string
    */
   search?: string | undefined;
+  /**
+   * The vendor whose invitable directory to search. Required when the caller is not itself a
+   *
+   * @remarks
+   * vendor; it is resolved through the caller's own access scope, so it can only name a vendor
+   * the caller may already read. Ignored for a vendor caller, which always searches its own.
+   */
+  vendorId?: number | undefined;
+  /**
+   * Narrows the search to one of the vendor's approved, calendaring-enabled target facilities.
+   *
+   * @remarks
+   * A facility the vendor does not target yields no results rather than widening the search.
+   */
+  facilityId?: number | undefined;
 };
 
 /**
@@ -60,6 +75,8 @@ export type ListOrSearchVendorInviteesRequest$Outbound = {
   items_per_page?: number | undefined;
   expand?: Array<string> | undefined;
   search?: string | undefined;
+  vendor_id?: number | undefined;
+  facility_id?: number | undefined;
 };
 
 /** @internal */
@@ -74,9 +91,13 @@ export const ListOrSearchVendorInviteesRequest$outboundSchema: z.ZodType<
   itemsPerPage: z.number().int().optional(),
   expand: z.array(components.Expand$outboundSchema).optional(),
   search: z.string().optional(),
+  vendorId: z.number().int().optional(),
+  facilityId: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
     itemsPerPage: "items_per_page",
+    vendorId: "vendor_id",
+    facilityId: "facility_id",
   });
 });
 

package/src/models/operations/listpendinginvitations.ts

@@ -6,7 +6,6 @@ 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";
 
@@ -61,7 +60,7 @@ export type ListPendingInvitationsListPendingInvitationsOk = {
    * Pagination information for a pageable list
    */
   pager: components.Pager;
-  items: Array<components.PendingInvitation | null>;
+  items: Array<components.Invite>;
 };
 
 export type ListPendingInvitationsResponse = {
@@ -128,7 +127,7 @@ export const ListPendingInvitationsListPendingInvitationsOk$inboundSchema:
     unknown
   > = z.object({
     pager: components.Pager$inboundSchema,
-    items: z.array(types.nullable(components.PendingInvitation$inboundSchema)),
+    items: z.array(components.Invite$inboundSchema),
   });
 
 export function listPendingInvitationsListPendingInvitationsOkFromJSON(

package/src/models/operations/liststandingappointments.ts

@@ -6,7 +6,6 @@ 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";
 
@@ -85,7 +84,7 @@ export type ListStandingAppointmentsListStandingAppointmentsOk = {
    * Pagination information for a pageable list
    */
   pager: components.Pager;
-  items: Array<components.StandingAppointment | null>;
+  items: Array<components.Event>;
 };
 
 export type ListStandingAppointmentsResponse = {
@@ -170,9 +169,7 @@ export const ListStandingAppointmentsListStandingAppointmentsOk$inboundSchema:
     unknown
   > = z.object({
     pager: components.Pager$inboundSchema,
-    items: z.array(
-      types.nullable(components.StandingAppointment$inboundSchema),
-    ),
+    items: z.array(components.Event$inboundSchema),
   });
 
 export function listStandingAppointmentsListStandingAppointmentsOkFromJSON(

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.ts

@@ -57,6 +57,7 @@ export type CompaniesListCompanyManagerContactsQueryError =
  *
  * @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.
  */
@@ -86,6 +87,7 @@ export function useCompaniesListCompanyManagerContacts(
  *
  * @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.
  */

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,

package/src/react-query/companiesListOrSearchCompanies.ts

@@ -76,6 +76,15 @@ export type CompaniesListOrSearchCompaniesQueryError =
  *
  * @remarks
  * List or search companies.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `company.location`
+ * - `company.vendor_type_restrictions`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListOrSearchCompanies(
   request: operations.ListOrSearchCompaniesRequest,
@@ -103,6 +112,15 @@ export function useCompaniesListOrSearchCompanies(
  *
  * @remarks
  * List or search companies.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `company.location`
+ * - `company.vendor_type_restrictions`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListOrSearchCompaniesSuspense(
   request: operations.ListOrSearchCompaniesRequest,
@@ -130,6 +148,15 @@ export function useCompaniesListOrSearchCompaniesSuspense(
  *
  * @remarks
  * List or search companies.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `company.location`
+ * - `company.vendor_type_restrictions`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListOrSearchCompaniesInfinite(
   request: operations.ListOrSearchCompaniesRequest,
@@ -171,6 +198,15 @@ export function useCompaniesListOrSearchCompaniesInfinite(
  *
  * @remarks
  * List or search companies.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `company.location`
+ * - `company.vendor_type_restrictions`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useCompaniesListOrSearchCompaniesInfiniteSuspense(
   request: operations.ListOrSearchCompaniesRequest,

package/src/react-query/companiesLookupCompanies.ts

@@ -76,6 +76,8 @@ export type CompaniesLookupCompaniesQueryError =
  *
  * @remarks
  * List companies available to the caller as minimal lookup summaries for dropdown and typeahead UIs.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompanies(
   request: operations.LookupCompaniesRequest,
@@ -103,6 +105,8 @@ export function useCompaniesLookupCompanies(
  *
  * @remarks
  * List companies available to the caller as minimal lookup summaries for dropdown and typeahead UIs.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesSuspense(
   request: operations.LookupCompaniesRequest,
@@ -130,6 +134,8 @@ export function useCompaniesLookupCompaniesSuspense(
  *
  * @remarks
  * List companies available to the caller as minimal lookup summaries for dropdown and typeahead UIs.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesInfinite(
   request: operations.LookupCompaniesRequest,
@@ -171,6 +177,8 @@ export function useCompaniesLookupCompaniesInfinite(
  *
  * @remarks
  * List companies available to the caller as minimal lookup summaries for dropdown and typeahead UIs.
+ *
+ * **Permissions.** Requires the `companies.view` permission.
  */
 export function useCompaniesLookupCompaniesInfiniteSuspense(
   request: operations.LookupCompaniesRequest,

package/src/react-query/dataRequestsAddDataRequestFile.ts

@@ -50,6 +50,8 @@ export type DataRequestsAddDataRequestFileMutationError =
  *
  * @remarks
  * It will set the vendor credential data request file attributes
+ *
+ * **Permissions.** Requires the `vendor-credential-data-requests.view` permission.
  */
 export function useDataRequestsAddDataRequestFileMutation(
   options?: MutationHookOptions<

package/src/react-query/dataRequestsDeleteDataRequestFile.ts

@@ -50,6 +50,8 @@ export type DataRequestsDeleteDataRequestFileMutationError =
  *
  * @remarks
  * It will delete the vendor credential data request file
+ *
+ * **Permissions.** Requires the `vendor-credential-data-requests.delete` permission.
  */
 export function useDataRequestsDeleteDataRequestFileMutation(
   options?: MutationHookOptions<

package/src/react-query/dataRequestsUpdateDataRequest.ts

@@ -50,6 +50,8 @@ export type DataRequestsUpdateDataRequestMutationError =
  *
  * @remarks
  * It will update the vendor credential data request attributes
+ *
+ * **Permissions.** Requires the `vendor-credential-data-requests.view` permission.
  */
 export function useDataRequestsUpdateDataRequestMutation(
   options?: MutationHookOptions<

package/src/react-query/eventsAcceptInvitation.ts

@@ -51,6 +51,8 @@ export type EventsAcceptInvitationMutationError =
  *
  * @remarks
  * Accept event invitation
+ *
+ * **Permissions.** Requires the `events.edit` permission.
  */
 export function useEventsAcceptInvitationMutation(
   options?: MutationHookOptions<

package/src/react-query/eventsCreateEvent.ts

@@ -36,6 +36,7 @@ export type EventsCreateEventMutationData = operations.CreateEventCreateEventOk;
 
 export type EventsCreateEventMutationError =
   | errors.ApiErrorResponse
+  | errors.ApiValidationErrorResponse
   | GreenSecurityError
   | ResponseValidationError
   | ConnectionError
@@ -50,6 +51,8 @@ export type EventsCreateEventMutationError =
  *
  * @remarks
  * Create a new event for calendar
+ *
+ * **Permissions.** Requires the `events.add` permission.
  */
 export function useEventsCreateEventMutation(
   options?: MutationHookOptions<

package/src/react-query/eventsDeclineInvitation.ts

@@ -51,6 +51,8 @@ export type EventsDeclineInvitationMutationError =
  *
  * @remarks
  * Decline event invitation
+ *
+ * **Permissions.** Requires the `events.edit` permission.
  */
 export function useEventsDeclineInvitationMutation(
   options?: MutationHookOptions<

package/src/react-query/eventsDeleteEvent.ts

@@ -51,6 +51,8 @@ export type EventsDeleteEventMutationError =
  *
  * @remarks
  * Delete event for calendar
+ *
+ * **Permissions.** Requires the `events.delete` permission.
  */
 export function useEventsDeleteEventMutation(
   options?: MutationHookOptions<

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

@@ -14,7 +14,7 @@ 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";
-export type EventsGetEventQueryData = operations.GetEventGetEventOk;
+export type EventsGetEventQueryData = components.Event;
 
 export function prefetchEventsGetEvent(
   queryClient: QueryClient,

package/src/react-query/eventsGetEvent.ts

@@ -59,11 +59,22 @@ export type EventsGetEventQueryError =
  * @remarks
  * Retrieve a single event by ID.
  *
+ * **Permissions.** Requires the `events.view` permission.
+ *
  * Available `expand` scopes are:
  *
  * - event.facility
  * - event.department
  * - event.invitees
+ * - event.location
+ * - event.attendees
+ * - event.creator
+ *
+ * Unrecognised values are ignored.
+ *
+ * This route always returns the current `Event` shape, whatever SDK version is calling: it was
+ * introduced after the calendar list endpoints and has never served the older string-valued
+ * shape they did.
  */
 export function useEventsGetEvent(
   request: operations.GetEventRequest,
@@ -86,11 +97,22 @@ export function useEventsGetEvent(
  * @remarks
  * Retrieve a single event by ID.
  *
+ * **Permissions.** Requires the `events.view` permission.
+ *
  * Available `expand` scopes are:
  *
  * - event.facility
  * - event.department
  * - event.invitees
+ * - event.location
+ * - event.attendees
+ * - event.creator
+ *
+ * Unrecognised values are ignored.
+ *
+ * This route always returns the current `Event` shape, whatever SDK version is calling: it was
+ * introduced after the calendar list endpoints and has never served the older string-valued
+ * shape they did.
  */
 export function useEventsGetEventSuspense(
   request: operations.GetEventRequest,