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

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,

package/src/react-query/eventsListFeed.ts

@@ -75,7 +75,21 @@ export type EventsListFeedQueryError =
  * List events feed
  *
  * @remarks
- * List events feed
+ * List events feed.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.creator` and `event.invitees` scopes already applied,
+ * so `event_creator`, `event_creator_img_url` and `invitees` are populated — the fields this
+ * feed has always carried. SDK builds below `0.55.0-beta.1` receive the older `Feed` shape
+ * instead, in which `facility` and `department` are name strings rather than ids; the server
+ * chooses by the `X-SDK-User-Agent` header the SDK sends, so an existing client keeps the
+ * shape it was generated against until it is regenerated.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListFeed(
   request: operations.ListFeedRequest,
@@ -96,7 +110,21 @@ export function useEventsListFeed(
  * List events feed
  *
  * @remarks
- * List events feed
+ * List events feed.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.creator` and `event.invitees` scopes already applied,
+ * so `event_creator`, `event_creator_img_url` and `invitees` are populated — the fields this
+ * feed has always carried. SDK builds below `0.55.0-beta.1` receive the older `Feed` shape
+ * instead, in which `facility` and `department` are name strings rather than ids; the server
+ * chooses by the `X-SDK-User-Agent` header the SDK sends, so an existing client keeps the
+ * shape it was generated against until it is regenerated.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListFeedSuspense(
   request: operations.ListFeedRequest,
@@ -120,7 +148,21 @@ export function useEventsListFeedSuspense(
  * List events feed
  *
  * @remarks
- * List events feed
+ * List events feed.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.creator` and `event.invitees` scopes already applied,
+ * so `event_creator`, `event_creator_img_url` and `invitees` are populated — the fields this
+ * feed has always carried. SDK builds below `0.55.0-beta.1` receive the older `Feed` shape
+ * instead, in which `facility` and `department` are name strings rather than ids; the server
+ * chooses by the `X-SDK-User-Agent` header the SDK sends, so an existing client keeps the
+ * shape it was generated against until it is regenerated.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListFeedInfinite(
   request: operations.ListFeedRequest,
@@ -155,7 +197,21 @@ export function useEventsListFeedInfinite(
  * List events feed
  *
  * @remarks
- * List events feed
+ * List events feed.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.creator` and `event.invitees` scopes already applied,
+ * so `event_creator`, `event_creator_img_url` and `invitees` are populated — the fields this
+ * feed has always carried. SDK builds below `0.55.0-beta.1` receive the older `Feed` shape
+ * instead, in which `facility` and `department` are name strings rather than ids; the server
+ * chooses by the `X-SDK-User-Agent` header the SDK sends, so an existing client keeps the
+ * shape it was generated against until it is regenerated.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListFeedInfiniteSuspense(
   request: operations.ListFeedRequest,

package/src/react-query/eventsListLocations.ts

@@ -76,6 +76,8 @@ export type EventsListLocationsQueryError =
  *
  * @remarks
  * List meeting locations for invitees or an event
+ *
+ * **Permissions.** Requires the `events.view` permission. Results are also scoped to the caller's own tenant: `event_id` is resolved through the caller's own event access (organizer, invitee, or the facility/system/company hosting it), and `invitee_user_ids`/`invitee_department_ids` only return labels for facilities the caller may otherwise see.
  */
 export function useEventsListLocations(
   request: operations.ListLocationsRequest,
@@ -100,6 +102,8 @@ export function useEventsListLocations(
  *
  * @remarks
  * List meeting locations for invitees or an event
+ *
+ * **Permissions.** Requires the `events.view` permission. Results are also scoped to the caller's own tenant: `event_id` is resolved through the caller's own event access (organizer, invitee, or the facility/system/company hosting it), and `invitee_user_ids`/`invitee_department_ids` only return labels for facilities the caller may otherwise see.
  */
 export function useEventsListLocationsSuspense(
   request: operations.ListLocationsRequest,
@@ -127,6 +131,8 @@ export function useEventsListLocationsSuspense(
  *
  * @remarks
  * List meeting locations for invitees or an event
+ *
+ * **Permissions.** Requires the `events.view` permission. Results are also scoped to the caller's own tenant: `event_id` is resolved through the caller's own event access (organizer, invitee, or the facility/system/company hosting it), and `invitee_user_ids`/`invitee_department_ids` only return labels for facilities the caller may otherwise see.
  */
 export function useEventsListLocationsInfinite(
   request: operations.ListLocationsRequest,
@@ -168,6 +174,8 @@ export function useEventsListLocationsInfinite(
  *
  * @remarks
  * List meeting locations for invitees or an event
+ *
+ * **Permissions.** Requires the `events.view` permission. Results are also scoped to the caller's own tenant: `event_id` is resolved through the caller's own event access (organizer, invitee, or the facility/system/company hosting it), and `invitee_user_ids`/`invitee_department_ids` only return labels for facilities the caller may otherwise see.
  */
 export function useEventsListLocationsInfiniteSuspense(
   request: operations.ListLocationsRequest,

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

@@ -81,6 +81,8 @@ export function buildEventsListOrSearchVendorInviteesQuery(
       itemsPerPage: request.itemsPerPage,
       expand: request.expand,
       search: request.search,
+      vendorId: request.vendorId,
+      facilityId: request.facilityId,
     }),
     queryFn: async function eventsListOrSearchVendorInviteesQueryFn(
       ctx,
@@ -126,6 +128,8 @@ export function buildEventsListOrSearchVendorInviteesInfiniteQuery(
       itemsPerPage: request.itemsPerPage,
       expand: request.expand,
       search: request.search,
+      vendorId: request.vendorId,
+      facilityId: request.facilityId,
     }),
     queryFn: async function eventsListOrSearchVendorInviteesQuery(
       ctx,
@@ -169,6 +173,8 @@ export function queryKeyEventsListOrSearchVendorInvitees(
     itemsPerPage?: number | undefined;
     expand?: Array<components.Expand> | undefined;
     search?: string | undefined;
+    vendorId?: number | undefined;
+    facilityId?: number | undefined;
   },
 ): QueryKey {
   return [
@@ -187,6 +193,8 @@ export function queryKeyEventsListOrSearchVendorInviteesInfinite(
     itemsPerPage?: number | undefined;
     expand?: Array<components.Expand> | undefined;
     search?: string | undefined;
+    vendorId?: number | undefined;
+    facilityId?: number | undefined;
   },
 ): QueryKey {
   return [

package/src/react-query/eventsListOrSearchVendorInvitees.ts

@@ -77,12 +77,16 @@ export type EventsListOrSearchVendorInviteesQueryError =
  * @remarks
  * List or search vendor invitees.
  *
+ * **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.
+ *
  * Available `expand` scopes are:
  *
- * - contact.facility
- * - contact.system
- * - contact.department
- * - contact.user
+ * - `contact.user`
+ * - `contact.facility`
+ * - `contact.system`
+ * - `contact.department`
+ *
+ * Unrecognised values are ignored.
  */
 export function useEventsListOrSearchVendorInvitees(
   request: operations.ListOrSearchVendorInviteesRequest,
@@ -111,12 +115,16 @@ export function useEventsListOrSearchVendorInvitees(
  * @remarks
  * List or search vendor invitees.
  *
+ * **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.
+ *
  * Available `expand` scopes are:
  *
- * - contact.facility
- * - contact.system
- * - contact.department
- * - contact.user
+ * - `contact.user`
+ * - `contact.facility`
+ * - `contact.system`
+ * - `contact.department`
+ *
+ * Unrecognised values are ignored.
  */
 export function useEventsListOrSearchVendorInviteesSuspense(
   request: operations.ListOrSearchVendorInviteesRequest,
@@ -145,12 +153,16 @@ export function useEventsListOrSearchVendorInviteesSuspense(
  * @remarks
  * List or search vendor invitees.
  *
+ * **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.
+ *
  * Available `expand` scopes are:
  *
- * - contact.facility
- * - contact.system
- * - contact.department
- * - contact.user
+ * - `contact.user`
+ * - `contact.facility`
+ * - `contact.system`
+ * - `contact.department`
+ *
+ * Unrecognised values are ignored.
  */
 export function useEventsListOrSearchVendorInviteesInfinite(
   request: operations.ListOrSearchVendorInviteesRequest,
@@ -193,12 +205,16 @@ export function useEventsListOrSearchVendorInviteesInfinite(
  * @remarks
  * List or search vendor invitees.
  *
+ * **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.
+ *
  * Available `expand` scopes are:
  *
- * - contact.facility
- * - contact.system
- * - contact.department
- * - contact.user
+ * - `contact.user`
+ * - `contact.facility`
+ * - `contact.system`
+ * - `contact.department`
+ *
+ * Unrecognised values are ignored.
  */
 export function useEventsListOrSearchVendorInviteesInfiniteSuspense(
   request: operations.ListOrSearchVendorInviteesRequest,
@@ -245,6 +261,8 @@ export function setEventsListOrSearchVendorInviteesData(
       itemsPerPage?: number | undefined;
       expand?: Array<components.Expand> | undefined;
       search?: string | undefined;
+      vendorId?: number | undefined;
+      facilityId?: number | undefined;
     },
   ],
   data: EventsListOrSearchVendorInviteesQueryData,
@@ -267,6 +285,8 @@ export function invalidateEventsListOrSearchVendorInvitees(
       itemsPerPage?: number | undefined;
       expand?: Array<components.Expand> | undefined;
       search?: string | undefined;
+      vendorId?: number | undefined;
+      facilityId?: number | undefined;
     }]
   >,
   filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,

package/src/react-query/eventsListPendingInvitations.ts

@@ -75,7 +75,21 @@ export type EventsListPendingInvitationsQueryError =
  * List pending invitations
  *
  * @remarks
- * List pending invitations
+ * List pending invitations.
+ *
+ * **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.
+ *
+ * Returns `Invite` items with the `invite.event` and `invite.invitee` scopes already applied,
+ * so `event` is the expanded `{ id, name }` summary rather than a bare id, and `invitee` is
+ * populated — the appointment and the recipient this list has always named. This endpoint
+ * takes no `expand` parameter; both scopes are applied on every call and cannot be turned off.
+ * SDK builds below `0.55.0-beta.1` receive the older `PendingInvitation` shape instead, which
+ * embeds the appointment.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Invite`. See the `Invite` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListPendingInvitations(
   request: operations.ListPendingInvitationsRequest,
@@ -102,7 +116,21 @@ export function useEventsListPendingInvitations(
  * List pending invitations
  *
  * @remarks
- * List pending invitations
+ * List pending invitations.
+ *
+ * **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.
+ *
+ * Returns `Invite` items with the `invite.event` and `invite.invitee` scopes already applied,
+ * so `event` is the expanded `{ id, name }` summary rather than a bare id, and `invitee` is
+ * populated — the appointment and the recipient this list has always named. This endpoint
+ * takes no `expand` parameter; both scopes are applied on every call and cannot be turned off.
+ * SDK builds below `0.55.0-beta.1` receive the older `PendingInvitation` shape instead, which
+ * embeds the appointment.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Invite`. See the `Invite` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListPendingInvitationsSuspense(
   request: operations.ListPendingInvitationsRequest,
@@ -129,7 +157,21 @@ export function useEventsListPendingInvitationsSuspense(
  * List pending invitations
  *
  * @remarks
- * List pending invitations
+ * List pending invitations.
+ *
+ * **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.
+ *
+ * Returns `Invite` items with the `invite.event` and `invite.invitee` scopes already applied,
+ * so `event` is the expanded `{ id, name }` summary rather than a bare id, and `invitee` is
+ * populated — the appointment and the recipient this list has always named. This endpoint
+ * takes no `expand` parameter; both scopes are applied on every call and cannot be turned off.
+ * SDK builds below `0.55.0-beta.1` receive the older `PendingInvitation` shape instead, which
+ * embeds the appointment.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Invite`. See the `Invite` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListPendingInvitationsInfinite(
   request: operations.ListPendingInvitationsRequest,
@@ -170,7 +212,21 @@ export function useEventsListPendingInvitationsInfinite(
  * List pending invitations
  *
  * @remarks
- * List pending invitations
+ * List pending invitations.
+ *
+ * **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.
+ *
+ * Returns `Invite` items with the `invite.event` and `invite.invitee` scopes already applied,
+ * so `event` is the expanded `{ id, name }` summary rather than a bare id, and `invitee` is
+ * populated — the appointment and the recipient this list has always named. This endpoint
+ * takes no `expand` parameter; both scopes are applied on every call and cannot be turned off.
+ * SDK builds below `0.55.0-beta.1` receive the older `PendingInvitation` shape instead, which
+ * embeds the appointment.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Invite`. See the `Invite` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListPendingInvitationsInfiniteSuspense(
   request: operations.ListPendingInvitationsRequest,

package/src/react-query/eventsListStandingAppointments.ts

@@ -75,7 +75,20 @@ export type EventsListStandingAppointmentsQueryError =
  * List standing appointments
  *
  * @remarks
- * List standing appointment
+ * List standing appointments.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.location`, `event.attendees`, `event.viewer_invite`,
+ * `event.creator` and `event.invitees` scopes already applied, so `location`, `attendees`,
+ * `event_creator`, `event_creator_img_url` and `invitees` are populated and `status` carries
+ * the reader's own outstanding invite. SDK builds below `0.55.0-beta.1` receive the older
+ * `StandingAppointment` shape instead.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListStandingAppointments(
   request: operations.ListStandingAppointmentsRequest,
@@ -102,7 +115,20 @@ export function useEventsListStandingAppointments(
  * List standing appointments
  *
  * @remarks
- * List standing appointment
+ * List standing appointments.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.location`, `event.attendees`, `event.viewer_invite`,
+ * `event.creator` and `event.invitees` scopes already applied, so `location`, `attendees`,
+ * `event_creator`, `event_creator_img_url` and `invitees` are populated and `status` carries
+ * the reader's own outstanding invite. SDK builds below `0.55.0-beta.1` receive the older
+ * `StandingAppointment` shape instead.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListStandingAppointmentsSuspense(
   request: operations.ListStandingAppointmentsRequest,
@@ -129,7 +155,20 @@ export function useEventsListStandingAppointmentsSuspense(
  * List standing appointments
  *
  * @remarks
- * List standing appointment
+ * List standing appointments.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.location`, `event.attendees`, `event.viewer_invite`,
+ * `event.creator` and `event.invitees` scopes already applied, so `location`, `attendees`,
+ * `event_creator`, `event_creator_img_url` and `invitees` are populated and `status` carries
+ * the reader's own outstanding invite. SDK builds below `0.55.0-beta.1` receive the older
+ * `StandingAppointment` shape instead.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListStandingAppointmentsInfinite(
   request: operations.ListStandingAppointmentsRequest,
@@ -170,7 +209,20 @@ export function useEventsListStandingAppointmentsInfinite(
  * List standing appointments
  *
  * @remarks
- * List standing appointment
+ * List standing appointments.
+ *
+ * **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.
+ *
+ * Returns `Event` items with the `event.location`, `event.attendees`, `event.viewer_invite`,
+ * `event.creator` and `event.invitees` scopes already applied, so `location`, `attendees`,
+ * `event_creator`, `event_creator_img_url` and `invitees` are populated and `status` carries
+ * the reader's own outstanding invite. SDK builds below `0.55.0-beta.1` receive the older
+ * `StandingAppointment` shape instead.
+ *
+ * The boundary is the prerelease build `0.55.0-beta.1`, not the `0.55.0` release, so
+ * `0.55.0-beta.1` itself already receives `Event`. See the `Event` schema for exactly how a
+ * build is compared against it.
  */
 export function useEventsListStandingAppointmentsInfiniteSuspense(
   request: operations.ListStandingAppointmentsRequest,