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

package/src/react-query/vendorsUpdateVendorManagedByCompany.ts

@@ -51,6 +51,8 @@ export type VendorsUpdateVendorManagedByCompanyMutationError =
  *
  * @remarks
  * It will update the vendor managed by company access rights
+ *
+ * **Permissions.** Requires the `vendors.edit` permission.
  */
 export function useVendorsUpdateVendorManagedByCompanyMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorPaymentResponsibility.ts

@@ -55,6 +55,8 @@ export type VendorsUpdateVendorPaymentResponsibilityMutationError =
  * vendor's user ID (to assign responsibility back to the vendor) or the
  * authenticated manager's own user ID (to claim responsibility). Omitted fields
  * are left unchanged.
+ *
+ * **Permissions.** Requires the `vendors.edit` permission.
  */
 export function useVendorsUpdateVendorPaymentResponsibilityMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorScrubDetails.ts

@@ -50,6 +50,8 @@ export type VendorsUpdateVendorScrubDetailsMutationError =
  *
  * @remarks
  * Update vendor scrub details
+ *
+ * **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.
  */
 export function useVendorsUpdateVendorScrubDetailsMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsVendorsExport.ts

@@ -64,6 +64,46 @@ export type VendorsVendorsExportQueryError =
  * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
  * `download_url` and `status_id`.
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `vendor.user`
+ * - `vendor.vendor_type`
+ * - `vendor.vendor_job`
+ * - `vendor.badge_details`
+ * - `vendor.required_badge_type`
+ * - `vendor.image_urls`
+ * - `vendor.payment_profile`
+ * - `vendor.primary_facility`
+ * - `vendor.primary_department`
+ * - `vendor.company`
+ * - `vendor.credentialing_subscription`
+ * - `vendor.scrubs_subscription`
+ * - `vendor.payment_responsibility`
+ * - `vendor.background_check_date_expires`
+ * - `vendor.credit_balance`
+ * - `vendor.registration_data`
+ * - `vendor.registration_finished`
+ * - `vendor.target_facilities`
+ * - `vendor.approved_calendaring_facilities`
+ * - `vendor.pending_invoice`
+ * - `vendor.vendor_groups`
+ * - `vendor.has_credentialed_facilities`
+ * - `vendor.has_emerald_status`
+ * - `vendor.has_target_facility_questions`
+ * - `vendor.custom_fields`
+ * - `vendor.last_scanned`
+ * - `subscription.current_line_item`
+ * - `subscription.date_ends`
+ * - `subscription.variant_title`
+ * - `subscription.next_line_item`
+ * - `subscription.current_financial_status`
+ * - `subscription.next_financial_status`
+ * - `subscription.expedited_offers`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`. The export job builds its own columns and does not consult `expand`, so the parameter is validated but has no effect on the generated CSV; it is accepted for backwards compatibility.
  */
 export function useVendorsVendorsExport(
   request: operations.VendorsExportRequest,
@@ -97,6 +137,46 @@ export function useVendorsVendorsExport(
  * alongside the vendor's identity, contact, and company details.
  * Returns a `status_url` to poll until the export is ready, plus a
  * `download_url` and `status_id`.
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
+ * Available `expand` scopes are:
+ *
+ * - `vendor.user`
+ * - `vendor.vendor_type`
+ * - `vendor.vendor_job`
+ * - `vendor.badge_details`
+ * - `vendor.required_badge_type`
+ * - `vendor.image_urls`
+ * - `vendor.payment_profile`
+ * - `vendor.primary_facility`
+ * - `vendor.primary_department`
+ * - `vendor.company`
+ * - `vendor.credentialing_subscription`
+ * - `vendor.scrubs_subscription`
+ * - `vendor.payment_responsibility`
+ * - `vendor.background_check_date_expires`
+ * - `vendor.credit_balance`
+ * - `vendor.registration_data`
+ * - `vendor.registration_finished`
+ * - `vendor.target_facilities`
+ * - `vendor.approved_calendaring_facilities`
+ * - `vendor.pending_invoice`
+ * - `vendor.vendor_groups`
+ * - `vendor.has_credentialed_facilities`
+ * - `vendor.has_emerald_status`
+ * - `vendor.has_target_facility_questions`
+ * - `vendor.custom_fields`
+ * - `vendor.last_scanned`
+ * - `subscription.current_line_item`
+ * - `subscription.date_ends`
+ * - `subscription.variant_title`
+ * - `subscription.next_line_item`
+ * - `subscription.current_financial_status`
+ * - `subscription.next_financial_status`
+ * - `subscription.expedited_offers`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`. The export job builds its own columns and does not consult `expand`, so the parameter is validated but has no effect on the generated CSV; it is accepted for backwards compatibility.
  */
 export function useVendorsVendorsExportSuspense(
   request: operations.VendorsExportRequest,

package/src/react-query/webhooksCreateWebhookEndpoint.ts

@@ -66,6 +66,8 @@ export type WebhooksCreateWebhookEndpointMutationError =
  * site-wide marketplace app installations, to every event of the site.
  *
  * Requires the `webhook` / `add` permission.
+ *
+ * **Permissions.** Requires the `webhook.add` permission.
  */
 export function useWebhooksCreateWebhookEndpointMutation(
   options?: MutationHookOptions<

package/src/react-query/webhooksDeleteWebhookEndpoint.ts

@@ -58,6 +58,8 @@ export type WebhooksDeleteWebhookEndpointMutationError =
  * events for entities it lost access to.
  *
  * Requires the `webhook` / `delete` permission.
+ *
+ * **Permissions.** Requires the `webhook.delete` permission.
  */
 export function useWebhooksDeleteWebhookEndpointMutation(
   options?: MutationHookOptions<

package/src/react-query/webhooksGetWebhookEndpoint.ts

@@ -63,6 +63,8 @@ export type WebhooksGetWebhookEndpointQueryError =
  * indistinguishable from one that does not exist.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function useWebhooksGetWebhookEndpoint(
   request: operations.GetWebhookEndpointRequest,
@@ -96,6 +98,8 @@ export function useWebhooksGetWebhookEndpoint(
  * indistinguishable from one that does not exist.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function useWebhooksGetWebhookEndpointSuspense(
   request: operations.GetWebhookEndpointRequest,

package/src/react-query/webhooksListAllWebhookEndpoints.ts

@@ -82,6 +82,8 @@ export type WebhooksListAllWebhookEndpointsQueryError =
  * Sortable by `id`, `webhook_url`, `created_at` and `updated_at`.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function useWebhooksListAllWebhookEndpoints(
   request: operations.ListAllWebhookEndpointsRequest,
@@ -115,6 +117,8 @@ export function useWebhooksListAllWebhookEndpoints(
  * Sortable by `id`, `webhook_url`, `created_at` and `updated_at`.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function useWebhooksListAllWebhookEndpointsSuspense(
   request: operations.ListAllWebhookEndpointsRequest,
@@ -148,6 +152,8 @@ export function useWebhooksListAllWebhookEndpointsSuspense(
  * Sortable by `id`, `webhook_url`, `created_at` and `updated_at`.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function useWebhooksListAllWebhookEndpointsInfinite(
   request: operations.ListAllWebhookEndpointsRequest,
@@ -195,6 +201,8 @@ export function useWebhooksListAllWebhookEndpointsInfinite(
  * Sortable by `id`, `webhook_url`, `created_at` and `updated_at`.
  *
  * Requires the `webhook` / `view` permission.
+ *
+ * **Permissions.** Requires the `webhook.view` permission.
  */
 export function useWebhooksListAllWebhookEndpointsInfiniteSuspense(
   request: operations.ListAllWebhookEndpointsRequest,

package/src/react-query/webhooksUpdatesTheWebhookEndpointWithTheGivenId.ts

@@ -76,6 +76,8 @@ export type WebhooksUpdatesTheWebhookEndpointWithTheGivenIdMutationError =
  * ignored if you send them back.
  *
  * Requires the `webhook` / `edit` permission.
+ *
+ * **Permissions.** Requires the `webhook.edit` permission.
  */
 export function useWebhooksUpdatesTheWebhookEndpointWithTheGivenIdMutation(
   options?: MutationHookOptions<

package/src/react-query/zonesGetSecurityZone.ts

@@ -59,11 +59,15 @@ export type ZonesGetSecurityZoneQueryError =
  * @remarks
  * Get security zone details
  *
+ * **Permissions.** Requires the `zones.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - zone.facility
- * - zone.department
- * - zone.rules
+ * - `zone.facility`
+ * - `zone.department`
+ * - `zone.rules`
+ *
+ * Unrecognised values are ignored.
  */
 export function useZonesGetSecurityZone(
   request: operations.GetSecurityZoneRequest,
@@ -92,11 +96,15 @@ export function useZonesGetSecurityZone(
  * @remarks
  * Get security zone details
  *
+ * **Permissions.** Requires the `zones.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - zone.facility
- * - zone.department
- * - zone.rules
+ * - `zone.facility`
+ * - `zone.department`
+ * - `zone.rules`
+ *
+ * Unrecognised values are ignored.
  */
 export function useZonesGetSecurityZoneSuspense(
   request: operations.GetSecurityZoneRequest,

package/src/react-query/zonesListOrSearchSecurityZones.ts

@@ -76,6 +76,8 @@ export type ZonesListOrSearchSecurityZonesQueryError =
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZones(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -103,6 +105,8 @@ export function useZonesListOrSearchSecurityZones(
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZonesSuspense(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -130,6 +134,8 @@ export function useZonesListOrSearchSecurityZonesSuspense(
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZonesInfinite(
   request: operations.ListOrSearchSecurityZonesRequest,
@@ -171,6 +177,8 @@ export function useZonesListOrSearchSecurityZonesInfinite(
  *
  * @remarks
  * List or search security zones
+ *
+ * **Permissions.** Requires the `zones.view` permission.
  */
 export function useZonesListOrSearchSecurityZonesInfiniteSuspense(
   request: operations.ListOrSearchSecurityZonesRequest,

package/src/react-query/zonesSecurityZoneCheckin.ts

@@ -51,6 +51,8 @@ export type ZonesSecurityZoneCheckinMutationError =
  *
  * @remarks
  * Security zone checkin request
+ *
+ * **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.
  */
 export function useZonesSecurityZoneCheckinMutation(
   options?: MutationHookOptions<

package/src/sdk/alerts.ts

@@ -15,6 +15,8 @@ export class Alerts extends ClientSDK {
    *
    * @remarks
    * List alerts for user.
+   *
+   * **Permissions.** Requires the `alerts.view` permission.
    */
   async listAlerts(
     request: operations.ListAlertsRequest,
@@ -32,6 +34,8 @@ export class Alerts extends ClientSDK {
    *
    * @remarks
    * Update user alerts
+   *
+   * **Permissions.** Requires the `alerts.edit` permission.
    */
   async updateUserAlerts(
     request: operations.UpdateUserAlertsRequestBody,

package/src/sdk/companies.ts

@@ -22,6 +22,15 @@ export class Companies extends ClientSDK {
    *
    * @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`.
    */
   async listOrSearchCompanies(
     request: operations.ListOrSearchCompaniesRequest,
@@ -42,10 +51,14 @@ export class Companies extends ClientSDK {
    * @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`.
    */
   async getCompany(
     request: operations.GetCompanyRequest,
@@ -63,6 +76,8 @@ export class Companies extends ClientSDK {
    *
    * @remarks
    * List companies available to the caller as minimal lookup summaries for dropdown and typeahead UIs.
+   *
+   * **Permissions.** Requires the `companies.view` permission.
    */
   async lookupCompanies(
     request: operations.LookupCompaniesRequest,
@@ -85,6 +100,8 @@ export class Companies extends ClientSDK {
    * 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.
    */
   async addCompanyManager(
     request: operations.AddCompanyManagerRequest,
@@ -102,6 +119,8 @@ export class Companies extends ClientSDK {
    *
    * @remarks
    * List or search company managers.
+   *
+   * **Permissions.** Requires the `company_managers.view` permission.
    */
   async listCompanyManagers(
     request: operations.ListCompanyManagersRequest,
@@ -121,6 +140,14 @@ export class Companies extends ClientSDK {
    *
    * @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`.
    */
   async listCompanyCredentials(
     request: operations.ListCompanyCredentialsRequest,
@@ -140,6 +167,16 @@ export class Companies extends ClientSDK {
    *
    * @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`.
    */
   async listCompanyCredits(
     request: operations.ListCompanyCreditsRequest,
@@ -159,6 +196,7 @@ export class Companies extends ClientSDK {
    *
    * @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/sdk/datarequests.ts

@@ -15,6 +15,8 @@ export class DataRequests extends ClientSDK {
    *
    * @remarks
    * It will set the vendor credential data request file attributes
+   *
+   * **Permissions.** Requires the `vendor-credential-data-requests.view` permission.
    */
   async addDataRequestFile(
     request: operations.AddDataRequestFileRequest,
@@ -32,6 +34,8 @@ export class DataRequests extends ClientSDK {
    *
    * @remarks
    * It will delete the vendor credential data request file
+   *
+   * **Permissions.** Requires the `vendor-credential-data-requests.delete` permission.
    */
   async deleteDataRequestFile(
     request: operations.DeleteDataRequestFileRequest,
@@ -49,6 +53,8 @@ export class DataRequests extends ClientSDK {
    *
    * @remarks
    * It will update the vendor credential data request attributes
+   *
+   * **Permissions.** Requires the `vendor-credential-data-requests.view` permission.
    */
   async updateDataRequest(
     request: operations.UpdateDataRequestRequest,

package/src/sdk/events.ts

@@ -25,6 +25,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Create a new event for calendar
+   *
+   * **Permissions.** Requires the `events.add` permission.
    */
   async createEvent(
     request: operations.CreateEventRequestBody,
@@ -43,16 +45,27 @@ export class Events extends ClientSDK {
    * @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.
    */
   async getEvent(
     request: operations.GetEventRequest,
     options?: RequestOptions,
-  ): Promise<operations.GetEventGetEventOk> {
+  ): Promise<components.Event> {
     return unwrapAsync(eventsGetEvent(
       this,
       request,
@@ -65,6 +78,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Update event for calendar
+   *
+   * **Permissions.** Requires the `events.edit` permission.
    */
   async updateEvent(
     request: operations.UpdateEventRequest,
@@ -82,6 +97,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Delete event for calendar
+   *
+   * **Permissions.** Requires the `events.delete` permission.
    */
   async deleteEvent(
     request: operations.DeleteEventRequest,
@@ -99,6 +116,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Accept event invitation
+   *
+   * **Permissions.** Requires the `events.edit` permission.
    */
   async acceptInvitation(
     request: operations.AcceptInvitationRequest,
@@ -116,6 +135,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Decline event invitation
+   *
+   * **Permissions.** Requires the `events.edit` permission.
    */
   async declineInvitation(
     request: operations.DeclineInvitationRequest,
@@ -134,12 +155,16 @@ export class Events extends ClientSDK {
    * @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.
    */
   async listOrSearchVendorInvitees(
     request: operations.ListOrSearchVendorInviteesRequest,
@@ -162,6 +187,8 @@ export class Events extends ClientSDK {
    *
    * @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.
    */
   async listLocations(
     request: operations.ListLocationsRequest,
@@ -178,7 +205,21 @@ export class Events extends ClientSDK {
    * 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.
    */
   async listPendingInvitations(
     request: operations.ListPendingInvitationsRequest,
@@ -197,7 +238,21 @@ export class Events extends ClientSDK {
    * 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.
    */
   async listFeed(
     request: operations.ListFeedRequest,
@@ -214,7 +269,20 @@ export class Events extends ClientSDK {
    * 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.
    */
   async listStandingAppointments(
     request: operations.ListStandingAppointmentsRequest,

package/src/sdk/fhirconfigs.ts

@@ -19,6 +19,8 @@ export class FhirConfigs extends ClientSDK {
    *
    * @remarks
    * List available FHIR configurations. This method requires the `fhir_config` / `view` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.view` permission.
    */
   async listOfFhirConfigurations(
     request: operations.ListOfFhirConfigurationsRequest,
@@ -40,6 +42,8 @@ export class FhirConfigs extends ClientSDK {
    * Create a new FHIR configuration. The `facility_id` under the `applies_to` property is required to match the Facility that the user belongs to.
    *
    * This endpoint requires the `fhir_configs` / `add` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.add` permission.
    */
   async createAFhirConfig(
     request: components.FhirConfigCreate,
@@ -59,6 +63,8 @@ export class FhirConfigs extends ClientSDK {
    * Retrieve a FHIR configuration by ID.
    *
    * This endpoint requires the `fhir_configs` / `view` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.view` permission.
    */
   async getFhirConfig(
     request: operations.GetFhirConfigRequest,
@@ -73,6 +79,9 @@ export class FhirConfigs extends ClientSDK {
 
   /**
    * Update any portion of a FHIR config by ID
+   *
+   * @remarks
+   * **Permissions.** Requires the `fhir_configs.edit` permission.
    */
   async updateFhirConfigById(
     request: operations.UpdateFhirConfigByIdRequest,
@@ -90,6 +99,8 @@ export class FhirConfigs extends ClientSDK {
    *
    * @remarks
    * Requires the `fhir_config` / `delete` permission.
+   *
+   * **Permissions.** Requires the `fhir_configs.delete` permission.
    */
   async deleteFhirConfigById(
     request: operations.DeleteFhirConfigByIdRequest,