@greensecurity/javascript-sdk 0.44.0-beta.7 → 0.44.0-beta.71

package/src/sdk/medicalproducts.ts

@@ -0,0 +1,674 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { medicalProductsCreateDistributor } from "../funcs/medicalProductsCreateDistributor.js";
+import { medicalProductsCreateManufacturer } from "../funcs/medicalProductsCreateManufacturer.js";
+import { medicalProductsCreateMedicalProduct } from "../funcs/medicalProductsCreateMedicalProduct.js";
+import { medicalProductsCreateMedicalProductCategory } from "../funcs/medicalProductsCreateMedicalProductCategory.js";
+import { medicalProductsCreateMedicalProductFamily } from "../funcs/medicalProductsCreateMedicalProductFamily.js";
+import { medicalProductsDeleteDistributor } from "../funcs/medicalProductsDeleteDistributor.js";
+import { medicalProductsDeleteManufacturer } from "../funcs/medicalProductsDeleteManufacturer.js";
+import { medicalProductsDeleteMedicalProduct } from "../funcs/medicalProductsDeleteMedicalProduct.js";
+import { medicalProductsDeleteMedicalProductCategory } from "../funcs/medicalProductsDeleteMedicalProductCategory.js";
+import { medicalProductsDeleteMedicalProductFamily } from "../funcs/medicalProductsDeleteMedicalProductFamily.js";
+import { medicalProductsGetDistributor } from "../funcs/medicalProductsGetDistributor.js";
+import { medicalProductsGetManufacturer } from "../funcs/medicalProductsGetManufacturer.js";
+import { medicalProductsGetMedicalProduct } from "../funcs/medicalProductsGetMedicalProduct.js";
+import { medicalProductsGetMedicalProductCategory } from "../funcs/medicalProductsGetMedicalProductCategory.js";
+import { medicalProductsGetMedicalProductFamily } from "../funcs/medicalProductsGetMedicalProductFamily.js";
+import { medicalProductsListAllDistributors } from "../funcs/medicalProductsListAllDistributors.js";
+import { medicalProductsListAllManufacturers } from "../funcs/medicalProductsListAllManufacturers.js";
+import { medicalProductsListAllMedicalProductCategories } from "../funcs/medicalProductsListAllMedicalProductCategories.js";
+import { medicalProductsListAllMedicalProductFamilies } from "../funcs/medicalProductsListAllMedicalProductFamilies.js";
+import { medicalProductsListAllMedicalProducts } from "../funcs/medicalProductsListAllMedicalProducts.js";
+import { medicalProductsPatchDistributor } from "../funcs/medicalProductsPatchDistributor.js";
+import { medicalProductsPatchManufacturer } from "../funcs/medicalProductsPatchManufacturer.js";
+import { medicalProductsPatchMedicalProduct } from "../funcs/medicalProductsPatchMedicalProduct.js";
+import { medicalProductsPatchMedicalProductCategory } from "../funcs/medicalProductsPatchMedicalProductCategory.js";
+import { medicalProductsPatchMedicalProductFamily } from "../funcs/medicalProductsPatchMedicalProductFamily.js";
+import { medicalProductsUpdateDistributor } from "../funcs/medicalProductsUpdateDistributor.js";
+import { medicalProductsUpdateManufacturer } from "../funcs/medicalProductsUpdateManufacturer.js";
+import { medicalProductsUpdateMedicalProduct } from "../funcs/medicalProductsUpdateMedicalProduct.js";
+import { medicalProductsUpdateMedicalProductCategory } from "../funcs/medicalProductsUpdateMedicalProductCategory.js";
+import { medicalProductsUpdateMedicalProductFamily } from "../funcs/medicalProductsUpdateMedicalProductFamily.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
+
+export 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.
+   */
+  async listAllMedicalProducts(
+    request: operations.ListAllMedicalProductsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListAllMedicalProductsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(medicalProductsListAllMedicalProducts(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a medical product
+   *
+   * @remarks
+   * Adds a medical product to the medical product catalog.
+   *
+   * Requires the `medical_products` / `add` permission.
+   */
+  async createMedicalProduct(
+    request: components.MedicalProductCreate,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProduct> {
+    return unwrapAsync(medicalProductsCreateMedicalProduct(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async getMedicalProduct(
+    request: operations.GetMedicalProductRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProduct> {
+    return unwrapAsync(medicalProductsGetMedicalProduct(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async updateMedicalProduct(
+    request: operations.UpdateMedicalProductRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProduct> {
+    return unwrapAsync(medicalProductsUpdateMedicalProduct(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async patchMedicalProduct(
+    request: operations.PatchMedicalProductRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProduct> {
+    return unwrapAsync(medicalProductsPatchMedicalProduct(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async deleteMedicalProduct(
+    request: operations.DeleteMedicalProductRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteApiResponse> {
+    return unwrapAsync(medicalProductsDeleteMedicalProduct(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async listAllMedicalProductFamilies(
+    request: operations.ListAllMedicalProductFamiliesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListAllMedicalProductFamiliesResponse,
+      { page: number }
+    >
+  > {
+    return unwrapResultIterator(medicalProductsListAllMedicalProductFamilies(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a product family
+   *
+   * @remarks
+   * Adds a product family to the medical product catalog.
+   *
+   * Requires the `medical_products` / `add` permission.
+   */
+  async createMedicalProductFamily(
+    request: components.MedicalProductFamilyCreate,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductFamily> {
+    return unwrapAsync(medicalProductsCreateMedicalProductFamily(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async getMedicalProductFamily(
+    request: operations.GetMedicalProductFamilyRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductFamily> {
+    return unwrapAsync(medicalProductsGetMedicalProductFamily(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async updateMedicalProductFamily(
+    request: operations.UpdateMedicalProductFamilyRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductFamily> {
+    return unwrapAsync(medicalProductsUpdateMedicalProductFamily(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async patchMedicalProductFamily(
+    request: operations.PatchMedicalProductFamilyRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductFamily> {
+    return unwrapAsync(medicalProductsPatchMedicalProductFamily(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async deleteMedicalProductFamily(
+    request: operations.DeleteMedicalProductFamilyRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteApiResponse> {
+    return unwrapAsync(medicalProductsDeleteMedicalProductFamily(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async listAllMedicalProductCategories(
+    request: operations.ListAllMedicalProductCategoriesRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      operations.ListAllMedicalProductCategoriesResponse,
+      { page: number }
+    >
+  > {
+    return unwrapResultIterator(medicalProductsListAllMedicalProductCategories(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a product category
+   *
+   * @remarks
+   * Adds a product category to the medical product catalog.
+   *
+   * Requires the `medical_product_categories` / `add` permission.
+   */
+  async createMedicalProductCategory(
+    request: components.MedicalProductCategoryCreate,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductCategory> {
+    return unwrapAsync(medicalProductsCreateMedicalProductCategory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async getMedicalProductCategory(
+    request: operations.GetMedicalProductCategoryRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductCategory> {
+    return unwrapAsync(medicalProductsGetMedicalProductCategory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async updateMedicalProductCategory(
+    request: operations.UpdateMedicalProductCategoryRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductCategory> {
+    return unwrapAsync(medicalProductsUpdateMedicalProductCategory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async patchMedicalProductCategory(
+    request: operations.PatchMedicalProductCategoryRequest,
+    options?: RequestOptions,
+  ): Promise<components.MedicalProductCategory> {
+    return unwrapAsync(medicalProductsPatchMedicalProductCategory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async deleteMedicalProductCategory(
+    request: operations.DeleteMedicalProductCategoryRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteApiResponse> {
+    return unwrapAsync(medicalProductsDeleteMedicalProductCategory(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async listAllManufacturers(
+    request: operations.ListAllManufacturersRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListAllManufacturersResponse, { page: number }>
+  > {
+    return unwrapResultIterator(medicalProductsListAllManufacturers(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a manufacturer
+   *
+   * @remarks
+   * Adds a manufacturer to the medical product catalog.
+   *
+   * Requires the `manufacturers` / `add` permission.
+   */
+  async createManufacturer(
+    request: components.ManufacturerCreate,
+    options?: RequestOptions,
+  ): Promise<components.Manufacturer> {
+    return unwrapAsync(medicalProductsCreateManufacturer(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get the manufacturer with the given ID
+   *
+   * @remarks
+   * Returns a single manufacturer. Retired records are not returned.
+   *
+   * Requires the `manufacturers` / `view` permission.
+   */
+  async getManufacturer(
+    request: operations.GetManufacturerRequest,
+    options?: RequestOptions,
+  ): Promise<components.Manufacturer> {
+    return unwrapAsync(medicalProductsGetManufacturer(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async updateManufacturer(
+    request: operations.UpdateManufacturerRequest,
+    options?: RequestOptions,
+  ): Promise<components.Manufacturer> {
+    return unwrapAsync(medicalProductsUpdateManufacturer(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Partially update the manufacturer with the given ID
+   *
+   * @remarks
+   * Identical to `PUT`: both leave omitted keys as they are.
+   *
+   * Requires the `manufacturers` / `edit` permission.
+   */
+  async patchManufacturer(
+    request: operations.PatchManufacturerRequest,
+    options?: RequestOptions,
+  ): Promise<components.Manufacturer> {
+    return unwrapAsync(medicalProductsPatchManufacturer(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async deleteManufacturer(
+    request: operations.DeleteManufacturerRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteApiResponse> {
+    return unwrapAsync(medicalProductsDeleteManufacturer(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async listAllDistributors(
+    request: operations.ListAllDistributorsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<operations.ListAllDistributorsResponse, { page: number }>
+  > {
+    return unwrapResultIterator(medicalProductsListAllDistributors(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a distributor
+   *
+   * @remarks
+   * Adds a distributor to the medical product catalog.
+   *
+   * Requires the `distributors` / `add` permission.
+   */
+  async createDistributor(
+    request: components.DistributorCreate,
+    options?: RequestOptions,
+  ): Promise<components.Distributor> {
+    return unwrapAsync(medicalProductsCreateDistributor(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get the distributor with the given ID
+   *
+   * @remarks
+   * Returns a single distributor. Retired records are not returned.
+   *
+   * Requires the `distributors` / `view` permission.
+   */
+  async getDistributor(
+    request: operations.GetDistributorRequest,
+    options?: RequestOptions,
+  ): Promise<components.Distributor> {
+    return unwrapAsync(medicalProductsGetDistributor(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async updateDistributor(
+    request: operations.UpdateDistributorRequest,
+    options?: RequestOptions,
+  ): Promise<components.Distributor> {
+    return unwrapAsync(medicalProductsUpdateDistributor(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Partially update the distributor with the given ID
+   *
+   * @remarks
+   * Identical to `PUT`: both leave omitted keys as they are.
+   *
+   * Requires the `distributors` / `edit` permission.
+   */
+  async patchDistributor(
+    request: operations.PatchDistributorRequest,
+    options?: RequestOptions,
+  ): Promise<components.Distributor> {
+    return unwrapAsync(medicalProductsPatchDistributor(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async deleteDistributor(
+    request: operations.DeleteDistributorRequest,
+    options?: RequestOptions,
+  ): Promise<components.DeleteApiResponse> {
+    return unwrapAsync(medicalProductsDeleteDistributor(
+      this,
+      request,
+      options,
+    ));
+  }
+}