@icure/cardinal-sdk 2.1.1 → 2.1.3

package/model/Invoice.mjs

@@ -9,69 +9,320 @@ import { DecryptedInvoicingCode, EncryptedInvoicingCode } from './embed/Invoicin
 import { Payment } from './embed/Payment.mjs';
 import { PaymentType } from './embed/PaymentType.mjs';
 import { SecurityMetadata } from './embed/SecurityMetadata.mjs';
+/**
+ *
+ *  Represents an invoice. An invoice is used to bill patients, mutual funds, or paying agencies for
+ *  healthcare
+ *  services rendered. It is serialized in JSON and saved in the underlying iCure CouchDB database.
+ *  /
+ */
 export class DecryptedInvoice {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the invoice in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The identifiers of the invoice.
+         */
         this.identifier = [];
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this invoice.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this invoice.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the invoice as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular invoice.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the invoice was drafted.
+         */
         this.invoiceDate = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the invoice was sent.
+         */
         this.sentDate = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the invoice was printed.
+         */
         this.printedDate = undefined;
+        /**
+         *
+         *  The list of invoicing codes associated with this invoice.
+         */
         this.invoicingCodes = [];
+        /**
+         *
+         *  Map of receipt references.
+         */
         this.receipts = {};
+        /**
+         *
+         *  Id of the recipient of the invoice.
+         */
         this.recipientId = undefined;
+        /**
+         *
+         *  The invoice reference number.
+         */
         this.invoiceReference = undefined;
+        /**
+         *
+         *  The decision reference number.
+         */
         this.decisionReference = undefined;
+        /**
+         *
+         *  The third party reference.
+         */
         this.thirdPartyReference = undefined;
+        /**
+         *
+         *  Justification for third party payment.
+         */
         this.thirdPartyPaymentJustification = undefined;
+        /**
+         *
+         *  Reason for third party payment.
+         */
         this.thirdPartyPaymentReason = undefined;
+        /**
+         *
+         *  The reason for the invoice.
+         */
         this.reason = undefined;
+        /**
+         *
+         *  The group id for grouping related invoices.
+         */
         this.groupId = undefined;
+        /**
+         *
+         *  Type of payment (cash, wired, insurance, debit card, etc.).
+         */
         this.paymentType = undefined;
+        /**
+         *
+         *  The amount paid.
+         */
         this.paid = undefined;
+        /**
+         *
+         *  List of payments made for this invoice.
+         */
         this.payments = undefined;
+        /**
+         *
+         *  SSIN of the gnotion.
+         */
         this.gnotionSsin = undefined;
+        /**
+         *
+         *  Last name of the gnotion.
+         */
         this.gnotionLastName = undefined;
+        /**
+         *
+         *  First name of the gnotion.
+         */
         this.gnotionFirstName = undefined;
+        /**
+         *
+         *  CD-HCPARTY code of the gnotion.
+         */
         this.gnotionCdHcParty = undefined;
+        /**
+         *
+         *  The invoicing period.
+         */
         this.invoicePeriod = undefined;
+        /**
+         *
+         *  The type of care provider.
+         */
         this.careProviderType = undefined;
+        /**
+         *
+         *  SSIN of the internship.
+         */
         this.internshipSsin = undefined;
+        /**
+         *
+         *  Last name of the internship supervisor.
+         */
         this.internshipLastName = undefined;
+        /**
+         *
+         *  First name of the internship supervisor.
+         */
         this.internshipFirstName = undefined;
+        /**
+         *
+         *  CD-HCPARTY code of the internship.
+         */
         this.internshipCdHcParty = undefined;
+        /**
+         *
+         *  CBE number of the internship.
+         */
         this.internshipCbe = undefined;
+        /**
+         *
+         *  SSIN of the supervisor.
+         */
         this.supervisorSsin = undefined;
+        /**
+         *
+         *  Last name of the supervisor.
+         */
         this.supervisorLastName = undefined;
+        /**
+         *
+         *  First name of the supervisor.
+         */
         this.supervisorFirstName = undefined;
+        /**
+         *
+         *  CD-HCPARTY code of the supervisor.
+         */
         this.supervisorCdHcParty = undefined;
+        /**
+         *
+         *  CBE number of the supervisor.
+         */
         this.supervisorCbe = undefined;
+        /**
+         *
+         *  Error message if any.
+         */
         this.error = undefined;
+        /**
+         *
+         *  Name of the encounter location.
+         */
         this.encounterLocationName = undefined;
+        /**
+         *
+         *  Norm of the encounter location.
+         */
         this.encounterLocationNorm = undefined;
+        /**
+         *
+         *  Justification for long delay.
+         */
         this.longDelayJustification = undefined;
+        /**
+         *
+         *  Id of the corrective invoice.
+         */
         this.correctiveInvoiceId = undefined;
+        /**
+         *
+         *  Id of the corrected invoice.
+         */
         this.correctedInvoiceId = undefined;
+        /**
+         *
+         *  Whether this invoice is a credit note.
+         */
         this.creditNote = undefined;
+        /**
+         *
+         *  Id of the related invoice for the credit note.
+         */
         this.creditNoteRelatedInvoiceId = undefined;
+        /**
+         *
+         *  Identity document reader information.
+         */
         this.idDocument = undefined;
+        /**
+         *
+         *  The admission date for hospitalization invoices.
+         */
         this.admissionDate = undefined;
+        /**
+         *
+         *  Service code of the location.
+         */
         this.locationService = undefined;
+        /**
+         *
+         *  The reason for cancellation.
+         */
         this.cancelReason = undefined;
+        /**
+         *
+         *  The date of cancellation.
+         */
         this.cancelDate = undefined;
+        /**
+         *
+         *  Extra options for the invoice.
+         */
         this.options = {};
+        /**
+         *
+         *  The secret patient key, encrypted in the patient's own AES key.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The patient id encrypted in the delegates' AES keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The keys used to encrypt this entity when stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = false;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== false)
@@ -396,69 +647,320 @@ export class DecryptedInvoice {
         return res;
     }
 }
+/**
+ *
+ *  Represents an invoice. An invoice is used to bill patients, mutual funds, or paying agencies for
+ *  healthcare
+ *  services rendered. It is serialized in JSON and saved in the underlying iCure CouchDB database.
+ *  /
+ */
 export class EncryptedInvoice {
     constructor(partial) {
         var _a;
+        /**
+         *
+         *  The revision of the invoice in the database, used for conflict management / optimistic locking.
+         */
         this.rev = undefined;
+        /**
+         *
+         *  The identifiers of the invoice.
+         */
         this.identifier = [];
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of creation.
+         */
         this.created = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) of the latest modification.
+         */
         this.modified = undefined;
+        /**
+         *
+         *  The id of the User that created this invoice.
+         */
         this.author = undefined;
+        /**
+         *
+         *  The id of the HealthcareParty that is responsible for this invoice.
+         */
         this.responsible = undefined;
+        /**
+         *
+         *  Tags that qualify the invoice as being member of a certain class.
+         */
         this.tags = [];
+        /**
+         *
+         *  Codes that identify or qualify this particular invoice.
+         */
         this.codes = [];
+        /**
+         *
+         *  Hard delete (unix epoch in ms) timestamp of the object.
+         */
         this.deletionDate = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the invoice was drafted.
+         */
         this.invoiceDate = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the invoice was sent.
+         */
         this.sentDate = undefined;
+        /**
+         *
+         *  The timestamp (unix epoch in ms) when the invoice was printed.
+         */
         this.printedDate = undefined;
+        /**
+         *
+         *  The list of invoicing codes associated with this invoice.
+         */
         this.invoicingCodes = [];
+        /**
+         *
+         *  Map of receipt references.
+         */
         this.receipts = {};
+        /**
+         *
+         *  Id of the recipient of the invoice.
+         */
         this.recipientId = undefined;
+        /**
+         *
+         *  The invoice reference number.
+         */
         this.invoiceReference = undefined;
+        /**
+         *
+         *  The decision reference number.
+         */
         this.decisionReference = undefined;
+        /**
+         *
+         *  The third party reference.
+         */
         this.thirdPartyReference = undefined;
+        /**
+         *
+         *  Justification for third party payment.
+         */
         this.thirdPartyPaymentJustification = undefined;
+        /**
+         *
+         *  Reason for third party payment.
+         */
         this.thirdPartyPaymentReason = undefined;
+        /**
+         *
+         *  The reason for the invoice.
+         */
         this.reason = undefined;
+        /**
+         *
+         *  The group id for grouping related invoices.
+         */
         this.groupId = undefined;
+        /**
+         *
+         *  Type of payment (cash, wired, insurance, debit card, etc.).
+         */
         this.paymentType = undefined;
+        /**
+         *
+         *  The amount paid.
+         */
         this.paid = undefined;
+        /**
+         *
+         *  List of payments made for this invoice.
+         */
         this.payments = undefined;
+        /**
+         *
+         *  SSIN of the gnotion.
+         */
         this.gnotionSsin = undefined;
+        /**
+         *
+         *  Last name of the gnotion.
+         */
         this.gnotionLastName = undefined;
+        /**
+         *
+         *  First name of the gnotion.
+         */
         this.gnotionFirstName = undefined;
+        /**
+         *
+         *  CD-HCPARTY code of the gnotion.
+         */
         this.gnotionCdHcParty = undefined;
+        /**
+         *
+         *  The invoicing period.
+         */
         this.invoicePeriod = undefined;
+        /**
+         *
+         *  The type of care provider.
+         */
         this.careProviderType = undefined;
+        /**
+         *
+         *  SSIN of the internship.
+         */
         this.internshipSsin = undefined;
+        /**
+         *
+         *  Last name of the internship supervisor.
+         */
         this.internshipLastName = undefined;
+        /**
+         *
+         *  First name of the internship supervisor.
+         */
         this.internshipFirstName = undefined;
+        /**
+         *
+         *  CD-HCPARTY code of the internship.
+         */
         this.internshipCdHcParty = undefined;
+        /**
+         *
+         *  CBE number of the internship.
+         */
         this.internshipCbe = undefined;
+        /**
+         *
+         *  SSIN of the supervisor.
+         */
         this.supervisorSsin = undefined;
+        /**
+         *
+         *  Last name of the supervisor.
+         */
         this.supervisorLastName = undefined;
+        /**
+         *
+         *  First name of the supervisor.
+         */
         this.supervisorFirstName = undefined;
+        /**
+         *
+         *  CD-HCPARTY code of the supervisor.
+         */
         this.supervisorCdHcParty = undefined;
+        /**
+         *
+         *  CBE number of the supervisor.
+         */
         this.supervisorCbe = undefined;
+        /**
+         *
+         *  Error message if any.
+         */
         this.error = undefined;
+        /**
+         *
+         *  Name of the encounter location.
+         */
         this.encounterLocationName = undefined;
+        /**
+         *
+         *  Norm of the encounter location.
+         */
         this.encounterLocationNorm = undefined;
+        /**
+         *
+         *  Justification for long delay.
+         */
         this.longDelayJustification = undefined;
+        /**
+         *
+         *  Id of the corrective invoice.
+         */
         this.correctiveInvoiceId = undefined;
+        /**
+         *
+         *  Id of the corrected invoice.
+         */
         this.correctedInvoiceId = undefined;
+        /**
+         *
+         *  Whether this invoice is a credit note.
+         */
         this.creditNote = undefined;
+        /**
+         *
+         *  Id of the related invoice for the credit note.
+         */
         this.creditNoteRelatedInvoiceId = undefined;
+        /**
+         *
+         *  Identity document reader information.
+         */
         this.idDocument = undefined;
+        /**
+         *
+         *  The admission date for hospitalization invoices.
+         */
         this.admissionDate = undefined;
+        /**
+         *
+         *  Service code of the location.
+         */
         this.locationService = undefined;
+        /**
+         *
+         *  The reason for cancellation.
+         */
         this.cancelReason = undefined;
+        /**
+         *
+         *  The date of cancellation.
+         */
         this.cancelDate = undefined;
+        /**
+         *
+         *  Extra options for the invoice.
+         */
         this.options = {};
+        /**
+         *
+         *  The secret patient key, encrypted in the patient's own AES key.
+         */
         this.secretForeignKeys = [];
+        /**
+         *
+         *  The patient id encrypted in the delegates' AES keys.
+         */
         this.cryptedForeignKeys = {};
+        /**
+         *
+         *  The delegations giving access to connected healthcare information.
+         */
         this.delegations = {};
+        /**
+         *
+         *  The keys used to encrypt this entity when stored encrypted.
+         */
         this.encryptionKeys = {};
+        /**
+         *
+         *  The base64-encoded encrypted fields of this entity.
+         */
         this.encryptedSelf = undefined;
+        /**
+         *
+         *  The security metadata of the entity.
+         */
         this.securityMetadata = undefined;
         this.isEncrypted = true;
         if (partial.isEncrypted !== undefined && partial.isEncrypted !== true)

package/model/ListOfProperties.d.mts

@@ -1,5 +1,14 @@
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
+/**
+ *
+ *
+ *   DTO wrapping a set of property stubs, used for bulk property operations.
+ */
 export declare class ListOfProperties {
+    /**
+     *
+     *  The set of property stubs.
+     */
     properties: Array<DecryptedPropertyStub>;
     constructor(partial: Partial<ListOfProperties>);
     toJSON(): object;

package/model/ListOfProperties.mjs

@@ -1,8 +1,17 @@
 // auto-generated file
 import { expectArray, expectObject, extractEntry } from '../internal/JsonDecodeUtils.mjs';
 import { DecryptedPropertyStub } from './PropertyStub.mjs';
+/**
+ *
+ *
+ *   DTO wrapping a set of property stubs, used for bulk property operations.
+ */
 export class ListOfProperties {
     constructor(partial) {
+        /**
+         *
+         *  The set of property stubs.
+         */
         this.properties = [];
         if ('properties' in partial && partial.properties !== undefined)
             this.properties = partial.properties;