@greensecurity/javascript-sdk 0.44.0-beta.65 → 0.44.0-beta.67

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

@@ -0,0 +1,334 @@
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { PageIterator } from "../types/operations.js";
+export declare class MedicalProducts extends ClientSDK {
+    /**
+     * List all medical products
+     *
+     * @remarks
+     * Returns the medical products in the medical product catalog. Retired records are excluded
+     * unless `status` asks for them.
+     *
+     * A medical product is a single device 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.
+     *
+     * Sortable by id, product_name, brand_name, primary_di, status, created_at and updated_at.
+     *
+     * Requires the `medical_products` / `view` permission.
+     */
+    listAllMedicalProducts(request: operations.ListAllMedicalProductsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListAllMedicalProductsResponse, {
+        page: number;
+    }>>;
+    /**
+     * Create a medical product
+     *
+     * @remarks
+     * Adds a medical product to the medical product catalog.
+     *
+     * Requires the `medical_products` / `add` permission.
+     */
+    createMedicalProduct(request: components.MedicalProductCreate, options?: RequestOptions): Promise<components.MedicalProduct>;
+    /**
+     * Get the medical product with the given ID
+     *
+     * @remarks
+     * Returns a single medical product. Retired records are not returned.
+     *
+     * Requires the `medical_products` / `view` permission.
+     */
+    getMedicalProduct(request: operations.GetMedicalProductRequest, options?: RequestOptions): Promise<components.MedicalProduct>;
+    /**
+     * Update the medical product with the given ID
+     *
+     * @remarks
+     * Updates a medical product. Keys the request omits are left as they are.
+     *
+     * Requires the `medical_products` / `edit` permission.
+     */
+    updateMedicalProduct(request: operations.UpdateMedicalProductRequest, options?: RequestOptions): Promise<components.MedicalProduct>;
+    /**
+     * Partially update the medical product with the given ID
+     *
+     * @remarks
+     * Identical to `PUT`: both leave omitted keys as they are.
+     *
+     * Requires the `medical_products` / `edit` permission.
+     */
+    patchMedicalProduct(request: operations.PatchMedicalProductRequest, options?: RequestOptions): Promise<components.MedicalProduct>;
+    /**
+     * 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
+     * referencing it. Retiring also frees the record's natural key for a replacement.
+     *
+     * Requires the `medical_products` / `delete` permission.
+     */
+    deleteMedicalProduct(request: operations.DeleteMedicalProductRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
+    /**
+     * List all product families
+     *
+     * @remarks
+     * Returns the product families in the medical product catalog. Retired records are excluded
+     * 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.
+     *
+     * Families share the `medical_products` permission rather than 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.
+     *
+     * Requires the `medical_products` / `view` permission.
+     */
+    listAllMedicalProductFamilies(request: operations.ListAllMedicalProductFamiliesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListAllMedicalProductFamiliesResponse, {
+        page: number;
+    }>>;
+    /**
+     * Create a product family
+     *
+     * @remarks
+     * Adds a product family to the medical product catalog.
+     *
+     * Requires the `medical_products` / `add` permission.
+     */
+    createMedicalProductFamily(request: components.MedicalProductFamilyCreate, options?: RequestOptions): Promise<components.MedicalProductFamily>;
+    /**
+     * Get the product family with the given ID
+     *
+     * @remarks
+     * Returns a single product family. Retired records are not returned.
+     *
+     * Requires the `medical_products` / `view` permission.
+     */
+    getMedicalProductFamily(request: operations.GetMedicalProductFamilyRequest, options?: RequestOptions): Promise<components.MedicalProductFamily>;
+    /**
+     * Update the product family with the given ID
+     *
+     * @remarks
+     * Updates a product family. Keys the request omits are left as they are.
+     *
+     * Requires the `medical_products` / `edit` permission.
+     */
+    updateMedicalProductFamily(request: operations.UpdateMedicalProductFamilyRequest, options?: RequestOptions): Promise<components.MedicalProductFamily>;
+    /**
+     * Partially update the product family with the given ID
+     *
+     * @remarks
+     * Identical to `PUT`: both leave omitted keys as they are.
+     *
+     * Requires the `medical_products` / `edit` permission.
+     */
+    patchMedicalProductFamily(request: operations.PatchMedicalProductFamilyRequest, options?: RequestOptions): Promise<components.MedicalProductFamily>;
+    /**
+     * 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
+     * referencing it. Retiring also frees the record's natural key for a replacement.
+     *
+     * Requires the `medical_products` / `delete` permission.
+     */
+    deleteMedicalProductFamily(request: operations.DeleteMedicalProductFamilyRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
+    /**
+     * List all product categories
+     *
+     * @remarks
+     * Returns the product categories in the medical product catalog. Retired records are excluded
+     * unless `status` asks for them.
+     *
+     * 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.
+     *
+     * Requires the `medical_product_categories` / `view` permission.
+     */
+    listAllMedicalProductCategories(request: operations.ListAllMedicalProductCategoriesRequest, options?: RequestOptions): Promise<PageIterator<operations.ListAllMedicalProductCategoriesResponse, {
+        page: number;
+    }>>;
+    /**
+     * Create a product category
+     *
+     * @remarks
+     * Adds a product category to the medical product catalog.
+     *
+     * Requires the `medical_product_categories` / `add` permission.
+     */
+    createMedicalProductCategory(request: components.MedicalProductCategoryCreate, options?: RequestOptions): Promise<components.MedicalProductCategory>;
+    /**
+     * Get the product category with the given ID
+     *
+     * @remarks
+     * Returns a single product category. Retired records are not returned.
+     *
+     * Requires the `medical_product_categories` / `view` permission.
+     */
+    getMedicalProductCategory(request: operations.GetMedicalProductCategoryRequest, options?: RequestOptions): Promise<components.MedicalProductCategory>;
+    /**
+     * Update the product category with the given ID
+     *
+     * @remarks
+     * Updates a product category. Keys the request omits are left as they are.
+     *
+     * Requires the `medical_product_categories` / `edit` permission.
+     */
+    updateMedicalProductCategory(request: operations.UpdateMedicalProductCategoryRequest, options?: RequestOptions): Promise<components.MedicalProductCategory>;
+    /**
+     * Partially update the product category with the given ID
+     *
+     * @remarks
+     * Identical to `PUT`: both leave omitted keys as they are.
+     *
+     * Requires the `medical_product_categories` / `edit` permission.
+     */
+    patchMedicalProductCategory(request: operations.PatchMedicalProductCategoryRequest, options?: RequestOptions): Promise<components.MedicalProductCategory>;
+    /**
+     * 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
+     * referencing it. Retiring also frees the record's natural key for a replacement.
+     *
+     * Requires the `medical_product_categories` / `delete` permission.
+     */
+    deleteMedicalProductCategory(request: operations.DeleteMedicalProductCategoryRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
+    /**
+     * List all manufacturers
+     *
+     * @remarks
+     * Returns the manufacturers in the medical product catalog. Retired records are excluded
+     * 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.
+     *
+     * Sortable by id, name, country, status, created_at and updated_at.
+     *
+     * Requires the `manufacturers` / `view` permission.
+     */
+    listAllManufacturers(request: operations.ListAllManufacturersRequest, options?: RequestOptions): Promise<PageIterator<operations.ListAllManufacturersResponse, {
+        page: number;
+    }>>;
+    /**
+     * Create a manufacturer
+     *
+     * @remarks
+     * Adds a manufacturer to the medical product catalog.
+     *
+     * Requires the `manufacturers` / `add` permission.
+     */
+    createManufacturer(request: components.ManufacturerCreate, options?: RequestOptions): Promise<components.Manufacturer>;
+    /**
+     * Get the manufacturer with the given ID
+     *
+     * @remarks
+     * Returns a single manufacturer. Retired records are not returned.
+     *
+     * Requires the `manufacturers` / `view` permission.
+     */
+    getManufacturer(request: operations.GetManufacturerRequest, options?: RequestOptions): Promise<components.Manufacturer>;
+    /**
+     * Update the manufacturer with the given ID
+     *
+     * @remarks
+     * Updates a manufacturer. Keys the request omits are left as they are.
+     *
+     * Requires the `manufacturers` / `edit` permission.
+     */
+    updateManufacturer(request: operations.UpdateManufacturerRequest, options?: RequestOptions): Promise<components.Manufacturer>;
+    /**
+     * Partially update the manufacturer with the given ID
+     *
+     * @remarks
+     * Identical to `PUT`: both leave omitted keys as they are.
+     *
+     * Requires the `manufacturers` / `edit` permission.
+     */
+    patchManufacturer(request: operations.PatchManufacturerRequest, options?: RequestOptions): Promise<components.Manufacturer>;
+    /**
+     * 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
+     * referencing it. Retiring also frees the record's natural key for a replacement.
+     *
+     * Requires the `manufacturers` / `delete` permission.
+     */
+    deleteManufacturer(request: operations.DeleteManufacturerRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
+    /**
+     * List all distributors
+     *
+     * @remarks
+     * Returns the distributors in the medical product catalog. Retired records are excluded
+     * 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.
+     *
+     * Sortable by id, name, country, status, created_at and updated_at.
+     *
+     * Requires the `distributors` / `view` permission.
+     */
+    listAllDistributors(request: operations.ListAllDistributorsRequest, options?: RequestOptions): Promise<PageIterator<operations.ListAllDistributorsResponse, {
+        page: number;
+    }>>;
+    /**
+     * Create a distributor
+     *
+     * @remarks
+     * Adds a distributor to the medical product catalog.
+     *
+     * Requires the `distributors` / `add` permission.
+     */
+    createDistributor(request: components.DistributorCreate, options?: RequestOptions): Promise<components.Distributor>;
+    /**
+     * Get the distributor with the given ID
+     *
+     * @remarks
+     * Returns a single distributor. Retired records are not returned.
+     *
+     * Requires the `distributors` / `view` permission.
+     */
+    getDistributor(request: operations.GetDistributorRequest, options?: RequestOptions): Promise<components.Distributor>;
+    /**
+     * Update the distributor with the given ID
+     *
+     * @remarks
+     * Updates a distributor. Keys the request omits are left as they are.
+     *
+     * Requires the `distributors` / `edit` permission.
+     */
+    updateDistributor(request: operations.UpdateDistributorRequest, options?: RequestOptions): Promise<components.Distributor>;
+    /**
+     * Partially update the distributor with the given ID
+     *
+     * @remarks
+     * Identical to `PUT`: both leave omitted keys as they are.
+     *
+     * Requires the `distributors` / `edit` permission.
+     */
+    patchDistributor(request: operations.PatchDistributorRequest, options?: RequestOptions): Promise<components.Distributor>;
+    /**
+     * 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
+     * referencing it. Retiring also frees the record's natural key for a replacement.
+     *
+     * Requires the `distributors` / `delete` permission.
+     */
+    deleteDistributor(request: operations.DeleteDistributorRequest, options?: RequestOptions): Promise<components.DeleteApiResponse>;
+}
+//# sourceMappingURL=medicalproducts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"medicalproducts.d.ts","sourceRoot":"","sources":["../../../src/sdk/medicalproducts.ts"],"names":[],"mappings":"AAkCA,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,eAAgB,SAAQ,SAAS;IAC5C;;;;;;;;;;;;;;;;;OAiBG;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;;;;;;;OAOG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,oBAAoB,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;IAQrC;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;IAQrC;;;;;;;OAOG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;IAQrC;;;;;;;OAOG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC;IAQrC;;;;;;;;;OASG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAQxC;;;;;;;;;;;;;;;;OAgBG;IACG,6BAA6B,CACjC,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,qCAAqC,EAChD;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;OAOG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,0BAA0B,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;;;OAOG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,8BAA8B,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;;;OAOG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;;;OAOG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,CAAC,gCAAgC,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAQ3C;;;;;;;;;OASG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,iCAAiC,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAQxC;;;;;;;;;;;;;OAaG;IACG,+BAA+B,CACnC,OAAO,EAAE,UAAU,CAAC,sCAAsC,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CACV,UAAU,CAAC,uCAAuC,EAClD;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CACjB,CACF;IAQD;;;;;;;OAOG;IACG,4BAA4B,CAChC,OAAO,EAAE,UAAU,CAAC,4BAA4B,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;OAOG;IACG,yBAAyB,CAC7B,OAAO,EAAE,UAAU,CAAC,gCAAgC,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;OAOG;IACG,4BAA4B,CAChC,OAAO,EAAE,UAAU,CAAC,mCAAmC,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;OAOG;IACG,2BAA2B,CAC/B,OAAO,EAAE,UAAU,CAAC,kCAAkC,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAQ7C;;;;;;;;;OASG;IACG,4BAA4B,CAChC,OAAO,EAAE,UAAU,CAAC,mCAAmC,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAQxC;;;;;;;;;;;;;OAaG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,2BAA2B,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,YAAY,CAAC,UAAU,CAAC,4BAA4B,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CACxE;IAQD;;;;;;;OAOG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,kBAAkB,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;IAQnC;;;;;;;OAOG;IACG,eAAe,CACnB,OAAO,EAAE,UAAU,CAAC,sBAAsB,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;IAQnC;;;;;;;OAOG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;IAQnC;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;IAQnC;;;;;;;;;OASG;IACG,kBAAkB,CACtB,OAAO,EAAE,UAAU,CAAC,yBAAyB,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAQxC;;;;;;;;;;;;;OAaG;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;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,iBAAiB,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;IAQlC;;;;;;;OAOG;IACG,cAAc,CAClB,OAAO,EAAE,UAAU,CAAC,qBAAqB,EACzC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;IAQlC;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;IAQlC;;;;;;;OAOG;IACG,gBAAgB,CACpB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC;IAQlC;;;;;;;;;OASG;IACG,iBAAiB,CACrB,OAAO,EAAE,UAAU,CAAC,wBAAwB,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC;CAOzC"}