@equisoft/equisoft-connect-sdk-typescript 10.28.3 → 10.29.0

package/dist/models/ContactContactAdditionalInformation.d.ts

@@ -17,61 +17,61 @@ import { FieldValue } from './FieldValue';
  */
 export interface ContactContactAdditionalInformation {
     /**
-     *
+     * Is the contact deceased
      * @type {boolean}
      * @memberof ContactContactAdditionalInformation
      */
     isDeceased?: boolean;
     /**
-     *
+     * Deceased date
      * @type {Date}
      * @memberof ContactContactAdditionalInformation
      */
     deceasedDate?: Date | null;
     /**
-     *
+     * Is the contact a smoker
      * @type {boolean}
      * @memberof ContactContactAdditionalInformation
      */
     isSmoker?: boolean | null;
     /**
-     *
+     * Smoker end date
      * @type {Date}
      * @memberof ContactContactAdditionalInformation
      */
     smokerEndDate?: Date | null;
     /**
-     *
+     * Birthdate
      * @type {Date}
      * @memberof ContactContactAdditionalInformation
      */
     birthDate?: Date | null;
     /**
-     *
+     * Facebook link
      * @type {string}
      * @memberof ContactContactAdditionalInformation
      */
     facebookLink?: string;
     /**
-     *
+     * Twitter link
      * @type {string}
      * @memberof ContactContactAdditionalInformation
      */
     twitterLink?: string;
     /**
-     *
+     * LinkedIn link
      * @type {string}
      * @memberof ContactContactAdditionalInformation
      */
     linkedInLink?: string;
     /**
-     *
+     * Contact's language
      * @type {FieldValue}
      * @memberof ContactContactAdditionalInformation
      */
     language?: FieldValue | null;
     /**
-     *
+     * Contact's picture document id
      * @type {number}
      * @memberof ContactContactAdditionalInformation
      */

package/dist/models/ContactContactAddress.d.ts

@@ -17,19 +17,19 @@ import { FieldValue } from './FieldValue';
  */
 export interface ContactContactAddress {
     /**
-     *
+     * Address unique identifier
      * @type {number}
      * @memberof ContactContactAddress
      */
     id?: number;
     /**
-     *
+     * Is the contact main address
      * @type {boolean}
      * @memberof ContactContactAddress
      */
     isMain?: boolean;
     /**
-     *
+     * Is the contact postal address
      * @type {boolean}
      * @memberof ContactContactAddress
      */
@@ -41,31 +41,31 @@ export interface ContactContactAddress {
      */
     type?: FieldValue;
     /**
-     *
+     * Address line 1
      * @type {string}
      * @memberof ContactContactAddress
      */
     line1?: string;
     /**
-     *
+     * Address line 2
      * @type {string}
      * @memberof ContactContactAddress
      */
     line2?: string;
     /**
-     *
+     * Address state or province
      * @type {string}
      * @memberof ContactContactAddress
      */
     stateProvince?: string;
     /**
-     *
+     * Country
      * @type {string}
      * @memberof ContactContactAddress
      */
     country?: string;
     /**
-     *
+     * Postal code
      * @type {string}
      * @memberof ContactContactAddress
      */
@@ -77,13 +77,13 @@ export interface ContactContactAddress {
      */
     dateSince?: Date | null;
     /**
-     *
+     * City
      * @type {string}
      * @memberof ContactContactAddress
      */
     city?: string;
     /**
-     *
+     * Is address locked for modifications
      * @type {boolean}
      * @memberof ContactContactAddress
      */

package/dist/models/ContactContactEmail.d.ts

@@ -17,13 +17,13 @@ import { FieldValue } from './FieldValue';
  */
 export interface ContactContactEmail {
     /**
-     *
+     * Email unique identifier
      * @type {number}
      * @memberof ContactContactEmail
      */
     id?: number;
     /**
-     *
+     * Is the main email for contact
      * @type {boolean}
      * @memberof ContactContactEmail
      */
@@ -35,19 +35,19 @@ export interface ContactContactEmail {
      */
     type?: FieldValue;
     /**
-     *
+     * Email address
      * @type {string}
      * @memberof ContactContactEmail
      */
     email?: string;
     /**
-     *
+     * Email notes
      * @type {string}
      * @memberof ContactContactEmail
      */
     notes?: string;
     /**
-     *
+     * Is email locked for modifications
      * @type {boolean}
      * @memberof ContactContactEmail
      */

package/dist/models/ContactContactIdentification.d.ts

@@ -17,55 +17,55 @@ import { FieldValue } from './FieldValue';
  */
 export interface ContactContactIdentification {
     /**
-     *
+     * Contact's title
      * @type {FieldValue}
      * @memberof ContactContactIdentification
      */
     title?: FieldValue | null;
     /**
-     *
+     * Contact's gender
      * @type {string}
      * @memberof ContactContactIdentification
      */
     gender?: string;
     /**
-     *
+     * Contact's first name
      * @type {string}
      * @memberof ContactContactIdentification
      */
     firstName?: string;
     /**
-     *
+     * Contact's middle name
      * @type {string}
      * @memberof ContactContactIdentification
      */
     middleName?: string;
     /**
-     *
+     * Contact's last name
      * @type {string}
      * @memberof ContactContactIdentification
      */
     lastName?: string;
     /**
-     *
+     * Contact's maiden name
      * @type {string}
      * @memberof ContactContactIdentification
      */
     maidenName?: string;
     /**
-     *
+     * Contact's suffix
      * @type {string}
      * @memberof ContactContactIdentification
      */
     suffix?: string;
     /**
-     *
+     * Contact's greeting
      * @type {string}
      * @memberof ContactContactIdentification
      */
     greeting?: string;
     /**
-     *
+     * Contact's client number
      * @type {string}
      * @memberof ContactContactIdentification
      */

package/dist/models/ContactContactMaritalStatus.d.ts

@@ -17,31 +17,31 @@ import { FieldValue } from './FieldValue';
  */
 export interface ContactContactMaritalStatus {
     /**
-     *
+     * Marital status unique identifier
      * @type {number}
      * @memberof ContactContactMaritalStatus
      */
     id?: number;
     /**
-     *
+     * Marital status start date
      * @type {Date}
      * @memberof ContactContactMaritalStatus
      */
     startDate?: Date | null;
     /**
-     *
+     * Marital status end date
      * @type {Date}
      * @memberof ContactContactMaritalStatus
      */
     endDate?: Date | null;
     /**
-     *
+     * Marital status current status
      * @type {FieldValue}
      * @memberof ContactContactMaritalStatus
      */
     status?: FieldValue | null;
     /**
-     *
+     * Marriage contract type
      * @type {FieldValue}
      * @memberof ContactContactMaritalStatus
      */

package/dist/models/ContactContactOccupation.d.ts

@@ -16,37 +16,37 @@
  */
 export interface ContactContactOccupation {
     /**
-     *
+     * Occupation unique identifier
      * @type {number}
      * @memberof ContactContactOccupation
      */
     id?: number;
     /**
-     *
+     * Occupation description
      * @type {string}
      * @memberof ContactContactOccupation
      */
     occupation?: string;
     /**
-     *
+     * Employer
      * @type {string}
      * @memberof ContactContactOccupation
      */
     employer?: string;
     /**
-     *
+     * Occupation's start date
      * @type {Date}
      * @memberof ContactContactOccupation
      */
     startDate?: Date | null;
     /**
-     *
+     * Occupation's end date
      * @type {Date}
      * @memberof ContactContactOccupation
      */
     endDate?: Date | null;
     /**
-     *
+     * Occupation's annual income
      * @type {number}
      * @memberof ContactContactOccupation
      */

package/dist/models/ContactContactPhone.d.ts

@@ -17,13 +17,13 @@ import { FieldValue } from './FieldValue';
  */
 export interface ContactContactPhone {
     /**
-     *
+     * Phone unique identifier
      * @type {number}
      * @memberof ContactContactPhone
      */
     id?: number;
     /**
-     *
+     * Is contact's main phone
      * @type {boolean}
      * @memberof ContactContactPhone
      */
@@ -35,31 +35,31 @@ export interface ContactContactPhone {
      */
     type?: FieldValue;
     /**
-     *
+     * Phone number
      * @type {string}
      * @memberof ContactContactPhone
      */
     number?: string;
     /**
-     *
+     * Phone extension
      * @type {string}
      * @memberof ContactContactPhone
      */
     extension?: string;
     /**
-     *
+     * Is phone a long distance number
      * @type {boolean}
      * @memberof ContactContactPhone
      */
     longDistance?: boolean;
     /**
-     *
+     * Phone's notes
      * @type {string}
      * @memberof ContactContactPhone
      */
     notes?: string;
     /**
-     *
+     * Is phone locked for modifications
      * @type {boolean}
      * @memberof ContactContactPhone
      */

package/dist/models/ContactContactSegmentation.d.ts

@@ -47,43 +47,43 @@ export interface ContactContactSegmentation {
      */
     industries: Array<FieldValue>;
     /**
-     *
+     * Contact's segmentation 1
      * @type {FieldValue}
      * @memberof ContactContactSegmentation
      */
     segmentation1?: FieldValue | null;
     /**
-     *
+     * Contact's segmentation 2
      * @type {FieldValue}
      * @memberof ContactContactSegmentation
      */
     segmentation2?: FieldValue | null;
     /**
-     *
+     * Contact's segmentation 3
      * @type {FieldValue}
      * @memberof ContactContactSegmentation
      */
     segmentation3?: FieldValue | null;
     /**
-     *
+     * Contact's segmentation 4
      * @type {FieldValue}
      * @memberof ContactContactSegmentation
      */
     segmentation4?: FieldValue | null;
     /**
-     *
+     * Contact's segmentation 5
      * @type {FieldValue}
      * @memberof ContactContactSegmentation
      */
     segmentation5?: FieldValue | null;
     /**
-     *
+     * Contact's segmentation 6
      * @type {FieldValue}
      * @memberof ContactContactSegmentation
      */
     segmentation6?: FieldValue | null;
     /**
-     *
+     * Contact's territory
      * @type {FieldValue}
      * @memberof ContactContactSegmentation
      */

package/dist/models/ContactContactWebsite.d.ts

@@ -16,25 +16,25 @@
  */
 export interface ContactContactWebsite {
     /**
-     *
+     * Website unique identifier
      * @type {number}
      * @memberof ContactContactWebsite
      */
     id?: number;
     /**
-     *
+     * Website's url
      * @type {string}
      * @memberof ContactContactWebsite
      */
     url?: string;
     /**
-     *
+     * Is the contact's main website
      * @type {boolean}
      * @memberof ContactContactWebsite
      */
     isMain?: boolean;
     /**
-     *
+     * Is website locked for modifications
      * @type {boolean}
      * @memberof ContactContactWebsite
      */

package/dist/models/ContactsContact.d.ts

@@ -25,55 +25,55 @@ import { ContactContactWebsite } from './ContactContactWebsite';
  */
 export interface ContactsContact {
     /**
-     *
+     * Contact unique numeric identifier
      * @type {number}
      * @memberof ContactsContact
      */
     id: number;
     /**
-     *
+     * Contact unique string identifier
      * @type {string}
      * @memberof ContactsContact
      */
     uuid: string;
     /**
-     *
+     * Contact type ('CUS','OTHER')
      * @type {string}
      * @memberof ContactsContact
      */
     contactType: string;
     /**
-     *
+     * Contact complete name ("[Last name] [First Name]") or company Name for 'Organization' contact
      * @type {string}
      * @memberof ContactsContact
      */
     displayName?: string;
     /**
-     *
+     * Contact sort name
      * @type {string}
      * @memberof ContactsContact
      */
     sortName?: string;
     /**
-     *
+     * Contact notes
      * @type {string}
      * @memberof ContactsContact
      */
     notes?: string;
     /**
-     *
+     * Contact additional information related to the notes
      * @type {string}
      * @memberof ContactsContact
      */
     notesAdditionalInformation?: string;
     /**
-     *
+     * Creation time. As defined by date-time - RFC3339
      * @type {Date}
      * @memberof ContactsContact
      */
     creationDate?: Date | null;
     /**
-     *
+     * Last update time. As defined by date-time - RFC3339
      * @type {Date}
      * @memberof ContactsContact
      */
@@ -91,13 +91,13 @@ export interface ContactsContact {
      */
     additionalInformation?: ContactContactAdditionalInformation;
     /**
-     *
+     * Contact current marital status
      * @type {ContactContactMaritalStatus}
      * @memberof ContactsContact
      */
     currentMaritalStatus?: ContactContactMaritalStatus | null;
     /**
-     *
+     * Contact current occupation
      * @type {ContactContactOccupation}
      * @memberof ContactsContact
      */

package/dist/models/ContextEquisoftConnect.d.ts

@@ -19,13 +19,13 @@ import { ContextPreferences } from './ContextPreferences';
  */
 export interface ContextEquisoftConnect {
     /**
-     * $profile
+     * Profile name
      * @type {string}
      * @memberof ContextEquisoftConnect
      */
     profile: string;
     /**
-     * $appVersion
+     * Application version
      * @type {string}
      * @memberof ContextEquisoftConnect
      */

package/dist/models/ContextUserContext.d.ts

@@ -37,11 +37,11 @@ export interface ContextUserContext {
      */
     user: ContextUser;
     /**
-     *
+     * actor
      * @type {ContextActor}
      * @memberof ContextUserContext
      */
-    actor?: ContextActor;
+    actor?: ContextActor | null;
     /**
      *
      * @type {ContextEquisoftConnect}

package/dist/models/EventsCreateEventPayload.d.ts

@@ -66,10 +66,10 @@ export interface EventsCreateEventPayload {
     location?: string;
     /**
      * Event type
-     * @type {any}
+     * @type {string}
      * @memberof EventsCreateEventPayload
      */
-    type?: any | null;
+    type?: string;
     /**
      * ID of the field value to use as category.
      * @type {number}
@@ -84,10 +84,10 @@ export interface EventsCreateEventPayload {
     subCategoryId?: number;
     /**
      * Importance/Priority of an event or task. 5 is the most important.
-     * @type {any}
+     * @type {number}
      * @memberof EventsCreateEventPayload
      */
-    priority?: any | null;
+    priority?: number;
     /**
      * Confidentiality level of the Event (private or not). [NORMAL, PRIVATE]
      * @type {string}