@greensecurity/javascript-sdk 0.46.0-beta.5 → 0.46.0-beta.7

package/dist/commonjs/sdk/medicalproducts.js

@@ -42,17 +42,17 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * List all medical products
      *
      * @remarks
-     * Returns the medical products in the medical product catalog. Retired records are excluded
+     * Returns the medical products in the medical product catalog. The response omits retired records
      * unless `status` asks for them.
      *
-     * A medical product is a single device SKU. A device sold in several package configurations
+     * A medical product is a single device stock keeping unit (SKU). A device sold in several package configurations
      * is several SKUs grouped under a product family, not one record holding a list of part
      * numbers.
      *
      * The catalog is global reference data shared by every tenant, so it is not scoped to a
-     * site and access is governed by the permission alone.
+     * site and the permission alone controls access.
      *
-     * Sortable by id, product_name, brand_name, primary_di, status, created_at and updated_at.
+     * Sortable by id, `product_name`, `brand_name`, `primary_di`, status, `created_at` and `updated_at`.
      *
      * Requires the `medical_products` / `view` permission.
      *
@@ -91,7 +91,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Update the medical product with the given ID
      *
      * @remarks
-     * Updates a medical product. Keys the request omits are left as they are.
+     * Updates a medical product. The operation leaves keys that the request omits unchanged.
      *
      * Requires the `medical_products` / `edit` permission.
      *
@@ -104,7 +104,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Partially update the medical product with the given ID
      *
      * @remarks
-     * Identical to `PUT`: both leave omitted keys as they are.
+     * Updates a medical product the same way as `PUT`, leaving omitted keys unchanged.
      *
      * Requires the `medical_products` / `edit` permission.
      *
@@ -117,8 +117,8 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Delete the medical product with the given ID
      *
      * @remarks
-     * Retires a medical product. The record is marked deleted rather than destroyed: the catalog is
-     * shared by every tenant, so removing a row outright would take it out from under everyone
+     * Retires a medical product. The server marks the record as deleted instead of destroying it. Every tenant shares the catalog,
+     * so removing a row outright would take it out from under everyone
      * referencing it. Retiring also frees the record's natural key for a replacement.
      *
      * Requires the `medical_products` / `delete` permission.
@@ -132,16 +132,16 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * List all product families
      *
      * @remarks
-     * Returns the product families in the medical product catalog. Retired records are excluded
+     * Returns the product families in the medical product catalog. The response omits retired records
      * unless `status` asks for them.
      *
-     * A family groups the SKUs that share an intended purpose, risk class and essential design,
-     * which EU MDR Article 27 identifies with a Basic UDI-DI.
+     * A family groups the stock keeping units (SKUs) that share an intended purpose, risk class, and essential design,
+     * which Article 27 of the European Union Medical Device Regulation (MDR) identifies with a Basic UDI-DI.
      *
-     * Families share the `medical_products` permission rather than having one of their own,
+     * Families share the `medical_products` permission instead of having one of their own,
      * since a family has no meaning apart from the SKUs in it.
      *
-     * Sortable by id, name, brand_name, status, created_at and updated_at.
+     * Sortable by id, name, `brand_name`, status, `created_at` and `updated_at`.
      *
      * Requires the `medical_products` / `view` permission.
      *
@@ -180,7 +180,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Update the product family with the given ID
      *
      * @remarks
-     * Updates a product family. Keys the request omits are left as they are.
+     * Updates a product family. The operation leaves keys that the request omits unchanged.
      *
      * Requires the `medical_products` / `edit` permission.
      *
@@ -193,7 +193,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Partially update the product family with the given ID
      *
      * @remarks
-     * Identical to `PUT`: both leave omitted keys as they are.
+     * Updates a product family the same way as `PUT`, leaving omitted keys unchanged.
      *
      * Requires the `medical_products` / `edit` permission.
      *
@@ -206,8 +206,8 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Delete the product family with the given ID
      *
      * @remarks
