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

package/src/react-query/vendorsGetVendorsDetails.ts

@@ -59,31 +59,39 @@ export type VendorsGetVendorsDetailsQueryError =
  * @remarks
  * Retrieve an individual vendor details.
  *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * 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.has_target_facility_questions
- * vendor.custom_fields
+ * - `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`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useVendorsGetVendorsDetails(
   request: operations.GetVendorsDetailsRequest,
@@ -112,31 +120,39 @@ export function useVendorsGetVendorsDetails(
  * @remarks
  * Retrieve an individual vendor details.
  *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * 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.has_target_facility_questions
- * vendor.custom_fields
+ * - `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`
+ *
+ * Any other value is rejected with `422 Unprocessable Entity`.
  */
 export function useVendorsGetVendorsDetailsSuspense(
   request: operations.GetVendorsDetailsRequest,

package/src/react-query/vendorsGetVendorsExportStatus.ts

@@ -58,6 +58,8 @@ export type VendorsGetVendorsExportStatusQueryError =
  * @remarks
  * Poll the status of an asynchronous vendor export job. When `ready` is true,
  * the export is complete and can be downloaded via the download endpoint.
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsGetVendorsExportStatus(
   request: operations.GetVendorsExportStatusRequest,
@@ -86,6 +88,8 @@ export function useVendorsGetVendorsExportStatus(
  * @remarks
  * Poll the status of an asynchronous vendor export job. When `ready` is true,
  * the export is complete and can be downloaded via the download endpoint.
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsGetVendorsExportStatusSuspense(
   request: operations.GetVendorsExportStatusRequest,

package/src/react-query/vendorsListVendorAdditionalFacilityFields.ts

@@ -84,6 +84,8 @@ export type VendorsListVendorAdditionalFacilityFieldsQueryError =
  * with the `field_for` discriminator. Scheduled for removal after SDK
  * consumers migrate.
  *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFields(
@@ -120,6 +122,8 @@ export function useVendorsListVendorAdditionalFacilityFields(
  * with the `field_for` discriminator. Scheduled for removal after SDK
  * consumers migrate.
  *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsSuspense(
@@ -156,6 +160,8 @@ export function useVendorsListVendorAdditionalFacilityFieldsSuspense(
  * with the `field_for` discriminator. Scheduled for removal after SDK
  * consumers migrate.
  *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsInfinite(
@@ -206,6 +212,8 @@ export function useVendorsListVendorAdditionalFacilityFieldsInfinite(
  * with the `field_for` discriminator. Scheduled for removal after SDK
  * consumers migrate.
  *
+ * **Permissions.** Requires the `vendors.view` permission.
+ *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function useVendorsListVendorAdditionalFacilityFieldsInfiniteSuspense(

package/src/react-query/vendorsListVendorCredentialDataRequests.ts

@@ -59,10 +59,14 @@ export type VendorsListVendorCredentialDataRequestsQueryError =
  * @remarks
  * Retrieve an vendor credential data requests.
  *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - vendor_credential_data_request.vendor_credential
- * - vendor_credential_data_request.data_request
+ * - `vendor_credential_data_request.vendor_credential`
+ * - `vendor_credential_data_request.data_request`
+ *
+ * Unrecognised values are ignored.
  */
 export function useVendorsListVendorCredentialDataRequests(
   request: operations.ListVendorCredentialDataRequestsRequest,
@@ -91,10 +95,14 @@ export function useVendorsListVendorCredentialDataRequests(
  * @remarks
  * Retrieve an vendor credential data requests.
  *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - vendor_credential_data_request.vendor_credential
- * - vendor_credential_data_request.data_request
+ * - `vendor_credential_data_request.vendor_credential`
+ * - `vendor_credential_data_request.data_request`
+ *
+ * Unrecognised values are ignored.
  */
 export function useVendorsListVendorCredentialDataRequestsSuspense(
   request: operations.ListVendorCredentialDataRequestsRequest,

package/src/react-query/vendorsListVendorCredentialFiles.ts

@@ -59,10 +59,14 @@ export type VendorsListVendorCredentialFilesQueryError =
  * @remarks
  * Retrieve an vendor credential files.
  *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - vendor_credential_file.vendor_credential
- * - vendor_credential_file.credential_document
+ * - `vendor_credential_file.vendor_credential`
+ * - `vendor_credential_file.credential_document`
+ *
+ * Unrecognised values are ignored.
  */
 export function useVendorsListVendorCredentialFiles(
   request: operations.ListVendorCredentialFilesRequest,
@@ -91,10 +95,14 @@ export function useVendorsListVendorCredentialFiles(
  * @remarks
  * Retrieve an vendor credential files.
  *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * - vendor_credential_file.vendor_credential
- * - vendor_credential_file.credential_document
+ * - `vendor_credential_file.vendor_credential`
+ * - `vendor_credential_file.credential_document`
+ *
+ * Unrecognised values are ignored.
  */
 export function useVendorsListVendorCredentialFilesSuspense(
   request: operations.ListVendorCredentialFilesRequest,

package/src/react-query/vendorsListVendorCredentialHistory.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorCredentialHistoryQueryError =
  *
  * @remarks
  * Lists vendor credentials history
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentialHistory(
   request: operations.ListVendorCredentialHistoryRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorCredentialHistory(
  *
  * @remarks
  * Lists vendor credentials history
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentialHistorySuspense(
   request: operations.ListVendorCredentialHistoryRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorCredentialHistorySuspense(
  *
  * @remarks
  * Lists vendor credentials history
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentialHistoryInfinite(
   request: operations.ListVendorCredentialHistoryRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorCredentialHistoryInfinite(
  *
  * @remarks
  * Lists vendor credentials history
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentialHistoryInfiniteSuspense(
   request: operations.ListVendorCredentialHistoryRequest,

package/src/react-query/vendorsListVendorCredentials.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorCredentialsQueryError =
  *
  * @remarks
  * Lists vendor credentials, required credentials, and company credentials. Utilized in Vendor Dashboard.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentials(
   request: operations.ListVendorCredentialsRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorCredentials(
  *
  * @remarks
  * Lists vendor credentials, required credentials, and company credentials. Utilized in Vendor Dashboard.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentialsSuspense(
   request: operations.ListVendorCredentialsRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorCredentialsSuspense(
  *
  * @remarks
  * Lists vendor credentials, required credentials, and company credentials. Utilized in Vendor Dashboard.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentialsInfinite(
   request: operations.ListVendorCredentialsRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorCredentialsInfinite(
  *
  * @remarks
  * Lists vendor credentials, required credentials, and company credentials. Utilized in Vendor Dashboard.
+ *
+ * **Permissions.** Requires the `vendor_credentials.view` permission.
  */
 export function useVendorsListVendorCredentialsInfiniteSuspense(
   request: operations.ListVendorCredentialsRequest,

package/src/react-query/vendorsListVendorCredits.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorCreditsQueryError =
  *
  * @remarks
  * List the credits for the vendor. Defaults to chronological order (oldest first).
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorCredits(
   request: operations.ListVendorCreditsRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorCredits(
  *
  * @remarks
  * List the credits for the vendor. Defaults to chronological order (oldest first).
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorCreditsSuspense(
   request: operations.ListVendorCreditsRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorCreditsSuspense(
  *
  * @remarks
  * List the credits for the vendor. Defaults to chronological order (oldest first).
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorCreditsInfinite(
   request: operations.ListVendorCreditsRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorCreditsInfinite(
  *
  * @remarks
  * List the credits for the vendor. Defaults to chronological order (oldest first).
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorCreditsInfiniteSuspense(
   request: operations.ListVendorCreditsRequest,

package/src/react-query/vendorsListVendorCustomFields.ts

@@ -66,6 +66,8 @@ export type VendorsListVendorCustomFieldsQueryError =
  *
  * Accepts a numeric vendor ID, `me` for the authenticated vendor,
  * or an active QR code (format: contains hyphens).
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorCustomFields(
   request: operations.ListVendorCustomFieldsRequest,
@@ -102,6 +104,8 @@ export function useVendorsListVendorCustomFields(
  *
  * Accepts a numeric vendor ID, `me` for the authenticated vendor,
  * or an active QR code (format: contains hyphens).
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorCustomFieldsSuspense(
   request: operations.ListVendorCustomFieldsRequest,

package/src/react-query/vendorsListVendorFacilityStatuses.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorFacilityStatusesQueryError =
  *
  * @remarks
  * List the facilities for the vendor
+ *
+ * **Permissions.** Requires the `facilities.view` permission.
  */
 export function useVendorsListVendorFacilityStatuses(
   request: operations.ListVendorFacilityStatusesRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorFacilityStatuses(
  *
  * @remarks
  * List the facilities for the vendor
+ *
+ * **Permissions.** Requires the `facilities.view` permission.
  */
 export function useVendorsListVendorFacilityStatusesSuspense(
   request: operations.ListVendorFacilityStatusesRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorFacilityStatusesSuspense(
  *
  * @remarks
  * List the facilities for the vendor
+ *
+ * **Permissions.** Requires the `facilities.view` permission.
  */
 export function useVendorsListVendorFacilityStatusesInfinite(
   request: operations.ListVendorFacilityStatusesRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorFacilityStatusesInfinite(
  *
  * @remarks
  * List the facilities for the vendor
+ *
+ * **Permissions.** Requires the `facilities.view` permission.
  */
 export function useVendorsListVendorFacilityStatusesInfiniteSuspense(
   request: operations.ListVendorFacilityStatusesRequest,

package/src/react-query/vendorsListVendorInvoices.ts

@@ -79,10 +79,25 @@ export type VendorsListVendorInvoicesQueryError =
  *
  * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
+ * **Permissions.** Requires the `invoices.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * invoice.line_items
- * invoice.may_pay_invoice
+ * - `invoice.invoice_type`
+ * - `invoice.custom_fields`
+ * - `invoice.line_items`
+ * - `invoice.invoice_transactions`
+ * - `invoice.representative`
+ * - `invoice.payment_profile`
+ * - `invoice.may_pay_invoice`
+ * - `invoice.shareback_system`
+ * - `line_items.details`
+ * - `line_items.product`
+ * - `line_items.variant`
+ * - `invoice_transactions.payee`
+ * - `invoice_transactions.payment_profile`
+ *
+ * Unrecognised values are ignored.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
@@ -115,10 +130,25 @@ export function useVendorsListVendorInvoices(
  *
  * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
+ * **Permissions.** Requires the `invoices.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * invoice.line_items
- * invoice.may_pay_invoice
+ * - `invoice.invoice_type`
+ * - `invoice.custom_fields`
+ * - `invoice.line_items`
+ * - `invoice.invoice_transactions`
+ * - `invoice.representative`
+ * - `invoice.payment_profile`
+ * - `invoice.may_pay_invoice`
+ * - `invoice.shareback_system`
+ * - `line_items.details`
+ * - `line_items.product`
+ * - `line_items.variant`
+ * - `invoice_transactions.payee`
+ * - `invoice_transactions.payment_profile`
+ *
+ * Unrecognised values are ignored.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
@@ -151,10 +181,25 @@ export function useVendorsListVendorInvoicesSuspense(
  *
  * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
+ * **Permissions.** Requires the `invoices.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * invoice.line_items
- * invoice.may_pay_invoice
+ * - `invoice.invoice_type`
+ * - `invoice.custom_fields`
+ * - `invoice.line_items`
+ * - `invoice.invoice_transactions`
+ * - `invoice.representative`
+ * - `invoice.payment_profile`
+ * - `invoice.may_pay_invoice`
+ * - `invoice.shareback_system`
+ * - `line_items.details`
+ * - `line_items.product`
+ * - `line_items.variant`
+ * - `invoice_transactions.payee`
+ * - `invoice_transactions.payment_profile`
+ *
+ * Unrecognised values are ignored.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
@@ -201,10 +246,25 @@ export function useVendorsListVendorInvoicesInfinite(
  *
  * Deprecated: use `GET /invoices` instead, which supports both vendors and other roles through role-based scoping and the `id` query parameter for vendors.
  *
+ * **Permissions.** Requires the `invoices.view` permission.
+ *
  * Available `expand` scopes are:
  *
- * invoice.line_items
- * invoice.may_pay_invoice
+ * - `invoice.invoice_type`
+ * - `invoice.custom_fields`
+ * - `invoice.line_items`
+ * - `invoice.invoice_transactions`
+ * - `invoice.representative`
+ * - `invoice.payment_profile`
+ * - `invoice.may_pay_invoice`
+ * - `invoice.shareback_system`
+ * - `line_items.details`
+ * - `line_items.product`
+ * - `line_items.variant`
+ * - `invoice_transactions.payee`
+ * - `invoice_transactions.payment_profile`
+ *
+ * Unrecognised values are ignored.
  *
  * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */

package/src/react-query/vendorsListVendorJobTitles.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorJobTitlesQueryError =
  *
  * @remarks
  * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorJobTitles(
   request: operations.ListVendorJobTitlesRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorJobTitles(
  *
  * @remarks
  * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorJobTitlesSuspense(
   request: operations.ListVendorJobTitlesRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorJobTitlesSuspense(
  *
  * @remarks
  * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorJobTitlesInfinite(
   request: operations.ListVendorJobTitlesRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorJobTitlesInfinite(
  *
  * @remarks
  * List valid job titles for Vendors. This can be used during sign up or in a filter.
+ *
+ * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
  */
 export function useVendorsListVendorJobTitlesInfiniteSuspense(
   request: operations.ListVendorJobTitlesRequest,

package/src/react-query/vendorsListVendorManagedByCompanies.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorManagedByCompaniesQueryError =
  *
  * @remarks
  * List of companies managing the vendor
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorManagedByCompanies(
   request: operations.ListVendorManagedByCompaniesRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorManagedByCompanies(
  *
  * @remarks
  * List of companies managing the vendor
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorManagedByCompaniesSuspense(
   request: operations.ListVendorManagedByCompaniesRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorManagedByCompaniesSuspense(
  *
  * @remarks
  * List of companies managing the vendor
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorManagedByCompaniesInfinite(
   request: operations.ListVendorManagedByCompaniesRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorManagedByCompaniesInfinite(
  *
  * @remarks
  * List of companies managing the vendor
+ *
+ * **Permissions.** Requires the `vendors.view` permission.
  */
 export function useVendorsListVendorManagedByCompaniesInfiniteSuspense(
   request: operations.ListVendorManagedByCompaniesRequest,

package/src/react-query/vendorsListVendorScrubDetails.ts

@@ -57,6 +57,8 @@ export type VendorsListVendorScrubDetailsQueryError =
  *
  * @remarks
  * List 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 useVendorsListVendorScrubDetails(
   request: operations.ListVendorScrubDetailsRequest,
@@ -84,6 +86,8 @@ export function useVendorsListVendorScrubDetails(
  *
  * @remarks
  * List 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 useVendorsListVendorScrubDetailsSuspense(
   request: operations.ListVendorScrubDetailsRequest,

package/src/react-query/vendorsListVendorScrubPackages.ts

@@ -76,6 +76,8 @@ export type VendorsListVendorScrubPackagesQueryError =
  *
  * @remarks
  * List vendor scrub packages
+ *
+ * **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 useVendorsListVendorScrubPackages(
   request: operations.ListVendorScrubPackagesRequest,
@@ -103,6 +105,8 @@ export function useVendorsListVendorScrubPackages(
  *
  * @remarks
  * List vendor scrub packages
+ *
+ * **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 useVendorsListVendorScrubPackagesSuspense(
   request: operations.ListVendorScrubPackagesRequest,
@@ -130,6 +134,8 @@ export function useVendorsListVendorScrubPackagesSuspense(
  *
  * @remarks
  * List vendor scrub packages
+ *
+ * **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 useVendorsListVendorScrubPackagesInfinite(
   request: operations.ListVendorScrubPackagesRequest,
@@ -171,6 +177,8 @@ export function useVendorsListVendorScrubPackagesInfinite(
  *
  * @remarks
  * List vendor scrub packages
+ *
+ * **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 useVendorsListVendorScrubPackagesInfiniteSuspense(
   request: operations.ListVendorScrubPackagesRequest,