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

package/dist/commonjs/sdk/vendors.d.ts

@@ -9,13 +9,13 @@ export declare class Vendors extends ClientSDK {
      * @remarks
      * Returns a paginated list of vendors.
      *
-     * External vendors are 3rd parties who have consented to have their profile managed by companies in our system.
+     * External vendors are third parties who have consented to have their profile managed by companies on the platform.
      * 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:
+     * The `expand` parameter accepts the following scopes:
      *
      * - `vendor.user`
      * - `vendor.vendor_type`
@@ -51,7 +51,7 @@ export declare class Vendors extends ClientSDK {
      * - `subscription.next_financial_status`
      * - `subscription.expedited_offers`
      *
-     * Any other value is rejected with `422 Unprocessable Entity`.
+     * The API rejects any other value with `422 Unprocessable Entity`.
      */
     listVendors(request: operations.ListVendorsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListVendorsResponse, {
         page: number;
@@ -62,12 +62,12 @@ export declare class Vendors extends ClientSDK {
      * @remarks
      * Creates a new vendor account linked to the specified company.
      *
-     * `company_id` is optional for company managers — it defaults to their own company.
+     * `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.
+     * specified company (verified through 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 API cross-checks `zip` against `state`. It rejects a code that is not shaped like a real postal
+     * code, or that provably belongs to a different state, with `422` naming
      * the correct state.
      *
      * **Permissions.** Requires the `vendors.add` permission.
@@ -77,18 +77,18 @@ export declare class Vendors extends ClientSDK {
      * Create vendor registration
      *
      * @remarks
-     * Create an initial vendor registration. Once successful, the vendor will be able to continue to filling out the rest of their onboarding profile.
+     * Creates an initial vendor registration. After the registration succeeds, the vendor can continue filling out the rest of their onboarding profile.
      *
-     * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
+     * **Permissions.** No authentication required. The API accepts a token if supplied, but also allows anonymous callers.
      */
     createVendorRegistration(request: operations.CreateVendorRegistrationRequestBody, options?: RequestOptions): Promise<components.User>;
     /**
      * List vendor job titles
      *
      * @remarks
-     * List valid job titles for Vendors. This can be used during sign up or in a filter.
+     * Lists valid job titles for vendors. Use the list during sign-up or in a filter.
      *
-     * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
+     * **Permissions.** No authentication required. The endpoint accepts a token if you supply one, but anonymous callers are allowed.
      */
     listVendorJobTitles(request: operations.ListVendorJobTitlesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListVendorJobTitlesResponse, {
         page: number;
@@ -97,9 +97,9 @@ export declare class Vendors extends ClientSDK {
      * List vendor types
      *
      * @remarks
-     * List vendor types.
+     * Lists vendor types.
      *
-     * **Permissions.** No authentication required. A token is accepted if supplied, but anonymous callers are allowed.
+     * **Permissions.** No authentication required. The endpoint accepts a token if you supply one, but anonymous callers are allowed.
      */
     listVendorTypes(request: operations.ListVendorTypesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListVendorTypesResponse, {
         page: number;
@@ -123,17 +123,17 @@ export declare class Vendors extends ClientSDK {
      * Partially updates the payment responsibility record for a vendor. Only company
      * managers may call this endpoint. Each supplied `_user_id` must be either the
      * 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.
+     * authenticated manager's own user ID (to claim responsibility). The server leaves omitted fields
+     * unchanged.
      *
      * **Permissions.** Requires the `vendors.edit` permission.
      */
     updateVendorPaymentResponsibility(request: operations.UpdateVendorPaymentResponsibilityRequest, options?: RequestOptions): Promise<operations.UpdateVendorPaymentResponsibilityUpdateVendorPaymentResponsibilityOk>;
     /**
-     * List Vendor Credentials
+     * List vendor credentials
      *
      * @remarks
-     * Lists vendor credentials, required credentials, and company credentials. Utilized in Vendor Dashboard.
+     * Lists vendor credentials, required credentials, and company credentials.
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
@@ -141,14 +141,20 @@ export declare class Vendors extends ClientSDK {
         page: number;
     }>>;
     /**
-     * Get Vendor Credential details
+     * Get vendor credential details
      *
      * @remarks
-     * Get Vendor Credential details
+     * Gets Vendor Credential details
      *
-     * **Permissions.** Requires the `vendor_credentials.view` permission.
+     * **Permissions.** Requires the `vendor_credentials.view` permission. When `vendor_credential.vendor_credential_files`
+     * is expanded, a company manager viewing a vendor-owned credential (not a company-owned one) only
+     * receives the files they personally uploaded on the vendor's behalf.
+     *
+     * For that same restricted company manager, `json_data` is returned as `null` unless they are the
+     * one who first submitted this version of the credential - everything else in the response
+     * (status, dates, notes, credential/invoice/etc.) is unaffected.
      *
-     * Available `expand` scopes are:
+     * The following `expand` scopes are available:
      *
      * - `vendor_credential.credential`
      * - `vendor_credential.vendor`
@@ -179,14 +185,14 @@ export declare class Vendors extends ClientSDK {
      * - `subscription.expedited_offers`
      * - `background_check_results.pdf_uris`
      *
-     * Any other value is rejected with `422 Unprocessable Entity`.
+     * The endpoint rejects any other value with `422 Unprocessable Entity`.
      */
     getVendorCredentialDetails(request: operations.GetVendorCredentialDetailsRequest, options?: RequestOptions): Promise<operations.GetVendorCredentialDetailsGetVendorCredentialDetailsOk>;
     /**
      * Update vendor credential data
      *
      * @remarks
-     * Update vendor credential data
+     * Updates vendor credential data
      *
      * **Permissions.** Requires the `vendor_credentials.edit` permission.
      */
@@ -195,23 +201,27 @@ export declare class Vendors extends ClientSDK {
      * Get vendor credential file
      *
      * @remarks
-     * Retrieve an individual vendor credential file.
+     * Retrieves an individual vendor credential file.
      *
-     * **Permissions.** Requires the `vendor_credentials.view` permission.
+     * **Permissions.** Requires the `vendor_credentials.view` permission. Returns `400` for any file
+     * the caller cannot see, with the same response whether the file does not exist, is outside the
+     * caller's access, or belongs to a different credential. For a company manager on a vendor-owned
+     * credential (not a company-owned one) that includes every file not uploaded by that requesting
+     * manager.
      *
-     * Available `expand` scopes are:
+     * The `expand` parameter accepts these scopes:
      *
      * - `vendor_credential_file.vendor_credential`
      * - `vendor_credential_file.credential_document`
      *
-     * Unrecognised values are ignored.
+     * The API ignores unrecognized values.
      */
     getVendorCredentialFile(request: operations.GetVendorCredentialFileRequest, options?: RequestOptions): Promise<components.VendorCredentialFile>;
     /**
      * Update vendor credential file
      *
      * @remarks
-     * It will update the vendor credential file properties
+     * Updates the vendor credential file properties.
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
@@ -220,25 +230,25 @@ export declare class Vendors extends ClientSDK {
      * Delete vendor credential file
      *
      * @remarks
-     * It will delete the vendor credential file
+     * Deletes the vendor credential file.
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
     deleteVendorCredentialFile(request: operations.DeleteVendorCredentialFileRequest, options?: RequestOptions): Promise<boolean>;
     /**
-     * Get Vendor legal name
+     * Get vendor legal name
      *
      * @remarks
-     * Get vendor legal name
+     * Gets 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.
+     * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission. The caller's role and their relationship to the record determine what the response contains.
      */
     getVendorLegalName(request: operations.GetVendorLegalNameRequest, options?: RequestOptions): Promise<operations.GetVendorLegalNameGetVendorLegalNameOk>;
     /**
      * Decline vendor credential
      *
      * @remarks
-     * It will decline vendor credential
+     * Declines the vendor credential.
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
@@ -247,7 +257,7 @@ export declare class Vendors extends ClientSDK {
      * Accept vendor credential
      *
      * @remarks
-     * It will accept vendor credential
+     * Accepts the vendor credential.
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
@@ -256,41 +266,43 @@ export declare class Vendors extends ClientSDK {
      * Check download code for vendor credential
      *
      * @remarks
-     * It will check download code for vendor credential
+     * Checks the download code for the 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.
+     * **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 the response includes. A company manager checking a code for a vendor-owned credential (not a company-owned one) receives only the `urls` of files they personally uploaded on the vendor's behalf. The legacy single-attachment fallback is never returned to them, because it predates per-file uploader tracking.
      */
     checkDownloadCode(request: operations.CheckDownloadCodeRequest, options?: RequestOptions): Promise<operations.CheckDownloadCodeCheckDownloadCodeOk>;
     /**
      * Send download code for vendor credential
      *
      * @remarks
-     * It will send download code for vendor credential
+     * Sends a download code for the 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.
+     * **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 the response includes.
      */
     sendDownloadCode(request: operations.SendDownloadCodeRequest, options?: RequestOptions): Promise<boolean>;
     /**
-     * List Vendor Credential files
+     * List vendor credential files
      *
      * @remarks
-     * Retrieve an vendor credential files.
+     * Retrieves the files for a vendor credential.
      *
-     * **Permissions.** Requires the `vendor_credentials.view` permission.
+     * **Permissions.** Requires the `vendor_credentials.view` permission. A company manager
+     * viewing a vendor-owned credential (not a company-owned one) only sees files they personally
+     * uploaded on the vendor's behalf, even though they may otherwise manage the vendor.
      *
-     * Available `expand` scopes are:
+     * The following `expand` scopes are available:
      *
      * - `vendor_credential_file.vendor_credential`
      * - `vendor_credential_file.credential_document`
      *
-     * Unrecognised values are ignored.
+     * The endpoint ignores unrecognized values.
      */
     listVendorCredentialFiles(request: operations.ListVendorCredentialFilesRequest, options?: RequestOptions): Promise<Array<components.VendorCredentialFile | null>>;
     /**
      * Add vendor credential file
      *
      * @remarks
-     * It will add a new vendor credential file
+     * Adds a vendor credential file
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
@@ -299,7 +311,7 @@ export declare class Vendors extends ClientSDK {
      * Submit vendor credential
      *
      * @remarks
-     * It will submit vendor credential
+     * Submits the vendor credential.
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      */
@@ -308,27 +320,31 @@ export declare class Vendors extends ClientSDK {
      * Create or update BackgroundCheckResults
      *
      * @remarks
-     * It will create or update BackgroundCheckResults
+     * Creates or updates 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.
+     * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission: the caller's role and their relationship to the record determine what the response contains.
      */
     createOrUpdateBcr(request: operations.CreateOrUpdateBcrRequest, options?: RequestOptions): Promise<boolean>;
     /**
      * Create new vendor credential version
      *
      * @remarks
-     * It will submit vendor credential
+     * Creates a new version of the vendor credential.
      *
      * **Permissions.** Requires the `vendor_credentials.add` permission.
      */
     createNewVendorCredentialVersion(request: operations.CreateNewVendorCredentialVersionRequestBody, options?: RequestOptions): Promise<operations.CreateNewVendorCredentialVersionCreateNewVendorCredentialVersionOk>;
     /**
-     * List Vendor Credential History
+     * List vendor credential history
      *
      * @remarks
      * Lists vendor credentials history
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
+     *
+     * Each item's `submitted_by_current_user` says whether the calling user is the one who first
+     * submitted that version, so a vendor or company manager can tell their own submissions apart
+     * from ones made by someone else with access to the same credential.
      */
     listVendorCredentialHistory(request: operations.ListVendorCredentialHistoryRequest, options?: RequestOptions): Promise<PageIterator<operations.ListVendorCredentialHistoryResponse, {
         page: number;
@@ -337,23 +353,23 @@ export declare class Vendors extends ClientSDK {
      * List vendor credential data requests
      *
      * @remarks
-     * Retrieve an vendor credential data requests.
+     * Retrieves the data requests for a vendor credential.
      *
      * **Permissions.** Requires the `vendor_credentials.view` permission.
      *
-     * Available `expand` scopes are:
+     * The `expand` parameter accepts the following scopes:
      *
      * - `vendor_credential_data_request.vendor_credential`
      * - `vendor_credential_data_request.data_request`
      *
-     * Unrecognised values are ignored.
+     * The server ignores unrecognized values.
      */
     listVendorCredentialDataRequests(request: operations.ListVendorCredentialDataRequestsRequest, options?: RequestOptions): Promise<Array<components.VendorCredentialDataRequest | null>>;
     /**
      * Expedite time remaining
      *
      * @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.
+     * Gets the remaining time, in seconds, that the server expedites submitted credentials for vendors who have a paid 24-hour expedite credentials invoice.
      *
      * **Permissions.** Requires the `vendors.view` permission.
      */
@@ -362,11 +378,11 @@ export declare class Vendors extends ClientSDK {
      * Vendor subscription
      *
      * @remarks
-     * Get vendor subscription
+     * Gets vendor subscription
      *
      * **Permissions.** Requires the `vendors.view` permission.
      *
-     * Available `expand` scopes are:
+     * The `expand` parameter accepts the following scopes:
      *
      * - `subscription.date_ends`
      * - `subscription.variant_title`
@@ -376,16 +392,16 @@ export declare class Vendors extends ClientSDK {
      * - `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.
+     * The server ignores unrecognized values. It applies every scope except `subscription.expedited_offers` automatically, so passing them changes nothing.
      */
     getSubscription(request: operations.GetSubscriptionRequest, options?: RequestOptions): Promise<operations.GetSubscriptionGetSubscriptionOk>;
     /**
      * Change subscription
      *
      * @remarks
-     * Change a vendor's credentialing subscription by updating the vendor type
-     * and/or target facilities. If the new selection increases the subscription
-     * price, an invoice is created and the payment profile is charged; the
+     * Changes a vendor's credentialing subscription by updating the vendor type,
+     * the target facilities, or both. If the selection increases the subscription
+     * price, the server creates an invoice and charges the payment profile; the
      * response includes the invoice id.
      *
      * **Permissions.** Requires the `vendor_transactions.add` permission.
@@ -395,13 +411,13 @@ export declare class Vendors extends ClientSDK {
      * List vendor invoices
      *
      * @remarks
-     * List invoices for Vendors.
+     * Deprecated. Use `GET /invoices` instead. Lists invoices for vendors.
      *
      * 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:
+     * The `expand` parameter accepts the following scopes:
      *
      * - `invoice.invoice_type`
      * - `invoice.custom_fields`
@@ -417,7 +433,7 @@ export declare class Vendors extends ClientSDK {
      * - `invoice_transactions.payee`
      * - `invoice_transactions.payment_profile`
      *
-     * Unrecognised values are ignored.
+     * The server ignores unrecognized values.
      *
      * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
      */
@@ -428,22 +444,22 @@ export declare class Vendors extends ClientSDK {
      * Get invoice receipt for vendor
      *
      * @remarks
-     * Get invoice receipt for vendor
+     * Gets 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.
+     * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission. The caller's role and their relationship to the record determine what the response contains.
      */
     getVendorInvoiceReceipt(request: operations.GetVendorInvoiceReceiptRequest, options?: RequestOptions): Promise<operations.GetVendorInvoiceReceiptGetVendorInvoiceReceiptOk>;
     /**
      * Get vendor invoice details
      *
      * @remarks
-     * Retrieve an individual vendor invoice's details.
+     * Retrieves an individual vendor invoice's details.
      *
      * **Permissions.** Requires the `invoices.view` permission.
      *
      * **Permissions.** Requires the `invoices.view` permission.
      *
-     * Available `expand` scopes are:
+     * The `expand` parameter accepts the following scopes:
      *
      * - `invoice.invoice_type`
      * - `invoice.custom_fields`
@@ -460,14 +476,14 @@ export declare class Vendors extends ClientSDK {
      * - `invoice_transactions.payment_profile`
      * - `invoice.associated_credentials`
      *
-     * Unrecognised values are ignored.
+     * The server ignores unrecognized values.
      */
     getVendorInvoiceDetails(request: operations.GetVendorInvoiceDetailsRequest, options?: RequestOptions): Promise<components.Invoice>;
     /**
      * List vendor facility statuses
      *
      * @remarks
-     * List the facilities for the vendor
+     * Lists the facilities for the vendor
      *
      * **Permissions.** Requires the `facilities.view` permission.
      */
@@ -478,9 +494,9 @@ export declare class Vendors extends ClientSDK {
      * List vendor scrub purchases
      *
      * @remarks
-     * List vendor scrub purchases
+     * Lists 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.
+     * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission. The caller's role and their relationship to the record determine what the response contains.
      */
     listVendorScrubPurchases(request: operations.ListVendorScrubPurchasesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListVendorScrubPurchasesResponse, {
         page: number;
@@ -489,27 +505,27 @@ export declare class Vendors extends ClientSDK {
      * List vendor scrub details
      *
      * @remarks
-     * List vendor scrub details
+     * Lists 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.
+     * **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 the endpoint returns.
      */
     listVendorScrubDetails(request: operations.ListVendorScrubDetailsRequest, options?: RequestOptions): Promise<components.VendorScrubDetails>;
     /**
      * Update vendor scrub details
      *
      * @remarks
-     * Update vendor scrub details
+     * Updates 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.
+     * **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 the endpoint returns.
      */
     updateVendorScrubDetails(request: operations.UpdateVendorScrubDetailsRequest, options?: RequestOptions): Promise<boolean>;
     /**
      * List vendor scrub packages
      *
      * @remarks
-     * List vendor scrub packages
+     * Lists 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.
+     * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission. The caller's role and their relationship to the record determine what the response contains.
      */
     listVendorScrubPackages(request: operations.ListVendorScrubPackagesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListVendorScrubPackagesResponse, {
         page: number;
@@ -518,11 +534,11 @@ export declare class Vendors extends ClientSDK {
      * Get vendors details
      *
      * @remarks
-     * Retrieve an individual vendor details.
+     * Retrieves an individual vendor details.
      *
      * **Permissions.** Requires the `vendors.view` permission.
      *
-     * Available `expand` scopes are:
+     * The following `expand` scopes are available:
      *
      * - `vendor.user`
      * - `vendor.vendor_type`
@@ -552,34 +568,34 @@ export declare class Vendors extends ClientSDK {
      * - `vendor.last_scanned`
      * - `subscription.current_line_item`
      *
-     * Any other value is rejected with `422 Unprocessable Entity`.
+     * The server rejects any other value with `422 Unprocessable Entity`.
      */
     getVendorsDetails(request: operations.GetVendorsDetailsRequest, options?: RequestOptions): Promise<components.Vendor>;
     /**
      * Update vendor details
      *
      * @remarks
-     * Update an individual vendor's profile — title, location, supervisor, email
+     * Updates an individual vendor's profile—title, location, supervisor, email
      * preferences, primary department, and primary sales state. A company manager
      * can also remove the vendor from their company by sending `company_id: null`.
      *
      * 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
+     * `country` properties of the shared `UserLocation` schema have no effect here, and
      * 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
+     * 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
+     * of the two you omit from the request). The server rejects a code that is not shaped like a real
+     * postal code, or that provably belongs to a different state, 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
+     * `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
+     * 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.
@@ -589,7 +605,7 @@ export declare class Vendors extends ClientSDK {
      * List vendor credits
      *
      * @remarks
-     * List the credits for the vendor. Defaults to chronological order (oldest first).
+     * Lists the credits for the vendor. Defaults to chronological order (oldest first).
      *
      * **Permissions.** Requires the `vendors.view` permission.
      */
@@ -604,7 +620,7 @@ export declare class Vendors extends ClientSDK {
      *
      * Backward-compatible shape preserved: this endpoint continues to return
      * the legacy paginated envelope (`items` + `pager`) with the original
-     * `system` / `facility` / `field` / `value` keys per item. New consumers
+     * `system` / `facility` / `field` / `value` keys per item. Consumers
      * should migrate to `/custom-fields`, which returns an unpaginated array
      * with the `field_for` discriminator. Scheduled for removal after SDK
      * consumers migrate.
@@ -624,7 +640,7 @@ export declare class Vendors extends ClientSDK {
      * merged into a single array. Each item includes a `field_for` discriminator
      * indicating whether the field belongs to a company or facility.
      *
-     * Fields that the vendor has not yet set a value for are returned with
+     * The response returns fields that the vendor has not yet set a value for with
      * `value: null`, including fields where other vendors in the same company
      * have set values.
      *
@@ -639,7 +655,7 @@ export declare class Vendors extends ClientSDK {
      *
      * @remarks
      * Sets or updates a custom field value for the specified vendor. If the value
-     * does not exist it is created; if it already exists it is updated (upsert).
+     * does not exist, the API creates it; if it already exists, the API updates it (upsert).
      *
      * The vendor field must belong to the vendor's company or to one of the
      * vendor's targeted facilities, and must have `show_to_vendor` set to `true`.
@@ -647,14 +663,16 @@ export declare 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.
+     * **Permissions.** Requires the `vendors.edit` permission. A company manager whose company
+     * manages the vendor through a managed-by-company link, rather than owning it, also needs that
+     * link's `may_edit_profile` access right, or the API returns `403`.
      */
     updateVendorCustomField(request: operations.UpdateVendorCustomFieldRequest, options?: RequestOptions): Promise<components.VendorCustomFields>;
     /**
      * List of companies managing the vendor
      *
      * @remarks
-     * List of companies managing the vendor
+     * Lists the companies that manage the vendor
      *
      * **Permissions.** Requires the `vendors.view` permission.
      */
@@ -665,27 +683,54 @@ export declare class Vendors extends ClientSDK {
      * Add vendor managed by company
      *
      * @remarks
-     * It will add a vendor managed by company
+     * Adds a company as a manager of the vendor. The new company starts with every access right
+     * turned off. The company must be on the same site as the vendor. Otherwise, the API returns
+     * `404`.
      *
-     * **Permissions.** Requires the `vendors.edit` permission.
+     * The company the vendor belongs to can't be added, because it already has full rights over the
+     * vendor. The API returns `400`, as it does for a company that already manages the vendor.
+     *
+     * **Permissions.** Requires the `vendors.edit` permission. Only these callers can change which
+     * companies manage the vendor: the vendor, a company manager at the company the vendor belongs to,
+     * a Green Security administrator, or an app whose API token can update the vendor (an app
+     * installed for the vendor's whole site, for the company the vendor belongs to, or by the vendor).
+     * A company manager whose company manages the vendor through a managed-by-company link, rather
+     * than owning the vendor, gets a `403`, and so do facility and system users.
      */
     addVendorManagedByCompany(request: operations.AddVendorManagedByCompanyRequest, options?: RequestOptions): Promise<operations.AddVendorManagedByCompanyAddVendorManagedByCompanyOk>;
     /**
      * Delete vendor managed by company
      *
      * @remarks
-     * It will delete the vendor managed by company
+     * Removes a company as a manager of the vendor.
      *
-     * **Permissions.** Requires the `vendors.edit` permission.
+     * **Permissions.** Requires the `vendors.edit` permission. Only these callers can change which
+     * companies manage the vendor: the vendor, a company manager at the company the vendor belongs to,
+     * a Green Security administrator, or an app whose API token can update the vendor (an app
+     * installed for the vendor's whole site, for the company the vendor belongs to, or by the vendor).
+     * A company manager whose company manages the vendor through a managed-by-company link, rather
+     * than owning the vendor, gets a `403`, and so do facility and system users.
+     *
+     * If `managed_vendor_id` doesn't belong to this vendor, the API returns `404`, the same response
+     * as for an ID that doesn't exist.
      */
     deleteVendorManagedByCompany(request: operations.DeleteVendorManagedByCompanyRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
     /**
      * Update vendor managed by company access rights
      *
      * @remarks
-     * It will update the vendor managed by company access rights
+     * Updates the access rights that a company has for the vendor it manages.
      *
-     * **Permissions.** Requires the `vendors.edit` permission.
+     * **Permissions.** Requires the `vendors.edit` permission. Only these callers can change access
+     * rights: the vendor, a company manager at the company the vendor belongs to, a Green Security
+     * administrator, or an app whose API token can update the vendor (an app installed for the
+     * vendor's whole site, for the company the vendor belongs to, or by the vendor). A company manager
+     * whose company manages the vendor through a managed-by-company link, rather than owning the
+     * vendor, gets a `403`: that company can't change its own access rights or another company's.
+     * Facility and system users get a `403` too.
+     *
+     * If `managed_vendor_id` doesn't belong to this vendor, the API returns `404`, the same response
+     * as for an ID that doesn't exist.
      */
     updateVendorManagedByCompany(request: operations.UpdateVendorManagedByCompanyRequest, options?: RequestOptions): Promise<operations.UpdateVendorManagedByCompanyUpdateVendorManagedByCompanyOk>;
     /**
@@ -693,8 +738,8 @@ export declare class Vendors extends ClientSDK {
      *
      * @remarks
      * Enqueues an asynchronous job to generate a CSV export of vendors based on the
-     * provided filters (the same filters supported by the vendors list endpoint), in the same
-     * credential-inclusive format as the portal's "Download Full Report" button - one column per
+     * provided filters (the same filters supported by the vendors list endpoint). The file uses the same
+     * credential-inclusive format: one column per
      * applicable credential (status, due date, expiration), plus counts and percentage approved,
      * alongside the vendor's identity, contact, and company details.
      * Returns a `status_url` to poll until the export is ready, plus a
@@ -702,7 +747,7 @@ export declare class Vendors extends ClientSDK {
      *
      * **Permissions.** Requires the `vendors.view` permission.
      *
-     * Available `expand` scopes are:
+     * Use any of the following `expand` scopes:
      *
      * - `vendor.user`
      * - `vendor.vendor_type`
@@ -738,15 +783,15 @@ export declare class Vendors extends ClientSDK {
      * - `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.
+     * For any other value, the server responds with `422 Unprocessable Entity`. The export job builds its own columns and ignores `expand`. The server still validates the parameter for backward compatibility, but it does not change the generated CSV.
      */
     vendorsExport(request: operations.VendorsExportRequest, options?: RequestOptions): Promise<components.CsvExportEnqueuedResponse>;
     /**
      * Get vendor export status
      *
      * @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.
+     * Polls the status of an asynchronous vendor export job. When `ready` is true,
+     * the export is complete, and you can download it from the download endpoint.
      *
      * **Permissions.** Requires the `vendors.view` permission.
      */
@@ -756,7 +801,7 @@ export declare class Vendors extends ClientSDK {
      *
      * @remarks
      * 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
+     * responds with a 302 redirect to a short-lived presigned Amazon Simple Storage Service (S3) URL. If the
      * export job is still running, responds with 202.
      *
      * **Permissions.** Requires the `vendors.view` permission.
@@ -766,25 +811,31 @@ export declare class Vendors extends ClientSDK {
      * Purchase scrub credits
      *
      * @remarks
-     * Purchase scrub credits
+     * Purchases 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.
+     * **Permissions.** Requires a valid token. This endpoint is not gated on a named permission. The caller's role and their relationship to the record determine what the endpoint returns.
      */
     purchaseScrubCredits(request: operations.PurchaseScrubCreditsRequest, options?: RequestOptions): Promise<operations.PurchaseScrubCreditsPurchaseScrubCreditsOk>;
     /**
      * Create vendor company
      *
      * @remarks
-     * Create vendor company
+     * Creates vendor company
      *
-     * **Permissions.** Requires the `companies.add` permission.
+     * **Permissions.** Requires the `companies.add` permission. Only these callers can move the vendor
+     * into a new company: the vendor, a company manager at the company the vendor belongs to, a Green
+     * Security administrator, or an app installed for the vendor's whole site. An app needs a
+     * site-wide installation because only a site-wide installation can create companies. An app
+     * installed only for a company or by a user gets a `403`, even when its API token can update the
+     * vendor. A company manager whose company manages the vendor through a managed-by-company link,
+     * rather than owning the vendor, gets a `403`, and so do facility and system users.
      */
     createVendorCompany(request: operations.CreateVendorCompanyRequest, options?: RequestOptions): Promise<operations.CreateVendorCompanyCreateVendorCompanyOk>;
     /**
      * Calculate subscription price
      *
      * @remarks
-     * Calculate subscription price
+     * Calculates subscription price
      *
      * **Permissions.** Requires the `pricing_models.view` permission.
      */
@@ -793,7 +844,7 @@ export declare class Vendors extends ClientSDK {
      * 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.
+     * Returns every active target-facility screening question that applies to the vendor at the given facility, each paired with the vendor's answer when the vendor has answered. Questions that the vendor has not answered appear with a null answer. Read-only; used to review a rep's screening answers.
      * **Permissions.** Requires the `vendors.view` permission.
      */
     getVendorScreeningQuestions(request: operations.GetVendorScreeningQuestionsRequest, options?: RequestOptions): Promise<operations.GetVendorScreeningQuestionsGetVendorScreeningQuestionsOk>;
@@ -805,11 +856,9 @@ export declare class Vendors extends ClientSDK {
      *
      * **Permissions.** Requires the `vendors.view` permission.
      *
-     * Available `expand` scopes are:
-     *
-     * - `screening_question.screening_answers`
+     * The only available `expand` scope is `screening_question.screening_answers`.
      *
-     * Any other value is rejected with `422 Unprocessable Entity`.
+     * The endpoint rejects any other value with `422 Unprocessable Entity`.
      */
     getNextUnansweredScreeningQuestion(request: operations.GetNextUnansweredScreeningQuestionRequest, options?: RequestOptions): Promise<operations.GetNextUnansweredScreeningQuestionGetNextUnansweredScreeningQuestionOk>;
     /**
@@ -820,12 +869,12 @@ export declare class Vendors extends ClientSDK {
      *
      * **Permissions.** Requires the `vendors.view` permission.
      *
-     * Available `expand` scopes are:
+     * The following `expand` scopes are available:
      *
      * - `vendor_target_facility.facility`
      * - `vendor_target_facility.has_screening_responses`
      *
-     * Any other value is rejected with `422 Unprocessable Entity`.
+     * The endpoint rejects any other value with `422 Unprocessable Entity`.
      */
     getVendorTargetFacilities(request: operations.GetVendorTargetFacilitiesRequest, options?: RequestOptions): Promise<PageIterator<operations.GetVendorTargetFacilitiesResponse, {
         page: number;
@@ -851,13 +900,13 @@ export declare class Vendors extends ClientSDK {
         page: number;
     }>>;
     /**
-     * Get a one-time URL for uploading a credential file for automatic classification (Emerald vendors only)
+     * Get an upload URL for automatic credential classification
      *
      * @remarks
-     * This endpoint allows vendors on the Emerald plan to upload a series of
+     * Lets vendors on the Emerald plan upload a series of
      * documents and have them automatically ingested and routed to the proper
-     * credential. The endpoint will return a one-time-use URL where the file
-     * must be uploaded. Green Security will process the file asynchronously.
+     * credential. The endpoint returns a presigned URL where you upload the file. The URL expires after five minutes.
+     * Green Security processes the file asynchronously.
      *
      * Non-Emerald vendors must use `addVendorCredentialFile` instead.
      *