@greensecurity/javascript-sdk 0.46.0-beta.4 → 0.46.0-beta.6

package/dist/commonjs/funcs/invoicesMakePayment.js

@@ -51,9 +51,9 @@ const async_js_1 = require("../types/async.js");
  * Make payment for the invoice
  *
  * @remarks
- * Make payment for the invoice
+ * Makes a payment for the invoice.
  *
- * **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.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/invoicesUpdateInvoice.d.ts

@@ -12,18 +12,18 @@ import { Result } from "../types/fp.js";
  * Update invoice
  *
  * @remarks
- * It will replace all the lines with the lines passed as parameter
- * - Exactly one of vendor_id, company_id, facility_id, or system_id must be provided. - variant_id is required for the line - payment_handler_data must be set in the following format:
- *     1. for the 'vendor credential' and 'expedited credential' payment_handlers this should be a JSON
- *        with a key 'vendor_credential_id' and value as integer
- *     2. for the 'credentialing subscription' payment handler this should be a JSON
+ * Replaces all the lines with the lines in the request body.
+ * - Provide exactly one of `vendor_id`, `company_id`, `facility_id`, or `system_id`. Each line requires `variant_id`. Set `payment_handler_data` in the following format:
+ *     1. for the "vendor credential" and "expedited credential" payment_handlers this should be a JSON
+ *        with a key "vendor_credential_id" and value as integer
+ *     2. for the "credentialing subscription" payment handler this should be a JSON
  *        with the following keys and values:
- *          - old_vendor_type_id: required, must be nil or integer
+ *          - old_vendor_type_id: required, must be `null` or an integer
  *          - new_vendor_type_id: required, must be integer
- *          - old_facility_ids:   required, must be an array of integers (can be empty)
- *          - new_facility_ids:   required, must be array of integers
+ *          - old_facility_ids: required, must be an array of integers (can be empty)
+ *          - new_facility_ids: required, must be array of integers
  *
- * **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 it returns.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/invoicesUpdateInvoice.js

@@ -52,18 +52,18 @@ const types$ = __importStar(require("../types/primitives.js"));
  * Update invoice
  *
  * @remarks
- * It will replace all the lines with the lines passed as parameter
- * - Exactly one of vendor_id, company_id, facility_id, or system_id must be provided. - variant_id is required for the line - payment_handler_data must be set in the following format:
- *     1. for the 'vendor credential' and 'expedited credential' payment_handlers this should be a JSON
- *        with a key 'vendor_credential_id' and value as integer
- *     2. for the 'credentialing subscription' payment handler this should be a JSON
+ * Replaces all the lines with the lines in the request body.
+ * - Provide exactly one of `vendor_id`, `company_id`, `facility_id`, or `system_id`. Each line requires `variant_id`. Set `payment_handler_data` in the following format:
+ *     1. for the "vendor credential" and "expedited credential" payment_handlers this should be a JSON
+ *        with a key "vendor_credential_id" and value as integer
+ *     2. for the "credentialing subscription" payment handler this should be a JSON
  *        with the following keys and values:
- *          - old_vendor_type_id: required, must be nil or integer
+ *          - old_vendor_type_id: required, must be `null` or an integer
  *          - new_vendor_type_id: required, must be integer
- *          - old_facility_ids:   required, must be an array of integers (can be empty)
- *          - new_facility_ids:   required, must be array of integers
+ *          - old_facility_ids: required, must be an array of integers (can be empty)
+ *          - new_facility_ids: required, must be array of integers
  *
- * **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 it returns.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/lookupsListLookupSystems.d.ts

@@ -9,11 +9,11 @@ import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * List systems for dropdown/picker use
+ * List systems for use in selection lists
  *
  * @remarks
  * Returns all credentialing-eligible systems (and optionally their facilities) for the authenticated user.
- * Designed for lightweight dropdown and picker UIs.
+ * Designed for lightweight list and picker UIs.
  *
  * - **Company manager**: returns systems scoped to their site.
  * - **Vendor**: returns systems available to that vendor.
@@ -23,11 +23,11 @@ import { Result } from "../types/fp.js";
  *
  * **Permissions.** Requires the `systems.view` permission. Passing `expand=system.facilities` additionally requires `facilities.view`.
  *
- * Available `expand` scopes are:
+ * The `expand` parameter accepts the following scope:
  *
  * - `system.facilities`
  *
- * Any other value is rejected with `422 Unprocessable Entity`.
+ * The API rejects any other value with `422 Unprocessable Entity`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/lookupsListLookupSystems.js

