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

package/dist/commonjs/sdk/vendors.js

@@ -30,6 +30,7 @@ const vendorsGetVendorInvoiceDetails_js_1 = require("../funcs/vendorsGetVendorIn
 const vendorsGetVendorInvoiceReceipt_js_1 = require("../funcs/vendorsGetVendorInvoiceReceipt.js");
 const vendorsGetVendorLegalName_js_1 = require("../funcs/vendorsGetVendorLegalName.js");
 const vendorsGetVendorPaymentResponsibility_js_1 = require("../funcs/vendorsGetVendorPaymentResponsibility.js");
+const vendorsGetVendorScreeningQuestions_js_1 = require("../funcs/vendorsGetVendorScreeningQuestions.js");
 const vendorsGetVendorsDetails_js_1 = require("../funcs/vendorsGetVendorsDetails.js");
 const vendorsGetVendorsExportStatus_js_1 = require("../funcs/vendorsGetVendorsExportStatus.js");
 const vendorsGetVendorTargetFacilities_js_1 = require("../funcs/vendorsGetVendorTargetFacilities.js");
@@ -75,41 +76,45 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendors_js_1.vendorsListVendors)(this, request, options));
@@ -123,6 +128,12 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsCreateVendor_js_1.vendorsCreateVendor)(this, request, options));
@@ -132,6 +143,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsCreateVendorRegistration_js_1.vendorsCreateVendorRegistration)(this, request, options));
@@ -141,6 +154,8 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorJobTitles_js_1.vendorsListVendorJobTitles)(this, request, options));
@@ -150,6 +165,8 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorTypes_js_1.vendorsListVendorTypes)(this, request, options));
@@ -162,6 +179,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorPaymentResponsibility_js_1.vendorsGetVendorPaymentResponsibility)(this, request, options));
@@ -175,6 +194,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsUpdateVendorPaymentResponsibility_js_1.vendorsUpdateVendorPaymentResponsibility)(this, request, options));
@@ -184,6 +205,8 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorCredentials_js_1.vendorsListVendorCredentials)(this, request, options));
@@ -194,34 +217,40 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorCredentialDetails_js_1.vendorsGetVendorCredentialDetails)(this, request, options));
@@ -231,6 +260,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * Update vendor credential data
+     *
+     * **Permissions.** Requires the `vendor_credentials.edit` permission.
      */
     async updateVendorCredentialData(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsUpdateVendorCredentialData_js_1.vendorsUpdateVendorCredentialData)(this, request, options));
@@ -241,10 +272,14 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorCredentialFile_js_1.vendorsGetVendorCredentialFile)(this, request, options));
@@ -254,6 +289,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will update the vendor credential file properties
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async updateVendorCredentialFile(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsUpdateVendorCredentialFile_js_1.vendorsUpdateVendorCredentialFile)(this, request, options));
@@ -263,6 +300,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will delete the vendor credential file
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async deleteVendorCredentialFile(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsDeleteVendorCredentialFile_js_1.vendorsDeleteVendorCredentialFile)(this, request, options));
@@ -272,6 +311,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorLegalName_js_1.vendorsGetVendorLegalName)(this, request, options));
@@ -281,6 +322,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will decline vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async declineVendorCredential(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsDeclineVendorCredential_js_1.vendorsDeclineVendorCredential)(this, request, options));
@@ -290,6 +333,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will accept vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async acceptVendorCredential(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsAcceptVendorCredential_js_1.vendorsAcceptVendorCredential)(this, request, options));
@@ -299,6 +344,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsCheckDownloadCode_js_1.vendorsCheckDownloadCode)(this, request, options));
@@ -308,6 +355,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsSendDownloadCode_js_1.vendorsSendDownloadCode)(this, request, options));
@@ -318,10 +367,14 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsListVendorCredentialFiles_js_1.vendorsListVendorCredentialFiles)(this, request, options));
@@ -331,6 +384,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will add a new vendor credential file
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async addVendorCredentialFile(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsAddVendorCredentialFile_js_1.vendorsAddVendorCredentialFile)(this, request, options));
@@ -340,6 +395,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will submit vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async submitVendorCredential(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsSubmitVendorCredential_js_1.vendorsSubmitVendorCredential)(this, request, options));
@@ -349,6 +406,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsCreateOrUpdateBcr_js_1.vendorsCreateOrUpdateBcr)(this, request, options));
@@ -358,6 +417,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will submit vendor credential
+     *
+     * **Permissions.** Requires the `vendor_credentials.add` permission.
      */
     async createNewVendorCredentialVersion(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsCreateNewVendorCredentialVersion_js_1.vendorsCreateNewVendorCredentialVersion)(this, request, options));
@@ -367,6 +428,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * Lists vendor credentials history
+     *
+     * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     async listVendorCredentialHistory(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorCredentialHistory_js_1.vendorsListVendorCredentialHistory)(this, request, options));
@@ -377,10 +440,14 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsListVendorCredentialDataRequests_js_1.vendorsListVendorCredentialDataRequests)(this, request, options));
@@ -390,6 +457,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsExpediteTimeRemaining_js_1.vendorsExpediteTimeRemaining)(this, request, options));
@@ -400,9 +469,19 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetSubscription_js_1.vendorsGetSubscription)(this, request, options));
@@ -415,6 +494,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsChangeSubscription_js_1.vendorsChangeSubscription)(this, request, options));
@@ -427,10 +508,25 @@ class Vendors extends sdks_js_1.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.
      */
