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

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
      */

package/models/state-interest.ts

@@ -21,85 +21,85 @@
  */
 export interface StateInterest {
     /**
-     * Note: The database will apply a default value of `0` 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 `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Kev value identifying a specific state interest rate Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof StateInterest
      */
     'stateInterest_Key': number;
     /**
-     * 
+     * Value for interest to five decimal places, used in EDI/ACH interest calculations.
      * @type {number}
      * @memberof StateInterest
      */
     'acH_Interest_Pct'?: number | null;
     /**
-     * 
+     * User selection to control a window for interest to be avoided in EDI/ACH calculations.
      * @type {string}
      * @memberof StateInterest
      */
     'acH_No_Interest_Within'?: 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.
+     * Flag to control force only business days on the calendar to be used in EDI/ACH interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof StateInterest
      */
     'calc_Interest_ACH_Business_Days': boolean;
     /**
-     * 
+     * Value for the (lower bound on StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.
      * @type {number}
      * @memberof StateInterest
      */
     'calc_Interest_ACH_Prompt_Pay_Freq'?: number | null;
     /**
-     * 
+     * Value for the upper bound (StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.
      * @type {number}
      * @memberof StateInterest
      */
     'calc_Interest_ACH_Prompt_Pay_Freq_Thru'?: number | null;
     /**
-     * 
+     * Defines the unit for the prompt pay range in EDI/ACH calculations. D = Days, M = Months, Y = Years.
      * @type {string}
      * @memberof StateInterest
      */
     'calc_Interest_ACH_Prompt_Pay_Type'?: 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.
+     * Flag to control force only business days on the calendar to be used in Manual/Default interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof StateInterest
      */
     'calc_Interest_Business_Days': boolean;
     /**
-     * 
+     * Value for the (lower bound on StateInterest entries only) for Prompt Pay range in Manual/Default calculations.
      * @type {number}
      * @memberof StateInterest
      */
     'calc_Interest_Prompt_Pay_Freq'?: number | null;
     /**
-     * 
+     * Value for the upper bound (StateInterest entries only) for Prompt Pay range in Manual/Default calculations.
      * @type {number}
      * @memberof StateInterest
      */
     'calc_Interest_Prompt_Pay_Freq_Thru'?: number | null;
     /**
-     * 
+     * Defines the unit for the prompt pay range in Manual/Default calculations. D = Days, M = Months, Y = Years.
      * @type {string}
      * @memberof StateInterest
      */
     'calc_Interest_Prompt_Pay_Type'?: 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.
+     * Flag to control if/how interest is compounded in EDI/ACH interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof StateInterest
      */
     'compound_ACH_Interest': boolean;
     /**
-     * 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.
+     * Flag to control if/how interest is compounded in Manual/Default interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof StateInterest
      */
     'compound_Interest': boolean;
     /**
-     * 
+     * Date the interest rate becomes effective
      * @type {string}
      * @memberof StateInterest
      */
@@ -117,25 +117,25 @@ export interface StateInterest {
      */
     'entry_User'?: string | null;
     /**
-     * 
+     * Interest rate that applies in the specified state
      * @type {number}
      * @memberof StateInterest
      */
     'interest_Pct'?: number | null;
     /**
-     * 
+     * Option to indicate no interest should be applied within the selected timeframe
      * @type {string}
      * @memberof StateInterest
      */
     'no_Interest_Within'?: string | null;
     /**
-     * 
+     * Two letter abbeviation for the state
      * @type {string}
      * @memberof StateInterest
      */
     'state': string;
     /**
-     * 
+     * Date the interest rate terminates
      * @type {string}
      * @memberof StateInterest
      */

package/models/state.ts

@@ -33,13 +33,13 @@ export interface State {
      */
     'all_States'?: string | null;
     /**
-     * Flag indicating if state tax should be applied to calculations  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.
+     * Flag indicating if state tax should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof State
      */
     'apply_State_Tax': boolean;
     /**
-     * Flag indicating if ACH/EDI prompt pay frequency is based on business days  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.
+     * Flag indicating if ACH/EDI prompt pay frequency is based on business days Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof State
      */
@@ -57,7 +57,7 @@ export interface State {
      */
     'calc_Interest_ACH_Prompt_Pay_Type'?: string | null;
     /**
-     * Flag indicating if manual prompt pay frequency is based on business days  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.
+     * Flag indicating if manual prompt pay frequency is based on business days Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof State
      */
@@ -75,7 +75,7 @@ export interface State {
      */
     'calc_Interest_Prompt_Pay_Type'?: string | null;
     /**
-     * Amount of the default percentage election that should be applied to calculations  Note: The database will apply a default value of `0` 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 `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * Amount of the default percentage election that should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof State
      */
@@ -111,13 +111,13 @@ export interface State {
      */
     'update_User'?: string | null;
     /**
-     * Flag indicating if the default percentage election should be applied to calculations  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.
+     * Flag indicating if the default percentage election should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof State
      */
     'use_Percentage_Election': boolean;
     /**
-     * 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.
+     * Flag to control whether to use the State Interest entries for a specific state instead of State Details. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof State
      */

package/models/sub-enrollment-plan.ts

@@ -39,13 +39,13 @@ export interface SubEnrollmentPlan {
      */
     'division_ID': string;
     /**
-     * References the Subenrollment.Group_Coverage_Start value in the parent table.
+     * References the Subenrollment.Group_Coverage_Start value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubEnrollmentPlan
      */
     'group_Coverage_Start': string;
     /**
-     * References the Subenrollment.Start_Date value in the parent table.
+     * References the Subenrollment.Start_Date value in the parent table. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubEnrollmentPlan
      */
@@ -57,13 +57,13 @@ export interface SubEnrollmentPlan {
      */
     'plan_ID': string;
     /**
-     * Start date of Plan coverage.
+     * Start date of Plan coverage. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubEnrollmentPlan
      */
     'plan_Start': string;
     /**
-     * 
+     * Holds the date for the subscriber\'s application to disclose pre-existing conditions.
      * @type {string}
      * @memberof SubEnrollmentPlan
      */
@@ -153,13 +153,13 @@ export interface SubEnrollmentPlan {
      */
     'update_User'?: string | null;
     /**
-     * This option tells the system to calculate the \'Volume\' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation.  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.
+     * This option tells the system to calculate the \'Volume\' using the Group volume rules. Checking this box will display an elipsis that when clicked will explain the volume calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {boolean}
      * @memberof SubEnrollmentPlan
      */
     'use_Volume_Scale': boolean;
     /**
-     * 
+     * Unique identifier for the CommissionAgencyRep table
      * @type {number}
      * @memberof SubEnrollmentPlan
      */

package/models/sub-payment-method.ts

@@ -21,13 +21,13 @@
  */
 export interface SubPaymentMethod {
     /**
-     * The primary key and identifier of the record  Note: The database will apply a default value of `0` 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 `0` to meet the API requirements and ensure that the functionality occurs as expected.
+     * The primary key and identifier of the record Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {number}
      * @memberof SubPaymentMethod
      */
     'sub_Payment_Method_Key': number;
     /**
-     * 
+     * Day of the month the ACH payment will be taken from the account
      * @type {number}
      * @memberof SubPaymentMethod
      */
@@ -39,7 +39,7 @@ export interface SubPaymentMethod {
      */
     'benefit_Code'?: string | null;
     /**
-     * The effective date of the payment method
+     * The effective date of the payment method Note: This field is marked as NOT NULL in the database and therefore required by the API.
      * @type {string}
      * @memberof SubPaymentMethod
      */