@@ -48,11 +48,11 @@ const errors = __importStar(require("../models/errors/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * List systems for dropdown/picker use
+ * List systems for use in selection lists
  *
  * @remarks
  * Returns all credentialing-eligible systems (and optionally their facilities) for the authenticated user.
- * Designed for lightweight dropdown and picker UIs.
+ * Designed for lightweight list and picker UIs.
  *
  * - **Company manager**: returns systems scoped to their site.
  * - **Vendor**: returns systems available to that vendor.
@@ -62,11 +62,11 @@ const async_js_1 = require("../types/async.js");
  *
  * **Permissions.** Requires the `systems.view` permission. Passing `expand=system.facilities` additionally requires `facilities.view`.
  *
- * Available `expand` scopes are:
+ * The `expand` parameter accepts the following scope:
  *
  * - `system.facilities`
  *
- * Any other value is rejected with `422 Unprocessable Entity`.
+ * The API rejects any other value with `422 Unprocessable Entity`.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/lookupsLookupCompanyManagers.d.ts

@@ -12,8 +12,8 @@ import { Result } from "../types/fp.js";
  * List the managers of a company for addressing a message
  *
  * @remarks
- * List the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an admin; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
- * **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.
+ * Lists the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an administrator; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{id}/managers`, which is the administration listing and requires the `company_managers` view permission.
+ * **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.
  */
 export declare function lookupsLookupCompanyManagers(client: GreenSecurityCore, request: operations.LookupCompanyManagersRequest, options?: RequestOptions): APIPromise<Result<operations.LookupCompanyManagersLookupCompanyManagersOk, errors.ApiErrorResponse | GreenSecurityError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=lookupsLookupCompanyManagers.d.ts.map

package/dist/commonjs/funcs/lookupsLookupCompanyManagers.js

@@ -51,8 +51,8 @@ const async_js_1 = require("../types/async.js");
  * List the managers of a company for addressing a message
  *
  * @remarks
- * List the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an admin; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{id}/managers`, which is the administration listing and is gated on the `company_managers` view permission.
- * **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.
+ * Lists the active managers of a company who have an email address, so someone who belongs to that company can contact them. Readable by a vendor of the company, a manager of the company, or an administrator; every other caller receives a 404. Carries only the fields needed to address a message, not the full company manager or user record. Distinct from `/companies/{id}/managers`, which is the administration listing and requires the `company_managers` view permission.
+ * **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.
  */
 function lookupsLookupCompanyManagers(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/lookupsLookupPostalCode.d.ts

@@ -12,24 +12,24 @@ import { Result } from "../types/fp.js";
  * Check a postal code against a state and country
  *
  * @remarks
- * Cross-checks a postal code against a state/province and country, the same check
- * every write path that stores a US or Canadian address enforces server-side (e.g.
+ * Cross-checks a postal code against a state or province and country, the same check
+ * every write path that stores a US or Canadian address enforces server-side (for example,
  * `PUT /users/{id}`, `PUT /vendors/{vendor_id_or_me}`). Useful for validating an
  * address before submitting it elsewhere.
  *
- * `status` is one of:
- * - `ok` — the postal code belongs to the given state/province.
- * - `invalid` — the postal code is not shaped like a real one for the given country.
- * - `mismatch` — the postal code is well-formed but belongs to a different state or
- *   province. `expected_states` names the state(s) it actually maps to.
- * - `unknown` — nothing to check against (an unsupported country, or a postal code
+ * The `status` field has one of the following values:
+ * - `ok`: the postal code belongs to the given state/province.
+ * - `invalid`: the postal code is not shaped like a real one for the given country.
+ * - `mismatch`: the postal code is well-formed but belongs to a different state or
+ *   province. `expected_states` names the states it maps to.
+ * - `unknown`: nothing to check against (an unsupported country, or a postal code
  *   absent from the US ZIP dataset). Treated as acceptable by every write path that
  *   uses this check.
  *
  * Only the US and Canada have a real code-to-subdivision map; every other country
  * always returns `unknown`.
  *
- * **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 API returns.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/lookupsLookupPostalCode.js

@@ -51,24 +51,24 @@ const async_js_1 = require("../types/async.js");
  * Check a postal code against a state and country
  *
  * @remarks
- * Cross-checks a postal code against a state/province and country, the same check
- * every write path that stores a US or Canadian address enforces server-side (e.g.
+ * Cross-checks a postal code against a state or province and country, the same check
+ * every write path that stores a US or Canadian address enforces server-side (for example,
  * `PUT /users/{id}`, `PUT /vendors/{vendor_id_or_me}`). Useful for validating an
  * address before submitting it elsewhere.
  *
- * `status` is one of:
- * - `ok` — the postal code belongs to the given state/province.
- * - `invalid` — the postal code is not shaped like a real one for the given country.
- * - `mismatch` — the postal code is well-formed but belongs to a different state or
- *   province. `expected_states` names the state(s) it actually maps to.
- * - `unknown` — nothing to check against (an unsupported country, or a postal code
+ * The `status` field has one of the following values:
+ * - `ok`: the postal code belongs to the given state/province.
+ * - `invalid`: the postal code is not shaped like a real one for the given country.
+ * - `mismatch`: the postal code is well-formed but belongs to a different state or
+ *   province. `expected_states` names the states it maps to.
+ * - `unknown`: nothing to check against (an unsupported country, or a postal code
  *   absent from the US ZIP dataset). Treated as acceptable by every write path that
  *   uses this check.
  *
  * Only the US and Canada have a real code-to-subdivision map; every other country
  * always returns `unknown`.
  *
- * **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 API returns.
  *
  * If set, this operation will use {@link Security.bearerJwt} from the global security.
  */

package/dist/commonjs/funcs/medicalProductsDeleteDistributor.d.ts

@@ -13,8 +13,8 @@ import { Result } from "../types/fp.js";
  * 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/funcs/medicalProductsDeleteDistributor.js

@@ -52,8 +52,8 @@ const async_js_1 = require("../types/async.js");
  * 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/funcs/medicalProductsDeleteManufacturer.d.ts

@@ -13,8 +13,8 @@ import { Result } from "../types/fp.js";
  * 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.

package/dist/commonjs/funcs/medicalProductsDeleteManufacturer.js

@@ -52,8 +52,8 @@ const async_js_1 = require("../types/async.js");
  * 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.

package/dist/commonjs/funcs/medicalProductsDeleteMedicalProduct.d.ts

@@ -13,8 +13,8 @@ import { Result } from "../types/fp.js";
  * 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.

package/dist/commonjs/funcs/medicalProductsDeleteMedicalProduct.js

@@ -52,8 +52,8 @@ const async_js_1 = require("../types/async.js");
  * 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.

package/dist/commonjs/funcs/medicalProductsDeleteMedicalProductCategory.d.ts

@@ -13,8 +13,8 @@ import { Result } from "../types/fp.js";
  * 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.

package/dist/commonjs/funcs/medicalProductsDeleteMedicalProductCategory.js

@@ -52,8 +52,8 @@ const async_js_1 = require("../types/async.js");
  * 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.

package/dist/commonjs/funcs/medicalProductsDeleteMedicalProductFamily.d.ts

@@ -13,8 +13,8 @@ import { Result } from "../types/fp.js";
  * 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.

package/dist/commonjs/funcs/medicalProductsDeleteMedicalProductFamily.js

@@ -52,8 +52,8 @@ const async_js_1 = require("../types/async.js");
  * 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.

package/dist/commonjs/funcs/medicalProductsListAllDistributors.d.ts

@@ -13,13 +13,13 @@ import { PageIterator } from "../types/operations.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllDistributors.js

@@ -52,13 +52,13 @@ const operations_js_1 = require("../types/operations.js");
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllManufacturers.d.ts

@@ -17,9 +17,9 @@ import { PageIterator } from "../types/operations.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllManufacturers.js

@@ -56,9 +56,9 @@ const operations_js_1 = require("../types/operations.js");
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllMedicalProductCategories.d.ts

@@ -13,13 +13,13 @@ import { PageIterator } from "../types/operations.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllMedicalProductCategories.js

@@ -52,13 +52,13 @@ const operations_js_1 = require("../types/operations.js");
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllMedicalProductFamilies.d.ts

@@ -13,16 +13,16 @@ import { PageIterator } from "../types/operations.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllMedicalProductFamilies.js

@@ -52,16 +52,16 @@ const operations_js_1 = require("../types/operations.js");
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllMedicalProducts.d.ts

@@ -13,17 +13,17 @@ import { PageIterator } from "../types/operations.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsListAllMedicalProducts.js

@@ -52,17 +52,17 @@ const operations_js_1 = require("../types/operations.js");
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsPatchDistributor.d.ts

@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsPatchDistributor.js

@@ -52,7 +52,7 @@ const async_js_1 = require("../types/async.js");
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsPatchManufacturer.d.ts

@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsPatchManufacturer.js

@@ -52,7 +52,7 @@ const async_js_1 = require("../types/async.js");
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsPatchMedicalProduct.d.ts

@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
  * 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.
  *

package/dist/commonjs/funcs/medicalProductsPatchMedicalProduct.js

@@ -52,7 +52,7 @@ const async_js_1 = require("../types/async.js");
  * 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.
  *