@@ -442,6 +538,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorInvoiceReceipt_js_1.vendorsGetVendorInvoiceReceipt)(this, request, options));
@@ -450,14 +548,30 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorInvoiceDetails_js_1.vendorsGetVendorInvoiceDetails)(this, request, options));
@@ -467,6 +581,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * List the facilities for the vendor
+     *
+     * **Permissions.** Requires the `facilities.view` permission.
      */
     async listVendorFacilityStatuses(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorFacilityStatuses_js_1.vendorsListVendorFacilityStatuses)(this, request, options));
@@ -476,6 +592,8 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorScrubPurchases_js_1.vendorsListVendorScrubPurchases)(this, request, options));
@@ -485,6 +603,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsListVendorScrubDetails_js_1.vendorsListVendorScrubDetails)(this, request, options));
@@ -494,6 +614,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsUpdateVendorScrubDetails_js_1.vendorsUpdateVendorScrubDetails)(this, request, options));
@@ -503,6 +625,8 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorScrubPackages_js_1.vendorsListVendorScrubPackages)(this, request, options));
@@ -513,31 +637,39 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorsDetails_js_1.vendorsGetVendorsDetails)(this, request, options));
@@ -553,13 +685,23 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsUpdateVendorDetails_js_1.vendorsUpdateVendorDetails)(this, request, options));
@@ -569,6 +711,8 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorCredits_js_1.vendorsListVendorCredits)(this, request, options));
@@ -586,6 +730,8 @@ class Vendors extends sdks_js_1.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) {
@@ -605,6 +751,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsListVendorCustomFields_js_1.vendorsListVendorCustomFields)(this, request, options));
@@ -621,6 +769,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsUpdateVendorCustomField_js_1.vendorsUpdateVendorCustomField)(this, request, options));
@@ -630,6 +780,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * List of companies managing the vendor
+     *
+     * **Permissions.** Requires the `vendors.view` permission.
      */
     async listVendorManagedByCompanies(request, options) {
         return (0, operations_js_1.unwrapResultIterator)((0, vendorsListVendorManagedByCompanies_js_1.vendorsListVendorManagedByCompanies)(this, request, options));
@@ -639,6 +791,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will add a vendor managed by company
+     *
+     * **Permissions.** Requires the `vendors.edit` permission.
      */
     async addVendorManagedByCompany(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsAddVendorManagedByCompany_js_1.vendorsAddVendorManagedByCompany)(this, request, options));
@@ -648,6 +802,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will delete the vendor managed by company
+     *
+     * **Permissions.** Requires the `vendors.edit` permission.
      */
     async deleteVendorManagedByCompany(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsDeleteVendorManagedByCompany_js_1.vendorsDeleteVendorManagedByCompany)(this, request, options));
@@ -657,6 +813,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * It will update the vendor managed by company access rights
+     *
+     * **Permissions.** Requires the `vendors.edit` permission.
      */
     async updateVendorManagedByCompany(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsUpdateVendorManagedByCompany_js_1.vendorsUpdateVendorManagedByCompany)(this, request, options));
@@ -672,6 +830,46 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsVendorsExport_js_1.vendorsVendorsExport)(this, request, options));
@@ -682,6 +880,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorsExportStatus_js_1.vendorsGetVendorsExportStatus)(this, request, options));
@@ -693,6 +893,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsDownloadVendorsExport_js_1.vendorsDownloadVendorsExport)(this, request, options));
@@ -702,6 +904,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsPurchaseScrubCredits_js_1.vendorsPurchaseScrubCredits)(this, request, options));
@@ -711,6 +915,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * Create vendor company
+     *
+     * **Permissions.** Requires the `companies.add` permission.
      */
     async createVendorCompany(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsCreateVendorCompany_js_1.vendorsCreateVendorCompany)(this, request, options));
@@ -720,15 +926,35 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * Calculate subscription price
+     *
+     * **Permissions.** Requires the `pricing_models.view` permission.
      */
     async calculateSubscriptionPrice(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsCalculateSubscriptionPrice_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetVendorScreeningQuestions_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsGetNextUnansweredScreeningQuestion_js_1.vendorsGetNextUnansweredScreeningQuestion)(this, request, options));
@@ -738,6 +964,15 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsGetVendorTargetFacilities_js_1.vendorsGetVendorTargetFacilities)(this, request, options));
@@ -747,6 +982,8 @@ class Vendors extends sdks_js_1.ClientSDK {
      *
      * @remarks
      * Cancels an existing handoff with the given QR code.
+     *
+     * **Permissions.** Requires the `vendor_scans.add` permission.
      */
     async cancelHandoff(request, options) {
         return (0, fp_js_1.unwrapAsync)((0, vendorsCancelHandoff_js_1.vendorsCancelHandoff)(this, request, options));
@@ -756,6 +993,8 @@ class Vendors extends sdks_js_1.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 (0, operations_js_1.unwrapResultIterator)((0, vendorsGetVendorUploadHistory_js_1.vendorsGetVendorUploadHistory)(this, request, options));
@@ -770,6 +1009,8 @@ class Vendors extends sdks_js_1.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 (0, fp_js_1.unwrapAsync)((0, vendorsAddVendorCredentialFileForAutoClassification_js_1.vendorsAddVendorCredentialFileForAutoClassification)(this, request, options));