@unified-api/typescript-sdk 2.85.51 → 2.85.53

package/src/sdk/models/shared/legalmatter.ts

@@ -22,30 +22,45 @@ import {
   LegalParty$outboundSchema,
 } from "./legalparty.js";
 
+/**
+ * how the matter is billed
+ */
 export const BillingMethod = {
   Hourly: "HOURLY",
   FlatFee: "FLAT_FEE",
   Contingency: "CONTINGENCY",
   Other: "OTHER",
 } as const;
+/**
+ * how the matter is billed
+ */
 export type BillingMethod = OpenEnum<typeof BillingMethod>;
 
+/**
+ * the matter status
+ */
 export const LegalMatterStatus = {
   Pending: "PENDING",
   Open: "OPEN",
   Closed: "CLOSED",
   Other: "OTHER",
 } as const;
+/**
+ * the matter status
+ */
 export type LegalMatterStatus = OpenEnum<typeof LegalMatterStatus>;
 
 export type LegalMatter = {
+  /**
+   * how the matter is billed
+   */
   billingMethod?: BillingMethod | undefined;
   /**
    * the client's own reference number for this matter
    */
   clientReference?: string | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the matter was closed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   closedAt?: Date | undefined;
   /**
@@ -57,24 +72,39 @@ export type LegalMatter = {
    */
   contactIds?: Array<string> | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the matter was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   createdAt?: Date | undefined;
+  /**
+   * ISO 4217 currency code
+   */
   currency?: string | undefined;
+  /**
+   * free-text description of the matter
+   */
   description?: string | undefined;
+  /**
+   * unique identifier for the matter
+   */
   id?: string | undefined;
+  /**
+   * whether the matter is billable
+   */
   isBillable?: boolean | undefined;
   /**
    * custom field values
    */
   metadata?: Array<LegalMetadata> | undefined;
+  /**
+   * the matter name
+   */
   name?: string | undefined;
   /**
    * the firm's display/matter number
    */
   number?: string | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the matter was opened (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   openedAt?: Date | undefined;
   /**
@@ -86,25 +116,31 @@ export type LegalMatter = {
    */
   parties?: Array<LegalParty> | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the matter became pending (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   pendingAt?: Date | undefined;
   /**
    * pointer to the Legal Practicearea object
    */
   practiceareaId?: string | undefined;
+  /**
+   * raw data from the integration
+   */
   raw?: { [k: string]: any } | undefined;
   /**
    * the matter stage name
    */
   stage?: string | undefined;
+  /**
+   * the matter status
+   */
   status?: LegalMatterStatus | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * statute of limitations deadline for the matter (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   statuteOfLimitationsAt?: Date | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the matter was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   updatedAt?: Date | undefined;
   /**

package/src/sdk/models/shared/legalmetadata.ts

@@ -14,6 +14,9 @@ export type LegalMetadata1 = {};
 
 export type LegalMetadata5 = LegalMetadata1 | string | number | boolean;
 
+/**
+ * additional data about the custom field
+ */
 export type LegalMetadataExtraData =
   | { [k: string]: any }
   | string
@@ -21,6 +24,9 @@ export type LegalMetadataExtraData =
   | boolean
   | Array<LegalMetadata1 | string | number | boolean>;
 
+/**
+ * the data type of the value
+ */
 export const LegalMetadataFormat = {
   Text: "TEXT",
   Number: "NUMBER",
@@ -36,6 +42,9 @@ export const LegalMetadataFormat = {
   Currency: "CURRENCY",
   Url: "URL",
 } as const;
+/**
+ * the data type of the value
+ */
 export type LegalMetadataFormat = OpenEnum<typeof LegalMetadataFormat>;
 
 export type LegalMetadataSchemas1 = {};
@@ -46,6 +55,9 @@ export type LegalMetadataSchemas5 =
   | number
   | boolean;
 
+/**
+ * the custom field value
+ */
 export type LegalMetadataValue =
   | { [k: string]: any }
   | string
@@ -54,6 +66,9 @@ export type LegalMetadataValue =
   | Array<LegalMetadataSchemas1 | string | number | boolean>;
 
 export type LegalMetadata = {
+  /**
+   * additional data about the custom field
+   */
   extraData?:
     | { [k: string]: any }
     | string
@@ -61,10 +76,25 @@ export type LegalMetadata = {
     | boolean
     | Array<LegalMetadata1 | string | number | boolean>
     | undefined;
+  /**
+   * the data type of the value
+   */
   format?: LegalMetadataFormat | undefined;
+  /**
+   * the custom field identifier
+   */
   id?: string | undefined;
+  /**
+   * the scope or origin of the custom field
+   */
   namespace?: string | undefined;
+  /**
+   * the custom field key
+   */
   slug?: string | undefined;
+  /**
+   * the custom field value
+   */
   value?:
     | { [k: string]: any }
     | string

package/src/sdk/models/shared/legalparty.ts

@@ -10,6 +10,9 @@ import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * the party role on the matter
+ */
 export const LegalPartyRole = {
   Client: "CLIENT",
   OpposingParty: "OPPOSING_PARTY",
@@ -21,6 +24,9 @@ export const LegalPartyRole = {
   Referrer: "REFERRER",
   Other: "OTHER",
 } as const;
+/**
+ * the party role on the matter
+ */
 export type LegalPartyRole = OpenEnum<typeof LegalPartyRole>;
 
 export type LegalParty = {
@@ -36,6 +42,9 @@ export type LegalParty = {
    * the vendor's free-text relationship description
    */
   description?: string | undefined;
+  /**
+   * the party role on the matter
+   */
   role?: LegalPartyRole | undefined;
 };
 

package/src/sdk/models/shared/legalpracticearea.ts

@@ -16,6 +16,9 @@ import {
   LegalMetadata$outboundSchema,
 } from "./legalmetadata.js";
 
+/**
+ * the normalized practice area type
+ */
 export const LegalPracticeareaType = {
   Administrative: "ADMINISTRATIVE",
   AdmiraltyAndMaritime: "ADMIRALTY_AND_MARITIME",
@@ -77,25 +80,46 @@ export const LegalPracticeareaType = {
   WillsAndEstates: "WILLS_AND_ESTATES",
   WorkersCompensation: "WORKERS_COMPENSATION",
 } as const;
+/**
+ * the normalized practice area type
+ */
 export type LegalPracticeareaType = OpenEnum<typeof LegalPracticeareaType>;
 
 export type LegalPracticearea = {
+  /**
+   * the practice area code
+   */
   code?: string | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the practice area was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   createdAt?: Date | undefined;
+  /**
+   * unique identifier for the practice area
+   */
   id?: string | undefined;
+  /**
+   * whether the practice area is active
+   */
   isActive?: boolean | undefined;
   /**
    * custom field values
    */
   metadata?: Array<LegalMetadata> | undefined;
+  /**
+   * the practice area name
+   */
   name?: string | undefined;
+  /**
+   * raw data from the integration
+   */
   raw?: { [k: string]: any } | undefined;
+  /**
+   * the normalized practice area type
+   */
   type?: LegalPracticeareaType | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the practice area was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   updatedAt?: Date | undefined;
 };

package/src/sdk/models/shared/legaltimeentry.ts

@@ -24,17 +24,32 @@ export type LegalTimeentry = {
    */
   billableMinutes?: number | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the time entry was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   createdAt?: Date | undefined;
+  /**
+   * ISO 4217 currency code
+   */
   currency?: string | undefined;
+  /**
+   * description of the work performed
+   */
   description?: string | undefined;
+  /**
+   * unique identifier for the time entry
+   */
   id?: string | undefined;
   /**
    * pointer to the Accounting Invoice this time was billed on (reference to AccountingInvoice)
    */
   invoiceId?: string | undefined;
+  /**
+   * whether the time entry is billable
+   */
   isBillable?: boolean | undefined;
+  /**
+   * whether the time entry has been billed
+   */
   isBilled?: boolean | undefined;
   /**
    * pointer to the Legal Matter this time is recorded against
@@ -52,14 +67,20 @@ export type LegalTimeentry = {
    * hourly rate, or the flat amount for flat-rate entries
    */
   rateAmount?: number | undefined;
+  /**
+   * raw data from the integration
+   */
   raw?: { [k: string]: any } | undefined;
   /**
    * UTBMS/LEDES task code
    */
   taskCode?: string | undefined;
+  /**
+   * total amount of the time entry
+   */
   totalAmount?: number | undefined;
   /**
-   * (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
+   * when the time entry was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
    */
   updatedAt?: Date | undefined;
   /**

package/src/sdk/models/shared/propertyhealthcarelocationaddress.ts

@@ -12,11 +12,29 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Postal address of the location
  */
 export type PropertyHealthcareLocationAddress = {
+  /**
+   * First line of the street address
+   */
   address1?: string | undefined;
+  /**
+   * Second line of the street address
+   */
   address2?: string | undefined;
+  /**
+   * City or locality
+   */
   city?: string | undefined;
+  /**
+   * Country
+   */
   country?: string | undefined;
+  /**
+   * Postal or ZIP code
+   */
   postalCode?: string | undefined;
+  /**
+   * Regional area (e.g., state in the U.S., province in Canada)
+   */
   region?: string | undefined;
 };
 

package/src/sdk/models/shared/propertyhealthcarepatientaddress.ts

@@ -12,11 +12,29 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Home address of the patient
  */
 export type PropertyHealthcarePatientAddress = {
+  /**
+   * First line of the street address
+   */
   address1?: string | undefined;
+  /**
+   * Second line of the street address
+   */
   address2?: string | undefined;
+  /**
+   * City or locality
+   */
   city?: string | undefined;
+  /**
+   * Country
+   */
   country?: string | undefined;
+  /**
+   * Postal or ZIP code
+   */
   postalCode?: string | undefined;
+  /**
+   * Regional area (e.g., state in the U.S., province in Canada)
+   */
   region?: string | undefined;
 };
 

package/src/sdk/models/shared/propertyhealthcarepractitioneraddress.ts

@@ -12,11 +12,29 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Work address of the practitioner
  */
 export type PropertyHealthcarePractitionerAddress = {
+  /**
+   * First line of the street address
+   */
   address1?: string | undefined;
+  /**
+   * Second line of the street address
+   */
   address2?: string | undefined;
+  /**
+   * City or locality
+   */
   city?: string | undefined;
+  /**
+   * Country
+   */
   country?: string | undefined;
+  /**
+   * Postal or ZIP code
+   */
   postalCode?: string | undefined;
+  /**
+   * Regional area (e.g., state in the U.S., province in Canada)
+   */
   region?: string | undefined;
 };