-     * Retires a product family. The record is marked deleted rather than destroyed: the catalog is
-     * shared by every tenant, so removing a row outright would take it out from under everyone
+     * Retires a product family. The server marks the record as deleted instead of destroying it. Every tenant shares the catalog,
+     * so removing a row outright would take it out from under everyone
      * referencing it. Retiring also frees the record's natural key for a replacement.
      *
      * Requires the `medical_products` / `delete` permission.
@@ -221,13 +221,13 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * List all product categories
      *
      * @remarks
-     * Returns the product categories in the medical product catalog. Retired records are excluded
+     * Returns the product categories in the medical product catalog. The endpoint excludes retired records
      * unless `status` asks for them.
      *
-     * The taxonomy is flat and multi-valued: a product, manufacturer or distributor belongs to
+     * The taxonomy is flat and multi-valued: a product, manufacturer, or distributor belongs to
      * as many categories as apply. There is deliberately no nesting.
      *
-     * Sortable by id, name, sort_order, created_at and updated_at.
+     * Sortable by id, name, `sort_order`, `created_at` and `updated_at`.
      *
      * Requires the `medical_product_categories` / `view` permission.
      *
@@ -266,7 +266,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Update the product category with the given ID
      *
      * @remarks
-     * Updates a product category. Keys the request omits are left as they are.
+     * Updates a product category. The operation leaves keys that the request omits unchanged.
      *
      * Requires the `medical_product_categories` / `edit` permission.
      *
@@ -279,7 +279,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Partially update the product category with the given ID
      *
      * @remarks
-     * Identical to `PUT`: both leave omitted keys as they are.
+     * Updates a product category the same way as `PUT`, leaving omitted keys unchanged.
      *
      * Requires the `medical_product_categories` / `edit` permission.
      *
@@ -292,8 +292,8 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Delete the product category with the given ID
      *
      * @remarks
-     * Retires a product category. The record is marked deleted rather than destroyed: the catalog is
-     * shared by every tenant, so removing a row outright would take it out from under everyone
+     * Retires a product category. The server marks the record as deleted instead of destroying it. Every tenant shares the catalog,
+     * so removing a row outright would take it out from under everyone
      * referencing it. Retiring also frees the record's natural key for a replacement.
      *
      * Requires the `medical_product_categories` / `delete` permission.
@@ -311,9 +311,9 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * unless `status` asks for them.
      *
      * Manufacturers and distributors are separate even though one real-world company is
-     * frequently both, because the two carry different identifiers for the same device.
+     * frequently both because the two carry different identifiers for the same device.
      *
-     * Sortable by id, name, country, status, created_at and updated_at.
+     * Sortable by id, name, country, status, `created_at` and `updated_at`.
      *
      * Requires the `manufacturers` / `view` permission.
      *
@@ -352,7 +352,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Update the manufacturer with the given ID
      *
      * @remarks
-     * Updates a manufacturer. Keys the request omits are left as they are.
+     * Updates a manufacturer. The operation leaves keys that the request omits unchanged.
      *
      * Requires the `manufacturers` / `edit` permission.
      *
@@ -365,7 +365,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Partially update the manufacturer with the given ID
      *
      * @remarks
-     * Identical to `PUT`: both leave omitted keys as they are.
+     * Updates a manufacturer the same way as `PUT`, leaving omitted keys unchanged.
      *
      * Requires the `manufacturers` / `edit` permission.
      *
@@ -378,8 +378,8 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Delete the manufacturer with the given ID
      *
      * @remarks
-     * Retires a manufacturer. The record is marked deleted rather than destroyed: the catalog is
-     * shared by every tenant, so removing a row outright would take it out from under everyone
+     * Retires a manufacturer. The server marks the record as deleted instead of destroying it. Every tenant shares the catalog,
+     * so removing a row outright would take it out from under everyone
      * referencing it. Retiring also frees the record's natural key for a replacement.
      *
      * Requires the `manufacturers` / `delete` permission.
@@ -393,13 +393,13 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * List all distributors
      *
      * @remarks
-     * Returns the distributors in the medical product catalog. Retired records are excluded
+     * Returns the distributors in the medical product catalog. The response omits retired records
      * unless `status` asks for them.
      *
      * Manufacturers and distributors are separate even though one real-world company is
