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

package/src/react-query/vendorsListVendorScrubPurchases.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorScrubPurchasesQueryError =
  *
  * @remarks
  * List vendor scrub purchases
+ *
+ * **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 useVendorsListVendorScrubPurchases(
   request: operations.ListVendorScrubPurchasesRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorScrubPurchases(
  *
  * @remarks
  * List vendor scrub purchases
+ *
+ * **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 useVendorsListVendorScrubPurchasesSuspense(
   request: operations.ListVendorScrubPurchasesRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorScrubPurchasesSuspense(
  *
  * @remarks
  * List vendor scrub purchases
+ *
+ * **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 useVendorsListVendorScrubPurchasesInfinite(
   request: operations.ListVendorScrubPurchasesRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorScrubPurchasesInfinite(
  *
  * @remarks
  * List vendor scrub purchases
+ *
+ * **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 useVendorsListVendorScrubPurchasesInfiniteSuspense(
   request: operations.ListVendorScrubPurchasesRequest,

package/src/react-query/vendorsListVendorTypes.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorTypesQueryError =
  *
  * @remarks
  * List vendor types.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorTypes(
   request: operations.ListVendorTypesRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorTypes(
  *
  * @remarks
  * List vendor types.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorTypesSuspense(
   request: operations.ListVendorTypesRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorTypesSuspense(
  *
  * @remarks
  * List vendor types.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorTypesInfinite(
   request: operations.ListVendorTypesRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorTypesInfinite(
  *
  * @remarks
  * List vendor types.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorTypesInfiniteSuspense(
   request: operations.ListVendorTypesRequest,

package/src/react-query/vendorsListVendors.ts

@@ -81,41 +81,45 @@ export type VendorsListVendorsQueryError =
  * Common use cases for this are 1099 contractors who represent multiple companies or any vendor that has their
  * credentials or payments handled by a company other than the one they use to do business with a facility.
  *
- * Available `expand` scopes are:
+ * **Permissions.** Requires the `vendors.view` permission.
  *
- * vendor.user
- * vendor.vendor_type
- * vendor.vendor_job
- * 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.custom_fields
- * vendor.last_scanned
+ * Available `expand` scopes are:
  *
- * Subscription expand scopes (require vendor.credentialing_subscription):
+ * - `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`
  *
- * subscription.date_ends
- * subscription.variant_title
- * subscription.current_line_item
- * subscription.next_line_item
- * subscription.current_financial_status
- * subscription.next_financial_status
- * subscription.expedited_offers
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useVendorsListVendors(
   request: operations.ListVendorsRequest,
@@ -145,41 +149,45 @@ export function useVendorsListVendors(
  * Common use cases for this are 1099 contractors who represent multiple companies or any vendor that has their
  * credentials or payments handled by a company other than the one they use to do business with a facility.
  *
- * Available `expand` scopes are:
+ * **Permissions.** Requires the `vendors.view` permission.
  *
- * vendor.user
- * vendor.vendor_type
- * vendor.vendor_job
- * 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.custom_fields
- * vendor.last_scanned
+ * Available `expand` scopes are:
  *
- * Subscription expand scopes (require vendor.credentialing_subscription):
+ * - `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`
  *
- * subscription.date_ends
- * subscription.variant_title
- * subscription.current_line_item
- * subscription.next_line_item
- * subscription.current_financial_status
- * subscription.next_financial_status
- * subscription.expedited_offers
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useVendorsListVendorsSuspense(
   request: operations.ListVendorsRequest,
@@ -212,41 +220,45 @@ export function useVendorsListVendorsSuspense(
  * Common use cases for this are 1099 contractors who represent multiple companies or any vendor that has their
  * credentials or payments handled by a company other than the one they use to do business with a facility.
  *
- * Available `expand` scopes are:
+ * **Permissions.** Requires the `vendors.view` permission.
  *
- * vendor.user
- * vendor.vendor_type
- * vendor.vendor_job
- * 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.custom_fields
- * vendor.last_scanned
+ * Available `expand` scopes are:
  *
- * Subscription expand scopes (require vendor.credentialing_subscription):
+ * - `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`
  *
- * subscription.date_ends
- * subscription.variant_title
- * subscription.current_line_item
- * subscription.next_line_item
- * subscription.current_financial_status
- * subscription.next_financial_status
- * subscription.expedited_offers
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useVendorsListVendorsInfinite(
   request: operations.ListVendorsRequest,
@@ -293,41 +305,45 @@ export function useVendorsListVendorsInfinite(
  * Common use cases for this are 1099 contractors who represent multiple companies or any vendor that has their
  * credentials or payments handled by a company other than the one they use to do business with a facility.
  *
- * Available `expand` scopes are:
+ * **Permissions.** Requires the `vendors.view` permission.
  *
- * vendor.user
- * vendor.vendor_type
- * vendor.vendor_job
- * 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.custom_fields
- * vendor.last_scanned
+ * Available `expand` scopes are:
  *
- * Subscription expand scopes (require vendor.credentialing_subscription):
+ * - `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`
  *
- * subscription.date_ends
- * subscription.variant_title
- * subscription.current_line_item
- * subscription.next_line_item
- * subscription.current_financial_status
- * subscription.next_financial_status
- * subscription.expedited_offers
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useVendorsListVendorsInfiniteSuspense(
   request: operations.ListVendorsRequest,

package/src/react-query/vendorsPurchaseScrubCredits.ts

@@ -51,6 +51,8 @@ export type VendorsPurchaseScrubCreditsMutationError =
  *
  * @remarks
  * Purchase scrub credits
+ *
+ * **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 useVendorsPurchaseScrubCreditsMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsSendDownloadCode.ts

@@ -50,6 +50,8 @@ export type VendorsSendDownloadCodeMutationError =
  *
  * @remarks
  * It will send download code for vendor credential
+ *
+ * **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 useVendorsSendDownloadCodeMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsSubmitVendorCredential.ts

@@ -50,6 +50,8 @@ export type VendorsSubmitVendorCredentialMutationError =
  *
  * @remarks
  * It will submit vendor credential
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsSubmitVendorCredentialMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorCredentialData.ts

@@ -50,6 +50,8 @@ export type VendorsUpdateVendorCredentialDataMutationError =
  *
  * @remarks
  * Update vendor credential data
+ *
+ * **Permissions.** Requires the `vendor_credentials.edit` permission.
  */
 export function useVendorsUpdateVendorCredentialDataMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorCredentialFile.ts

@@ -50,6 +50,8 @@ export type VendorsUpdateVendorCredentialFileMutationError =
  *
  * @remarks
  * It will update the vendor credential file properties
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsUpdateVendorCredentialFileMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorCustomField.ts

@@ -59,6 +59,8 @@ export type VendorsUpdateVendorCustomFieldMutationError =
  *
  * Accepts a numeric vendor ID, `me` for the authenticated vendor,
  * or an active QR code (format: contains hyphens).
+ *
+ * **Permissions.** Requires the `vendors.edit` permission.
  */
 export function useVendorsUpdateVendorCustomFieldMutation(
   options?: MutationHookOptions<

package/src/react-query/vendorsUpdateVendorDetails.ts

@@ -56,13 +56,23 @@ export type VendorsUpdateVendorDetailsMutationError =
  * From `location` this endpoint reads only `timezone`, `address1`, `address2`,
  * `city`, `state`, `zip`, `phone`, `mobile_phone` and `fax`. The `address` and
  * `country` properties of the shared `UserLocation` schema are ignored here and
- * updating them is not supported.
+ * updating them is not supported. `state` accepts a US state or a Canadian
+ * province — the vendor's country, set only at registration, is not editable
+ * through this endpoint.
+ *
+ * Submitting `location.zip` or `location.state` cross-checks the postal code
+ * against the resulting state (using the vendor's existing value for whichever
+ * of the two is left out of the request). A code that is not shaped like a real
+ * postal code, or that provably belongs to a different state, is rejected with
+ * `422` naming the correct state.
  *
  * For `title`, the `supervisor` fields, and every `location` field except
  * `timezone`, the value sent is the value stored: omit a field to leave it
  * unchanged, or send an empty string to clear it. `timezone` is the one
  * exception — it accepts only the values in its enum, so send one of those to
  * change it and omit it to leave it unchanged.
+ *
+ * **Permissions.** Requires the `vendors.edit` permission.
  */
 export function useVendorsUpdateVendorDetailsMutation(
   options?: MutationHookOptions<

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<