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

package/dist/esm/sdk/vendors.js

@@ -27,6 +27,7 @@ import { vendorsGetVendorInvoiceDetails } from "../funcs/vendorsGetVendorInvoice
 import { vendorsGetVendorInvoiceReceipt } from "../funcs/vendorsGetVendorInvoiceReceipt.js";
 import { vendorsGetVendorLegalName } from "../funcs/vendorsGetVendorLegalName.js";
 import { vendorsGetVendorPaymentResponsibility } from "../funcs/vendorsGetVendorPaymentResponsibility.js";
+import { vendorsGetVendorScreeningQuestions } from "../funcs/vendorsGetVendorScreeningQuestions.js";
 import { vendorsGetVendorsDetails } from "../funcs/vendorsGetVendorsDetails.js";
 import { vendorsGetVendorsExportStatus } from "../funcs/vendorsGetVendorsExportStatus.js";
 import { vendorsGetVendorTargetFacilities } from "../funcs/vendorsGetVendorTargetFacilities.js";
@@ -72,41 +73,45 @@ export class Vendors extends ClientSDK {
      * 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.
      *
+     * **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.custom_fields
-     * vendor.last_scanned
-     *
-     * Subscription expand scopes (require vendor.credentialing_subscription):
-     *
-     * 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
+     * - `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`.
      */
     async listVendors(request, options) {
         return unwrapResultIterator(vendorsListVendors(this, request, options));
@@ -120,6 +125,12 @@ export class Vendors extends ClientSDK {
      * `company_id` is optional for company managers — it defaults to their own company.
      * All other callers must provide `company_id`. The caller must have access to the
      * specified company (verified via scoped access policy) and the `vendors:add` permission.
+     *
+     * `zip` is cross-checked against `state`: 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.
+     *
+     * **Permissions.** Requires the `vendors.add` permission.
      */
     async createVendor(request, options) {
         return unwrapAsync(vendorsCreateVendor(this, request, options));
@@ -129,6 +140,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Create an initial vendor registration. Once successful, the vendor will be able to continue to filling out the rest of their onboarding profile.
+     *
+     * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
      */
     async createVendorRegistration(request, options) {
         return unwrapAsync(vendorsCreateVendorRegistration(this, request, options));
@@ -138,6 +151,8 @@ export class Vendors extends ClientSDK {
      *
      * @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.
      */
     async listVendorJobTitles(request, options) {
         return unwrapResultIterator(vendorsListVendorJobTitles(this, request, options));
@@ -147,6 +162,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * List vendor types.
+     *
+     * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
      */
     async listVendorTypes(request, options) {
         return unwrapResultIterator(vendorsListVendorTypes(this, request, options));
@@ -159,6 +176,8 @@ export class Vendors extends ClientSDK {
      * company manager's company, or by the vendor themselves. Each `_user_id` field
      * indicates which party is responsible for that payment category; `null` means
      * responsibility defaults to the vendor.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async getVendorPaymentResponsibility(request, options) {
         return unwrapAsync(vendorsGetVendorPaymentResponsibility(this, request, options));
@@ -172,6 +191,8 @@ export class Vendors extends ClientSDK {
      * 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.
      */
     async updateVendorPaymentResponsibility(request, options) {
         return unwrapAsync(vendorsUpdateVendorPaymentResponsibility(this, request, options));
@@ -181,6 +202,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Lists vendor credentials, required credentials, and company credentials. Utilized in Vendor Dashboard.
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async listVendorCredentials(request, options) {
         return unwrapResultIterator(vendorsListVendorCredentials(this, request, options));
@@ -191,34 +214,40 @@ export class Vendors extends ClientSDK {
      * @remarks
      * Get Vendor Credential details
      *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
+     *
      * Available `expand` scopes are:
-     *   - vendor_credential.credential
-     *   - vendor_credential.vendor
-     *   - vendor_credential.invoice
-     *   - vendor_credential.quote
-     *   - vendor_credential.vendor_credential_files
-     *   - vendor_credential.latest_vendor_credential_id
-     *   - vendor_credential.previously_approved
-     *   - vendor_credential.unsatisfied_dependencies
-     *   - vendor_credential.allow_expediting
-     *   - vendor_credential.unpaid_expedited_invoice_id
-     *   - vendor_credential.expedited_offers
-     *   - vendor_credential.background_check_results
-     *   - vendor_credential.vendor_credential_default_status
-     *   - vendor_credential.vendor_credential_data_requests
-     *   - vendor_credential.credential_variants
-     *   - vendor_credential.targets_chop
-     *   - vendor_credential.total_pending_credentials
-     *   - vendor_credential.background_check_provider_id
-     *   - vendor_credential.requires_invoice
-     *   - vendor_credential.credential_pricing_options
-     *   - 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
+     *
+     * - `vendor_credential.credential`
+     * - `vendor_credential.vendor`
+     * - `vendor_credential.invoice`
+     * - `vendor_credential.quote`
+     * - `vendor_credential.vendor_credential_files`
+     * - `vendor_credential.latest_vendor_credential_id`
+     * - `vendor_credential.previously_approved`
+     * - `vendor_credential.unsatisfied_dependencies`
+     * - `vendor_credential.allow_expediting`
+     * - `vendor_credential.unpaid_expedited_invoice_id`
+     * - `vendor_credential.expedited_offers`
+     * - `vendor_credential.background_check_results`
+     * - `vendor_credential.vendor_credential_default_status`
+     * - `vendor_credential.vendor_credential_data_requests`
+     * - `vendor_credential.credential_variants`
+     * - `vendor_credential.targets_chop`
+     * - `vendor_credential.total_pending_credentials`
+     * - `vendor_credential.background_check_provider_id`
+     * - `vendor_credential.requires_invoice`
+     * - `vendor_credential.credential_pricing_options`
+     * - `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`
+     * - `background_check_results.pdf_uris`
+     *
+     * Any other value is rejected with `422 Unprocessable Entity`.
      */
     async getVendorCredentialDetails(request, options) {
         return unwrapAsync(vendorsGetVendorCredentialDetails(this, request, options));
@@ -228,6 +257,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Update vendor credential data
+     *
+     * **Permissions.** Requires the `vendor_credentials.edit` permission.
      */
     async updateVendorCredentialData(request, options) {
         return unwrapAsync(vendorsUpdateVendorCredentialData(this, request, options));
@@ -238,10 +269,14 @@ export class Vendors extends ClientSDK {
      * @remarks
      * Retrieve an individual vendor credential file.
      *
+     * **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.
      */
     async getVendorCredentialFile(request, options) {
         return unwrapAsync(vendorsGetVendorCredentialFile(this, request, options));
@@ -251,6 +286,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will update the vendor credential file properties
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async updateVendorCredentialFile(request, options) {
         return unwrapAsync(vendorsUpdateVendorCredentialFile(this, request, options));
@@ -260,6 +297,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will delete the vendor credential file
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async deleteVendorCredentialFile(request, options) {
         return unwrapAsync(vendorsDeleteVendorCredentialFile(this, request, options));
@@ -269,6 +308,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Get vendor legal name
+     *
+     * **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.
      */
     async getVendorLegalName(request, options) {
         return unwrapAsync(vendorsGetVendorLegalName(this, request, options));
@@ -278,6 +319,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will decline vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async declineVendorCredential(request, options) {
         return unwrapAsync(vendorsDeclineVendorCredential(this, request, options));
@@ -287,6 +330,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will accept vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async acceptVendorCredential(request, options) {
         return unwrapAsync(vendorsAcceptVendorCredential(this, request, options));
@@ -296,6 +341,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will check 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.
      */
     async checkDownloadCode(request, options) {
         return unwrapAsync(vendorsCheckDownloadCode(this, request, options));
@@ -305,6 +352,8 @@ export class Vendors extends ClientSDK {
      *
      * @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.
      */
     async sendDownloadCode(request, options) {
         return unwrapAsync(vendorsSendDownloadCode(this, request, options));
@@ -315,10 +364,14 @@ export class Vendors extends ClientSDK {
      * @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.
      */
     async listVendorCredentialFiles(request, options) {
         return unwrapAsync(vendorsListVendorCredentialFiles(this, request, options));
@@ -328,6 +381,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will add a new vendor credential file
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async addVendorCredentialFile(request, options) {
         return unwrapAsync(vendorsAddVendorCredentialFile(this, request, options));
@@ -337,6 +392,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will submit vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async submitVendorCredential(request, options) {
         return unwrapAsync(vendorsSubmitVendorCredential(this, request, options));
@@ -346,6 +403,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will create or update BackgroundCheckResults
+     *
+     * **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.
      */
     async createOrUpdateBcr(request, options) {
         return unwrapAsync(vendorsCreateOrUpdateBcr(this, request, options));
@@ -355,6 +414,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will submit vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.add` permission.
      */
     async createNewVendorCredentialVersion(request, options) {
         return unwrapAsync(vendorsCreateNewVendorCredentialVersion(this, request, options));
@@ -364,6 +425,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Lists vendor credentials history
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async listVendorCredentialHistory(request, options) {
         return unwrapResultIterator(vendorsListVendorCredentialHistory(this, request, options));
@@ -374,10 +437,14 @@ export class Vendors extends ClientSDK {
      * @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.
      */
     async listVendorCredentialDataRequests(request, options) {
         return unwrapAsync(vendorsListVendorCredentialDataRequests(this, request, options));
@@ -387,6 +454,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * For vendors who have a paid 24-hour expedite credentials invoice, get the remaining time (in seconds) for which submitted credentials will be expedited.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async expediteTimeRemaining(request, options) {
         return unwrapAsync(vendorsExpediteTimeRemaining(this, request, options));
@@ -397,9 +466,19 @@ export class Vendors extends ClientSDK {
      * @remarks
      * Get vendor subscription
      *
+     * **Permissions.** Requires the `vendors.view` permission.
+     *
      * Available `expand` scopes are:
      *
-     * subscription.expedited_offer
+     * - `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`
+     *
+     * Unrecognised values are ignored. Every scope except `subscription.expedited_offers` is applied automatically, so passing them has no additional effect.
      */
     async getSubscription(request, options) {
         return unwrapAsync(vendorsGetSubscription(this, request, options));
@@ -412,6 +491,8 @@ export class Vendors extends ClientSDK {
      * and/or target facilities. If the new selection increases the subscription
      * price, an invoice is created and the payment profile is charged; the
      * response includes the invoice id.
+     *
+     * **Permissions.** Requires the `vendor_transactions.add` permission.
      */
     async changeSubscription(request, options) {
         return unwrapAsync(vendorsChangeSubscription(this, request, options));
@@ -424,10 +505,25 @@ export class Vendors extends ClientSDK {
      *
      * 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.
      */
@@ -439,6 +535,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Get invoice receipt for vendor
+     *
+     * **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.
      */
     async getVendorInvoiceReceipt(request, options) {
         return unwrapAsync(vendorsGetVendorInvoiceReceipt(this, request, options));
@@ -447,14 +545,30 @@ export class Vendors extends ClientSDK {
      * Get vendor invoice details
      *
      * @remarks
-     * Retrieve an individual vendor invoice detais.
+     * Retrieve an individual vendor invoice's details.
+     *
+     * **Permissions.** Requires the `invoices.view` permission.
+     *
+     * **Permissions.** Requires the `invoices.view` permission.
      *
      * Available `expand` scopes are:
      *
-     * invoice.line_items
-     * invoice.invoice_transactions
-     * invoice.may_pay_invoice
-     * invoice_transactions.payee
+     * - `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`
+     * - `invoice.associated_credentials`
+     *
+     * Unrecognised values are ignored.
      */
     async getVendorInvoiceDetails(request, options) {
         return unwrapAsync(vendorsGetVendorInvoiceDetails(this, request, options));
@@ -464,6 +578,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * List the facilities for the vendor
+     *
+     * **Permissions.** Requires the `facilities.view` permission.
      */
     async listVendorFacilityStatuses(request, options) {
         return unwrapResultIterator(vendorsListVendorFacilityStatuses(this, request, options));
@@ -473,6 +589,8 @@ export class Vendors extends ClientSDK {
      *
      * @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.
      */
     async listVendorScrubPurchases(request, options) {
         return unwrapResultIterator(vendorsListVendorScrubPurchases(this, request, options));
@@ -482,6 +600,8 @@ export class Vendors extends ClientSDK {
      *
      * @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.
      */
     async listVendorScrubDetails(request, options) {
         return unwrapAsync(vendorsListVendorScrubDetails(this, request, options));
@@ -491,6 +611,8 @@ export class Vendors extends ClientSDK {
      *
      * @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.
      */
     async updateVendorScrubDetails(request, options) {
         return unwrapAsync(vendorsUpdateVendorScrubDetails(this, request, options));
@@ -500,6 +622,8 @@ export class Vendors extends ClientSDK {
      *
      * @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.
      */
     async listVendorScrubPackages(request, options) {
         return unwrapResultIterator(vendorsListVendorScrubPackages(this, request, options));
@@ -510,31 +634,39 @@ export class Vendors extends ClientSDK {
      * @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`.
      */
     async getVendorsDetails(request, options) {
         return unwrapAsync(vendorsGetVendorsDetails(this, request, options));
@@ -550,13 +682,23 @@ export class Vendors extends ClientSDK {
      * 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.
      */
     async updateVendorDetails(request, options) {
         return unwrapAsync(vendorsUpdateVendorDetails(this, request, options));
@@ -566,6 +708,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * List the credits for the vendor. Defaults to chronological order (oldest first).
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async listVendorCredits(request, options) {
         return unwrapResultIterator(vendorsListVendorCredits(this, request, options));
@@ -583,6 +727,8 @@ export class Vendors extends ClientSDK {
      * 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.
      */
     async listVendorAdditionalFacilityFields(request, options) {
@@ -602,6 +748,8 @@ export class Vendors extends ClientSDK {
      *
      * Accepts a numeric vendor ID, `me` for the authenticated vendor,
      * or an active QR code (format: contains hyphens).
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async listVendorCustomFields(request, options) {
         return unwrapAsync(vendorsListVendorCustomFields(this, request, options));
@@ -618,6 +766,8 @@ export class Vendors extends ClientSDK {
      *
      * Accepts a numeric vendor ID, `me` for the authenticated vendor,
      * or an active QR code (format: contains hyphens).
+     *
+     * **Permissions.** Requires the `vendors.edit` permission.
      */
     async updateVendorCustomField(request, options) {
         return unwrapAsync(vendorsUpdateVendorCustomField(this, request, options));
@@ -627,6 +777,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * List of companies managing the vendor
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async listVendorManagedByCompanies(request, options) {
         return unwrapResultIterator(vendorsListVendorManagedByCompanies(this, request, options));
@@ -636,6 +788,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will add a vendor managed by company
+     *
+     * **Permissions.** Requires the `vendors.edit` permission.
      */
     async addVendorManagedByCompany(request, options) {
         return unwrapAsync(vendorsAddVendorManagedByCompany(this, request, options));
@@ -645,6 +799,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will delete the vendor managed by company
+     *
+     * **Permissions.** Requires the `vendors.edit` permission.
      */
     async deleteVendorManagedByCompany(request, options) {
         return unwrapAsync(vendorsDeleteVendorManagedByCompany(this, request, options));
@@ -654,6 +810,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * It will update the vendor managed by company access rights
+     *
+     * **Permissions.** Requires the `vendors.edit` permission.
      */
     async updateVendorManagedByCompany(request, options) {
         return unwrapAsync(vendorsUpdateVendorManagedByCompany(this, request, options));
@@ -669,6 +827,46 @@ export class Vendors extends ClientSDK {
      * 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.
      */
     async vendorsExport(request, options) {
         return unwrapAsync(vendorsVendorsExport(this, request, options));
@@ -679,6 +877,8 @@ export class Vendors extends ClientSDK {
      * @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.
      */
     async getVendorsExportStatus(request, options) {
         return unwrapAsync(vendorsGetVendorsExportStatus(this, request, options));
@@ -690,6 +890,8 @@ export class Vendors extends ClientSDK {
      * Downloads the exported vendors CSV. When the export is ready the server
      * responds with a 302 redirect to a short-lived presigned S3 URL. If the
      * export job is still running, responds with 202.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async downloadVendorsExport(request, options) {
         return unwrapAsync(vendorsDownloadVendorsExport(this, request, options));
@@ -699,6 +901,8 @@ export class Vendors extends ClientSDK {
      *
      * @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.
      */
     async purchaseScrubCredits(request, options) {
         return unwrapAsync(vendorsPurchaseScrubCredits(this, request, options));
@@ -708,6 +912,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Create vendor company
+     *
+     * **Permissions.** Requires the `companies.add` permission.
      */
     async createVendorCompany(request, options) {
         return unwrapAsync(vendorsCreateVendorCompany(this, request, options));
@@ -717,15 +923,35 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Calculate subscription price
+     *
+     * **Permissions.** Requires the `pricing_models.view` permission.
      */
     async calculateSubscriptionPrice(request, options) {
         return unwrapAsync(vendorsCalculateSubscriptionPrice(this, request, options));
     }
+    /**
+     * List a vendor's target-facility screening questions and answers
+     *
+     * @remarks
+     * Returns every active target-facility screening question that currently applies to the vendor at the given facility, each paired with the vendor's answer when one has been given. Questions that have not been answered are included with a null answer. Read-only; used to review a rep's screening answers.
+     * **Permissions.** Requires the `vendors.view` permission.
+     */
+    async getVendorScreeningQuestions(request, options) {
+        return unwrapAsync(vendorsGetVendorScreeningQuestions(this, request, options));
+    }
     /**
      * Get the next unanswered screening question
      *
      * @remarks
      * Returns the next unanswered screening question for the vendor specified by the vendor_id_or_me path parameter.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
+     *
+     * Available `expand` scopes are:
+     *
+     * - `screening_question.screening_answers`
+     *
+     * Any other value is rejected with `422 Unprocessable Entity`.
      */
     async getNextUnansweredScreeningQuestion(request, options) {
         return unwrapAsync(vendorsGetNextUnansweredScreeningQuestion(this, request, options));
@@ -735,6 +961,15 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Returns a paginated list of target facility rows for the specified vendor, including per-row screening question status.
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
+     *
+     * Available `expand` scopes are:
+     *
+     * - `vendor_target_facility.facility`
+     * - `vendor_target_facility.has_screening_responses`
+     *
+     * Any other value is rejected with `422 Unprocessable Entity`.
      */
     async getVendorTargetFacilities(request, options) {
         return unwrapResultIterator(vendorsGetVendorTargetFacilities(this, request, options));
@@ -744,6 +979,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Cancels an existing handoff with the given QR code.
+     *
+     * **Permissions.** Requires the `vendor_scans.add` permission.
      */
     async cancelHandoff(request, options) {
         return unwrapAsync(vendorsCancelHandoff(this, request, options));
@@ -753,6 +990,8 @@ export class Vendors extends ClientSDK {
      *
      * @remarks
      * Lists files the vendor has uploaded across all their credentials, ordered by upload date descending. Excludes decline-document uploads.
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async getVendorUploadHistory(request, options) {
         return unwrapResultIterator(vendorsGetVendorUploadHistory(this, request, options));
@@ -767,6 +1006,8 @@ export class Vendors extends ClientSDK {
      * must be uploaded. Green Security will process the file asynchronously.
      *
      * Non-Emerald vendors must use `addVendorCredentialFile` instead.
+     *
+     * **Permissions.** Requires the `vendor_credentials.add` permission.
      */
     async addVendorCredentialFileForAutoClassification(request, options) {
         return unwrapAsync(vendorsAddVendorCredentialFileForAutoClassification(this, request, options));