@vbasoftware/vbapi-vbasoftware-typescript-axios 1.20240531.2 → 1.20240913.2

package/models/report-track-status.ts

@@ -21,7 +21,7 @@
  */
 export interface ReportTrackStatus {
     /**
-     * ID of the report definition.
+     * ID of the report definition. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof ReportTrackStatus
      */
@@ -39,10 +39,34 @@ export interface ReportTrackStatus {
      */
     'description'?: string | null;
     /**
-     * Indicates that this \'Tracking Status\' will be chosen by default for new reports.
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof ReportTrackStatus
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof ReportTrackStatus
+     */
+    'entry_User'?: string | null;
+    /**
+     * Indicates that this \'Tracking Status\' will be chosen by default for new reports. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof ReportTrackStatus
      */
     'status_Default': boolean;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof ReportTrackStatus
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof ReportTrackStatus
+     */
+    'update_User'?: string | null;
 }
 

package/models/search-request.ts

@@ -58,6 +58,24 @@ export interface SearchRequest {
      * @memberof SearchRequest
      */
     'include_Result_Details'?: boolean | null;
+    /**
+     * This flag indicates you want your search to return a random sample or records matching your search criteria.  If you flag this as true, Random_Sample_Count must also be a value >= 0 or it will throw an exception.
+     * @type {boolean}
+     * @memberof SearchRequest
+     */
+    'use_Random_Sample'?: boolean | null;
+    /**
+     * This value is the raw count of random records you want as a sample based on your search.  Value must be between 0-1000 (because search has paging, this value will default limit to 750 if you do not pass in a larger page size).  As noted below, this value must be between 0-100 if you are flagging this as a percent sample.
+     * @type {number}
+     * @memberof SearchRequest
+     */
+    'random_Sample_Count'?: number | null;
+    /**
+     * This flag indicates that the value in Random_Sample_Count is a Percent value between 0-100.  If true, the Random_Sample_Count is used as the Pct sample of the full result set.  As noted, if this is true, the value in Random_Sample_Count must be between 0-100 or an exception will be thrown.
+     * @type {boolean}
+     * @memberof SearchRequest
+     */
+    'random_Sample_Count_Is_Percent'?: boolean | null;
     /**
      * 
      * @type {Array<CriteriaDetail>}

package/models/security-area-report.ts

@@ -27,10 +27,34 @@ export interface SecurityAreaReport {
      */
     'security_Area': string;
     /**
-     * Name of the report that is being applied or removed from the security area.
+     * Name of the report that is being applied or removed from the security area. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SecurityAreaReport
      */
     'reportDefinition_Key': number;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof SecurityAreaReport
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof SecurityAreaReport
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof SecurityAreaReport
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof SecurityAreaReport
+     */
+    'update_User'?: string | null;
 }
 

package/models/security-area-user.ts

@@ -32,11 +32,35 @@ export interface SecurityAreaUser {
      * @memberof SecurityAreaUser
      */
     'security_Area': string;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof SecurityAreaUser
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof SecurityAreaUser
+     */
+    'entry_User'?: string | null;
     /**
      * Security level that is being applied to the selected User.
      * @type {number}
      * @memberof SecurityAreaUser
      */
     'security_Level'?: number | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof SecurityAreaUser
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof SecurityAreaUser
+     */
+    'update_User'?: string | null;
 }
 

package/models/security-area.ts

@@ -32,5 +32,29 @@ export interface SecurityArea {
      * @memberof SecurityArea
      */
     'description'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof SecurityArea
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof SecurityArea
+     */
+    'entry_User'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof SecurityArea
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof SecurityArea
+     */
+    'update_User'?: string | null;
 }
 

package/models/security-field-set-detail.ts

@@ -21,13 +21,13 @@
  */
 export interface SecurityFieldSetDetail {
     /**
-     * 
+     * Unique identifier for the Security Field Set entry.
      * @type {string}
      * @memberof SecurityFieldSetDetail
      */
     'securityFieldSet_ID': string;
     /**
-     * 
+     * Unique identifier for the Security Field entry.
      * @type {string}
      * @memberof SecurityFieldSetDetail
      */
@@ -45,13 +45,13 @@ export interface SecurityFieldSetDetail {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Type of Field access that is applied.  Only two values:  VIEW or VIEW_MASK.  VIEW locks the field down but shows the information in the field.  VIEW_MASK allow the field to be viewed only but also the information is masked.
      * @type {string}
      * @memberof SecurityFieldSetDetail
      */
     'field_Access'?: string | null;
     /**
-     * 
+     * Identifies the type of Mask applied to this feild.  For now, only two values apply:  SSN or ALL.  SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.
      * @type {string}
      * @memberof SecurityFieldSetDetail
      */

package/models/security-field-set.ts

@@ -21,19 +21,19 @@
  */
 export interface SecurityFieldSet {
     /**
-     * 
+     * Unique identifier for the Security Field Set entry.
      * @type {string}
      * @memberof SecurityFieldSet
      */
     'securityFieldSet_ID': string;
     /**
-     * 
+     * Description of the Security Field Set.
      * @type {string}
      * @memberof SecurityFieldSet
      */
     'description'?: string | null;
     /**
-     * 
+     * Display name of the Security Field Set.
      * @type {string}
      * @memberof SecurityFieldSet
      */

package/models/security-field-user-group.ts

@@ -21,7 +21,7 @@
  */
 export interface SecurityFieldUserGroup {
     /**
-     * Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * Unique identifier for the Security Field User Group entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SecurityFieldUserGroup
      */
@@ -39,25 +39,25 @@ export interface SecurityFieldUserGroup {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Type of Field access that is applied.  Only two values:  VIEW or VIEW_MASK.  VIEW locks the field down but shows the information in the field.  VIEW_MASK allow the field to be viewed only but also the information is masked.
      * @type {string}
      * @memberof SecurityFieldUserGroup
      */
     'field_Access'?: string | null;
     /**
-     * 
+     * Identifies the type of Mask applied to this feild.  For now, only two values apply:  SSN or ALL.  SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.
      * @type {string}
      * @memberof SecurityFieldUserGroup
      */
     'field_Mask'?: string | null;
     /**
-     * 
+     * Unique identifier for the Security Field Set entry.
      * @type {string}
      * @memberof SecurityFieldUserGroup
      */
     'securityFieldSet_ID'?: string | null;
     /**
-     * 
+     * Unique identifier for the Security Field entry.
      * @type {string}
      * @memberof SecurityFieldUserGroup
      */
@@ -75,7 +75,7 @@ export interface SecurityFieldUserGroup {
      */
     'update_User'?: string | null;
     /**
-     * Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * ID of the User Group that the level is being set for. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SecurityFieldUserGroup
      */

package/models/security-field-user.ts

@@ -21,7 +21,7 @@
  */
 export interface SecurityFieldUser {
     /**
-     * Note: This field is marked as NOT NULL in the database and therefore required by the API.
+     * Unique identifier for the Security Field User entry. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SecurityFieldUser
      */
@@ -39,25 +39,25 @@ export interface SecurityFieldUser {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Type of Field access that is applied.  Only two values:  VIEW or VIEW_MASK.  VIEW locks the field down but shows the information in the field.  VIEW_MASK allow the field to be viewed only but also the information is masked.
      * @type {string}
      * @memberof SecurityFieldUser
      */
     'field_Access'?: string | null;
     /**
-     * 
+     * Identifies the type of Mask applied to this feild.  For now, only two values apply:  SSN or ALL.  SSN applies a standard mask of xxx-xx-9977 vs a mask of ALL which sets the field to ***** regardless of value being stored.
      * @type {string}
      * @memberof SecurityFieldUser
      */
     'field_Mask'?: string | null;
     /**
-     * 
+     * Unique identifier for the Security Field Set entry.
      * @type {string}
      * @memberof SecurityFieldUser
      */
     'securityFieldSet_ID'?: string | null;
     /**
-     * 
+     * Unique identifier for the Security Field entry.
      * @type {string}
      * @memberof SecurityFieldUser
      */
@@ -75,7 +75,7 @@ export interface SecurityFieldUser {
      */
     'update_User'?: string | null;
     /**
-     * 
+     * ID of the User whom the level is being set for.
      * @type {string}
      * @memberof SecurityFieldUser
      */

package/models/security-field.ts

@@ -21,19 +21,19 @@
  */
 export interface SecurityField {
     /**
-     * 
+     * Unique identifier for the Security Field entry.
      * @type {string}
      * @memberof SecurityField
      */
     'securityField_ID': string;
     /**
-     * 
+     * Name of the Column, without table, containing values for the Security Field entry.
      * @type {string}
      * @memberof SecurityField
      */
     'column_Name'?: string | null;
     /**
-     * 
+     * This is what the user sees on the front-end for this field entry.
      * @type {string}
      * @memberof SecurityField
      */
@@ -51,7 +51,7 @@ export interface SecurityField {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Name of Table containing values for the Security Field entry.
      * @type {string}
      * @memberof SecurityField
      */

package/models/send-to.ts

@@ -27,31 +27,43 @@ export interface SendTo {
      */
     'sendTo_ID': string;
     /**
-     * Flag indicating this entity can receive disability payments or correspondence
+     * Flag indicating this entity can receive disability payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SendTo
      */
     'disability': boolean;
     /**
-     * Flag indicating this entity can receive life payments or correspondence
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof SendTo
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof SendTo
+     */
+    'entry_User'?: string | null;
+    /**
+     * Flag indicating this entity can receive life payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SendTo
      */
     'life': boolean;
     /**
-     * Flag indicating correspondence can be sent to this entity
+     * Flag indicating correspondence can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SendTo
      */
     'mail_To': boolean;
     /**
-     * Flag indicating this entity can receive medical payments or correspondence
+     * Flag indicating this entity can receive medical payments or correspondence Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SendTo
      */
     'medical': boolean;
     /**
-     * Flag indicating payments can be sent to this entity
+     * Flag indicating payments can be sent to this entity Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SendTo
      */
@@ -62,5 +74,17 @@ export interface SendTo {
      * @memberof SendTo
      */
     'sendTo_Description'?: string | null;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof SendTo
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof SendTo
+     */
+    'update_User'?: string | null;
 }
 

package/models/signature.ts

@@ -21,7 +21,7 @@
  */
 export interface Signature {
     /**
-     * Key value identifying a signature used on checks
+     * Key value identifying a signature used on checks Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof Signature
      */
@@ -32,6 +32,18 @@ export interface Signature {
      * @memberof Signature
      */
     'description'?: string | null;
+    /**
+     * Date record was first added to the system
+     * @type {string}
+     * @memberof Signature
+     */
+    'entry_Date'?: string;
+    /**
+     * User that first added the record to the system
+     * @type {string}
+     * @memberof Signature
+     */
+    'entry_User'?: string | null;
     /**
      * No longer used
      * @type {string}
@@ -44,5 +56,17 @@ export interface Signature {
      * @memberof Signature
      */
     'signature_File': string;
+    /**
+     * Date the record was last updated in the system
+     * @type {string}
+     * @memberof Signature
+     */
+    'update_Date'?: string;
+    /**
+     * User that last updated the record in the system
+     * @type {string}
+     * @memberof Signature
+     */
+    'update_User'?: string | null;
 }
 

package/models/ssoconfig.ts

@@ -21,61 +21,67 @@
  */
 export interface SSOConfig {
     /**
-     * 
+     * A unique identifier for each SSO configuration setting. This is the primary key of the table.
      * @type {string}
      * @memberof SSOConfig
      */
     'ssoConfig_ID': string;
     /**
-     * 
+     * The authorization URL for the initial authentication step in the SSO process.
      * @type {string}
      * @memberof SSOConfig
      */
     'auth_URL'?: string | null;
     /**
-     * 
+     * The client ID issued by the identity provider.
      * @type {string}
      * @memberof SSOConfig
      */
     'client_ID'?: string | null;
     /**
-     * 
+     * The client secret issued by the identity provider.
      * @type {string}
      * @memberof SSOConfig
      */
     'client_Secret'?: string | null;
     /**
-     * 
+     * A detailed description of the SSO configuration.
      * @type {string}
      * @memberof SSOConfig
      */
     'description'?: string | null;
     /**
-     * 
+     * The display name for the SSO configuration.  This value is displayed to the user on the login screen.
      * @type {string}
      * @memberof SSOConfig
      */
     'display'?: string | null;
     /**
-     * 
+     * The name of the SSO provider (e.g., Active Directory, Google, Okta, Auth0).
      * @type {string}
      * @memberof SSOConfig
      */
     'provider_Name'?: string | null;
     /**
-     * Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.
+     * The URL to which the identity provider will redirect the user after authentication.
+     * @type {string}
+     * @memberof SSOConfig
+     */
+    'redirect_URL'?: string | null;
+    /**
+     * A flag indicating whether the SSO configuration is enabled. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SSOConfig
      */
     'ssO_Enable': boolean;
     /**
-     * 
+     * A list of scopes or permissions requested from the identity provider.
      * @type {string}
      * @memberof SSOConfig
      */
     'scopes'?: string | null;
     /**
-     * 
+     * The token URL used to exchange an authorization code for an access token.
      * @type {string}
      * @memberof SSOConfig
      */