-     * frequently both, because the two carry different identifiers for the same device.
+     * frequently both because the two carry different identifiers for the same device.
      *
-     * Sortable by id, name, country, status, created_at and updated_at.
+     * Sortable by id, name, country, status, `created_at` and `updated_at`.
      *
      * Requires the `distributors` / `view` permission.
      *
@@ -438,7 +438,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Update the distributor with the given ID
      *
      * @remarks
-     * Updates a distributor. Keys the request omits are left as they are.
+     * Updates a distributor. Keys that the request omits keep their current values.
      *
      * Requires the `distributors` / `edit` permission.
      *
@@ -451,7 +451,7 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Partially update the distributor with the given ID
      *
      * @remarks
-     * Identical to `PUT`: both leave omitted keys as they are.
+     * Behaves like `PUT`. Both leave omitted keys as they are.
      *
      * Requires the `distributors` / `edit` permission.
      *
@@ -464,8 +464,8 @@ class MedicalProducts extends sdks_js_1.ClientSDK {
      * Delete the distributor with the given ID
      *
      * @remarks
-     * Retires a distributor. The record is marked deleted rather than destroyed: the catalog is
-     * shared by every tenant, so removing a row outright would take it out from under everyone
+     * Retires a distributor. The server marks the record as deleted instead of destroying it. Every tenant shares the catalog,
+     * so removing a row outright would take it out from under everyone
      * referencing it. Retiring also frees the record's natural key for a replacement.
      *
      * Requires the `distributors` / `delete` permission.

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

@@ -5,7 +5,7 @@ export declare class MobileDevices extends ClientSDK {
      * Add mobile device
      *
      * @remarks
-     * Add mobile device
+     * Adds mobile device
      *
      * **Permissions.** Requires the `mobile_devices.add` permission.
      */

package/dist/commonjs/sdk/mobiledevices.js

@@ -12,7 +12,7 @@ class MobileDevices extends sdks_js_1.ClientSDK {
      * Add mobile device
      *
      * @remarks
-     * Add mobile device
+     * Adds mobile device
      *
      * **Permissions.** Requires the `mobile_devices.add` permission.
      */

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

@@ -7,11 +7,11 @@ export declare class Organizations extends ClientSDK {
      * List or search facilities
      *
      * @remarks
-     * List or search facilities.
+     * Lists or searches facilities.
      *
-     * **Permissions.** Requires any of `facilities.view`, `facility.search` or `targeted_facilities.view`. Callers holding only `targeted_facilities.view` or `facility.search` see a reduced record, and expansion scopes are applied only to facilities within their read scope.
+     * **Permissions.** Requires any of `facilities.view`, `facility.search` or `targeted_facilities.view`. Callers holding only `targeted_facilities.view` or `facility.search` see a reduced record, and the API applies expansion scopes only to facilities within their read scope.
      *
-     * Available `expand` scopes are:
+     * The `expand` parameter accepts these scopes:
      *
      * - `facility.system`
      * - `facility.contacts`
@@ -24,7 +24,7 @@ export declare class Organizations extends ClientSDK {
      * - `facility.scrubs_policy`
      * - `facility.flu_credential`
      *
-     * Unrecognised values are ignored. Expansion is applied only to facilities the caller can read; rows outside that scope are returned unexpanded.
+     * The API ignores unrecognized values. It applies expansion only to facilities the caller can read and returns rows outside that scope unexpanded.
      */
     listOrSearchFacilities(request: operations.ListOrSearchFacilitiesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchFacilitiesResponse, {
         page: number;
@@ -33,14 +33,14 @@ export declare class Organizations extends ClientSDK {
      * Get facility
      *
      * @remarks
-     * Retrieve an individual facility.
+     * Retrieves an individual facility.
      *
-     * **Permissions.** Requires `facilities.view`, `facility_profile.view`, or `targeted_facilities.view`. `facility.search` does not grant access on its own — it only extends the reach of a `targeted_facilities.view` caller to a facility they are not targeted at, returning the public summary for it instead of a 403.
+     * **Permissions.** Requires `facilities.view`, `facility_profile.view`, or `targeted_facilities.view`. `facility.search` does not grant access on its own. It only extends the reach of a `targeted_facilities.view` caller to a facility they are not targeted at, returning the public summary for it instead of a 403.
      *
-     * - Callers with `facilities.view` or `facility_profile.view` can look up any facility, but only receive full expansion for their own facility; for any other facility, expansion is dropped and only the public summary is returned.
-     * - Callers with `targeted_facilities.view` receive the full record and full expansion for a facility they are targeted at (a vendor's target facilities, or a facility/system user's own facility). For a facility they are not targeted at, they receive the public summary (no expansion) if they also hold `facility.search`, or a 401 otherwise.
+     * - Callers with `facilities.view` or `facility_profile.view` can look up any facility, but only receive full expansion for their own facility. For any other facility, the server drops the expansion and returns only the public summary.
+     * - Callers with `targeted_facilities.view` receive the full record and full expansion for a facility they are targeted at (a vendor's target facilities, or a facility user's or system user's own facility). For a facility they are not targeted at, they receive the public summary (no expansion) if they also hold `facility.search`, or a 401 otherwise.
      *
-     * Available `expand` scopes are:
+     * Use any of the following `expand` scopes:
      *
      * - `facility.system`
      * - `facility.contacts`
@@ -53,14 +53,14 @@ export declare class Organizations extends ClientSDK {
      * - `facility.scrubs_policy`
      * - `facility.flu_credential`
      *
-     * Unrecognised values are ignored. Expansion is dropped entirely for callers who can only see the facility's public summary.
+     * The server ignores unrecognized values. The server drops expansion entirely for callers who can see only the facility's public summary.
      */
     getFacility(request: operations.GetFacilityRequest, options?: RequestOptions): Promise<components.Facility>;
     /**
      * List or search departments
      *
      * @remarks
-     * List or search departments.
+     * Lists or searches departments.
      *
      * **Permissions.** Requires the `departments.view` permission.
      */
@@ -71,24 +71,24 @@ export declare class Organizations extends ClientSDK {
      * List company target facilities
      *
      * @remarks
-     * Lists the CompanyTargetFacility links for a company — the facilities the
+     * Lists the CompanyTargetFacility links for a company—the facilities the
      * company is targeting. Each row carries the linked facility (with location
      * and parent system), the link status, and per-facility counts of the
      * company's individuals targeting it.
      *
      * When `include_potential_targets=true`, returns every non-deleted facility
-     * reachable via a LEFT JOIN against the caller's *potential-target* scope:
-     * for a facility/system/vendor/company-manager caller, that's the public,
+     * in the caller's *potential-target* scope, whether or not it is targeted.
+     * For a facility/system/vendor/company-manager caller, that scope is the public,
      * non-deleted, listed facility directory plus the caller's own read scope
-     * for Facility — not the read scope alone, so the roster includes
+     * for facilities—not the read scope alone, so the roster includes
      * facilities the caller has no existing relationship with. An API-user
      * caller is the exception: it sees only its own read scope, with no
-     * directory added. Targeted rows carry their CTF `id` and `status`;
+     * directory added. Targeted rows carry their link `id` and `status`;
      * non-targeted rows have `id: null` and `status: "Not Targeted"`.
      *
      * Access control: the URL's `company_id` must be in the caller's read scope
      * for Company (a company manager's or vendor's own company, or a company
-     * whose app is activated for the API user). Callers outside that scope
+     * with an app activation for the API user). Callers outside that scope
      * receive `404 Company not found`.
      *
      * Filter with `has_individual` / `has_active_individual` to drive the
@@ -96,11 +96,9 @@ export declare class Organizations extends ClientSDK {
      *
      * **Permissions.** Requires the `target_facilities.view` permission.
      *
-     * Available `expand` scopes are:
+     * The only available `expand` scope is `company_target_facility.facility`.
      *
-     * - `company_target_facility.facility`
-     *
-     * Any other value is rejected with `422 Unprocessable Entity`.
+     * The server rejects any other value with `422 Unprocessable Entity`.
      */
     listCompanyTargetFacilities(request: operations.ListCompanyTargetFacilitiesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListCompanyTargetFacilitiesResponse, {
         page: number;
@@ -109,20 +107,20 @@ export declare class Organizations extends ClientSDK {
      * Add a company target facility
      *
      * @remarks
-     * Links the URL's company to an existing facility. The link is created with
-     * status `Pending`. Only the link row is created — the Facility entity
-     * itself is never created or modified by this endpoint.
+     * Links the URL's company to an existing facility. The link starts with
+     * status `Pending`. This endpoint creates only the link row. It never creates or modifies the facility entity
+     * itself.
      *
      * Access control: the URL's `company_id` must be in the caller's update
-     * scope for Company, AND the `facility_id` must be in the caller's create
+     * scope for Company, and the `facility_id` must be in the caller's create
      * scope for Facility. For a facility/system/vendor/company-manager caller,
-     * that create scope is widened the same way listing's potential-target
-     * scope is: it includes the public, non-deleted, listed facility directory
+     * that create scope widens the same way listing's potential-target
+     * scope does. It includes the public, non-deleted, listed facility directory
      * in addition to the caller's own create scope, so a non-deleted publicly
-     * listed facility can be targeted even when it isn't otherwise in the
-     * caller's Facility relation. An API-user caller is the exception —
+     * listed facility is a valid target even when it isn't otherwise in the
+     * caller's Facility relation. An API-user caller is the exception. Its access is
      * restricted to its own create scope (a facility on the company's site, or
-     * a facility reachable via the API user's site/system/facility-scoped
+     * a facility reachable through the API user's site/system/facility-scoped
      * activation), with no directory added. Either being out of scope returns
      * `404 Company not found` / `404 Facility not found` respectively. Deleted
      * facilities also return `404 Facility not found`.
@@ -131,11 +129,9 @@ export declare class Organizations extends ClientSDK {
      *
      * **Permissions.** Requires the `target_facilities.add` permission.
      *
-     * Available `expand` scopes are:
-     *
-     * - `company_target_facility.facility`
+     * The only available `expand` scope is `company_target_facility.facility`.
      *
-     * Any other value is rejected with `422 Unprocessable Entity`.
+     * The server rejects any other value with `422 Unprocessable Entity`.
      */
     createCompanyTargetFacility(request: operations.CreateCompanyTargetFacilityRequest, options?: RequestOptions): Promise<operations.CreateCompanyTargetFacilityCreateCompanyTargetFacilityOk>;
     /**
@@ -144,10 +140,10 @@ export declare class Organizations extends ClientSDK {
      * @remarks
      * Removes a CompanyTargetFacility link. Blocked when any of the company's
      * individuals still target the same facility (to avoid orphaning their
-     * vendor-scoped target rows). Only the link row is removed — the Facility
+     * vendor-scoped target rows). The operation removes only the link row; the facility
      * entity itself is never touched.
      *
-     * Access control: the URL's `company_id` must be in the caller's update
+     * Access control: the `company_id` in the URL must be in the caller's update
      * scope for Company (a company manager's or vendor's own company, or a
      * company whose app is activated for the API user). Callers outside that
      * scope receive `404 Company not found`.
@@ -165,7 +161,7 @@ export declare class Organizations extends ClientSDK {
      *
      * Returns a `status_url` for polling until the export is ready, along with a `download_url` and `status_id`.
      *
-     * Access control: the URL's `company_id` must be in the caller's read scope for Company. Callers
+     * Access control: the `company_id` in the URL must be in the caller's read scope for Company. Callers
      * outside that scope receive `404 Company not found`.
      *
      * **Permissions.** Requires the `target_facilities.view` permission.
@@ -175,8 +171,8 @@ export declare class Organizations extends ClientSDK {
      * Get company target facilities export status
      *
      * @remarks
-     * Poll the state of an asynchronous company target facilities export job. When `ready` is true,
-     * the export is complete and can be downloaded via the download endpoint.
+     * Polls the state of an asynchronous company target facilities export job. When `ready` is true,
+     * the export is complete and you can download it from the download endpoint.
      *
      * **Permissions.** Requires the `target_facilities.view` permission.
      */
@@ -185,8 +181,8 @@ export declare class Organizations extends ClientSDK {
      * Download company target facilities CSV
      *
      * @remarks
-     * Returns the exported company target facilities CSV via a 302 redirect to a short-lived presigned S3 URL.
-     * If the export is still being generated, returns 202 with a JSON `{ ready: false }` payload.
+     * Returns the exported company target facilities CSV through a 302 redirect to a short-lived presigned Amazon Simple Storage Service (S3) URL.
+     * If the export is still in progress, returns 202 with a JSON `{ ready: false }` payload.
      *
      * **Permissions.** Requires the `target_facilities.view` permission.
      */
@@ -195,25 +191,21 @@ export declare class Organizations extends ClientSDK {
      * List vendors targeting a facility
      *
      * @remarks
-     * Powers the Company Portal → Facility Details page. Returns the
-     * paginated list of company-scoped vendor reps that are targeting the
-     * given facility, with each row carrying the rep's name + email, their
+     * Returns the paginated list of company-scoped vendor reps that are targeting the
+     * given facility, with each row carrying the rep's name and email, their
      * last visit to this facility, their facility access status, and any
-     * company custom fields the company has flagged `show_to_vendor` (which
-     * is where the "Employee ID" column on the UI lives).
+     * company custom fields the company has flagged `show_to_vendor`.
      *
-     * Filtering: pass `status=approved|pending|denied` to scope the rows to a
-     * single status tab. Pass `search=<term>` for a single search box that
-     * matches first name, last name, full name, email, OR any visible custom
-     * field value (covering the "search by name / email / Employee ID"
-     * requirement).
+     * Filtering: pass `status=approved|pending|denied` to return only the rows
+     * with that status. Pass `search=<term>` to match first name, last name,
+     * full name, email, or any visible custom field value.
      *
      * Access control:
-     *   * Regular users: the URL's `:id` must be in the caller's read scope for
-     *     Facility (resolved via `has_facility_access_policy`). Out-of-scope or
+     *   * Non-API users: the `:id` in the URL must be in the caller's read scope for
+     *     Facility (resolved through `has_facility_access_policy`). Out-of-scope or
      *     soft-deleted facilities return `404 Facility not found`.
      *   * API users: must pass `company_id`. Both the company and the facility
-     *     must be activated for the caller's marketplace app
+     *     must have an activation for the caller's marketplace app
      *     (`MarketplaceAppActivation`).
      *
      * **Permissions.** Requires the `vendors.view` permission.
@@ -226,19 +218,19 @@ export declare class Organizations extends ClientSDK {
      *
      * @remarks
      * Enqueues an asynchronous job to generate a CSV export of the vendors (vendor reps)
-     * targeting the given facility, applying the same access scope and filter parameters as
+     * targeting the given facility. The job applies the same access scope and filter parameters as
      * the listing endpoint. The CSV contains: Name, Email, one column per company custom field
-     * flagged `show_to_vendor` (e.g. Employee ID), Last Visit, and Status.
+     * flagged `show_to_vendor` (for example, Employee ID), Last Visit, and Status.
      *
      * Returns a `status_url` for polling until the export is ready, along with a `download_url`
      * and `status_id`.
      *
      * Access control mirrors the list endpoint:
-     *   * Regular users — facility must be in the caller's read scope (via
+     *   * Non-API users: facility must be in the caller's read scope (through
      *     `has_facility_access_policy`); company resolved from the session. Out-of-scope or
      *     soft-deleted facilities return `404 Facility not found`.
-     *   * API users — `company_id` required; both the company AND the facility must be
-     *     activated for the caller's marketplace app via the join-scoped
+     *   * API users: `company_id` required; both the company and the facility need an activation
+     *     for the caller's marketplace app, verified with the join-scoped
      *     `MarketplaceAppActivation` check.
      *
      * **Permissions.** Requires the `vendors.view` permission.
@@ -248,8 +240,8 @@ export declare class Organizations extends ClientSDK {
      * Get facility vendors export status
      *
      * @remarks
-     * Poll the state of an asynchronous facility vendors export job. When `ready` is true,
-     * the export is complete and can be downloaded via the download endpoint.
+     * Polls the state of an asynchronous facility vendors 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.
      */
@@ -258,8 +250,8 @@ export declare class Organizations extends ClientSDK {
      * Download facility vendors CSV
      *
      * @remarks
-     * Returns the exported facility vendors CSV via a 302 redirect to a short-lived
-     * presigned S3 URL. If the export is still being generated, returns 202 with a JSON
+     * Returns the exported facility vendors CSV through a 302 redirect to a short-lived
+     * presigned Amazon Simple Storage Service (S3) URL. If the export is still in progress, returns 202 with a JSON
      * `{ ready: false }` payload.
      *
      * **Permissions.** Requires the `vendors.view` permission.
@@ -269,16 +261,16 @@ export declare class Organizations extends ClientSDK {
      * List or search department contacts
      *
      * @remarks
-     * List or search department contacts.
+     * Lists or searches department contacts.
      *
      * **Permissions.** Requires the `departments.view` permission.
      *
-     * Available `expand` scopes are:
+     * The `expand` parameter accepts the following scopes:
      *
      * - `department_membership.contact`
      * - `department_membership.department`
      *
-     * Unrecognised values are ignored.
+     * The server ignores unrecognized values.
      */
     listOrSearchDepartmentContacts(request: operations.ListOrSearchDepartmentContactsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListOrSearchDepartmentContactsResponse, {
         page: number;

package/dist/commonjs/sdk/organizations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"organizations.d.ts","sourceRoot":"","sources":["../../../src/sdk/organizations.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,8BAA8B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC1E;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAQ/B;;;;;;;OAOG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,+BAA+B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC3E;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,mCAAmC,EAC9C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;IAQD;;;;;;;;;;;;;;;OAeG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;;;;;;;;OAcG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;;;;OAQG;IACG,sCAAsC,CAC1C,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kDAAkD,CAAC;IAQzE;;;;;;;;OAQG;IACG,qCAAqC,CACzC,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,6CAA6C,GAAG,SAAS,CACrE;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,2BAA2B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CACvE;IAQD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;;;;OAQG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;;;OASG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,GAAG,SAAS,CAAC;IAQxE;;;;;;;;;;;;;;OAcG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,sCAAsC,EACjD;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;CAOF"}
+{"version":3,"file":"organizations.d.ts","sourceRoot":"","sources":["../../../src/sdk/organizations.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAE5D,OAAO,EAAE,YAAY,EAAwB,MAAM,wBAAwB,CAAC;AAE5E,qBAAa,aAAc,SAAQ,SAAS;IAC1C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,8BAA8B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC1E;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,WAAW,CACf,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;IAQ/B;;;;;;;OAOG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,+BAA+B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAC3E;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,mCAAmC,EAC9C;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,wDAAwD,CACpE;IAQD;;;;;;;;;;;;;;;OAeG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,OAAO,CAAC;IAQnB;;;;;;;;;;;;;;OAcG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;;;;OAQG;IACG,sCAAsC,CAC1C,OAAO,EAAE,UAAU,CAAC,6CAA6C,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,kDAAkD,CAAC;IAQzE;;;;;;;;OAQG;IACG,qCAAqC,CACzC,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,UAAU,CAAC,6CAA6C,GAAG,SAAS,CACrE;IAQD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,2BAA2B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CACvE;IAQD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CACzB,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iCAAiC,CAAC;IAQxD;;;;;;;;OAQG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,uBAAuB,CAAC;IAQ9C;;;;;;;;;OASG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,GAAG,SAAS,CAAC;IAQxE;;;;;;;;;;;;;;OAcG;IACG,8BAA8B,CAClC,OAAO,EAAE,UAAU,CAAC,qCAAqC,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,sCAAsC,EACjD;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;CAOF"}